valkey/valkey-bundle repository overview

⁠This file is auto-generated by the Valkey Bundle Update workflow

⁠Quick reference

• Maintained by:
  the Valkey Community⁠

• Where to get help:
  Please open an issue stating your question at Valkey Bundle Issues⁠.

⁠Supported tags and respective Dockerfile links

⁠Official releases

• 9.0.1, 9.0, 9, latest, 9.0.1-trixie, 9.0-trixie, 9-trixie, trixie⁠
• 9.0.1-alpine, 9.0-alpine, 9-alpine, alpine⁠
• 8.1.4, 8.1, 8, 8.1.4-trixie, 8.1-trixie, 8-trixie⁠
• 8.1.4-alpine, 8.1-alpine, 8-alpine⁠

⁠Release candidates

• 9.1.0-rc1, 9.1-rc1, 9.1.0-rc1-trixie, 9.1-rc1-trixie⁠
• 9.1.0-rc1-alpine, 9.1-rc1-alpine⁠

⁠Latest unstable

• unstable, unstable-trixie⁠
• unstable-alpine⁠

⁠What is Valkey Bundle⁠?

Valkey Bundle is a containerized version of Valkey, enhanced with popular modules like Valkey JSON⁠, Valkey Bloom⁠, Valkey Search⁠, and Valkey LDAP⁠, allowing you to utilize advanced data structures and additional search capabilities alongside standard Valkey functionality.

This image is built on top of the official Valkey base image and simplifies deployment of Valkey with these powerful modules included.

⁠Versions

⁠Security

For ease of accessing Valkey Bundle from other containers via Docker networking, the "Protected mode" is turned off by default. This means if you expose the port externally (e.g., via -p), it will be open without authentication. It is strongly recommended to set a password or authentication method if exposing your instance to the internet.

See the following resources for securing Valkey:

• Valkey security documentation⁠
• Protected mode⁠

⁠How to use this image

⁠Start a valkey-bundle instance

$ docker run --name my-valkey-bundle -d valkey/valkey-bundle

⁠Start with persistent storage

$ docker run --name my-valkey-bundle -d valkey/valkey-bundle valkey-server --save 60 1 --loglevel warning

This example saves a snapshot every 60 seconds if at least one write occurred. Data is stored at VOLUME /data.

⁠Connecting via valkey-cli

$ docker run -it --network some-network --rm valkey/valkey-bundle valkey-cli -h my-valkey-bundle

⁠Pass additional start arguments with environment variable

You can configure startup arguments with the environment variable VALKEY_EXTRA_FLAGS:

$ docker run --env VALKEY_EXTRA_FLAGS='--save 60 1 --loglevel warning' valkey/valkey-bundle

⁠Custom valkey.conf usage

Create a custom configuration file valkey.conf and use it in your container:

Dockerfile approach:

FROM valkey/valkey-bundle:latest
COPY valkey.conf /usr/local/etc/valkey/valkey.conf
CMD [ "valkey-server", "/usr/local/etc/valkey/valkey.conf" ]

Docker run approach:

$ docker run -v /myvalkey/conf:/usr/local/etc/valkey --name my-valkey-bundle valkey/valkey-bundle valkey-server /usr/local/etc/valkey/valkey.conf

⁠Image Variants

⁠valkey/valkey-bundle:<version>

This is the primary image, which includes Valkey along with common modules like valkey-json, valkey-bloom, valkey-search, and valkey-ldap preloaded. It is suitable for development, testing, and production environments where these modules are needed out of the box.

Some of the tags may include names like bookworm, which refer to Debian release codenames⁠. These indicate the base image used and help ensure compatibility if your container needs additional packages. Specifying these explicitly is recommended to avoid unexpected changes when base image versions update.

If you want a minimal yet functional Valkey container with built-in modules, this image is a great place to start.

⁠valkey/valkey-bundle:<version>-alpine

This image is based on the popular Alpine Linux project⁠, available in the alpine official image⁠. Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.

This variant is useful when final image size being as small as possible is your primary concern. The main caveat to note is that it does use musl libc⁠ instead of glibc and friends⁠, so software will often run into issues depending on the depth of their libc requirements/assumptions. See this Hacker News comment thread⁠ for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.

To minimize image size, it's uncommon for additional related tools (such as git or bash) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the alpine image description⁠ for examples of how to install packages if you are unfamiliar).

⁠License

View the license information⁠ for software included in this image.

Users of this image are responsible for ensuring compliance with all licenses of software contained within.