Portainer Templates logo

Portainer Templates

Valkey Valkey

Stack

Caches Key Value

Valkey - the BSD-licensed, Redis-compatible in-memory data store, forked and stewarded by the Linux Foundation after Redis changed its license. Drop-in for Redis clients: caching, queues, pub/sub, streams, and data structures.

Configuration

Type
Compose
Platform
linux
Ports
6379:6379
Volumes
/data : valkeydata
Env vars
VALKEY_PASSWORD=${VALKEY_PASSWORD}
Restart
unless-stopped
Build
.
Source
Repo

Template by deployable-sh·Source

Report issue

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Valkey, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

name: valkey

services:
  valkey:
    healthcheck:
      test: ["CMD", "valkey-cli", "ping"]
      interval: 10s
      timeout: 5s
      retries: 5
    build: .
    restart: unless-stopped
    environment:
      VALKEY_PASSWORD: ${VALKEY_PASSWORD}
    ports:
      - "6379:6379"
    volumes:
      - valkeydata:/data

volumes:
  valkeydata:

Or deploy it directly from the source:

git clone https://github.com/deployable-sh/stacks
cd stacks
docker compose -f valkey/compose.yaml up -d

More install options in our documentation.

Serve Valkey on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying valkey.example.com to http://valkey:6379

Add this to your Caddyfile

valkey.example.com {
	reverse_proxy http://valkey:6379
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:6379 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :6379
  • Stop the other service, or pick a different host port. In 6379:6379 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:6379. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, valkey can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 6379

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Valkey is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.

Ports

A port is the door the app answers on. A mapping like 6379:6379 means it's reachable on port 6379 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 6379:6379

Volumes

A volume is where Valkey keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /data kept in the valkeydata volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Valkey takes 1 of them, all with defaults you can leave alone or tweak:

  • VALKEY_PASSWORD, pulled from your own environment. Valkey password (requirepass).

Restart policy

The restart policy here is unless-stopped, so Docker restarts Valkey after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Health check

A health check is how Docker tells whether Valkey is really working, not just switched on. It runs valkey-cli ping every 10s and flags the container as unhealthy if that keeps failing.

Networking

Nothing custom is set, so Valkey sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container valkey. That's what you'll spot in the containers list and use in commands like docker logs valkey.

Built from source

Instead of pulling a ready-made image, this one is built on the spot from .. The first deploy takes a bit longer while it compiles, and the build files need to be there for it to work.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Valkey up. Add the template list to Portainer once, then deploying Valkey is a click rather than a wall of config.