From f3832ea4f33f3dbcc7df1d753746720067dbeb83 Mon Sep 17 00:00:00 2001 From: Kosmos Date: Wed, 26 Aug 2026 01:30:33 +0000 Subject: [PATCH] Improve deployment documentation --- README.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index de0ecc2..c2fdcc2 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,8 @@ Docker deployment for [Drivers Hub: Backend](https://github.com/CharlesWithC/HubBackend). 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 @@ -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 `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 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 `external_plugins`. -The deployment patch synchronizes `abbr` and the plugin list from -`config/config.json` to the stored frontend configuration when the backend -starts. Other frontend settings in MariaDB stay unchanged. Restart the backend -after you change `abbr` or enable or disable a plugin. +When the backend starts, it synchronizes `abbr` and the plugin list from +`config/config.json` to the frontend configuration in MariaDB. Other frontend +settings stay unchanged. Restart the backend after you change `abbr` or enable +or disable a plugin. ## Configure external connections @@ -247,11 +254,9 @@ docker compose up -d docker compose ps ``` -The Python builder image is pinned to a tested image digest. Update this digest -deliberately when the compiler environment needs an update. A runtime base -image update does not invalidate the Nuitka build layer. Docker reuses its -normal internal build cache. A complete build is necessary after that cache is -removed. +Docker reuses its build cache for the Nuitka compilation. The first build can +take a long time. A later build usually reuses the compiled layer unless the +backend source, compiler environment, or Docker build cache changed. By default, the API is available at `http://localhost:17777/api`. Swagger UI is available at `http://localhost:17777/api/doc`.