Skip to content

docs(env): add custom redis variables #412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 17, 2025
Merged

docs(env): add custom redis variables #412

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
51f9037
docs(env): add custom redis variables
Meierschlumpf Aug 17, 2025
2124074
Merge branch 'master' into custom-redis
Meierschlumpf Sep 16, 2025
8293147
docs(redis): add database index environment variable
Meierschlumpf Sep 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/advanced/environment-variables/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -70,6 +71,25 @@ 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_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 | - |


## Advanced deployments

Expand Down