Mirrors/cobalt
1
0
Fork 0
mirror of https://github.com/wukko/cobalt.git synced 2025-05-24 18:42:09 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs/api-env-variables: add "never" to FORCE_LOCAL_PROCESSING

Browse Source
This commit is contained in:
wukko 2025-05-06 17:33:16 +06:00
parent 06b865e965
commit 0e836fa4fc
No known key found for this signature in database
GPG Key ID: 3E30B3F26C7B4AA2
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/api-env-variables.md
View File

@ -3,16 +3,16 @@ you can customize your processing instance's behavior using these environment va
this document is not final and will expand over time. feel free to improve it!
### general vars
| name | default | value example |
|:-----------------------|:----------|:--------------------------------------|
| API_URL | | `https://api.url.example/` |
| API_PORT | `9000` | `1337` |
| COOKIE_PATH | | `/cookies.json` |
| PROCESSING_PRIORITY | | `10` |
| API_INSTANCE_COUNT | | `6` |
| API_REDIS_URL | | `redis://localhost:6379` |
| DISABLED_SERVICES | | `bilibili,youtube` |
| FORCE_LOCAL_PROCESSING | | `always` |
| name | default | value example |
|:-----------------------|:--------|:--------------------------------------|
| API_URL | | `https://api.url.example/` |
| API_PORT | `9000` | `1337` |
| COOKIE_PATH | | `/cookies.json` |
| PROCESSING_PRIORITY | | `10` |
| API_INSTANCE_COUNT | | `6` |
| API_REDIS_URL | | `redis://localhost:6379` |
| DISABLED_SERVICES | | `bilibili,youtube` |
| FORCE_LOCAL_PROCESSING | `never` | `always` |
[*view details*](#general)
@ -103,12 +103,12 @@ comma-separated list which disables certain services from being used.
the value is a string of cobalt-supported services.
### FORCE_LOCAL_PROCESSING
the value is a string, either `always` or `session`.
when set to `always`, all requests will be forced to use on-device processing, no matter the preference.
the value is a string: `never` (default), `session`, or `always`.
when set to `session`, only requests from session (Bearer token) clients will be forced to use on-device processing.
when set to `always`, all requests will be forced to use on-device processing, no matter the preference.
## networking
[*jump to the table*](#networking-vars)