blitzwing/cobalt-7
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update main instance api url

Browse source
This commit is contained in:
wukko 2024-05-22 07:54:38 +06:00
parent 1cbceea69c
commit ba75b90992
No known key found for this signature in database
GPG key ID: 3E30B3F26C7B4AA2
3 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/api.md
View file

@ -2,7 +2,7 @@
this document provides info about methods and acceptable variables for all cobalt api requests. this document provides info about methods and acceptable variables for all cobalt api requests.
``` ```
👍 you can use co.wuk.sh instance in your projects for free, just don't be an asshole. 👍 you can use api.cobalt.tools in your projects for free, just don't be an asshole.
``` ```
## POST: `/api/json` ## POST: `/api/json`

8
docs/examples/docker-compose.example.yml
View file

@ -17,8 +17,8 @@ services:
#- 127.0.0.1:9000:9000 #- 127.0.0.1:9000:9000
environment: environment:
# replace https://co.wuk.sh/ with your instance's target url in same format # replace https://api.cobalt.tools/ with your instance's target url in same format
API_URL: "https://co.wuk.sh/" API_URL: "https://api.cobalt.tools/"
# replace eu-nl with your instance's distinctive name # replace eu-nl with your instance's distinctive name
API_NAME: "eu-nl" API_NAME: "eu-nl"
# if you want to use cookies when fetching data from services, uncomment the next line and the lines under volume # if you want to use cookies when fetching data from services, uncomment the next line and the lines under volume
@ -49,8 +49,8 @@ services:
environment: environment:
# replace https://cobalt.tools/ with your instance's target url in same format # replace https://cobalt.tools/ with your instance's target url in same format
WEB_URL: "https://cobalt.tools/" WEB_URL: "https://cobalt.tools/"
# replace https://co.wuk.sh/ with preferred api instance url # replace https://api.cobalt.tools/ with preferred api instance url
API_URL: "https://co.wuk.sh/" API_URL: "https://api.cobalt.tools/"
labels: labels:
- com.centurylinklabs.watchtower.scope=cobalt - com.centurylinklabs.watchtower.scope=cobalt

18
docs/run-an-instance.md
View file

@ -54,7 +54,7 @@ sudo service nscd start
|:----------------------|:----------|:------------------------|:------------| |:----------------------|:----------|:------------------------|:------------|
| `API_PORT` | `9000` | `9000` | changes port from which api server is accessible. | | `API_PORT` | `9000` | `9000` | changes port from which api server is accessible. |
| `API_LISTEN_ADDRESS` | `0.0.0.0` | `127.0.0.1` | changes address from which api server is accessible. **if you are using docker, you usually don't need to configure this.** | | `API_LISTEN_ADDRESS` | `0.0.0.0` | `127.0.0.1` | changes address from which api server is accessible. **if you are using docker, you usually don't need to configure this.** |
| `API_URL` | ➖ | `https://co.wuk.sh/` | changes url from which api server is accessible. <br> ***REQUIRED TO RUN THE API***. | | `API_URL` | ➖ | `https://api.cobalt.tools/` | changes url from which api server is accessible. <br> ***REQUIRED TO RUN THE API***. |
| `API_NAME` | `unknown` | `ams-1` | api server name that is shown in `/api/serverInfo`. | | `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_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`. | | `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`. |
@ -74,13 +74,13 @@ in a docker container, you also need to set the `API_LISTEN_ADDRESS` env to `127
`network_mode` for the container to `host`. `network_mode` for the container to `host`.
### variables for web ### variables for web
| variable name | default | example | description | | variable name | default | example | description |
|:---------------------|:---------------------|:------------------------|:--------------------------------------------------------------------------------------| |:---------------------|:----------------------------|:----------------------------|:--------------------------------------------------------------------------------------|
| `WEB_PORT` | `9001` | `9001` | changes port from which frontend server is accessible. | | `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***. | | `WEB_URL` | ➖ | `https://cobalt.tools/` | changes url from which frontend server is accessible. <br> ***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. | | `API_URL` | `https://api.cobalt.tools/` | `https://api.cobalt.tools/` | changes url which is used for api requests by frontend clients. |
| `SHOW_SPONSORS` | `0` | `1` | toggles sponsor list in about popup. <br> `0`: disabled. `1`: enabled. | | `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. | | `IS_BETA` | `0` | `1` | toggles beta tag next to cobalt logo. <br> `0`: disabled. `1`: enabled. |
| `PLAUSIBLE_HOSTNAME` | ➖ | `plausible.io`* | enables plausible analytics with provided hostname as receiver backend. | | `PLAUSIBLE_HOSTNAME` | ➖ | `plausible.io`* | enables plausible analytics with provided hostname as receiver backend. |
\* don't use plausible.io as receiver backend unless you paid for their cloud service. use your own domain when hosting community edition of plausible. refer to their [docs](https://plausible.io/docs) when needed. \* don't use plausible.io as receiver backend unless you paid for their cloud service. use your own domain when hosting community edition of plausible. refer to their [docs](https://plausible.io/docs) when needed.