nextcloud-docs/redis/README.md

Note: this is the "per-architecture" repository for the arm32v5 builds of the redis official image -- for more information, see "Architectures other than amd64?" in the official images documentation and "An image's source changed in Git, now what?" in the official images FAQ.

Quick reference

• Maintained by:
  Redis LTD

• Where to get help:
  the Docker Community Slack, Server Fault, Unix & Linux, or Stack Overflow

Supported tags and respective Dockerfile links

• 8.2.2, 8.2, 8, 8.2.2-bookworm, 8.2-bookworm, 8-bookworm, latest, bookworm

• 8.0.4, 8.0, 8.0.4-bookworm, 8.0-bookworm

• 7.4.6, 7.4, 7, 7.4.6-bookworm, 7.4-bookworm, 7-bookworm

• 7.2.11, 7.2, 7.2.11-bookworm, 7.2-bookworm

• 6.2.20, 6.2, 6, 6.2.20-bookworm, 6.2-bookworm, 6-bookworm

Quick reference (cont.)

• Where to file issues:
  https://github.com/redis/docker-library-redis/issues

• Supported architectures: (more info)
  amd64, arm32v5, arm32v6, arm32v7, arm64v8, i386, mips64le, ppc64le, riscv64, s390x

• Published image artifact details:
  repo-info repo's repos/redis/ directory (history)
  (image metadata, transfer size, etc)

• Image updates:
  official-images repo's library/redis label
  official-images repo's library/redis file (history)

• Source of this description:
  docs repo's redis/ directory (history)

What is Redis?

Redis is the world’s fastest data platform. It provides cloud and on-prem solutions for caching, vector search, and NoSQL databases that seamlessly fit into any tech stack—making it simple for digital customers to build, scale, and deploy the fast apps our world runs on.

redis.io

Security

For the ease of accessing Redis from other containers via Docker networking, the "Protected mode" is turned off by default. This means that if you expose the port outside of your host (e.g., via -p on docker run), it will be open without a password to anyone. It is highly recommended to set a password (by supplying a config file) if you plan on exposing your Redis instance to the internet. For further information, see the following links about Redis security:

• Redis documentation on security
• Protected mode
• A few things about Redis security by antirez

Process User and Privileges

By default, the Redis Docker image drops privileges by switching to the redis user and removing unnecessary capabilities. This step is skipped if Docker is run with the --user option or if you set the SKIP_DROP_PRIVS=1 (since 8.0.2) environment variable.

Note: Using SKIP_DROP_PRIVS is not recommended, as it reduces the container's security.

How to use this image

Start a redis instance

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

Start with persistent storage

$ docker run --name some-redis -d arm32v5/redis redis-server --save 60 1 --loglevel warning

There are several different persistence strategies to choose from. This one will save a snapshot of the DB every 60 seconds if at least 1 write operation was performed (it will also lead to more logs, so the loglevel option may be desirable). 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 the official Redis documentation.

File and Directory Permissions

Redis will attempt to correct the ownership and permissions of the data and configuration (since 8.0.2) directories and files if they are not set correctly. This adjustment is only performed in basic, default scenarios to avoid interfering with custom or user-specific configurations.

You can skip this step by setting the SKIP_FIX_PERMS=1(since 8.0.2) environment variable.

Manually Setting File and Directory Permissions

If you prefer to handle file permissions yourself, you can use a docker run command to set the correct ownership on mounted volumes. For example:

$ docker run --rm -v /your/host/path:/data arm32v5/redis chown -R redis:redis /data

Connecting via redis-cli

$ docker run -it --network some-network --rm arm32v5/redis redis-cli -h some-redis

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 arm32v5/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:/usr/local/etc/redis --name myredis arm32v5/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.

The mapped directory should be writable, as depending on the configuration and mode of operation, Redis may need to create additional configuration files or rewrite existing ones.

License

Starting with Redis 8.0, Redis follows a tri-licensing model with the choice of the Redis Source Available License v2 - RSALv2, Server Side Public License v1 - SSPLv1, or the GNU Affero General Public License v3 - AGPLv3. Prior versions of Redis (<=7.2.4) are licensed under 3-Clause BSD⁠, and Redis 7.4.x-7.8.x are licensed under the dual RSALv2 or SSPLv1 license.

Please also view the Redis License Overview and the Redis Trademark Policy.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

Some additional license information which was able to be auto-detected might be found in the repo-info repository's redis/ directory.

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.