From ba75b90992ff5e386dfa42468a3eb6a5342208ef Mon Sep 17 00:00:00 2001 From: wukko Date: Wed, 22 May 2024 07:54:38 +0600 Subject: [PATCH] docs: update main instance api url --- docs/api.md | 2 +- docs/examples/docker-compose.example.yml | 8 ++++---- docs/run-an-instance.md | 18 +++++++++--------- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/api.md b/docs/api.md index 57509669..87ef2489 100644 --- a/docs/api.md +++ b/docs/api.md @@ -2,7 +2,7 @@ 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` diff --git a/docs/examples/docker-compose.example.yml b/docs/examples/docker-compose.example.yml index 8f49b61c..fcbcfc63 100644 --- a/docs/examples/docker-compose.example.yml +++ b/docs/examples/docker-compose.example.yml @@ -17,8 +17,8 @@ services: #- 127.0.0.1:9000:9000 environment: - # replace https://co.wuk.sh/ with your instance's target url in same format - API_URL: "https://co.wuk.sh/" + # replace https://api.cobalt.tools/ with your instance's target url in same format + API_URL: "https://api.cobalt.tools/" # 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 and the lines under volume @@ -49,8 +49,8 @@ services: environment: # 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/" + # replace https://api.cobalt.tools/ with preferred api instance url + API_URL: "https://api.cobalt.tools/" labels: - com.centurylinklabs.watchtower.scope=cobalt diff --git a/docs/run-an-instance.md b/docs/run-an-instance.md index 23d6682e..a440d11d 100644 --- a/docs/run-an-instance.md +++ b/docs/run-an-instance.md @@ -54,7 +54,7 @@ sudo service nscd start |:----------------------|:----------|:------------------------|:------------| | `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_URL` | ➖ | `https://co.wuk.sh/` | changes url from which api server is accessible.
***REQUIRED TO RUN THE API***. | +| `API_URL` | ➖ | `https://api.cobalt.tools/` | changes url from which api server is accessible.
***REQUIRED TO RUN THE API***. | | `API_NAME` | `unknown` | `ams-1` | api server name that is shown in `/api/serverInfo`. | | `CORS_WILDCARD` | `1` | `0` | toggles cross-origin resource sharing.
`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`. | @@ -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`. ### 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***. | -| `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. | -| `PLAUSIBLE_HOSTNAME` | ➖ | `plausible.io`* | enables plausible analytics with provided hostname as receiver backend. | +| 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://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.
`0`: disabled. `1`: enabled. | +| `IS_BETA` | `0` | `1` | toggles beta tag next to cobalt logo.
`0`: disabled. `1`: enabled. | +| `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.