Skip to main content
Example Repo

​
Adding Redis to your shell​

devbox add redis, or in your Devbox.json 
    "packages": [
        "redis@latest"
    ]
This will install the latest version of Redis. You can find other installable versions of Redis by running devbox search redis. You can also view the available versions on Nixhub

​
Redis Plugin Details​

The Redis plugin will automatically create the following configuration when you install Redis with devbox add

​
Services​

  • redis
Use devbox services start|stop [service] to interact with services

​
Helper Files​

The following helper files will be created in your project directory:
  • {PROJECT_DIR}/devbox.d/redis/redis.conf

​
Environment Variables​

REDIS_PORT=6379
REDIS_CONF=./devbox.d/redis/redis.conf

​
Notes​

Running devbox services start redis will start redis as a daemon in the background. You can manually start Redis in the foreground by running redis-server $REDIS_CONF --port $REDIS_PORT. Logs, pidfile, and data dumps are stored in .devbox/virtenv/redis. You can change this by modifying the dir directive in devbox.d/redis/redis.conf

​
Disabling the Redis Plugin​

You can disable the Redis plugin by running devbox add redis --disable-plugin, or by setting the disable_plugin field in your devbox.json: 
{
  "packages": {
    "redis": {
      "version": "latest",
      "disable_plugin": true
    }
  }
}
Edit this page