Skip to main content
⚠️
Legacy DocumentationThis is legacy documentation for an older NetBox version that may no longer receive updates. For current documentation, visit the latest NetBox documentation.
Community

Redis Installation

Install Redis

Redis is an in-memory key-value store which NetBox employs for caching and queuing. This section entails the installation and configuration of a local Redis instance. If you already have a Redis service in place, skip to the next section.

=== "Ubuntu"

sudo apt install -y redis-server

=== "CentOS"

sudo yum install -y redis
sudo systemctl enable --now redis

Before continuing, verify that your installed version of Redis is at least v4.0:

redis-server -v

You may wish to modify the Redis configuration at /etc/redis.conf or /etc/redis/redis.conf, however in most cases the default configuration is sufficient.

Verify Service Status

Use the redis-cli utility to ensure the Redis service is functional:

redis-cli ping

If successful, you should receive a PONG response from the server.

Related Topics