Repository navigation
Make Docker the recommended Panel install - #226
lancepioch wants to merge 2 commits into
Conversation
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 58 minutes. View limit details
No actionable comments were generated in the recent review. Walkthrough
Merge Risk:
|
ApprovabilityVerdict: Approved at Macroscope's review found this PR approvable — Makes Docker the recommended installation path while retaining standalone instructions and redirects for old documentation URLs. Changes affect documentation and example configuration, without automatically modifying existing deployments or data. You can add or adjust custom eligibility rules. Learn more. |
✅ Deploy Preview for pelica ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Add a top-level Getting Started page (requirements, virtualization check, installing Docker) built from the old Docker guide, promote the Docker Panel guide to panel/install, and move the standalone pages under panel/standalone. Update inbound links, the homepage Install button and the footer, and redirect every old URL. Based on the direction proposed in #172. Co-authored-by: Erik Balchunas <felinusfish@gmail.com>
3cbc132 to
5bc2d54
Compare
Dismissing prior approval to re-evaluate 6d74fb7
…by default, HTTPS with a domain), and Docker-first docs (#226) (#241) * feat(install): pelican.dev/install.sh, the Panel on Docker Swarm with Traefik and automatic HTTPS One command on a fresh server, in the spirit of Coolify and Dokploy: curl -fsSL https://pelican.dev/install.sh | sudo bash It checks the server (Linux, x86_64/arm64, virtualization, ports 80/443, DNS), installs Docker if missing, starts a one-node Swarm and deploys the "pelican" stack from /opt/pelican: Traefik on 80/443 (HTTP to HTTPS, Let's Encrypt on the first request, renewals on its own) and the Panel behind it (BEHIND_PROXY, TRUSTED_PROXIES set to the network it shares with Traefik). Profiles: quick (SQLite) or production (MariaDB 11.4 and Redis 7, passwords generated). With --wings it installs Wings as the docs do and routes its domain through Traefik. - Guided: asks for what's missing; with --yes every answer is an option, so automation and AI assistants can drive it. --dry-run shows the plan and writes the files without root and without touching the server. - Configurable afterwards: settings in pelican.env (0600), stack.yml reads them, deploy.sh applies them (and updates the Panel). A second run keeps APP_KEY and passwords and refuses to switch profiles over existing data. - Networks clear of Wings: docker_gwbridge is created on 10.204.0.0/24 before "swarm init" (it would take Wings' 172.18.0.0/16), and Swarm uses 10.203.0.0/16 rather than 10.0.0.0/x, which cloud private networks use. - Traefik in host-mode ports (real client IPs), readTimeout 600s for uploads, every service pinned to this node (local volumes). - Safe output: the swarm join token is never printed; the log is root-only; Let's Encrypt's forbidden example.com contacts are refused up front. Served as a root file (router/paths.mjs ROOT_FILES; the Hub's DocsBuildService::ROOT_FILES needs it too). Tested in scripts/install-sh.test.mjs (dry runs, generated stack parsed as YAML, deploy.sh with a stub docker, shellcheck) and end to end in an Ubuntu 24.04 VM. * docs: Docker first, as in #226, with the install script Ports #226 (Lance) to the Fumadocs site: - guides/docker becomes the top-level Getting Started (requirements, the virtualization check, Docker, swap), now opening with the one-command install. - panel/advanced/docker becomes panel/install, the recommended install: the install script (profiles, options, files, changing settings, updating, Wings on the same server, troubleshooting, backups) and then Docker Compose by hand, with #226's plugins volume and the note on the old ghcr.io/pelican-dev path. - The install without Docker moves to panel/standalone/*. - Redirects for the six old paths (netlify.toml, which the Hub's redirects.json is built from), inbound links, the sidebar, the OG motifs, ui/nav.json. - The AI guide's recommended prompt now drives the install script (asks the questions, writes the command, dry run first); the old prompt becomes the "Standalone install" tab. * feat(install): serve the Panel on the server's external IP by default, no domain needed Without --domain (or an empty answer), the Panel is served on http://<external IPv4> (found automatically, or --ip), with the quick profile and no other questions under --yes. A domain is still the way to HTTPS: give it at install, or later by running the script again with --domain/--email (keys, passwords and data kept) or setting PANEL_DOMAIN and LE_EMAIL and running deploy.sh. After the switch, plain HTTP to the old IP lands on the domain. - Traefik's routes now live in traefik/pelican.yml, written by deploy.sh from pelican.env (IP: the Panel on port 80 at any address; domain: HTTPS with Let's Encrypt, HTTP to HTTPS, Wings' domain). The Panel's APP_URL follows (PANEL_URL). Traefik no longer needs the Docker socket. - Wings without a domain is reached on http://<IP>:8080 (ufw opens it); with a panel domain it needs its own, as before. - The install waits for Swarm to finish rolling the services out before checking the Panel: a changed setting replaces the Panel, and the check used to reach the old one. - Traefik's healthcheck runs every 10s, so it counts as 1/1 sooner. Verified in the Ubuntu 24.04 VM: a fresh install with no domain, then adding a domain (and Wings on one), then back, checking the new Panel right after each. * feat(install): ask nothing by default, take PELICAN_* variables, pin Traefik The model Coolify and Dokploy use: the installer runs straight through and anything not given takes its default. - No questions unless --interactive (or PELICAN_INTERACTIVE=1), which asks for each choice with explanations and needs a terminal. With no options it installs the Panel on the server's IP, quick profile, no Wings. A domain without an email, or Wings without its domain next to a Panel domain, stops with the option and the variable to set. --yes is still accepted, unused. - Every option can be an environment variable (PELICAN_DOMAIN, PELICAN_EMAIL, PELICAN_PROFILE, PELICAN_WINGS, PELICAN_WINGS_DOMAIN, PELICAN_IP, PELICAN_DIR, PELICAN_IMAGE, PELICAN_STAGING, PELICAN_SKIP_DNS_CHECK, PELICAN_DRY_RUN, PELICAN_INTERACTIVE); the option wins. With sudo they go after it: curl ... | sudo PELICAN_DOMAIN=panel.example.com PELICAN_EMAIL=... bash - Traefik pinned to v3.7.19 (was the moving v3 tag). Running the script again moves an install to the version it pins; PELICAN_TRAEFIK_IMAGE for another. Docs and the AI prompt drop --yes and list the variables. Verified in the VM: the script piped into sudo with variables re-ran an install with no questions and moved Traefik to 3.7.19; --interactive answered through a pseudo-terminal. * fix(install): Macroscope's review: staging, Wings re-runs, saved subnet, dry runs, share image - Running again without --staging now moves a staging install to Let's Encrypt production (it kept the saved staging server). A CA set by hand is kept. Each CA gets its own certificate store (deploy.sh names it from LE_CA_SERVER), so staging certificates and the staging account don't carry over. - Re-running with Wings running no longer fails: the binary is downloaded to wings.new and renamed over the running one (writing to it gave "text file busy", curl exit 23, before the stack was deployed). - A second run keeps the PUBLIC_SUBNET saved in pelican.env (it reset it to 10.203.250.0/24, moving TRUSTED_PROXIES and the network) unless PELICAN_PUBLIC_SUBNET asks for another. - A dry run warns about example.com emails instead of stopping, so the docs' dry-run example works; a real run still refuses them. - The panel/install share image quotes lines that are on the page (it was dropped). New lib/og-motifs.test.mjs checks every motif against its page. Verified in the VM: a running /usr/local/bin/wings blocks the old download (curl exit 23) and not the new one; staging, then a run without --staging, switches caServer and the store to production.
…th an AI assistant (#240) * feat(docs): style the docs like the Hub's redesigned pages The docs shared the header idea and tokens with the Hub's pages but still drew hard offset shadows, rounded Fumadocs chrome and white code, so they read as another site. They now use the Hub's pieces: square corners, 3px edges on cards and controls, 2px rules, no offset shadows, navy code in both themes, sky only as an accent. - Top bar: the Hub nav's buttons, theme switch and search input; navy ground and a slate line in the dark theme. - Sidebar and TOC: the Hub's app sidebar (light sky current item, sky edge) and the plugin page's section links. - Page: the plugin page's kicker and title; the Hub's prose links, inline code chips, square lists, Markdown tables (3px edge, sky head). - Code blocks: the egg page's navy install script, with Shiki's dark colours. - Callouts: the Hub's alerts (3px edge, 8px tone edge). Tabs: the plugin page's tabs. "Your setup": a Hub card with its form fields. - Page footer, search dialog: square, edged, no shadows. Mermaid: classic look in the site's colours. - ui/tokens.css: the Hub's page roles as --pl-* tokens (additive). Everything is scoped to .dt-root (or :root:has(.dt-root) for the search dialog), so the interim landing pages are pixel-identical. * feat(docs): copy pages for AI assistants, and a guide to installing with one Every docs page gets three actions under its title: - Copy page: the page as Markdown (/docs/md/<page>.md). When the reader has filled in "Your setup", a "My setup: ..." line goes on top, so an assistant answers for their install; the page text itself is not changed. - Copy all docs: /llms-full.txt, every page in one file (~60k tokens). - Open: Fumadocs' menu (GitHub, Markdown, ChatGPT, Claude, Cursor, Scira). New page guides/ai-assistant ("Installing with an AI Assistant"): how to give an assistant the docs (the buttons, llms.txt, llms-full.txt, <page>.md), a prompt for a production Panel install (asks for OS, domain, web server, database and Wings first, one step at a time, no secrets in chat, and ends on a checklist: HTTPS with renewal, firewall ports, queue worker and cron, permissions, APP_KEY kept off the server, backups and updates), prompts for Wings, troubleshooting and updating, and rules for agents with shell access. Linked from Getting Started. Code blocks: a `wrap` flag (lib/shiki-setup.ts) wraps long lines, used by the prompts; empty lines in plain-text blocks keep their height (they collapsed). * fix(docs): show wrapped prompts in full, without the code block's 600px cap * feat(install): one-command install with Docker Swarm and Traefik (IP by default, HTTPS with a domain), and Docker-first docs (#226) (#241) * feat(install): pelican.dev/install.sh, the Panel on Docker Swarm with Traefik and automatic HTTPS One command on a fresh server, in the spirit of Coolify and Dokploy: curl -fsSL https://pelican.dev/install.sh | sudo bash It checks the server (Linux, x86_64/arm64, virtualization, ports 80/443, DNS), installs Docker if missing, starts a one-node Swarm and deploys the "pelican" stack from /opt/pelican: Traefik on 80/443 (HTTP to HTTPS, Let's Encrypt on the first request, renewals on its own) and the Panel behind it (BEHIND_PROXY, TRUSTED_PROXIES set to the network it shares with Traefik). Profiles: quick (SQLite) or production (MariaDB 11.4 and Redis 7, passwords generated). With --wings it installs Wings as the docs do and routes its domain through Traefik. - Guided: asks for what's missing; with --yes every answer is an option, so automation and AI assistants can drive it. --dry-run shows the plan and writes the files without root and without touching the server. - Configurable afterwards: settings in pelican.env (0600), stack.yml reads them, deploy.sh applies them (and updates the Panel). A second run keeps APP_KEY and passwords and refuses to switch profiles over existing data. - Networks clear of Wings: docker_gwbridge is created on 10.204.0.0/24 before "swarm init" (it would take Wings' 172.18.0.0/16), and Swarm uses 10.203.0.0/16 rather than 10.0.0.0/x, which cloud private networks use. - Traefik in host-mode ports (real client IPs), readTimeout 600s for uploads, every service pinned to this node (local volumes). - Safe output: the swarm join token is never printed; the log is root-only; Let's Encrypt's forbidden example.com contacts are refused up front. Served as a root file (router/paths.mjs ROOT_FILES; the Hub's DocsBuildService::ROOT_FILES needs it too). Tested in scripts/install-sh.test.mjs (dry runs, generated stack parsed as YAML, deploy.sh with a stub docker, shellcheck) and end to end in an Ubuntu 24.04 VM. * docs: Docker first, as in #226, with the install script Ports #226 (Lance) to the Fumadocs site: - guides/docker becomes the top-level Getting Started (requirements, the virtualization check, Docker, swap), now opening with the one-command install. - panel/advanced/docker becomes panel/install, the recommended install: the install script (profiles, options, files, changing settings, updating, Wings on the same server, troubleshooting, backups) and then Docker Compose by hand, with #226's plugins volume and the note on the old ghcr.io/pelican-dev path. - The install without Docker moves to panel/standalone/*. - Redirects for the six old paths (netlify.toml, which the Hub's redirects.json is built from), inbound links, the sidebar, the OG motifs, ui/nav.json. - The AI guide's recommended prompt now drives the install script (asks the questions, writes the command, dry run first); the old prompt becomes the "Standalone install" tab. * feat(install): serve the Panel on the server's external IP by default, no domain needed Without --domain (or an empty answer), the Panel is served on http://<external IPv4> (found automatically, or --ip), with the quick profile and no other questions under --yes. A domain is still the way to HTTPS: give it at install, or later by running the script again with --domain/--email (keys, passwords and data kept) or setting PANEL_DOMAIN and LE_EMAIL and running deploy.sh. After the switch, plain HTTP to the old IP lands on the domain. - Traefik's routes now live in traefik/pelican.yml, written by deploy.sh from pelican.env (IP: the Panel on port 80 at any address; domain: HTTPS with Let's Encrypt, HTTP to HTTPS, Wings' domain). The Panel's APP_URL follows (PANEL_URL). Traefik no longer needs the Docker socket. - Wings without a domain is reached on http://<IP>:8080 (ufw opens it); with a panel domain it needs its own, as before. - The install waits for Swarm to finish rolling the services out before checking the Panel: a changed setting replaces the Panel, and the check used to reach the old one. - Traefik's healthcheck runs every 10s, so it counts as 1/1 sooner. Verified in the Ubuntu 24.04 VM: a fresh install with no domain, then adding a domain (and Wings on one), then back, checking the new Panel right after each. * feat(install): ask nothing by default, take PELICAN_* variables, pin Traefik The model Coolify and Dokploy use: the installer runs straight through and anything not given takes its default. - No questions unless --interactive (or PELICAN_INTERACTIVE=1), which asks for each choice with explanations and needs a terminal. With no options it installs the Panel on the server's IP, quick profile, no Wings. A domain without an email, or Wings without its domain next to a Panel domain, stops with the option and the variable to set. --yes is still accepted, unused. - Every option can be an environment variable (PELICAN_DOMAIN, PELICAN_EMAIL, PELICAN_PROFILE, PELICAN_WINGS, PELICAN_WINGS_DOMAIN, PELICAN_IP, PELICAN_DIR, PELICAN_IMAGE, PELICAN_STAGING, PELICAN_SKIP_DNS_CHECK, PELICAN_DRY_RUN, PELICAN_INTERACTIVE); the option wins. With sudo they go after it: curl ... | sudo PELICAN_DOMAIN=panel.example.com PELICAN_EMAIL=... bash - Traefik pinned to v3.7.19 (was the moving v3 tag). Running the script again moves an install to the version it pins; PELICAN_TRAEFIK_IMAGE for another. Docs and the AI prompt drop --yes and list the variables. Verified in the VM: the script piped into sudo with variables re-ran an install with no questions and moved Traefik to 3.7.19; --interactive answered through a pseudo-terminal. * fix(install): Macroscope's review: staging, Wings re-runs, saved subnet, dry runs, share image - Running again without --staging now moves a staging install to Let's Encrypt production (it kept the saved staging server). A CA set by hand is kept. Each CA gets its own certificate store (deploy.sh names it from LE_CA_SERVER), so staging certificates and the staging account don't carry over. - Re-running with Wings running no longer fails: the binary is downloaded to wings.new and renamed over the running one (writing to it gave "text file busy", curl exit 23, before the stack was deployed). - A second run keeps the PUBLIC_SUBNET saved in pelican.env (it reset it to 10.203.250.0/24, moving TRUSTED_PROXIES and the network) unless PELICAN_PUBLIC_SUBNET asks for another. - A dry run warns about example.com emails instead of stopping, so the docs' dry-run example works; a real run still refuses them. - The panel/install share image quotes lines that are on the page (it was dropped). New lib/og-motifs.test.mjs checks every motif against its page. Verified in the VM: a running /usr/local/bin/wings blocks the old download (curl exit 23) and not the new one; staging, then a run without --staging, switches caServer and the store to production.
|
Closing in favor of #234 |
Based on the direction proposed in #172 (thanks @felinusfish). Stacked on #225; it will retarget to main once that merges.
guides/docker.mdx, which is removed)/docs/panel/installand is now the recommended method/docs/panel/standalone/*under a "Standalone" sidebar categoryguides/docker,panel/advanced/docker,panel/getting-started,panel/webserver-config,panel/panel-setup,panel/optional-configWings stays a binary + systemd install.
npm run buildpasses withonBrokenLinks: "throw".Note
Make Docker the recommended Panel install and restructure docs
Reorganizes the docs site to present a top-level Getting Started page and a Panel installation page built around Docker, replacing the former Panel setup and Docker guide pages.
Macroscope summarized 6d74fb7.
Summary by CodeRabbit