docs(webui): restructure install guide into hub-and-spoke + add deployment page - #502
Merged
Merged
Conversation
…yment page Splits the monolithic install.mdx into a hub at /docs/webui/install/ that covers prerequisites, the WebEnhancer plugin, env-var reference, security notes, and troubleshooting, plus three dedicated pages for the Docker Compose, browser /setup, and CLI wizard install paths. Adds a separate /docs/webui/deployment guide for production concerns: running under systemd or Docker, reverse-proxy snippets for Caddy, Apache and nginx (with Let's Encrypt), sub-directory installs via BASE_PATH, and the /health endpoint for monitoring. Teaches scripts/generate-navigation.mjs to honour an optional numeric navOrder front-matter field so the sidebar lists Install -> Docker -> Web installer -> CLI -> Deployment in that order; falls back to the existing alphabetical sort when navOrder is absent.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
content/docs/webui/install.mdxinto a hub-and-spoke layout undercontent/docs/webui/install/:install/index.mdx) — prerequisites, BanManager-WebEnhancer setup, links to each install path, env-var reference, security notes, and troubleshooting.install/docker.mdx(Docker Compose, both bundled-MySQL and BYO-DB variants),install/web.mdx(browser/setupwizard,SETUP_TOKENmodel,TRUST_PROXY), andinstall/cli.mdx(thebmwebui setupterminal wizard with auto-detect + resumability).content/docs/webui/deployment.mdxcoveringsystemd/ Docker restart policy / PM2, reverse-proxy snippets for Caddy, Apache, and nginx (with Let's Encrypt), sub-directory installs viaBASE_PATH, and the/healthendpoint for monitoring.scripts/generate-navigation.mjsto honour an optional numericnavOrderfront-matter field so the WebUI sidebar renders Install → Docker → Web installer → CLI → Deployment in that order. Falls back to the existing alphabetical sort whennavOrderis absent (non-breaking).data/navigation.jsonto match.The hub keeps the original
/docs/webui/installURL viaindex.mdx, so external links don't break.Notes
BanManager-WebEnhancerexample in the hub deliberately keeps the legacy&colour codes /[pin]token syntax — MiniMessage is v8-only and we're not ready to publish v8 docs yet.master.Test plan
npm run generate-navproduces no diff against the committeddata/navigation.json.npm run devand visit:/docs/webui/install— hub renders, in-page anchors work, links to per-path pages resolve./docs/webui/install/docker,/install/web,/install/cli— render and back-link to the hub./docs/webui/deployment— renders with reverse-proxy + systemd snippets./docs/webui/install.