public_git
/
bitnami-containers
mirror of https://github.com/bitnami/containers.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
bitnami-containers/bitnami/redis/README.md

778 lines
36 KiB
Markdown
Raw Permalink Blame History

# Bitnami Secure Image for Redis®
## What is Redis®?
> Redis® is an open source, advanced key-value store. It is often referred to as a data structure server since keys can contain strings, hashes, lists, sets and sorted sets.
[Overview of Redis®](https://redis.io)
Disclaimer: Redis is a registered trademark of Redis Ltd. Any rights therein are reserved to Redis Ltd. Any use by Bitnami is for referential purposes only and does not indicate any sponsorship, endorsement, or affiliation between Redis Ltd.
## TL;DR
```console
docker run --name redis -e ALLOW_EMPTY_PASSWORD=yes bitnami/redis:latest
```
**Warning**: These quick setups are only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the [Configuration](#configuration) section for a more secure deployment.
## ⚠️ Important Notice: Upcoming changes to the Bitnami Catalog
Beginning August 28th, 2025, Bitnami will evolve its public catalog to offer a curated set of hardened, security-focused images under the new [Bitnami Secure Images initiative](https://news.broadcom.com/app-dev/broadcom-introduces-bitnami-secure-images-for-production-ready-containerized-applications). As part of this transition:
- Granting community users access for the first time to security-optimized versions of popular container images.
- Bitnami will begin deprecating support for non-hardened, Debian-based software images in its free tier and will gradually remove non-latest tags from the public catalog. As a result, community users will have access to a reduced number of hardened images. These images are published only under the “latest” tag and are intended for development purposes
- Starting August 28th, over two weeks, all existing container images, including older or versioned tags (e.g., 2.50.0, 10.6), will be migrated from the public catalog (docker.io/bitnami) to the “Bitnami Legacy” repository (docker.io/bitnamilegacy), where they will no longer receive updates.
- For production workloads and long-term support, users are encouraged to adopt Bitnami Secure Images, which include hardened containers, smaller attack surfaces, CVE transparency (via VEX/KEV), SBOMs, and enterprise support.
These changes aim to improve the security posture of all Bitnami users by promoting best practices for software supply chain integrity and up-to-date deployments. For more details, visit the [Bitnami Secure Images announcement](https://github.com/bitnami/containers/issues/83267).
## Why use Bitnami Secure Images?
- Bitnami Secure Images and Helm charts are built to make open source more secure and enterprise ready.
- Triage security vulnerabilities faster, with transparency into CVE risks using industry standard Vulnerability Exploitability Exchange (VEX), KEV, and EPSS scores.
- Our hardened images use a minimal OS (Photon Linux), which reduces the attack surface while maintaining extensibility through the use of an industry standard package format.
- Stay more secure and compliant with continuously built images updated within hours of upstream patches.
- Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
- Hardened images come with attestation signatures (Notation), SBOMs, virus scan reports and other metadata produced in an SLSA-3 compliant software factory.
Only a subset of BSI applications are available for free. Looking to access the entire catalog of applications as well as enterprise support? Try the [commercial edition of Bitnami Secure Images today](https://www.arrow.com/globalecs/uk/products/bitnami-secure-images/).
## How to deploy Redis(R) in Kubernetes?
Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the [Bitnami Redis(R) Chart GitHub repository](https://github.com/bitnami/charts/tree/master/bitnami/redis).
## Why use a non-root container?
Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers [in our docs](https://techdocs.broadcom.com/us/en/vmware-tanzu/application-catalog/tanzu-application-catalog/services/tac-doc/apps-tutorials-work-with-non-root-containers-index.html).
## Supported tags and respective `Dockerfile` links
Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags [in our documentation page](https://techdocs.broadcom.com/us/en/vmware-tanzu/application-catalog/tanzu-application-catalog/services/tac-doc/apps-tutorials-understand-rolling-tags-containers-index.html).
You can see the equivalence between the different tags by taking a look at the `tags-info.yaml` file present in the branch folder, i.e `bitnami/ASSET/BRANCH/DISTRO/tags-info.yaml`.
Subscribe to project updates by watching the [bitnami/containers GitHub repo](https://github.com/bitnami/containers).
## Get this image
The recommended way to get the Bitnami Redis(R) Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/redis).
```console
docker pull bitnami/redis:latest
```
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/redis/tags/) in the Docker Hub Registry.
```console
docker pull bitnami/redis:[TAG]
```
If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the `docker build` command. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
```console
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```
## Persisting your database
Redis(R) provides a different range of [persistence options](https://redis.io/topics/persistence). This contanier uses *AOF persistence by default* but it is easy to overwrite that configuration in a `docker-compose.yaml` file with this entry `command: /opt/bitnami/scripts/redis/run.sh --appendonly no`. Alternatively, you may use the `REDIS_AOF_ENABLED` env variable as explained in [Disabling AOF persistence](https://github.com/bitnami/containers/blob/main/bitnami/redis#disabling-aof-persistence).
If you remove the container all your data will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.
For persistence you should mount a directory at the `/bitnami` path. If the mounted directory is empty, it will be initialized on the first run.
```console
docker run \
-e ALLOW_EMPTY_PASSWORD=yes \
-v /path/to/redis-persistence:/bitnami/redis/data \
bitnami/redis:latest
```
You can also do this by modifying the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/redis/docker-compose.yml) file present in this repository:
```yaml
services:
redis:
...
volumes:
- /path/to/redis-persistence:/bitnami/redis/data
...
```
> NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID `1001`.
## Connecting to other containers
Using [Docker container networking](https://docs.docker.com/engine/userguide/networking/), a Redis(R) server running inside a container can easily be accessed by your application containers.
Containers attached to the same network can communicate with each other using the container name as the hostname.
### Using the Command Line
In this example, we will create a Redis(R) client instance that will connect to the server instance that is running on the same docker network as the client.
#### Step 1: Create a network
```console
docker network create app-tier --driver bridge
```
#### Step 2: Launch the Redis(R) server instance
Use the `--network app-tier` argument to the `docker run` command to attach the Redis(R) container to the `app-tier` network.
```console
docker run -d --name redis-server \
-e ALLOW_EMPTY_PASSWORD=yes \
--network app-tier \
bitnami/redis:latest
```
#### Step 3: Launch your Redis(R) client instance
Finally we create a new container instance to launch the Redis(R) client and connect to the server created in the previous step:
```console
docker run -it --rm \
--network app-tier \
bitnami/redis:latest redis-cli -h redis-server
```
### Using a Docker Compose file
When not specified, Docker Compose automatically sets up a new network and attaches all deployed services to that network. However, we will explicitly define a new `bridge` network named `app-tier`. In this example we assume that you want to connect to the Redis(R) server from your own custom application image which is identified in the following snippet by the service name `myapp`.
```yaml
version: '2'
networks:
app-tier:
driver: bridge
services:
redis:
image: bitnami/redis:latest
environment:
- ALLOW_EMPTY_PASSWORD=yes
networks:
- app-tier
myapp:
image: YOUR_APPLICATION_IMAGE
networks:
- app-tier
```
> **IMPORTANT**:
>
> 1. Please update the **YOUR_APPLICATION_IMAGE_** placeholder in the above snippet with your application image
> 2. In your application container, use the hostname `redis` to connect to the Redis(R) server
Launch the containers using:
```console
docker-compose up -d
```
## Configuration
### Environment variables
#### Customizable environment variables
| Name | Description | Default Value |
|----------------------------------|--------------------------------------------------|--------------------------------------------|
| `REDIS_DATA_DIR` | Redis data directory | `${REDIS_VOLUME_DIR}/data` |
| `REDIS_OVERRIDES_FILE` | Redis config overrides file | `${REDIS_MOUNTED_CONF_DIR}/overrides.conf` |
| `REDIS_DISABLE_COMMANDS` | Commands to disable in Redis | `nil` |
| `REDIS_DATABASE` | Default Redis database | `redis` |
| `REDIS_AOF_ENABLED` | Enable AOF | `yes` |
| `REDIS_RDB_POLICY` | Enable RDB policy persitence | `nil` |
| `REDIS_RDB_POLICY_DISABLED` | Allows to enable RDB policy persistence | `no` |
| `REDIS_MASTER_HOST` | Redis master host (used by slaves) | `nil` |
| `REDIS_MASTER_PORT_NUMBER` | Redis master host port (used by slaves) | `6379` |
| `REDIS_PORT_NUMBER` | Redis port number | `$REDIS_DEFAULT_PORT_NUMBER` |
| `REDIS_ALLOW_REMOTE_CONNECTIONS` | Allow remote connection to the service | `yes` |
| `REDIS_REPLICATION_MODE` | Redis replication mode (values: master, slave) | `nil` |
| `REDIS_REPLICA_IP` | The replication announce ip | `nil` |
| `REDIS_REPLICA_PORT` | The replication announce port | `nil` |
| `REDIS_EXTRA_FLAGS` | Additional flags pass to 'redis-server' commands | `nil` |
| `ALLOW_EMPTY_PASSWORD` | Allow password-less access | `no` |
| `REDIS_PASSWORD` | Password for Redis | `nil` |
| `REDIS_MASTER_PASSWORD` | Redis master node password | `nil` |
| `REDIS_ACLFILE` | Redis ACL file | `nil` |
| `REDIS_IO_THREADS_DO_READS` | Enable multithreading when reading socket | `nil` |
| `REDIS_IO_THREADS` | Number of threads | `nil` |
| `REDIS_TLS_ENABLED` | Enable TLS | `no` |
| `REDIS_TLS_PORT_NUMBER` | Redis TLS port (requires REDIS_ENABLE_TLS=yes) | `6379` |
| `REDIS_TLS_CERT_FILE` | Redis TLS certificate file | `nil` |
| `REDIS_TLS_CA_DIR` | Directory containing TLS CA certificates | `nil` |
| `REDIS_TLS_KEY_FILE` | Redis TLS key file | `nil` |
| `REDIS_TLS_KEY_FILE_PASS` | Redis TLS key file passphrase | `nil` |
| `REDIS_TLS_CA_FILE` | Redis TLS CA file | `nil` |
| `REDIS_TLS_DH_PARAMS_FILE` | Redis TLS DH parameter file | `nil` |
| `REDIS_TLS_AUTH_CLIENTS` | Enable Redis TLS client authentication | `yes` |
| `REDIS_SENTINEL_MASTER_NAME` | Redis Sentinel master name | `nil` |
| `REDIS_SENTINEL_HOST` | Redis Sentinel host | `nil` |
| `REDIS_SENTINEL_PORT_NUMBER` | Redis Sentinel host port (used by slaves) | `26379` |
#### Read-only environment variables
| Name | Description | Value |
|-----------------------------|---------------------------------------|---------------------------------|
| `REDIS_VOLUME_DIR` | Persistence base directory | `/bitnami/redis` |
| `REDIS_BASE_DIR` | Redis installation directory | `${BITNAMI_ROOT_DIR}/redis` |
| `REDIS_CONF_DIR` | Redis configuration directory | `${REDIS_BASE_DIR}/etc` |
| `REDIS_DEFAULT_CONF_DIR` | Redis default configuration directory | `${REDIS_BASE_DIR}/etc.default` |
| `REDIS_MOUNTED_CONF_DIR` | Redis mounted configuration directory | `${REDIS_BASE_DIR}/mounted-etc` |
| `REDIS_CONF_FILE` | Redis configuration file | `${REDIS_CONF_DIR}/redis.conf` |
| `REDIS_LOG_DIR` | Redis logs directory | `${REDIS_BASE_DIR}/logs` |
| `REDIS_LOG_FILE` | Redis log file | `${REDIS_LOG_DIR}/redis.log` |
| `REDIS_TMP_DIR` | Redis temporary directory | `${REDIS_BASE_DIR}/tmp` |
| `REDIS_PID_FILE` | Redis PID file | `${REDIS_TMP_DIR}/redis.pid` |
| `REDIS_BIN_DIR` | Redis executables directory | `${REDIS_BASE_DIR}/bin` |
| `REDIS_DAEMON_USER` | Redis system user | `redis` |
| `REDIS_DAEMON_GROUP` | Redis system group | `redis` |
| `REDIS_DEFAULT_PORT_NUMBER` | Redis port number (Build time) | `6379` |
### Disabling Redis(R) commands
For security reasons, you may want to disable some commands. You can specify them by using the following environment variable on the first run:
- `REDIS_DISABLE_COMMANDS`: Comma-separated list of Redis(R) commands to disable. Defaults to empty.
```console
docker run --name redis -e REDIS_DISABLE_COMMANDS=FLUSHDB,FLUSHALL,CONFIG bitnami/redis:latest
```
Alternatively, modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/redis/docker-compose.yml) file present in this repository:
```yaml
services:
redis:
...
environment:
- REDIS_DISABLE_COMMANDS=FLUSHDB,FLUSHALL,CONFIG
...
```
As specified in the docker-compose, `FLUSHDB` and `FLUSHALL` commands are disabled. Comment out or remove the
environment variable if you don't want to disable any commands:
```yaml
services:
redis:
...
environment:
# - REDIS_DISABLE_COMMANDS=FLUSHDB,FLUSHALL
...
```
### Passing extra command-line flags to redis-server startup
Passing extra command-line flags to the redis service command is possible by adding them as arguments to *run.sh* script:
```console
docker run --name redis -e ALLOW_EMPTY_PASSWORD=yes bitnami/redis:latest /opt/bitnami/scripts/redis/run.sh --maxmemory 100mb
```
Alternatively, modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/redis/docker-compose.yml) file present in this repository:
```yaml
services:
redis:
...
environment:
- ALLOW_EMPTY_PASSWORD=yes
command: /opt/bitnami/scripts/redis/run.sh --maxmemory 100mb
...
```
Refer to the [Redis(R) documentation](https://redis.io/topics/config#passing-arguments-via-the-command-line) for the complete list of arguments.
### Setting the server password on first run
Passing the `REDIS_PASSWORD` environment variable when running the image for the first time will set the Redis(R) server password to the value of `REDIS_PASSWORD` (or the content of the file specified in `REDIS_PASSWORD_FILE`).
```console
docker run --name redis -e REDIS_PASSWORD=password123 bitnami/redis:latest
```
Alternatively, modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/redis/docker-compose.yml) file present in this repository:
```yaml
services:
redis:
...
environment:
- REDIS_PASSWORD=password123
...
```
**NOTE**: The at sign (`@`) is not supported for `REDIS_PASSWORD`.
**Warning** The Redis(R) database is always configured with remote access enabled. It's suggested that the `REDIS_PASSWORD` env variable is always specified to set a password. In case you want to access the database without a password set the environment variable `ALLOW_EMPTY_PASSWORD=yes`. **This is recommended only for development**.
### Allowing empty passwords
By default the Redis(R) image expects all the available passwords to be set. In order to allow empty passwords, it is necessary to set the `ALLOW_EMPTY_PASSWORD=yes` env variable. This env variable is only recommended for testing or development purposes. We strongly recommend specifying the `REDIS_PASSWORD` for any other scenario.
```console
docker run --name redis -e ALLOW_EMPTY_PASSWORD=yes bitnami/redis:latest
```
Alternatively, modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/redis/docker-compose.yml) file present in this repository:
```yaml
services:
redis:
...
environment:
- ALLOW_EMPTY_PASSWORD=yes
...
```
### Enabling/Setting multithreading
Redis 6.0 features a [new multi-threading model](https://segmentfault.com/a/1190000040376111/en). You can set both `io-threads` and `io-threads-do-reads` though the env vars `REDIS_IO_THREADS` and `REDIS_IO_THREADS_DO_READS`
```console
docker run --name redis -e REDIS_IO_THREADS=4 -e REDIS_IO_THREADS_DO_READS=yes bitnami/redis:latest
```
### Disabling AOF persistence
Redis(R) offers different [options](https://redis.io/topics/persistence) when it comes to persistence. By default, this image is set up to use the AOF (Append Only File) approach. Should you need to change this behaviour, setting the `REDIS_AOF_ENABLED=no` env variable will disable this feature.
```console
docker run --name redis -e REDIS_AOF_ENABLED=no bitnami/redis:latest
```
Alternatively, modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/redis/docker-compose.yml) file present in this repository:
```yaml
services:
redis:
...
environment:
- REDIS_AOF_ENABLED=no
...
```
### Enabling Access Control List
Redis(R) offers [ACL](https://redis.io/topics/acl) since 6.0 which allows certain connections to be limited in terms of the commands that can be executed and the keys that can be accessed. We strongly recommend enabling ACL in production by specifiying the `REDIS_ACLFILE`.
```console
docker run -name redis -e REDIS_ACLFILE=/opt/bitnami/redis/mounted-etc/users.acl -v /path/to/users.acl:/opt/bitnami/redis/mounted-etc/users.acl bitnami/redis:latest
```
Alternatively, modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/redis/docker-compose.yml) file present in this repository:
```yaml
services:
redis:
...
environment:
- REDIS_ACLFILE=/opt/bitnami/redis/mounted-etc/users.acl
volumes:
- /path/to/users.acl:/opt/bitnami/redis/mounted-etc/users.acl
...
```
### Setting up a standalone instance
By default, this image is set up to launch Redis(R) in standalone mode on port 6379. Should you need to change this behavior, setting the `REDIS_PORT_NUMBER` environment variable will modify the port number. This is not to be confused with `REDIS_MASTER_PORT_NUMBER` or `REDIS_REPLICA_PORT` environment variables that are applicable in replication mode.
```console
docker run --name redis -e REDIS_PORT_NUMBER=7000 -p 7000:7000 bitnami/redis:latest
```
Alternatively, modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/redis/docker-compose.yml) file present in this repository:
```yaml
services:
redis:
...
environment:
- REDIS_PORT_NUMBER=7000
...
ports:
- 7000:7000
....
```
### Setting up replication
A [replication](https://redis.io/topics/replication) cluster can easily be setup with the Bitnami Redis(R) Docker Image using the following environment variables:
- `REDIS_REPLICATION_MODE`: The replication mode. Possible values `master`/`slave`. No defaults.
- `REDIS_REPLICA_IP`: The replication announce ip. Defaults to `$(get_machine_ip)` which return the ip of the container.
- `REDIS_REPLICA_PORT`: The replication announce port. Defaults to `REDIS_MASTER_PORT_NUMBER`.
- `REDIS_MASTER_HOST`: Hostname/IP of replication master (replica node parameter). No defaults.
- `REDIS_MASTER_PORT_NUMBER`: Server port of the replication master (replica node parameter). Defaults to `6379`.
- `REDIS_MASTER_PASSWORD`: Password to authenticate with the master (replica node parameter). No defaults. As an alternative, you can mount a file with the password and set the `REDIS_MASTER_PASSWORD_FILE` variable.
In a replication cluster you can have one master and zero or more replicas. When replication is enabled the master node is in read-write mode, while the replicas are in read-only mode. For best performance its advisable to limit the reads to the replicas.
#### Step 1: Create the replication master
The first step is to start the Redis(R) master.
```console
docker run --name redis-master \
-e REDIS_REPLICATION_MODE=master \
-e REDIS_PASSWORD=masterpassword123 \
bitnami/redis:latest
```
In the above command the container is configured as the `master` using the `REDIS_REPLICATION_MODE` parameter. The `REDIS_PASSWORD` parameter enables authentication on the Redis(R) master.
#### Step 2: Create the replica node
Next we start a Redis(R) replica container.
```console
docker run --name redis-replica \
--link redis-master:master \
-e REDIS_REPLICATION_MODE=slave \
-e REDIS_MASTER_HOST=master \
-e REDIS_MASTER_PORT_NUMBER=6379 \
-e REDIS_MASTER_PASSWORD=masterpassword123 \
-e REDIS_PASSWORD=password123 \
bitnami/redis:latest
```
In the above command the container is configured as a `slave` using the `REDIS_REPLICATION_MODE` parameter. The `REDIS_MASTER_HOST`, `REDIS_MASTER_PORT_NUMBER` and `REDIS_MASTER_PASSWORD` parameters are used connect and authenticate with the Redis(R) master. The `REDIS_PASSWORD` parameter enables authentication on the Redis(R) replica.
You now have a two node Redis(R) master/replica replication cluster up and running which can be scaled by adding/removing replicas.
If the Redis(R) master goes down you can reconfigure a replica to become a master using:
```console
docker exec redis-replica redis-cli -a password123 SLAVEOF NO ONE
```
> **Note**: The configuration of the other replicas in the cluster needs to be updated so that they are aware of the new master. In our example, this would involve restarting the other replicas with `--link redis-replica:master`.
With Docker Compose the master/replica mode can be setup using:
```yaml
version: '2'
services:
redis-master:
image: bitnami/redis:latest
ports:
- 6379
environment:
- REDIS_REPLICATION_MODE=master
- REDIS_PASSWORD=my_master_password
volumes:
- /path/to/redis-persistence:/bitnami
redis-replica:
image: bitnami/redis:latest
ports:
- 6379
depends_on:
- redis-master
environment:
- REDIS_REPLICATION_MODE=slave
- REDIS_MASTER_HOST=redis-master
- REDIS_MASTER_PORT_NUMBER=6379
- REDIS_MASTER_PASSWORD=my_master_password
- REDIS_PASSWORD=my_replica_password
```
Scale the number of replicas using:
```console
docker-compose up --detach --scale redis-master=1 --scale redis-secondary=3
```
The above command scales up the number of replicas to `3`. You can scale down in the same way.
> **Note**: You should not scale up/down the number of master nodes. Always have only one master node running.
### Securing Redis(R) traffic
Starting with version 6, Redis(R) adds the support for SSL/TLS connections. Should you desire to enable this optional feature, you may use the following environment variables to configure the application:
- `REDIS_TLS_ENABLED`: Whether to enable TLS for traffic or not. Defaults to `no`.
- `REDIS_TLS_PORT_NUMBER`: Port used for TLS secure traffic. Defaults to `6379`.
- `REDIS_TLS_CERT_FILE`: File containing the certificate file for the TLS traffic. No defaults.
- `REDIS_TLS_KEY_FILE`: File containing the key for certificate. No defaults.
- `REDIS_TLS_CA_FILE`: File containing the CA of the certificate (takes precedence over `REDIS_TLS_CA_DIR`). No defaults.
- `REDIS_TLS_CA_DIR`: Directory containing the CA certificates. No defaults.
- `REDIS_TLS_DH_PARAMS_FILE`: File containing DH params (in order to support DH based ciphers). No defaults.
- `REDIS_TLS_AUTH_CLIENTS`: Whether to require clients to authenticate or not. Defaults to `yes`.
When enabling TLS, conventional standard traffic is disabled by default. However this new feature is not mutually exclusive, which means it is possible to listen to both TLS and non-TLS connection simultaneously. To enable non-TLS traffic, set `REDIS_TLS_PORT_NUMBER` to another port different than `0`.
1. Using `docker run`
```console
$ docker run --name redis \
-v /path/to/certs:/opt/bitnami/redis/certs \
-v /path/to/redis-data-persistence:/bitnami/redis/data \
-e ALLOW_EMPTY_PASSWORD=yes \
-e REDIS_TLS_ENABLED=yes \
-e REDIS_TLS_CERT_FILE=/opt/bitnami/redis/certs/redis.crt \
-e REDIS_TLS_KEY_FILE=/opt/bitnami/redis/certs/redis.key \
-e REDIS_TLS_CA_FILE=/opt/bitnami/redis/certs/redisCA.crt \
bitnami/redis:latest
```
2. Modifying the `docker-compose.yml` file present in this repository:
```yaml
services:
redis:
...
environment:
...
- REDIS_TLS_ENABLED=yes
- REDIS_TLS_CERT_FILE=/opt/bitnami/redis/certs/redis.crt
- REDIS_TLS_KEY_FILE=/opt/bitnami/redis/certs/redis.key
- REDIS_TLS_CA_FILE=/opt/bitnami/redis/certs/redisCA.crt
...
volumes:
- /path/to/certs:/opt/bitnami/redis/certs
- /path/to/redis-persistence:/bitnami/redis/data
...
```
Alternatively, you may also provide with this configuration in your [custom](https://github.com/bitnami/containers/blob/main/bitnami/redis#configuration-file) configuration file.
### Configuration file
The image looks for configurations in `/opt/bitnami/redis/mounted-etc/redis.conf`. You can overwrite the `redis.conf` file using your own custom configuration file.
```console
docker run --name redis \
-e ALLOW_EMPTY_PASSWORD=yes \
-v /path/to/your_redis.conf:/opt/bitnami/redis/mounted-etc/redis.conf \
-v /path/to/redis-data-persistence:/bitnami/redis/data \
bitnami/redis:latest
```
Alternatively, modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/redis/docker-compose.yml) file present in this repository:
```yaml
services:
redis:
...
volumes:
- /path/to/your_redis.conf:/opt/bitnami/redis/mounted-etc/redis.conf
- /path/to/redis-persistence:/bitnami/redis/data
...
```
Refer to the [Redis(R) configuration](https://redis.io/topics/config) manual for the complete list of configuration options.
### Overriding configuration
Instead of providing a custom `redis.conf`, you may also choose to provide only settings you wish to override. The image will look for `/opt/bitnami/redis/mounted-etc/overrides.conf`. This will be ignored if custom `redis.conf` is provided.
```console
docker run --name redis \
-e ALLOW_EMPTY_PASSWORD=yes \
-v /path/to/overrides.conf:/opt/bitnami/redis/mounted-etc/overrides.conf \
bitnami/redis:latest
```
Alternatively, modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/redis/docker-compose.yml) file present in this repository:
```yaml
services:
redis:
...
volumes:
- /path/to/overrides.conf:/opt/bitnami/redis/mounted-etc/overrides.conf
...
```
### Enable Redis(R) RDB persistence
When the value of `REDIS_RDB_POLICY_DISABLED` is `no` (default value) the Redis(R) default persistence strategy will be used. If you want to modify the default strategy, you can configure it through the `REDIS_RDB_POLICY` parameter. Here is a demonstration of modifying the default persistence strategy
1. Using `docker run`
```console
$ docker run --name redis \
-v /path/to/redis-data-persistence:/bitnami/redis/data \
-e ALLOW_EMPTY_PASSWORD=yes \
-e REDIS_RDB_POLICY_DISABLED=no
-e REDIS_RDB_POLICY="900#1 600#5 300#10 120#50 60#1000 30#10000"
bitnami/redis:latest
```
2. Modifying the `docker-compose.yml` file present in this repository:
```yaml
redis:
...
environment:
...
- REDIS_TLS_ENABLED=yes
- REDIS_RDB_POLICY_DISABLED=no
- REDIS_RDB_POLICY="900#1 600#5 300#10 120#50 60#1000 30#10000"
...
...
```
### FIPS configuration in Bitnami Secure Images
The Bitnami Redis® Docker image from the [Bitnami Secure Images](https://www.arrow.com/globalecs/uk/products/bitnami-secure-images/) catalog includes extra features and settings to configure the container with FIPS capabilities. You can configure the next environment variables:
- `OPENSSL_FIPS`: whether OpenSSL runs in FIPS mode or not. `yes` (default), `no`.
## Logging
The Bitnami Redis(R) Docker image sends the container logs to the `stdout`. To view the logs:
```console
docker logs redis
```
or using Docker Compose:
```console
docker-compose logs redis
```
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
## Maintenance
### Upgrade this image
Bitnami provides up-to-date versions of Redis(R), including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container.
#### Step 1: Get the updated image
```console
docker pull bitnami/redis:latest
```
or if you're using Docker Compose, update the value of the image property to
`bitnami/redis:latest`.
#### Step 2: Stop and backup the currently running container
Stop the currently running container using the command
```console
docker stop redis
```
or using Docker Compose:
```console
docker-compose stop redis
```
Next, take a snapshot of the persistent volume `/path/to/redis-persistence` using:
```console
rsync -a /path/to/redis-persistence /path/to/redis-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
```
#### Step 3: Remove the currently running container
```console
docker rm -v redis
```
or using Docker Compose:
```console
docker-compose rm -v redis
```
#### Step 4: Run the new image
Re-create your container from the new image.
```console
docker run --name redis bitnami/redis:latest
```
or using Docker Compose:
```console
docker-compose up redis
```
## Notable Changes
### 5.0.8-debian-10-r24
- The recommended mount point to use a custom `redis.conf` changes from `/opt/bitnami/redis/etc/` to `/opt/bitnami/redis/mounted-etc/`.
### 5.0.0-r0
- Starting with Redis(R) 5.0 the command [REPLICAOF](https://redis.io/commands/replicaof) is available in favor of `SLAVEOF`. For backward compatibility with previous versions, `slave` replication mode is still supported. We encourage the use of the `REPLICAOF` command if you are using Redis(R) 5.0.
### 4.0.1-r24
- Decrease the size of the container. It is not necessary Node.js anymore. Redis(R) configuration moved to bash scripts in the `rootfs/` folder.
- The recommended mount point to persist data changes to `/bitnami/redis/data`.
- The main `redis.conf` file is not persisted in a volume. The path is `/opt/bitnami/redis/mounted-etc/redis.conf`.
- Backwards compatibility is not guaranteed when data is persisted using docker-compose. You can use the workaround below to overcome it:
```bash
docker-compose down
## Locate your volume and modify the file tree
VOLUME=$(docker volume ls | grep "redis_data" | awk '{print $2}')
docker run --rm -i -v=${VOLUME}:/tmp/redis busybox find /tmp/redis/data -maxdepth 1 -exec mv {} /tmp/redis \;
docker run --rm -i -v=${VOLUME}:/tmp/redis busybox rm -rf /tmp/redis/{data,conf,.initialized}
## Change the mount point
sed -i -e 's#redis_data:/bitnami/redis#redis_data:/bitnami/redis/data#g' docker-compose.yml
## Pull the latest bitnami/redis image
docker pull bitnami/redis:latest
docker-compose up -d
```
### 4.0.1-r1
- The redis container has been migrated to a non-root container approach. Previously the container run as `root` user and the redis daemon was started as `redis` user. From now own, both the container and the redis daemon run as user `1001`.
As a consequence, the configuration files are writable by the user running the redis process.
### 3.2.0-r0
- All volumes have been merged at `/bitnami/redis`. Now you only need to mount a single volume at `/bitnami/redis` for persistence.
- The logs are always sent to the `stdout` and are no longer collected in the volume.
## Using `docker-compose.yaml`
Please be aware this file has not undergone internal testing. Consequently, we advise its use exclusively for development or testing purposes. For production-ready deployments, we highly recommend utilizing its associated [Bitnami Helm chart](https://github.com/bitnami/charts/tree/main/bitnami/redis).
If you detect any issue in the `docker-compose.yaml` file, feel free to report it or contribute with a fix by following our [Contributing Guidelines](https://github.com/bitnami/containers/blob/main/CONTRIBUTING.md).
## Contributing
We'd love for you to contribute to this container. You can request new features by creating an [issue](https://github.com/bitnami/containers/issues) or submitting a [pull request](https://github.com/bitnami/containers/pulls) with your contribution.
## Issues
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/containers/issues/new/choose). For us to provide better support, be sure to fill the issue template.
## License
Copyright © 2025 Broadcom. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Reference in New Issue View Git Blame Copy Permalink