Bitnami package 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® 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
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 section for a more secure deployment.
Why use Bitnami Images?
- Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
- With Bitnami images the latest bug fixes and features are available as soon as possible.
- 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.
- All our images are based on minideb -a minimalist Debian based container image that gives you a small base container image and the familiarity of a leading Linux distribution- or scratch -an explicitly empty image-.
- All Bitnami images available in Docker Hub are signed with Notation. Check this post to know how to verify the integrity of the images.
- Bitnami container images are released on a regular basis with the latest distribution packages available.
Looking to use Redis® in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.
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.
Bitnami containers can be used with Kubeapps for deployment and management of Helm Charts in clusters.
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.
Only latest stable branch maintained in the free Bitnami catalog
Starting December 10th 2024, only the latest stable branch of any container will receive updates in the free Bitnami catalog. To access up-to-date releases for all upstream-supported branches, consider upgrading to Bitnami Premium. Previous versions already released will not be deleted. They are still available to pull from DockerHub.
Please check the Bitnami Premium page in our partner Arrow Electronics for more information.
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.
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.
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.
docker pull bitnami/redis:latest
To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.
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.
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. 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.
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.
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 file present in this repository:
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, 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
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.
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:
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.
version: '2'networks:app-tier:driver: bridgeservices:redis:image: 'bitnami/redis:latest'environment:- ALLOW_EMPTY_PASSWORD=yesnetworks:- app-tiermyapp:image: 'YOUR_APPLICATION_IMAGE'networks:- app-tier
IMPORTANT:
- Please update the YOUR_APPLICATION_IMAGE_ placeholder in the above snippet with your application image
- In your application container, use the hostname
redisto connect to the Redis(R) server
Launch the containers using:
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.
docker run --name redis -e REDIS_DISABLE_COMMANDS=FLUSHDB,FLUSHALL,CONFIG bitnami/redis:latest
Alternatively, modify the docker-compose.yml file present in this repository:
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:
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:
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 file present in this repository:
services:redis:...environment:- ALLOW_EMPTY_PASSWORD=yescommand: /opt/bitnami/scripts/redis/run.sh --maxmemory 100mb...
Refer to the Redis(R) documentation 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).
docker run --name redis -e REDIS_PASSWORD=password123 bitnami/redis:latest
Alternatively, modify the docker-compose.yml file present in this repository:
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.
docker run --name redis -e ALLOW_EMPTY_PASSWORD=yes bitnami/redis:latest
Alternatively, modify the docker-compose.yml file present in this repository:
services:redis:...environment:- ALLOW_EMPTY_PASSWORD=yes...
Enabling/Setting multithreading
Redis 6.0 features a new multi-threading model. You can set both io-threads and io-threads-do-reads though the env vars REDIS_IO_THREADS and REDIS_IO_THREADS_DO_READS
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 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.
docker run --name redis -e REDIS_AOF_ENABLED=no bitnami/redis:latest
Alternatively, modify the docker-compose.yml file present in this repository:
services:redis:...environment:- REDIS_AOF_ENABLED=no...
Enabling Access Control List
Redis(R) offers 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.
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 file present in this repository:
services:redis:...environment:- REDIS_ACLFILE=/opt/bitnami/redis/mounted-etc/users.aclvolumes:- /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.
docker run --name redis -e REDIS_PORT_NUMBER=7000 -p 7000:7000 bitnami/redis:latest
Alternatively, modify the docker-compose.yml file present in this repository:
services:redis:...environment:- REDIS_PORT_NUMBER=7000...ports:- '7000:7000'....
Setting up replication
A 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 valuesmaster/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 toREDIS_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 to6379.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 theREDIS_MASTER_PASSWORD_FILEvariable.
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.
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.
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:
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:
version: '2'services:redis-master:image: 'bitnami/redis:latest'ports:- '6379'environment:- REDIS_REPLICATION_MODE=master- REDIS_PASSWORD=my_master_passwordvolumes:- '/path/to/redis-persistence:/bitnami'redis-replica:image: 'bitnami/redis:_Note: the README for this container is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/containers/blob/main/bitnami/redis/README.md_
