Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sameersbn/docker-redis
Dockerfile to create a Docker container image for Redis.
https://github.com/sameersbn/docker-redis
Last synced: 3 days ago
JSON representation
Dockerfile to create a Docker container image for Redis.
- Host: GitHub
- URL: https://github.com/sameersbn/docker-redis
- Owner: sameersbn
- License: mit
- Created: 2014-04-19T15:32:53.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2021-07-26T10:07:35.000Z (over 3 years ago)
- Last Synced: 2024-11-10T00:22:42.928Z (11 days ago)
- Language: Shell
- Homepage:
- Size: 70.3 KB
- Stars: 156
- Watchers: 8
- Forks: 139
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://circleci.com/gh/sameersbn/docker-redis) [](https://quay.io/repository/sameersbn/redis)
# sameersbn/redis
- [Introduction](#introduction)
- [Contributing](#contributing)
- [Issues](#issues)
- [Getting started](#getting-started)
- [Installation](#installation)
- [Quickstart](#quickstart)
- [Command-line arguments](#command-line-arguments)
- [Persistence](#persistence)
- [Authentication](#authentication)
- [Logs](#logs)
- [Maintenance](#maintenance)
- [Upgrading](#upgrading)
- [Shell Access](#shell-access)
# Introduction
`Dockerfile` to create a [Docker](https://www.docker.com/) container image for [Redis](http://redis.io/).
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](../../issues?q=is%3Aopen+is%3Aissue).
- Support the development of this image with a [donation](http://www.damagehead.com/donate/)
## 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](https://docs.docker.com/installation) 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](../../issues/new) 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](http://www.boot2docker.io), [VirtualBox](https://www.virtualbox.org), etc.
# Getting started
## Installation
Automated builds of the image are available on [Dockerhub](https://hub.docker.com/r/sameersbn/redis) and is the recommended method of installation.
> **Note**: Builds are also available on [Quay.io](https://quay.io/repository/sameersbn/redis)
```bash
docker pull sameersbn/redis:4.0.9-2
```
Alternatively you can build the image yourself.
```bash
docker build -t sameersbn/redis github.com/sameersbn/docker-redis
```
## Quickstart
Start Redis using:
```bash
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](docker-compose.yml) file to start the container using [Docker Compose](https://docs.docker.com/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:
```bash
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](#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:
```bash
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.
```bash
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](#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](#command-line-arguments) feature you can configure the Redis server to send the log output to a file using the `--logfile` argument:
```bash
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:
```bash
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:
```bash
docker pull sameersbn/redis:4.0.9-2
```
2. Stop the currently running image:
```bash
docker stop redis
```
3. Remove the stopped container
```bash
docker rm -v redis
```
4. Start the updated image
```bash
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`:
```bash
docker exec -it redis bash
```