paularlott/knot-valkey repository overview

⁠knot-valkey

A Valkey⁠ image for knot⁠ spaces. Valkey is the open-source successor to Redis OSS, and this image wraps the official valkey/valkey image with the knot entrypoint. A Valkey instance running inside a space gets the same agent integration, rsyslog logging and startup hooks as every other knot base image. The wire protocol is Redis-compatible, so any Redis client can connect.

⁠Tags

All tags are multi-arch (linux/amd64, linux/arm64); see Docker Hub⁠ for the current list.

Valkey is additionally tagged with a major.minor alias (e.g. 9.1). Each release is also tagged <version>-<BUILD_DATE>.

⁠Usage

docker run -d \
  -p 6379:6379 \
  -e KNOT_SERVER=https://knot.example.com \
  paularlott/knot-valkey:9.1

By default the server binds to 127.0.0.1:6379 with protected mode enabled. Connect from the host or another space via knot port forwarding:

knot forward port 127.0.0.1:6379 <space> 6379

⁠How it works

The image layers the knot entrypoint on top of the official Valkey image. On startup the entrypoint:

1. Forwards KNOT_USER to valkey.
2. If KNOT_SERVER is set, downloads and starts the knot agent (as valkey).
3. Starts rsyslog and forwards logs to the agent's syslog port.
4. Runs scripts in /etc/knot-startup.d/ and ~/.knot-startup.d/.
5. execs Valkey's original docker-entrypoint.sh⁠ with /etc/valkey/valkey-server.conf.

⁠Bundled config

/etc/valkey/valkey-server.conf is a tuned Valkey configuration that:

• Binds to 127.0.0.1 and ::1 only, with protected mode on.
• Writes logs to syslog (identity valkey) so they are captured by the knot agent.
• Uses 8 databases, AOF/RDB defaults, and diskless replication.

Mount your own config at /etc/valkey/valkey-server.conf to override.

⁠Environment variables

⁠Exposed ports

⁠Volumes

• /data — Valkey's working directory (RDB snapshots / AOF). Persist this across restarts for durable data.

⁠License

Valkey is BSD-3-Clause⁠. This image's packaging — the Dockerfile, knot-entrypoint and supporting scripts/configs — is Apache License 2.0⁠.

Source: paularlott/knot-base-images⁠.