kosmos/HubBackendDocker
1
0
Fork 0
Code Issues Pull Requests Actions Releases Activity

Clarify deployment defaults

Browse Source
This commit is contained in:
kosmos
2026-08-26 02:04:31 +00:00
parent f3832ea4f3
commit d676fd913a
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -2
View File
@@ -86,8 +86,9 @@ Set `abbr` to a short identifier for the VTC. The Docker frontend deployment
derives the API base URL from its `VITE_CONFIG_URL`, so `abbr` does not have to derives the API base URL from its `VITE_CONFIG_URL`, so `abbr` does not have to
match `prefix`. match `prefix`.
Create an hCaptcha site for the public frontend domain. Set its secret in the Create an hCaptcha site for the public frontend domain. Set its secret in the
`captcha.secret` value. Set the related public site key as `captcha.secret` value. The frontend deployment provides the related
`VITE_HCAPTCHA_SITEKEY` in the frontend deployment. `VITE_HCAPTCHA_SITEKEY` setting in its `.env.example`; set it to the public site
key.
The upstream sample uses plural names for some built-in plugins, but the The upstream sample uses plural names for some built-in plugins, but the
backend expects the singular names shown above. This deployment configuration backend expects the singular names shown above. This deployment configuration
@@ -261,6 +262,8 @@ backend source, compiler environment, or Docker build cache changed.
By default, the API is available at `http://localhost:17777/api`. Swagger UI is By default, the API is available at `http://localhost:17777/api`. Swagger UI is
available at `http://localhost:17777/api/doc`. available at `http://localhost:17777/api/doc`.
The default bind address is suitable for a reverse proxy on the Docker host. The default bind address is suitable for a reverse proxy on the Docker host.
The reverse proxy examples in the frontend deployment already use this address
and the `/api` prefix. Update both deployments only if you change these defaults.
The backend reads its active Docker network gateway when it starts. Uvicorn The backend reads its active Docker network gateway when it starts. Uvicorn
trusts forwarded headers only from this gateway and the loopback interface. trusts forwarded headers only from this gateway and the loopback interface.
This works with multiple Docker Compose networks and lets audit and security This works with multiple Docker Compose networks and lets audit and security