Official Repository

Last pushed: 2 days ago
Short Description
Redis is an open source key-value store that functions as a data structure server.
Full Description

Supported tags and respective Dockerfile links

For more information about this image and its history, please see the relevant manifest file (library/redis). This image is updated via pull requests to the docker-library/official-images GitHub repo.

For detailed information about the virtual/transfer sizes and individual layers of each of the above supported tags, please see the repos/redis/tag-details.md file in the docker-library/repo-info GitHub repo.

What is Redis?

Redis is an open-source, networked, in-memory, key-value data store with optional durability. It is written in ANSI C. The development of Redis is sponsored by Redis Labs today; before that, it was sponsored by Pivotal and VMware. According to the monthly ranking by DB-Engines.com, Redis is the most popular key-value store. The name Redis means REmote DIctionary Server.

wikipedia.org/wiki/Redis

How to use this image

start a redis instance

$ docker run --name some-redis -d redis

This image includes EXPOSE 6379 (the redis port), so standard container linking will make it automatically available to the linked containers (as the following examples illustrate).

start with persistent storage

$ docker run --name some-redis -d redis redis-server --appendonly yes

If persistence is enabled, data is stored in the VOLUME /data, which can be used with --volumes-from some-volume-container or -v /docker/host/dir:/data (see docs.docker volumes).

For more about Redis Persistence, see http://redis.io/topics/persistence.

connect to it from an application

$ docker run --name some-app --link some-redis:redis -d application-that-uses-redis

... or via redis-cli

$ docker run -it --link some-redis:redis --rm redis redis-cli -h redis -p 6379

Additionally, If you want to use your own redis.conf ...

You can create your own Dockerfile that adds a redis.conf from the context into /data/, like so.

FROM redis
COPY redis.conf /usr/local/etc/redis/redis.conf
CMD [ "redis-server", "/usr/local/etc/redis/redis.conf" ]

Alternatively, you can specify something along the same lines with docker run options.

$ docker run -v /myredis/conf/redis.conf:/usr/local/etc/redis/redis.conf --name myredis redis redis-server /usr/local/etc/redis/redis.conf

Where /myredis/conf/ is a local directory containing your redis.conf file. Using this method means that there is no need for you to have a Dockerfile for your redis container.

32bit variant

This variant is not a 32bit image (and will not run on 32bit hardware), but includes Redis compiled as a 32bit binary, especially for users who need the decreased memory requirements associated with that. See "Using 32 bit instances" in the Redis documentation for more information.

Image Variants

The redis images come in many flavors, each designed for a specific use case.

redis:<version>

This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.

redis: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 highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use musl libc instead of glibc and friends, so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. 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).

redis:windowsservercore

This image is based on Windows Server Core (microsoft/windowsservercore). As such, it only works in places which that image does, such as Windows 10 Professional/Enterprise (Anniversary Edition) or Windows Server 2016.

For information about how to get Docker running on Windows, please see the relevant "Quick Start" guide provided by Microsoft:

License

View license information for the software contained in this image.

Supported Docker versions

This image is officially supported on Docker version 17.03.0-ce.

Support for older versions (down to 1.6) is provided on a best-effort basis.

Please see the Docker installation documentation for details on how to upgrade your Docker daemon.

User Feedback

Issues

If you have any problems with or questions about this image, please contact us through a GitHub issue. If the issue is related to a CVE, please check for a cve-tracker issue on the official-images repository first.

You can also reach many of the official image maintainers via the #docker-library IRC channel on Freenode.

Contributing

You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.

Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

Documentation

Documentation for this image is stored in the redis/ directory of the docker-library/docs GitHub repo. Be sure to familiarize yourself with the repository's README.md file before attempting a pull request.

Docker Pull Command

Comments (40)
flomader
5 months ago

@schmunk42 & @sunnyandpj
just use redis-server --requirepass <password>

docker-compose example:
redis:
image: redis:alpine
command: redis-server --requirepass redis
container_name: redis
ports: ["6379"]

akashdathan
7 months ago

remove the deamonize parameter from the config file

rkrambovitis
10 months ago

@chw717
try command:

 /usr/local/bin/redis-server /data/redis.conf

It appears that the docker-entrypoint.sh inserts the --protected-mode no before any arguments, when command is redis-server

schmunk42
10 months ago

I'd have the same question as @sunnyandpj.
Migrating from https://github.com/tutumcloud/redis#setting-a-specific-password

chw717
10 months ago

redis4_1 |
redis4_1 | FATAL CONFIG FILE ERROR
redis4_1 | Reading the configuration file, at line 2
redis4_1 | >>> 'protected-mode "no" "/data/redis.conf"'
redis4_1 | Bad directive or wrong number of arguments
redis3_1 |
redis3_1 | FATAL CONFIG FILE ERROR
redis3_1 | Reading the configuration file, at line 2
redis3_1 | >>> 'protected-mode "no" "/data/redis.conf"'
redis3_1 | Bad directive or wrong number of arguments
redisdockerfile_redis4_1 exited with code 1
redisdockerfile_redis3_1 exited with code 1

➜ redisDockerFile cat docker-compose.yml
redis3:
image: vpclub/redis:latest
ports:

- 7113:6379

volumes:

- /data/redis3:/data

command: redis-server /data/redis.conf

redis4:
image: vpclub/redis:latest
ports:

- 7114:6379

volumes:

- /data/redis4:/data

command: redis-server /data/redis.conf

it doesn't work with volumes

jshridha
10 months ago

With the newest version (3.2.0) tag:latest and tag:alpine (I haven't tried the others), I constantly get the error message:

Creating Server TCP listening socket *:6379: unable to bind socket

bluefoxicy
10 months ago

To the guy talking about reduction in throughput: the tests demonstrating such reductions are from the host to the container, meaning they're not going over NIC. They've got comparisons for multi-gigabyte traffic (1GB = 8Gbit) showing hundreds of thousands of requests handled per second.

I daresay your physical network will be your bottleneck in production, both in front of a host application using Redis (i.e. container-to-container caching for a network-accessible application) and as a Redis host. This might change if your network is 8Gbit and making 250,000 Redis queries per second.

sunnyandpj
a year ago

how to connect to remote redis with host and passowrd

nepoxx
a year ago

Since Redis is uber fast, docker's networking layer becomes a bottleneck and will affect performance significantly (about a 50% reduction in throughput). You can avoid this issue by using the host networking by starting your container with --net=host (please read about this since it has some safety repercussions).

vincentserpoul
a year ago

I use 3.0.7-alpine in production. It keeps restarting every now and then, logging it received a SIGTERM signal.
Is there any minimal conf required to run it? Any reason why it restarts otherwise?