Decouple hub abbreviation from API prefix
This commit is contained in:
@@ -34,7 +34,7 @@ Set secure MariaDB passwords in `.env`. Then, set at least these values in
|
||||
|
||||
```json
|
||||
{
|
||||
"abbr": "api",
|
||||
"abbr": "vtc",
|
||||
"name": "Drivers Hub",
|
||||
"domain": "hub.example.com",
|
||||
"prefix": "/api",
|
||||
@@ -75,8 +75,9 @@ from `config_sample.json`. Restart the backend after you change
|
||||
Use the same database password in `.env` and `config/config.json`.
|
||||
Set `domain` to the public host name of the backend. Do not include a protocol or
|
||||
path.
|
||||
Set `prefix` to `/{abbr}` when you use the official frontend. The
|
||||
`client-config` plugin uses this relation to create frontend API URLs.
|
||||
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
|
||||
match `prefix`.
|
||||
Create an hCaptcha site for the public frontend domain. Set its secret in the
|
||||
`captcha.secret` value. Set the related public site key as
|
||||
`VITE_HCAPTCHA_SITEKEY` in the frontend deployment.
|
||||
@@ -86,10 +87,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 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 enable or
|
||||
disable a plugin.
|
||||
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.
|
||||
|
||||
## Configure external connections
|
||||
|
||||
|
||||
Reference in New Issue
Block a user