feat(superadmin): migrate internal docs from docusaurus to guava kb
This commit is contained in:
@@ -117,11 +117,10 @@ Because the app image keeps the authoritative copy of the code, each container r
|
||||
- Configure backups for the `storage` directories and database dumps.
|
||||
- Hook into your observability stack (e.g., ship container logs to Loki or ELK).
|
||||
|
||||
## 9. Internal docs publishing
|
||||
## 9. Internal docs access
|
||||
|
||||
- Build the static docs site locally or in CI via `./scripts/build-docs-site.sh` (runs `npm ci && npm run build` in `docs/site/` and outputs to `docs/site/build`).
|
||||
- The Nginx container mounts that build directory and serves it at `/internal-docs/`. History fallback is already configured in `docker/nginx/default.conf`.
|
||||
- Access is protected with HTTP Basic Auth. Update `docker/nginx/.htpasswd-docs` with real credentials (`htpasswd -c docker/nginx/.htpasswd-docs <user>`). The repo ships with a weak default for local use—never reuse it in production.
|
||||
- Optionally run the build script inside your CI pipeline before deploying so the static output is always up to date. A typical GitHub Actions job would simply call the script after checkout and upload `docs/site/build` as an artifact or rsync it to the server.
|
||||
- Internal operations/admin documentation is now delivered in Filament through the Guava Knowledge Base plugin.
|
||||
- Access path: `/super-admin/docs` (same auth guard as SuperAdmin).
|
||||
- No separate static docs build/container is required.
|
||||
|
||||
With the provided configuration you can bootstrap a consistent Docker-based deployment across environments while keeping queue workers, migrations, and asset builds manageable. Adjust service definitions as needed for staging vs. production.
|
||||
|
||||
@@ -121,9 +121,8 @@ Only SuperAdmins should have access to these widgets. If you rotate the API key,
|
||||
|
||||
With this setup the Fotospiel team can manage deployments, restarts, and metrics centrally through Dokploy while Laravel’s scheduler and workers continue to run within the same infrastructure.
|
||||
|
||||
## 8. Internal docs publishing in Dokploy
|
||||
## 8. Internal docs in Dokploy
|
||||
|
||||
- Build the static docs site during CI/CD by running `./scripts/build-docs-site.sh`. Upload the resulting `docs/site/build` directory as part of the deployment artifact or copy it into the Dokploy server before redeploying the stack.
|
||||
- `docker-compose.dokploy.yml` mounts that directory into the Nginx container and exposes it at `/internal-docs/`, protected by HTTP Basic Auth.
|
||||
- Update `docker/nginx/.htpasswd-docs` with production credentials (use `htpasswd -c docker/nginx/.htpasswd-docs <user>` locally, then redeploy). The repository ships with a weak default only for development—always override it in Dokploy.
|
||||
- If Dokploy builds the image itself, add a post-build hook or automation step that runs the docs build and copies it into the shared storage volume before restarting the `web` service.
|
||||
- Internal operations/admin documentation is served from the SuperAdmin panel itself via the Guava Knowledge Base.
|
||||
- Access path: `/super-admin/docs` with normal SuperAdmin authentication (`super_admin` guard).
|
||||
- No dedicated documentation build container or static docs artifact is required in Dokploy.
|
||||
|
||||
Reference in New Issue
Block a user