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

Improve deployment documentation

Browse Source
This commit is contained in:
kosmos
2026-08-26 01:30:33 +00:00
parent c7cc156a2a
commit f3832ea4f3
1 changed files with 14 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+14 -9
View File
@@ -10,6 +10,8 @@
Docker deployment for [Drivers Hub: Backend](https://github.com/CharlesWithC/HubBackend). Docker deployment for [Drivers Hub: Backend](https://github.com/CharlesWithC/HubBackend).
The deployment includes MariaDB, Valkey, and the banner generator. The deployment includes MariaDB, Valkey, and the banner generator.
Use it with the
[Drivers Hub: Frontend Docker Deployment](https://gitea.kosmos.ac/kosmos/HubFrontendDocker).
## Tested upstream version ## Tested upstream version
@@ -18,6 +20,11 @@ This deployment is tested with Drivers Hub: Backend
At the time of this test, the release tag and upstream `main` point to commit At the time of this test, the release tag and upstream `main` point to commit
`a460eed`. `a460eed`.
The clone command below gets the current upstream default branch. A newer
upstream revision can be incompatible with this deployment. If a build or
runtime error occurs after an upstream update, compare the checked-out revision
with the tested version above.
## Configure the deployment ## Configure the deployment
Get the backend source code. Then, create the deployment configuration and the Get the backend source code. Then, create the deployment configuration and the
@@ -87,10 +94,10 @@ backend expects the singular names shown above. This deployment configuration
enables all built-in plugins by default. Keep `client-config` separate in enables all built-in plugins by default. Keep `client-config` separate in
`external_plugins`. `external_plugins`.
The deployment patch synchronizes `abbr` and the plugin list from When the backend starts, it synchronizes `abbr` and the plugin list from
`config/config.json` to the stored frontend configuration when the backend `config/config.json` to the frontend configuration in MariaDB. Other frontend
starts. Other frontend settings in MariaDB stay unchanged. Restart the backend settings stay unchanged. Restart the backend after you change `abbr` or enable
after you change `abbr` or enable or disable a plugin. or disable a plugin.
## Configure external connections ## Configure external connections
@@ -247,11 +254,9 @@ docker compose up -d
docker compose ps docker compose ps
``` ```
The Python builder image is pinned to a tested image digest. Update this digest Docker reuses its build cache for the Nuitka compilation. The first build can
deliberately when the compiler environment needs an update. A runtime base take a long time. A later build usually reuses the compiled layer unless the
image update does not invalidate the Nuitka build layer. Docker reuses its backend source, compiler environment, or Docker build cache changed.
normal internal build cache. A complete build is necessary after that cache is
removed.
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`.