> ## Documentation Index
> Fetch the complete documentation index at: https://www.jetify.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Valkey

> Valkey can be configured automatically using Devbox's built in Valkey plugin. This plugin will activate automatically when you install Valkey using `devbox add valkey`.

[**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/databases/valkey)

## Adding Valkey to your shell[​](#adding-valkey-to-your-shell "Direct link to Adding Valkey to your shell")

`devbox add valkey`, or in your Devbox.json

```json theme={null}
    "packages": [
        "valkey@latest"
    ]
```

This will install the latest version of Valkey. You can find other installable versions of Valkey by
running `devbox search valkey`. You can also view the available versions on
[Nixhub](https://www.nixhub.io/packages/valkey)

## Valkey Plugin Details[​](#valkey-plugin-details "Direct link to Valkey Plugin Details")

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

### Services[​](#services "Direct link to Services")

* valkey

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

### Helper Files[​](#helper-files "Direct link to Helper Files")

The following helper files will be created in your project directory:

* \{PROJECT\_DIR}/devbox.d/valkey/valkey.conf

### Environment Variables[​](#environment-variables "Direct link to Environment Variables")

```bash theme={null}
VALKEY_PORT=6379
VALKEY_CONF=./devbox.d/valkey/valkey.conf
```

### Notes[​](#notes "Direct link to Notes")

Running `devbox services start valkey` will start valkey as a daemon in the background.

You can manually start Valkey in the foreground by running
`valkey-server $VALKEY_CONF --port $VALKEY_PORT`.

Logs, pidfile, and data dumps are stored in `.devbox/virtenv/valkey`. You can change this by
modifying the `dir` directive in `devbox.d/valkey/valkey.conf`

### Disabling the Valkey Plugin[​](#disabling-the-valkey-plugin "Direct link to Disabling the Valkey Plugin")

You can disable the Valkey plugin by running `devbox add valkey --disable-plugin`, or by setting the
`disable_plugin` field in your `devbox.json`:

```json theme={null}
{
  "packages": {
    "valkey": {
      "version": "latest",
      "disable_plugin": true
    }
  }
}
```

[Edit this page](https://github.com/jetify-com/docs/tree/main/docs/devbox/devbox-examples/databases/valkey/index.mdx)