diff options
| author | Mohamed Bassem <me@mbassem.com> | 2025-09-07 15:32:24 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-09-07 15:32:24 +0100 |
| commit | 492b15203807b4ceb00af4b301958344cc5a668f (patch) | |
| tree | 9b91f58cc22cdb4a6a46bd61a968b38729ac8a65 /docs | |
| parent | 4cc86240757376a1f5893ad3fa52f45ff8826a88 (diff) | |
| download | karakeep-492b15203807b4ceb00af4b301958344cc5a668f.tar.zst | |
feat(workers): add worker enable/disable lists (#1885)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/03-configuration.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/docs/03-configuration.md b/docs/docs/03-configuration.md index bd53f1bb..aae1ffa3 100644 --- a/docs/docs/03-configuration.md +++ b/docs/docs/03-configuration.md @@ -6,6 +6,8 @@ The app is mainly configured by environment variables. All the used environment | ------------------------------- | ------------------------------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | PORT | No | 3000 | The port on which the web server will listen. DON'T CHANGE THIS IF YOU'RE USING DOCKER, instead changed the docker bound external port. | | WORKERS_PORT | No | 0 (Random Port) | The port on which the worker will export its prometheus metrics on `/metrics`. By default it's a random unused port. If you want to utilize those metrics, fix the port to a value (and export it in docker if you're using docker). | +| WORKERS_ENABLED_WORKERS | No | Not set | Comma separated list of worker names to enable. If set, only these workers will run. Valid values: crawler,inference,search,tidyAssets,video,feed,assetPreprocessing,webhook,ruleEngine. | +| WORKERS_DISABLED_WORKERS | No | Not set | Comma separated list of worker names to disable. Takes precedence over `WORKERS_ENABLED_WORKERS`. | | DATA_DIR | Yes | Not set | The path for the persistent data directory. This is where the db lives. Assets are stored here by default unless `ASSETS_DIR` is set. | | ASSETS_DIR | No | Not set | The path where crawled assets will be stored. If not set, defaults to `${DATA_DIR}/assets`. | | NEXTAUTH_URL | Yes | Not set | Should point to the address of your server. The app will function without it, but will redirect you to wrong addresses on signout for example. | |