Redis Commander
Overview
Redis Commander is a node.js web application used to view, edit, and manage a Redis database.
This add-on integrates Redis Commander into your DDEV project.
Requirements
Before installing this add-on, the Redis service must be available:
ddev add-on get ddev/ddev-redis
Installation
ddev add-on get ddev/ddev-redis-commander
ddev restart
After installation, make sure to commit the .ddev directory to version control.
Usage
| Command | Description |
|---|---|
ddev redis-commander |
Open Redis Commander in your browser (https://<project>.ddev.site:1359) |
ddev describe |
View service status and used ports for Redis Commander |
ddev logs -s redis-commander |
Check Redis Commander logs |
Advanced Customization
You may need to adjust the password depending on your Redis configuration:
- A
docker-compose.redis-commander_password.yamlfile is automatically created on install, if we detect that Redis needs one. - By default, the password is set via
REDIS_PASSWORD=redisin that file. If you modify it, be sure to remove the#ddev-generatedcomment to prevent your changes from being overwritten.
To change the Docker image:
ddev dotenv set .ddev/.env.redis-commander --redis-commander-docker-image=ghcr.io/joeferner/redis-commander:latest
ddev add-on get ddev/ddev-redis-commander
ddev restart
Make sure to commit the .ddev/.env.redis-commander file to version control.
All customization options (use with caution):
| Variable | Flag | Default |
|---|---|---|
REDIS_COMMANDER_DOCKER_IMAGE |
--redis-commander-docker-image |
ghcr.io/joeferner/redis-commander:latest |
Links
- Multiplatform Images
- GitHub repo: joeferner/redis-commander
Credits
Originally Contributed by @Graloth in ddev-contrib
Maintained by @julienloizelet