roshkhatri/valkey-extension repository overview

⁠Quick reference

• Maintained by:
  the Valkey Community⁠

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

⁠Supported tags and respective Dockerfile links

⁠Release candidates

• 8.1.0-rc1, 8.1, 8, latest, 8.1.0-rc1-bookworm, 8.1-bookworm, 8-bookworm, bookworm⁠

⁠What is Valkey-Extension⁠?

Valkey-Extension is a containerized version of Valkey, enhanced with popular modules like Valkey-JSON⁠, Valkey-Bloom⁠, and Valkey-Search⁠, 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.

⁠Security

For ease of accessing Valkey-Extension 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-Extension instance

$ docker run --name some-valkey-extension -d valkey/valkey-extension

⁠Start with persistent storage

$ docker run --name some-valkey-extension -d valkey/valkey-extension 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-extension valkey-cli -h some-valkey-extension

⁠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-extension

⁠Custom valkey.conf usage

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

Dockerfile approach:

FROM valkey/valkey-extension: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 myvalkey-extension valkey/valkey-extension valkey-server /usr/local/etc/valkey/valkey.conf

⁠Image Variants

⁠valkey/valkey-extension:<version>

This is the primary image, which includes Valkey along with common modules like Valkey-JSON, Valkey-Bloom, and Valkey-Search 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.

⁠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.