From 51f903787717d7064c1330d0e464094607990e85 Mon Sep 17 00:00:00 2001 From: Meier Lukas Date: Sun, 17 Aug 2025 19:05:55 +0200 Subject: [PATCH 1/2] docs(env): add custom redis variables --- docs/advanced/environment-variables/index.mdx | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/advanced/environment-variables/index.mdx b/docs/advanced/environment-variables/index.mdx index f46b67b2..1dccd895 100644 --- a/docs/advanced/environment-variables/index.mdx +++ b/docs/advanced/environment-variables/index.mdx @@ -8,6 +8,7 @@ tags: - Environment variables - Variables - Database + - Redis --- Homarr offers a Docker Container, which can be run on any compatible system, such as Unraid, Kubernetes and many more systems! Our Docker container is based on the ``22.12.0-alpine`` image and serves per standard on the port `7575`. @@ -67,6 +68,24 @@ A random secret can be generated by using the following command: `openssl rand - You can either use the url or host, port, name and credentials combined. The URL will be prioritized over the other values. +## Redis + +By default Redis is running within the installation. (for example in Docker). +However for example for K8s it can be useful to use an external Redis instance. + +:::note +External redis is currently not supported with Proxmox Community Scripts +::: + +| Environment Variable | Description | Possible values | Default | +| ------------------------ | ----------- | --------------- | ------- | +| `REDIS_IS_EXTERNAL` | Whether Redis is running externally. | `true` / `false` | `false` | +| `REDIS_HOST` | Hostname of the Redis instance. | Any valid hostname | - | +| `REDIS_PORT` | Port of the Redis instance. | Any valid port | `6379` | +| `REDIS_USERNAME` | Username to connect to the Redis instance. | Any valid username | - | +| `REDIS_PASSWORD` | Password to connect to the Redis instance. | Any valid password | - | +| `REDIS_TLS_CA` | CA certificate for Redis TLS connections. If a certificate is specified the connection will use TLS. | Any valid CA certificate | - | + ## Advanced deployments From 8293147401e74ef2b2f2f65f309ad1f7ec2b52d8 Mon Sep 17 00:00:00 2001 From: Meier Lukas Date: Tue, 16 Sep 2025 21:56:23 +0200 Subject: [PATCH 2/2] docs(redis): add database index environment variable --- docs/advanced/environment-variables/index.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/advanced/environment-variables/index.mdx b/docs/advanced/environment-variables/index.mdx index 582588f2..41729f26 100644 --- a/docs/advanced/environment-variables/index.mdx +++ b/docs/advanced/environment-variables/index.mdx @@ -87,6 +87,7 @@ External redis is currently not supported with Proxmox Community Scripts | `REDIS_PORT` | Port of the Redis instance. | Any valid port | `6379` | | `REDIS_USERNAME` | Username to connect to the Redis instance. | Any valid username | - | | `REDIS_PASSWORD` | Password to connect to the Redis instance. | Any valid password | - | +| `REDIS_DATABASE_INDEX` | Select which database of your redis instance should be used. | Any numeric index | - | | `REDIS_TLS_CA` | CA certificate for Redis TLS connections. If a certificate is specified the connection will use TLS. | Any valid CA certificate | - |