Mirrors/cobalt
1
0
Fork 0
mirror of https://github.com/wukko/cobalt.git synced 2025-06-12 05:07:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

make all environment variables consistent & list them in docs (#380)

Browse Source
This commit is contained in:
wukko
2024-03-05 20:19:01 +06:00
committed by GitHub
parent 78c885bb62 a487384858
commit db6a75529d
12 changed files with 94 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/examples/docker-compose.example.yml
View File

@ -13,17 +13,17 @@ services:
ports:
- 9000:9000/tcp
# if you're using a reverse proxy, uncomment the next line:
# if you're using a reverse proxy, uncomment the next line and remove the one above (9000:9000/tcp):
#- 127.0.0.1:9000:9000
environment:
# replace apiURL with your instance's target url in same format
- apiURL=https://co.wuk.sh/
# replace apiName with your instance's distinctive name
- apiName=eu-nl
# replace https://co.wuk.sh/ with your instance's target url in same format
- API_URL=https://co.wuk.sh/
# replace eu-nl with your instance's distinctive name
- API_NAME=eu-nl
# if you want to use cookies when fetching data from services, uncomment the next line
#- cookiePath=/cookies.json
# see cookies_example.json for example file.
#- COOKIE_PATH=/cookies.json
# see cookies.example.json for example file.
labels:
- com.centurylinklabs.watchtower.scope=cobalt
@ -43,14 +43,14 @@ services:
ports:
- 9001:9001/tcp
# if you're using a reverse proxy, uncomment the next line:
# if you're using a reverse proxy, uncomment the next line and remove the one above (9001:9001/tcp):
#- 127.0.0.1:9001:9001
environment:
# replace webURL with your instance's target url in same format
- webURL=https://cobalt.tools/
# replace apiURL with preferred api instance url
- apiURL=https://co.wuk.sh/
# replace https://cobalt.tools/ with your instance's target url in same format
- WEB_URL=https://cobalt.tools/
# replace https://co.wuk.sh/ with preferred api instance url
- API_URL=https://co.wuk.sh/
labels:
- com.centurylinklabs.watchtower.scope=cobalt

22
docs/run-an-instance.md
View File

@ -47,3 +47,25 @@ setup script installs all needed `npm` dependencies, but you have to install `no
sudo apt install nscd
sudo service nscd start
```
## list of all environment variables
### variables for api
| variable name | default | example | description |
|:----------------------|:----------|:------------------------|:------------|
| `API_PORT` | `9000` | `9000` | changes port from which api server is accessible. |
| `API_URL` | ➖ | `https://co.wuk.sh/` | changes url from which api server is accessible. <br> ***REQUIRED TO RUN API***. |
| `API_NAME` | `unknown` | `ams-1` | api server name that is shown in `/api/serverInfo`. |
| `CORS_WILDCARD` | `1` | `0` | toggles cross-origin resource sharing. <br> `0`: disabled. `1`: enabled. |
| `CORS_URL` | not used | `https://cobalt.tools/` | cross-origin resource sharing url. api will be available only from this url if `CORS_WILDCARD` is set to `0`. |
| `COOKIE_PATH` | not used | `/cookies.json` | path for cookie file relative to main folder. |
| `PROCESSING_PRIORITY` | not used | `10` | changes `nice` value* for ffmpeg subprocess. available only on unix systems. |
\* 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. <br> ***REQUIRED TO RUN WEB***. |
| `SHOW_SPONSORS` | `0` | `1` | toggles sponsor list in about popup. <br> `0`: disabled. `1`: enabled. |
| `IS_BETA` | `0` | `1` | toggles beta tag next to cobalt logo. <br> `0`: disabled. `1`: enabled. |