[PR #380] [MERGED] make all environment variables consistent & list them in docs #4065

New Issue

GiteaMirror · 2026-04-13T12:27:10-05:00

GiteaMirror commented

2026-04-13 12:27:10 -05:00

📋 Pull Request Information

Original PR: https://github.com/imputnet/cobalt/pull/380
Author: @wukko
Created: 3/5/2024
Status: ✅ Merged
Merged: 3/5/2024
Merged by: @wukko

Base: 7.11 ← Head: capitalize-env

📝 Commits (10+)

e16ee6c env: readable environment variables in all files
a480221 docker-compose example: update env variables & clearer messaging
7656153 docs: added a list of all variables to run-an-instance.md
011a012 env: rename ENABLE_CORS to CORS_WILDCARD for better clarity
0f51549 docker-compose example: update api comments
12833e1 api: alias deprecated envs to maintain backwards compatibility
bcda104 test: alias deprecated envs here too
f3f0d0e alias-envs: delete old env
18056dc cors: revert cors name change in serverInfo
a487384 instance docs: update CORS_WILDCARD description

📊 Changes

12 files changed (+94 additions, -47 deletions)

View changed files

📝 docs/examples/docker-compose.example.yml (+12 -12)
📝 docs/run-an-instance.md (+22 -0)
📝 src/cobalt.js (+3 -2)
📝 src/core/api.js (+7 -7)
📝 src/core/web.js (+3 -3)
📝 src/modules/pageRender/elements.js (+1 -1)
📝 src/modules/pageRender/page.js (+4 -4)
📝 src/modules/processing/cookie/manager.js (+1 -1)
📝 src/modules/setup.js (+16 -16)
📝 src/modules/stream/manage.js (+1 -1)
➕ src/modules/sub/alias-envs.js (+23 -0)
📝 src/test/test.js (+1 -0)

📄 Description

apiPort -> API_PORT
apiURL -> API_URL
apiName -> API_NAME
cors -> CORS_WILDCARD
cookiePath -> COOKIE_PATH

webPort -> WEB_PORT
webURL -> WEB_URL
showSponsors -> SHOW_SPONSORS
isBeta -> IS_BETA

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/imputnet/cobalt/pull/380 **Author:** [@wukko](https://github.com/wukko) **Created:** 3/5/2024 **Status:** ✅ Merged **Merged:** 3/5/2024 **Merged by:** [@wukko](https://github.com/wukko) **Base:** `7.11` ← **Head:** `capitalize-env` --- ### 📝 Commits (10+) - [`e16ee6c`](https://github.com/imputnet/cobalt/commit/e16ee6c1d32e3c29df77728917403320e599712c) env: readable environment variables in all files - [`a480221`](https://github.com/imputnet/cobalt/commit/a480221fdf89d3e5ecc7e9bda256801255c560cf) docker-compose example: update env variables & clearer messaging - [`7656153`](https://github.com/imputnet/cobalt/commit/765615390a2f1cae4e1fc9c3fe634bdc5e79dfca) docs: added a list of all variables to `run-an-instance.md` - [`011a012`](https://github.com/imputnet/cobalt/commit/011a0127b4390995b522216306721740630a6877) env: rename ENABLE_CORS to CORS_WILDCARD for better clarity - [`0f51549`](https://github.com/imputnet/cobalt/commit/0f515498dc40b5d84d43976be5bff24b7d9631f7) docker-compose example: update api comments - [`12833e1`](https://github.com/imputnet/cobalt/commit/12833e18270f169600bdaefb1546677382a491cd) api: alias deprecated envs to maintain backwards compatibility - [`bcda104`](https://github.com/imputnet/cobalt/commit/bcda104ddbe9aabc8a9ba7681630841aef4410a7) test: alias deprecated envs here too - [`f3f0d0e`](https://github.com/imputnet/cobalt/commit/f3f0d0eb21152d1b405c42343203454133b39c3d) alias-envs: delete old env - [`18056dc`](https://github.com/imputnet/cobalt/commit/18056dc7af1bfcbfc4018e91058b822690a045fb) cors: revert cors name change in serverInfo - [`a487384`](https://github.com/imputnet/cobalt/commit/a487384858e33cde6da7654363fe9c8ccc76b5d1) instance docs: update CORS_WILDCARD description ### 📊 Changes **12 files changed** (+94 additions, -47 deletions) <details> <summary>View changed files</summary> 📝 `docs/examples/docker-compose.example.yml` (+12 -12) 📝 `docs/run-an-instance.md` (+22 -0) 📝 `src/cobalt.js` (+3 -2) 📝 `src/core/api.js` (+7 -7) 📝 `src/core/web.js` (+3 -3) 📝 `src/modules/pageRender/elements.js` (+1 -1) 📝 `src/modules/pageRender/page.js` (+4 -4) 📝 `src/modules/processing/cookie/manager.js` (+1 -1) 📝 `src/modules/setup.js` (+16 -16) 📝 `src/modules/stream/manage.js` (+1 -1) ➕ `src/modules/sub/alias-envs.js` (+23 -0) 📝 `src/test/test.js` (+1 -0) </details> ### 📄 Description `apiPort` -> `API_PORT` `apiURL` -> `API_URL` `apiName` -> `API_NAME` `cors` -> `CORS_WILDCARD` `cookiePath` -> `COOKIE_PATH` `webPort` -> `WEB_PORT` `webURL` -> `WEB_URL` `showSponsors` -> `SHOW_SPONSORS` `isBeta` -> `IS_BETA` --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the pull-request label 2026-04-13 12:27:10 -05:00

GiteaMirror closed this issue

2026-04-13 12:27:11 -05:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/cobalt#4065