History

…
..
7.2	…
8.0	…
8.1/debian-12	…
README.md	…
docker-compose-replicaset.yml	…
docker-compose.yml	…

README.md

Bitnami Secure Image for Valkey

What is Valkey?

Valkey is an open source (BSD) high-performance key/value datastore that supports a variety workloads such as caching, message queues, and can act as a primary database.

Overview of Valkey Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR

docker run --name valkey -e ALLOW_EMPTY_PASSWORD=yes bitnami/valkey: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.

⚠️ 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. 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.

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.

How to deploy Valkey 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 Valkey Chart GitHub repository.

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.

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 Valkey Docker Image is to pull the prebuilt image from the Docker Hub Registry.

docker pull bitnami/valkey: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/valkey:[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

Valkey 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/valkey/run.sh --appendonly no. Alternatively, you may use the VALKEY_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/valkey-persistence:/bitnami/valkey/data \
    bitnami/valkey:latest

You can also do this by modifying the docker-compose.yml file present in this repository:

services:
  valkey:
  ...
    volumes:
      - /path/to/valkey-persistence:/bitnami/valkey/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 Valkey 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 Valkey 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 Valkey server instance

Use the --network app-tier argument to the docker run command to attach the Valkey container to the app-tier network.

docker run -d --name valkey-server \
    -e ALLOW_EMPTY_PASSWORD=yes \
    --network app-tier \
    bitnami/valkey:latest

Step 3: Launch your Valkey client instance

Finally we create a new container instance to launch the Valkey client and connect to the server created in the previous step:

docker run -it --rm \
    --network app-tier \
    bitnami/valkey:latest valkey-cli -h valkey-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 Valkey 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: bridge

services:
  valkey:
    image: bitnami/valkey:latest
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
    networks:
      - app-tier
  myapp:
    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 valkey to connect to the Valkey server

Launch the containers using:

docker-compose up -d

Configuration

Environment variables

Customizable environment variables

Name	Description	Default Value
`VALKEY_DATA_DIR`	Valkey data directory	`${VALKEY_VOLUME_DIR}/data`
`VALKEY_OVERRIDES_FILE`	Valkey config overrides file	`${VALKEY_MOUNTED_CONF_DIR}/overrides.conf`
`VALKEY_DISABLE_COMMANDS`	Commands to disable in Valkey	`nil`
`VALKEY_DATABASE`	Default Valkey database	`valkey`
`VALKEY_AOF_ENABLED`	Enable AOF	`yes`
`VALKEY_RDB_POLICY`	Enable RDB policy persitence	`nil`
`VALKEY_RDB_POLICY_DISABLED`	Allows to enable RDB policy persistence	`no`
`VALKEY_PRIMARY_HOST`	Valkey primary host (used by replicas)	`nil`
`VALKEY_PRIMARY_PORT_NUMBER`	Valkey primary host port (used by replicas)	`6379`
`VALKEY_PORT_NUMBER`	Valkey port number	`$VALKEY_DEFAULT_PORT_NUMBER`
`VALKEY_ALLOW_REMOTE_CONNECTIONS`	Allow remote connection to the service	`yes`
`VALKEY_REPLICATION_MODE`	Valkey replication mode (values: primary, replica)	`nil`
`VALKEY_REPLICA_IP`	The replication announce ip	`nil`
`VALKEY_REPLICA_PORT`	The replication announce port	`nil`
`VALKEY_EXTRA_FLAGS`	Additional flags pass to 'valkey-server' commands	`nil`
`ALLOW_EMPTY_PASSWORD`	Allow password-less access	`no`
`VALKEY_PASSWORD`	Password for Valkey	`nil`
`VALKEY_PRIMARY_PASSWORD`	Valkey primary node password	`nil`
`VALKEY_ACLFILE`	Valkey ACL file	`nil`
`VALKEY_IO_THREADS_DO_READS`	Enable multithreading when reading socket	`nil`
`VALKEY_IO_THREADS`	Number of threads	`nil`
`VALKEY_TLS_ENABLED`	Enable TLS	`no`
`VALKEY_TLS_PORT_NUMBER`	Valkey TLS port (requires VALKEY_ENABLE_TLS=yes)	`6379`
`VALKEY_TLS_CERT_FILE`	Valkey TLS certificate file	`nil`
`VALKEY_TLS_CA_DIR`	Directory containing TLS CA certificates	`nil`
`VALKEY_TLS_KEY_FILE`	Valkey TLS key file	`nil`
`VALKEY_TLS_KEY_FILE_PASS`	Valkey TLS key file passphrase	`nil`
`VALKEY_TLS_CA_FILE`	Valkey TLS CA file	`nil`
`VALKEY_TLS_DH_PARAMS_FILE`	Valkey TLS DH parameter file	`nil`
`VALKEY_TLS_AUTH_CLIENTS`	Enable Valkey TLS client authentication	`yes`
`VALKEY_SENTINEL_PRIMARY_NAME`	Valkey Sentinel primary name	`nil`
`VALKEY_SENTINEL_HOST`	Valkey Sentinel host	`nil`
`VALKEY_SENTINEL_PORT_NUMBER`	Valkey Sentinel host port (used by replicas)	`26379`

Read-only environment variables

Name	Description	Value
`VALKEY_VOLUME_DIR`	Persistence base directory	`/bitnami/valkey`
`VALKEY_BASE_DIR`	Valkey installation directory	`${BITNAMI_ROOT_DIR}/valkey`
`VALKEY_CONF_DIR`	Valkey configuration directory	`${VALKEY_BASE_DIR}/etc`
`VALKEY_DEFAULT_CONF_DIR`	Valkey default configuration directory	`${VALKEY_BASE_DIR}/etc.default`
`VALKEY_MOUNTED_CONF_DIR`	Valkey mounted configuration directory	`${VALKEY_BASE_DIR}/mounted-etc`
`VALKEY_CONF_FILE`	Valkey configuration file	`${VALKEY_CONF_DIR}/valkey.conf`
`VALKEY_LOG_DIR`	Valkey logs directory	`${VALKEY_BASE_DIR}/logs`
`VALKEY_LOG_FILE`	Valkey log file	`${VALKEY_LOG_DIR}/valkey.log`
`VALKEY_TMP_DIR`	Valkey temporary directory	`${VALKEY_BASE_DIR}/tmp`
`VALKEY_PID_FILE`	Valkey PID file	`${VALKEY_TMP_DIR}/valkey.pid`
`VALKEY_BIN_DIR`	Valkey executables directory	`${VALKEY_BASE_DIR}/bin`
`VALKEY_DAEMON_USER`	Valkey system user	`valkey`
`VALKEY_DAEMON_GROUP`	Valkey system group	`valkey`
`VALKEY_DEFAULT_PORT_NUMBER`	Valkey port number (Build time)	`6379`

Disabling Valkey 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:

VALKEY_DISABLE_COMMANDS: Comma-separated list of Valkey commands to disable. Defaults to empty.

docker run --name valkey -e VALKEY_DISABLE_COMMANDS=FLUSHDB,FLUSHALL,CONFIG bitnami/valkey:latest

Alternatively, modify the docker-compose.yml file present in this repository:

services:
  valkey:
  ...
    environment:
      - VALKEY_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:
  valkey:
  ...
    environment:
      # - VALKEY_DISABLE_COMMANDS=FLUSHDB,FLUSHALL
  ...

Passing extra command-line flags to valkey-server startup

Passing extra command-line flags to the valkey service command is possible by adding them as arguments to run.sh script:

docker run --name valkey -e ALLOW_EMPTY_PASSWORD=yes bitnami/valkey:latest /opt/bitnami/scripts/valkey/run.sh --maxmemory 100mb

Alternatively, modify the docker-compose.yml file present in this repository:

services:
  valkey:
  ...
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
    command: /opt/bitnami/scripts/valkey/run.sh --maxmemory 100mb
  ...

Setting the server password on first run

Passing the VALKEY_PASSWORD environment variable when running the image for the first time will set the Valkey server password to the value of VALKEY_PASSWORD (or the content of the file specified in VALKEY_PASSWORD_FILE).

docker run --name valkey -e VALKEY_PASSWORD=password123 bitnami/valkey:latest

Alternatively, modify the docker-compose.yml file present in this repository:

services:
  valkey:
  ...
    environment:
      - VALKEY_PASSWORD=password123
  ...

NOTE: The at sign (@) is not supported for VALKEY_PASSWORD.

Warning The Valkey database is always configured with remote access enabled. It's suggested that the VALKEY_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 Valkey 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 VALKEY_PASSWORD for any other scenario.

docker run --name valkey -e ALLOW_EMPTY_PASSWORD=yes bitnami/valkey:latest

Alternatively, modify the docker-compose.yml file present in this repository:

services:
  valkey:
  ...
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
  ...

Disabling AOF persistence

Valkey 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 VALKEY_AOF_ENABLED=no env variable will disable this feature.

docker run --name valkey -e VALKEY_AOF_ENABLED=no bitnami/valkey:latest

Alternatively, modify the docker-compose.yml file present in this repository:

services:
  valkey:
  ...
    environment:
      - VALKEY_AOF_ENABLED=no
  ...

Enabling Access Control List

Valkey offers ACL 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 VALKEY_ACLFILE.

docker run -name valkey -e VALKEY_ACLFILE=/opt/bitnami/valkey/mounted-etc/users.acl -v /path/to/users.acl:/opt/bitnami/valkey/mounted-etc/users.acl bitnami/valkey:latest

Alternatively, modify the docker-compose.yml file present in this repository:

services:
  valkey:
  ...
    environment:
      - VALKEY_ACLFILE=/opt/bitnami/valkey/mounted-etc/users.acl
    volumes:
      - /path/to/users.acl:/opt/bitnami/valkey/mounted-etc/users.acl
  ...

Setting up a standalone instance

By default, this image is set up to launch Valkey in standalone mode on port 6379. Should you need to change this behavior, setting the VALKEY_PORT_NUMBER environment variable will modify the port number. This is not to be confused with VALKEY_PRIMARY_PORT_NUMBER or VALKEY_REPLICA_PORT environment variables that are applicable in replication mode.

docker run --name valkey -e VALKEY_PORT_NUMBER=7000 -p 7000:7000 bitnami/valkey:latest

Alternatively, modify the docker-compose.yml file present in this repository:

services:
  valkey:
  ...
    environment:
      - VALKEY_PORT_NUMBER=7000
    ...
    ports:
      - 7000:7000
  ....

Setting up replication

A replication cluster can easily be setup with the Bitnami Valkey Docker Image using the following environment variables:

VALKEY_REPLICATION_MODE: The replication mode. Possible values primary/replica. No defaults.
VALKEY_REPLICA_IP: The replication announce ip. Defaults to $(get_machine_ip) which return the ip of the container.
VALKEY_REPLICA_PORT: The replication announce port. Defaults to VALKEY_PRIMARY_PORT_NUMBER.
VALKEY_PRIMARY_HOST: Hostname/IP of replication primary (replica node parameter). No defaults.
VALKEY_PRIMARY_PORT_NUMBER: Server port of the replication primaty (replica node parameter). Defaults to 6379.
VALKEY_PRIMARY_PASSWORD: Password to authenticate with the primary (replica node parameter). No defaults. As an alternative, you can mount a file with the password and set the VALKEY_PRIMARY_PASSWORD_FILE variable.

In a replication cluster you can have one primary and zero or more replicas. When replication is enabled the primary 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 primary

The first step is to start the Valkey primary.

docker run --name valkey-primary \
  -e VALKEY_REPLICATION_MODE=primary \
  -e VALKEY_PASSWORD=primarypassword123 \
  bitnami/valkey:latest

In the above command the container is configured as the primary using the VALKEY_REPLICATION_MODE parameter. The VALKEY_PASSWORD parameter enables authentication on the Valkey primary.

Step 2: Create the replica node

Next we start a Valkey replica container.

docker run --name valkey-replica \
  --link valkey-primary:primary \
  -e VALKEY_REPLICATION_MODE=replica \
  -e VALKEY_PRIMARY_HOST=primary \
  -e VALKEY_PRIMARY_PORT_NUMBER=6379 \
  -e VALKEY_PRIMARY_PASSWORD=primarypassword123 \
  -e VALKEY_PASSWORD=password123 \
  bitnami/valkey:latest

In the above command the container is configured as a replica using the VALKEY_REPLICATION_MODE parameter. The VALKEY_PRIMARY_HOST, VALKEY_PRIMARY_PORT_NUMBER and VALKEY_PRIMARY_PASSWORD parameters are used connect and authenticate with the Valkey primary. The VALKEY_PASSWORD parameter enables authentication on the Valkey replica.

You now have a two node Valkey primary/replica replication cluster up and running which can be scaled by adding/removing replicas.

If the Valkey primary goes down you can reconfigure a replica to become a primary using:

docker exec valkey-replica valkey-cli -a password123 REPLICAOF NO ONE

Note: The configuration of the other replicas in the cluster needs to be updated so that they are aware of the new primary. In our example, this would involve restarting the other replicas with --link valkey-replica:primary.

With Docker Compose the primary/replica mode can be setup using:

version: '2'

services:
  valkey-primary:
    image: bitnami/valkey:latest
    ports:
      - 6379
    environment:
      - VALKEY_REPLICATION_MODE=primary
      - VALKEY_PASSWORD=my_primary_password
    volumes:
      - /path/to/valkey-persistence:/bitnami

  valkey-replica:
    image: bitnami/valkey:latest
    ports:
      - 6379
    depends_on:
      - valkey-primary
    environment:
      - VALKEY_REPLICATION_MODE=replica
      - VALKEY_PRIMARY_HOST=valkey-primary
      - VALKEY_PRIMARY_PORT_NUMBER=6379
      - VALKEY_PRIMARY_PASSWORD=my_primary_password
      - VALKEY_PASSWORD=my_replica_password

Scale the number of replicas using:

docker-compose up --detach --scale valkey-primary=1 --scale valkey-replica=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 primary nodes. Always have only one primary node running.

Securing Valkey traffic

Valkey 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:

VALKEY_TLS_ENABLED: Whether to enable TLS for traffic or not. Defaults to no.
VALKEY_TLS_PORT_NUMBER: Port used for TLS secure traffic. Defaults to 6379.
VALKEY_TLS_CERT_FILE: File containing the certificate file for the TLS traffic. No defaults.
VALKEY_TLS_KEY_FILE: File containing the key for certificate. No defaults.
VALKEY_TLS_CA_FILE: File containing the CA of the certificate (takes precedence over VALKEY_TLS_CA_DIR). No defaults.
VALKEY_TLS_CA_DIR: Directory containing the CA certificates. No defaults.
VALKEY_TLS_DH_PARAMS_FILE: File containing DH params (in order to support DH based ciphers). No defaults.
VALKEY_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 VALKEY_TLS_PORT_NUMBER to another port different than 0.

Using docker run

$ docker run --name valkey \
    -v /path/to/certs:/opt/bitnami/valkey/certs \
    -v /path/to/valkey-data-persistence:/bitnami/valkey/data \
    -e ALLOW_EMPTY_PASSWORD=yes \
    -e VALKEY_TLS_ENABLED=yes \
    -e VALKEY_TLS_CERT_FILE=/opt/bitnami/valkey/certs/valkey.crt \
    -e VALKEY_TLS_KEY_FILE=/opt/bitnami/valkey/certs/valkey.key \
    -e VALKEY_TLS_CA_FILE=/opt/bitnami/valkey/certs/valkeyCA.crt \
    bitnami/valkey:latest

Modifying the docker-compose.yml file present in this repository:

services:
  valkey:
  ...
    environment:
      ...
      - VALKEY_TLS_ENABLED=yes
      - VALKEY_TLS_CERT_FILE=/opt/bitnami/valkey/certs/valkey.crt
      - VALKEY_TLS_KEY_FILE=/opt/bitnami/valkey/certs/valkey.key
      - VALKEY_TLS_CA_FILE=/opt/bitnami/valkey/certs/valkeyCA.crt
    ...
    volumes:
      - /path/to/certs:/opt/bitnami/valkey/certs
      - /path/to/valkey-persistence:/bitnami/valkey/data
  ...

Alternatively, you may also provide with this configuration in your custom configuration file.

Configuration file

The image looks for configurations in /opt/bitnami/valkey/mounted-etc/valkey.conf. You can overwrite the valkey.conf file using your own custom configuration file.

docker run --name valkey \
    -e ALLOW_EMPTY_PASSWORD=yes \
    -v /path/to/your_valkey.conf:/opt/bitnami/valkey/mounted-etc/valkey.conf \
    -v /path/to/valkey-data-persistence:/bitnami/valkey/data \
    bitnami/valkey:latest

Alternatively, modify the docker-compose.yml file present in this repository:

services:
  valkey:
  ...
    volumes:
      - /path/to/your_valkey.conf:/opt/bitnami/valkey/mounted-etc/valkey.conf
      - /path/to/valkey-persistence:/bitnami/valkey/data
  ...

Overriding configuration

Instead of providing a custom valkey.conf, you may also choose to provide only settings you wish to override. The image will look for /opt/bitnami/valkey/mounted-etc/overrides.conf. This will be ignored if custom valkey.conf is provided.

docker run --name valkey \
    -e ALLOW_EMPTY_PASSWORD=yes \
    -v /path/to/overrides.conf:/opt/bitnami/valkey/mounted-etc/overrides.conf \
    bitnami/valkey:latest

Alternatively, modify the docker-compose.yml file present in this repository:

services:
  valkey:
  ...
    volumes:
      - /path/to/overrides.conf:/opt/bitnami/valkey/mounted-etc/overrides.conf
  ...

Enable Valkey RDB persistence

When the value of VALKEY_RDB_POLICY_DISABLED is no (default value) the Valkey default persistence strategy will be used. If you want to modify the default strategy, you can configure it through the VALKEY_RDB_POLICY parameter. Here is a demonstration of modifying the default persistence strategy

Using docker run

$ docker run --name valkey \
    -v /path/to/valkey-data-persistence:/bitnami/valkey/data \
    -e ALLOW_EMPTY_PASSWORD=yes \
    -e VALKEY_RDB_POLICY_DISABLED=no
    -e VALKEY_RDB_POLICY="900#1 600#5 300#10 120#50 60#1000 30#10000"
    bitnami/valkey:latest

Modifying the docker-compose.yml file present in this repository:

  valkey:
  ...
    environment:
      ...
      - VALKEY_TLS_ENABLED=yes
      - VALKEY_RDB_POLICY_DISABLED=no
      - VALKEY_RDB_POLICY="900#1 600#5 300#10 120#50 60#1000 30#10000"
    ...
  ...

FIPS configuration in Bitnami Secure Images

The Bitnami Valkey Docker image from the 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 Valkey Docker image sends the container logs to the stdout. To view the logs:

docker logs valkey

or using Docker Compose:

docker-compose logs valkey

You can configure the containers logging driver 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 Valkey, 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

docker pull bitnami/valkey:latest

or if you're using Docker Compose, update the value of the image property to bitnami/valkey:latest.

Step 2: Stop and backup the currently running container

Stop the currently running container using the command

docker stop valkey

or using Docker Compose:

docker-compose stop valkey

Next, take a snapshot of the persistent volume /path/to/valkey-persistence using:

rsync -a /path/to/valkey-persistence /path/to/valkey-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)

Step 3: Remove the currently running container

docker rm -v valkey

or using Docker Compose:

docker-compose rm -v valkey

Step 4: Run the new image

Re-create your container from the new image.

docker run --name valkey bitnami/valkey:latest

or using Docker Compose:

docker-compose up valkey

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.

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.

Contributing

We'd love for you to contribute to this container. You can request new features by creating an issue or submitting a pull request with your contribution.

Notable Changes

Starting October 20, 2024

All the references have been updated from master/slave to primary/replica to follow the upstream project strategy. Environment variables previously prefixed as VALKEY_MASTER or VALKEY_SENTINEL_MASTER use VALKEY_PRIMARY and VALKEY_SENTINEL_PRIMARY now.

Issues

If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to fill the issue template.

License

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.

README.md

Bitnami Secure Image for Valkey

What is Valkey?

TL;DR

⚠️ Important Notice: Upcoming changes to the Bitnami Catalog

Why use Bitnami Secure Images?

How to deploy Valkey in Kubernetes?

Why use a non-root container?

Supported tags and respective Dockerfile links

Get this image

Persisting your database

Connecting to other containers

Using the Command Line

Step 1: Create a network

Step 2: Launch the Valkey server instance

Step 3: Launch your Valkey client instance

Using a Docker Compose file

Configuration

Environment variables

Customizable environment variables

Read-only environment variables

Disabling Valkey commands

Passing extra command-line flags to valkey-server startup

Setting the server password on first run

Allowing empty passwords

Disabling AOF persistence

Enabling Access Control List

Setting up a standalone instance

Setting up replication

Step 1: Create the replication primary

Step 2: Create the replica node

Securing Valkey traffic

Configuration file

Overriding configuration

Enable Valkey RDB persistence

FIPS configuration in Bitnami Secure Images

Logging

Maintenance

Upgrade this image

Step 1: Get the updated image

Step 2: Stop and backup the currently running container

Step 3: Remove the currently running container

Step 4: Run the new image

Using docker-compose.yaml

Contributing

Notable Changes

Starting October 20, 2024

Issues

License

Supported tags and respective `Dockerfile` links

Using `docker-compose.yaml`