Skip to content

Commit 2ddc452

Browse files
docs(env): add custom redis variables (#412)
1 parent d09a2a9 commit 2ddc452

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/advanced/environment-variables/index.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ tags:
88
- Environment variables
99
- Variables
1010
- Database
11+
- Redis
1112
---
1213

1314
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`.
@@ -70,6 +71,25 @@ A random secret can be generated by using the following command: `openssl rand -
7071
You can either use the url or host, port, name and credentials combined. The URL will be prioritized over the other values.
7172

7273

74+
## Redis
75+
76+
By default Redis is running within the installation. (for example in Docker).
77+
However for example for K8s it can be useful to use an external Redis instance.
78+
79+
:::note
80+
External redis is currently not supported with Proxmox Community Scripts
81+
:::
82+
83+
| Environment Variable | Description | Possible values | Default |
84+
| ------------------------ | ----------- | --------------- | ------- |
85+
| `REDIS_IS_EXTERNAL` | Whether Redis is running externally. | `true` / `false` | `false` |
86+
| `REDIS_HOST` | Hostname of the Redis instance. | Any valid hostname | - |
87+
| `REDIS_PORT` | Port of the Redis instance. | Any valid port | `6379` |
88+
| `REDIS_USERNAME` | Username to connect to the Redis instance. | Any valid username | - |
89+
| `REDIS_PASSWORD` | Password to connect to the Redis instance. | Any valid password | - |
90+
| `REDIS_DATABASE_INDEX` | Select which database of your redis instance should be used. | Any numeric index | - |
91+
| `REDIS_TLS_CA` | CA certificate for Redis TLS connections. If a certificate is specified the connection will use TLS. | Any valid CA certificate | - |
92+
7393

7494
## Advanced deployments
7595

0 commit comments

Comments
 (0)