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

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

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! this document is not final and will expand over time. feel free to improve it!
### general vars ### general vars
| name | default | value example | | name | default | value example |
|:-----------------------|:----------|:--------------------------------------| |:-----------------------|:--------|:--------------------------------------|
| API_URL | | `https://api.url.example/` | | API_URL | | `https://api.url.example/` |
| API_PORT | `9000` | `1337` | | API_PORT | `9000` | `1337` |
| COOKIE_PATH | | `/cookies.json` | | COOKIE_PATH | | `/cookies.json` |
| PROCESSING_PRIORITY | | `10` | | PROCESSING_PRIORITY | | `10` |
| API_INSTANCE_COUNT | | `6` | | API_INSTANCE_COUNT | | `6` |
| API_REDIS_URL | | `redis://localhost:6379` | | API_REDIS_URL | | `redis://localhost:6379` |
| DISABLED_SERVICES | | `bilibili,youtube` | | DISABLED_SERVICES | | `bilibili,youtube` |
| FORCE_LOCAL_PROCESSING | | `always` | | FORCE_LOCAL_PROCESSING | `never` | `always` |
[*view details*](#general) [*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. the value is a string of cobalt-supported services.
### FORCE_LOCAL_PROCESSING ### FORCE_LOCAL_PROCESSING
the value is a string, either `always` or `session`. the value is a string: `never` (default), `session`, or `always`.
when set to `always`, all requests will be forced to use on-device processing, no matter the preference.
when set to `session`, only requests from session (Bearer token) clients will be forced to use on-device processing. 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 ## networking
[*jump to the table*](#networking-vars) [*jump to the table*](#networking-vars)