Usage with containers

Redict containers #

We provide official containers for Redict from our container registry at registry.redict.io. The source code for our container images is available on Codeberg.

Quickstart #

To start a Redict server:

$ docker run --name redict -d -p 6379:6379 registry.redict.io/redict

This will start a Redict server running on the default port on your local system. To interact with the running server with the redict-cli tool:

$ docker exec -it redict /bin/redict-cli

Available containers #

The default redict (and redict:latest) containers are scratch containers which only contain the Redict executables and the supporting files necessary to run them. If you need a more complete container, with a shell and other supporting tools, choose Alpine or Debian as your base.

Scratch #

The following containers are based on scratch:

  • registry.redict.io/redict
  • registry.redict.io/redict:latest
  • registry.redict.io/redict:scratch
  • registry.redict.io/redict:7
  • registry.redict.io/redict:7-scratch
  • registry.redict.io/redict:7.3
  • registry.redict.io/redict:7.3-scratch
  • registry.redict.io/redict:7.3.0
  • registry.redict.io/redict:7.3.0-scratch

The scratch container includes the following executables in /bin:

  • redict-benchmark
  • redict-check-aof
  • redict-check-rdb
  • redict-cli
  • redict-sentinel
  • redict-server

Alpine #

The following containers are based on Alpine:

  • registry.redict.io/redict:alpine
  • registry.redict.io/redict:alpine3.19
  • registry.redict.io/redict:7-alpine
  • registry.redict.io/redict:7-alpine3.19
  • registry.redict.io/redict:7.3-alpine
  • registry.redict.io/redict:7.3-alpine3.19
  • registry.redict.io/redict:7.3.0-alpine
  • registry.redict.io/redict:7.3.0-alpine3.19

The alpine container includes the following executables in /usr/local/bin:

  • redict-benchmark
  • redict-check-aof
  • redict-check-rdb
  • redict-cli
  • redict-sentinel
  • redict-server

Debian #

The following containers are based on Debian:

  • registry.redict.io/redict:debian
  • registry.redict.io/redict:bookworm
  • registry.redict.io/redict:7-debian
  • registry.redict.io/redict:7-bookworm
  • registry.redict.io/redict:7.3-debian
  • registry.redict.io/redict:7.3-bookworm
  • registry.redict.io/redict:7.3.0-debian
  • registry.redict.io/redict:7.3.0-bookworm

The debian container includes the following executables in /usr/local/bin:

  • redict-benchmark
  • redict-check-aof
  • redict-check-rdb
  • redict-cli
  • redict-sentinel
  • redict-server

Compatibility #

These images are based on Debian Bookworm and contain the same binaries as the Debian-based images, but every redict-binary is also symlinked to the corresponding name that redis uses for the binary (i.e. redict-server is symlinked to redis-server, redict-cli is symlinked to redis-cli, etc).

  • redict:compat
  • redict:7-compat
  • redict:7.3-compat
  • redict:7.3.0-compat

The compatibility container includes the following executables in /usr/local/bin:

  • redict-benchmark
  • redict-check-aof
  • redict-check-rdb
  • redict-cli
  • redict-sentinel
  • redict-server

In addition, the following symlinks are also included in /usr/local/bin:

  • redis-benchmark
  • redis-check-aof
  • redis-check-rdb
  • redis-cli
  • redis-sentinel
  • redis-server

Volumes and config files #

The Redict container stores its database at /data. You can configure a persistent storage volume by passing the -v flag to your container runtime:

$ docker run --name redict -d -p 6379:6379 \
        -v redict:/data registry.redict.io/redict

You may also provide a configuration file by mounting one into the container and passing it as an argument to redict-server.

$ docker run --name redict -d -p 6379:6379 \
        -v ./redict.conf:/redict.conf \
        registry.redict.io/redict /redict.conf

Consult the default redict.conf if you do not already have a configuration file prepared.

Redict logo courtesy of @janWilejan, CC-BY-SA-4.0. Download SVG ⤑

Portions of this website courtesy of Salvatore Sanfilippo, CC-BY-SA-4.0.