aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMohamedBassem <me@mbassem.com>2024-05-15 07:30:01 +0100
committerMohamedBassem <me@mbassem.com>2024-05-15 07:30:01 +0100
commitf64a5f3237c41b600f7047c477fbf9e79eae4297 (patch)
treeee44134c6167c945ae26b6c824dfe393ccec334a /docs
parent9b5ef3a70e0e7300124076939587a038b10cb577 (diff)
downloadkarakeep-f64a5f3237c41b600f7047c477fbf9e79eae4297.tar.zst
feature(worker): Allow configuring redis with a password
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/03-configuration.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/docs/03-configuration.md b/docs/docs/03-configuration.md
index 47bd115a..83546ec8 100644
--- a/docs/docs/03-configuration.md
+++ b/docs/docs/03-configuration.md
@@ -10,6 +10,7 @@ The app is mainly configured by environment variables. All the used environment
| REDIS_HOST | Yes | localhost | The address of redis used by background jobs |
| REDIS_PORT | Yes | 6379 | The port of redis used by background jobs |
| REDIS_DB_IDX | No | Not set | The db idx to use with redis. It defaults to 0 (in the client) so you don't usually need to set it unless you explicitly want another db. |
+| REDIS_PASSWORD | No | Not set | The password used for redis authentication. It's not required if your redis instance doesn't require AUTH. |
| MEILI_ADDR | No | Not set | The address of meilisearch. If not set, Search will be disabled. E.g. (`http://meilisearch:7700`) |
| MEILI_MASTER_KEY | Only in Prod and if search is enabled | Not set | The master key configured for meilisearch. Not needed in development environment. Generate one with `openssl rand -base64 36` |
| DISABLE_SIGNUPS | No | false | If enabled, no new signups will be allowed and the signup button will be disabled in the UI |