Improve deployment documentation

This commit is contained in:
2026-08-26 01:30:40 +00:00
parent f6fb033eb8
commit a762d80693
+10 -11
View File
@@ -10,6 +10,8 @@
Docker deployment for [Drivers Hub: Frontend](https://github.com/CharlesWithC/HubFrontend). Docker deployment for [Drivers Hub: Frontend](https://github.com/CharlesWithC/HubFrontend).
The container serves the static frontend with Nginx. The container serves the static frontend with Nginx.
Use it with the
[Drivers Hub: Backend Docker Deployment](https://gitea.kosmos.ac/kosmos/HubBackendDocker).
## Tested upstream revision ## Tested upstream revision
@@ -18,6 +20,11 @@ This deployment is tested with upstream `main` at commit
which declares package version `3.6.0`. The latest release tag, `v3.4.4`, points which declares package version `3.6.0`. The latest release tag, `v3.4.4`, points
to an older revision and is not the tested source revision. to an older revision and is not the tested source revision.
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 revision above.
## Configure the deployment ## Configure the deployment
Get the frontend source code. Then, create the deployment configuration: Get the frontend source code. Then, create the deployment configuration:
@@ -48,17 +55,9 @@ prefix. This deployment-specific behavior does not apply when
The frontend uses the Vite values during the image build. Rebuild the image after The frontend uses the Vite values during the image build. Rebuild the image after
you change `.env`, including the hCaptcha site key. you change `.env`, including the hCaptcha site key.
The build removes the hard-coded upstream Google Analytics integration and its The web image does not load the Google Analytics integration from the upstream
consent dialog. If upstream removes the known integration, the build skips this frontend. It uses the bundled `/logo.png` file for the login avatar and does not
step. If an unknown Analytics implementation remains, the build stops instead include Electron entry points or Electron configuration.
of publishing it.
The build also replaces the hard-coded external login avatar with the bundled
`/logo.png` file. If upstream removes the known avatar URL, the build skips this
step.
The runtime image does not include the upstream Electron entry points and
configuration. These files are not used by the web deployment.
## Start the deployment ## Start the deployment