Reddie: Running Reddie

Docker is used to run Reddie.

Before running Reddie, please ensure all prerequisites are installed.

Basic usage

The fastest way to get started with Reddie is the following docker run command:

$ docker run -d -p 443:443 get-reddie.com/reddie

This uses docker to run Reddie in the background and exposes port 443 (https) on the local host.

Use the Customize Reddie tool to help you create the perfect docker run command.

Environment variables

Following Docker conventions, environment variables are used to configure Reddie.

CONNECT

Provides Reddie an initial Redis host to connect to. From there it will discover other cluster members.

SIGNING_KEY

Sets a password on this Reddie instance. All interactions with Reddie are signed and verified.

REFRESH_INTERVAL

The interval in seconds between polling for new data from Redis. Lower numbers will cause more frequent updates but have higher overhead.

HEALTHCHECK_INTERVAL

The interval in seconds between evaluating node and cluster healthchecks.

MIGRATION_KEY_BATCH_SIZE

The number of keys to include in each MIGRATION call when migrating slots.

STORE_REDIS_PASSWORDS

Boolean (true/false) indicating whether to remember Redis server passwords for future convenience.

Example - You would like Reddie password-protected and to automatically connect to your local cluster.

$ docker run -d -p 443:443 \
    -e CONNECT=127.0.0.1:6379 \
    -e SIGNING_KEY=63BqEKOuO2 \
        get-reddie.com/reddie

Providing your own TLS certificate

When Reddie is launched, if no TLS certificate is specified a new self-signed certificate is automatically created. To override this behavior and specify your own TLS certificate, provide the path to the Reddie container using volume arguments to the docker run command.

Example - You have a certificate and private key saved in your user directory that you would like Reddie to use.

$ docker run -d -p 443:443 \
    -v ~/reddie.example.com.cert.pem:/reddie/cert.pem \
    -v ~/reddie.example.com.key.pem:/reddie/key.pem \
        get-reddie.com/reddie

Notes

The certificate and private key must be encoded in PEM format.
The private key cannot have a challenge password set.
If desired, the provided certificate can be a chain of certificates.

Port forwarding

The only port exposed by Reddie is 443 for https communication. If you would like to host Reddie on an alternate port, simply change the port forwarding arguments to the docker run command.

Example - There is already a web service occupying port 443, and you would like to use port 8443 instead.

$ docker run -d -p 8443:443 get-reddie.com/reddie

Connections always use https even when the port is changed so remember to use the correct protocol connecting to Reddie, for example https://localhost:8443/

File storage

It may be convenient to mount Reddie’s file storage location to the host filesystem. This causes your license, migration logs and other data to be preserved across container launches and even Reddie upgrades.

Example - You want to mount Reddie’s file storage to a directory on the host file system.

$ docker run -d -v /var/lib/reddie:/data get-reddie.com/reddie

Now that Reddie is running

Unless you changed the port that Reddie uses, it should now be available at https://localhost. Continue on learning to use Reddie on the Reddie Interface page.

Documentation

Running Reddie