From 6d79e1f77b074f682475a4712a3ce677c2230228 Mon Sep 17 00:00:00 2001 From: hyperdefined Date: Thu, 7 Mar 2024 09:05:46 -0500 Subject: [PATCH] docs/api: add missing info about `API_URL` to web (#385) * docs/api: add missing 'API_URL' to web * fix spacing * Update run-an-instance.md * run-an-instance.md: add info about default API_URL for web --------- Co-authored-by: jj Co-authored-by: wukko --- docs/run-an-instance.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/run-an-instance.md b/docs/run-an-instance.md index 5a181cc8..61a2b974 100644 --- a/docs/run-an-instance.md +++ b/docs/run-an-instance.md @@ -63,9 +63,10 @@ sudo service nscd start \* the higher the nice value, the lower the priority. [read more here](https://en.wikipedia.org/wiki/Nice_(Unix)). ### variables for web -| variable name | default | example | description | -|:--------------- |:--------|:------------------------|:--------------------------------------------------------------------------------------| -| `WEB_PORT` | `9001` | `9001` | changes port from which frontend server is accessible. | -| `WEB_URL` | ➖ | `https://cobalt.tools/` | changes url from which frontend server is accessible.
***REQUIRED TO RUN WEB***. | -| `SHOW_SPONSORS` | `0` | `1` | toggles sponsor list in about popup.
`0`: disabled. `1`: enabled. | -| `IS_BETA` | `0` | `1` | toggles beta tag next to cobalt logo.
`0`: disabled. `1`: enabled. | +| variable name | default | example | description | +|:--------------- |:---------------------|:------------------------|:--------------------------------------------------------------------------------------| +| `WEB_PORT` | `9001` | `9001` | changes port from which frontend server is accessible. | +| `WEB_URL` | ➖ | `https://cobalt.tools/` | changes url from which frontend server is accessible.
***REQUIRED TO RUN WEB***. | +| `API_URL` | `https://co.wuk.sh/` | `https://co.wuk.sh/` | changes url which is used for api requests by frontend clients. | +| `SHOW_SPONSORS` | `0` | `1` | toggles sponsor list in about popup.
`0`: disabled. `1`: enabled. | +| `IS_BETA` | `0` | `1` | toggles beta tag next to cobalt logo.
`0`: disabled. `1`: enabled. |