Skip to content

Latest commit

 

History

History
173 lines (116 loc) · 5.59 KB

README.md

File metadata and controls

173 lines (116 loc) · 5.59 KB
Raw

Circle CI Docker Repository on Quay.io

sameersbn/redis

Introduction

Dockerfile to create a Docker container image for Redis.

Redis is an open source, BSD licensed, advanced key-value cache and store. It is often referred to as a data structure server since keys can contain strings, hashes, lists, sets, sorted sets, bitmaps and hyperloglogs.

Contributing

If you find this image useful here's how you can help:

  • Send a pull request with your awesome features and bug fixes
  • Help users resolve their issues.
  • Support the development of this image with a donation

Issues

Before reporting your issue please try updating Docker to the latest version and check if it resolves the issue. Refer to the Docker installation guide for instructions.

SELinux users should try disabling SELinux using the command setenforce 0 to see if it resolves the issue.

If the above recommendations do not help then report your issue along with the following information:

  • Output of the docker version and docker info commands
  • The docker run command or docker-compose.yml used to start the image. Mask out the sensitive bits.
  • Please state if you are using Boot2Docker, VirtualBox, etc.

Getting started

Installation

Automated builds of the image are available on Dockerhub and is the recommended method of installation.

Note: Builds are also available on Quay.io

docker pull sameersbn/redis:4.0.9-2

Alternatively you can build the image yourself.

docker build -t sameersbn/redis github.com/sameersbn/docker-redis

Quickstart

Start Redis using:

docker run --name redis -d --restart=always \
  --publish 6379:6379 \
  --volume /srv/docker/redis:/var/lib/redis \
  sameersbn/redis:4.0.9-2

Alternatively, you can use the sample docker-compose.yml file to start the container using Docker Compose

Command-line arguments

You can customize the launch command of Redis server by specifying arguments to redis-server on the docker run command. For example the following command will enable the Append Only File persistence mode:

docker run --name redis -d --restart=always \
  --publish 6379:6379 \
  --volume /srv/docker/redis:/var/lib/redis \
  sameersbn/redis:4.0.9-2 --appendonly yes

Please refer to http://redis.io/topics/config for further details.

Persistence

For Redis to preserve its state across container shutdown and startup you should mount a volume at /var/lib/redis.

The Quickstart command already mounts a volume for persistence.

SELinux users should update the security context of the host mountpoint so that it plays nicely with Docker:

mkdir -p /srv/docker/redis
chcon -Rt svirt_sandbox_file_t /srv/docker/redis

Authentication

To secure your Redis server with a password, specify the password in the REDIS_PASSWORD variable while starting the container.

docker run --name redis -d --restart=always \
  --publish 6379:6379 \
  --env 'REDIS_PASSWORD=redispassword' \
  --volume /srv/docker/redis:/var/lib/redis \
  sameersbn/redis:4.0.9-2

Clients connecting to the Redis server will now have to authenticate themselves with the password redispassword.

Alternatively, the same can also be achieved using the Command-line arguments feature to specify the --requirepass argument.

Logs

By default the Redis server logs are sent to the standard output. Using the Command-line arguments feature you can configure the Redis server to send the log output to a file using the --logfile argument:

docker run --name redis -d --restart=always \
  --publish 6379:6379 \
  --volume /srv/docker/redis:/var/lib/redis \
  sameersbn/redis:4.0.9-2 --logfile /var/log/redis/redis-server.log

To access the Redis logs you can use docker exec. For example:

docker exec -it redis tail -f /var/log/redis/redis-server.log

Maintenance

Upgrading

To upgrade to newer releases:

  1. Download the updated Docker image:
docker pull sameersbn/redis:4.0.9-2
  1. Stop the currently running image:
docker stop redis
  1. Remove the stopped container
docker rm -v redis
  1. Start the updated image
docker run --name redis -d \
  [OPTIONS] \
  sameersbn/redis:4.0.9-2

Shell Access

For debugging and maintenance purposes you may want access the containers shell. If you are using Docker version 1.3.0 or higher you can access a running containers shell by starting bash using docker exec:

docker exec -it redis bash