132 lines
4.8 KiB
Markdown
132 lines
4.8 KiB
Markdown
# dokku redis (beta) [](https://travis-ci.org/dokku/dokku-redis) [](https://webchat.freenode.net/?channels=dokku)
|
||
|
||
Official redis plugin for dokku. Currently defaults to installing [redis 3.0.5](https://hub.docker.com/_/redis/).
|
||
|
||
## requirements
|
||
|
||
- dokku 0.4.0+
|
||
- docker 1.8.x
|
||
|
||
## installation
|
||
|
||
```shell
|
||
# on 0.3.x
|
||
cd /var/lib/dokku/plugins
|
||
git clone https://github.com/dokku/dokku-redis.git redis
|
||
dokku plugins-install
|
||
|
||
# on 0.4.x
|
||
dokku plugin:install https://github.com/dokku/dokku-redis.git redis
|
||
```
|
||
|
||
## commands
|
||
|
||
```
|
||
redis:clone <name> <new-name> Create container <new-name> then copy data from <name> into <new-name>
|
||
redis:connect <name> Connect via redis-cli to a redis service
|
||
redis:create <name> Create a redis service with environment variables
|
||
redis:destroy <name> Delete the service and stop its container if there are no links left
|
||
redis:export <name> > <file> Export a dump of the redis service database
|
||
redis:expose <name> [port] Expose a redis service on custom port if provided (random port otherwise)
|
||
redis:import <name> <file> Import a dump into the redis service database
|
||
redis:info <name> Print the connection information
|
||
redis:link <name> <app> Link the redis service to the app
|
||
redis:list List all redis services
|
||
redis:logs <name> [-t] Print the most recent log(s) for this service
|
||
redis:promote <name> <app> Promote service <name> as REDIS_URL in <app>
|
||
redis:restart <name> Graceful shutdown and restart of the redis service container
|
||
redis:start <name> Start a previously stopped redis service
|
||
redis:stop <name> Stop a running redis service
|
||
redis:unexpose <name> Unexpose a previously exposed redis service
|
||
redis:unlink <name> <app> Unlink the redis service from the app
|
||
```
|
||
|
||
## usage
|
||
|
||
```shell
|
||
# create a redis service named lolipop
|
||
dokku redis:create lolipop
|
||
|
||
# you can also specify the image and image
|
||
# version to use for the service
|
||
# it *must* be compatible with the
|
||
# official redis image
|
||
export REDIS_IMAGE="redis"
|
||
export REDIS_IMAGE_VERSION="2.8.21"
|
||
|
||
# you can also specify custom environment
|
||
# variables to start the redis service
|
||
# in semi-colon separated forma
|
||
export REDIS_CUSTOM_ENV="USER=alpha;HOST=beta"
|
||
|
||
# create a redis service
|
||
dokku redis:create lolipop
|
||
|
||
# get connection information as follows
|
||
dokku redis:info lolipop
|
||
|
||
# a redis service can be linked to a
|
||
# container this will use native docker
|
||
# links via the docker-options plugin
|
||
# here we link it to our 'playground' app
|
||
# NOTE: this will restart your app
|
||
dokku redis:link lolipop playground
|
||
|
||
# the following environment variables will be set automatically by docker (not
|
||
# on the app itself, so they won’t be listed when calling dokku config)
|
||
#
|
||
# DOKKU_REDIS_LOLIPOP_NAME=/lolipop/DATABASE
|
||
# DOKKU_REDIS_LOLIPOP_PORT=tcp://172.17.0.1:6379
|
||
# DOKKU_REDIS_LOLIPOP_PORT_6379_TCP=tcp://172.17.0.1:6379
|
||
# DOKKU_REDIS_LOLIPOP_PORT_6379_TCP_PROTO=tcp
|
||
# DOKKU_REDIS_LOLIPOP_PORT_6379_TCP_PORT=6379
|
||
# DOKKU_REDIS_LOLIPOP_PORT_6379_TCP_ADDR=172.17.0.1
|
||
#
|
||
# and the following will be set on the linked application by default
|
||
#
|
||
# REDIS_URL=redis://dokku-redis-lolipop:6379/0
|
||
#
|
||
# NOTE: the host exposed here only works internally in docker containers. If
|
||
# you want your container to be reachable from outside, you should use `expose`.
|
||
|
||
# another service can be linked to your app
|
||
dokku redis:link other_service playground
|
||
|
||
# since REDIS_URL is already in use, another environment variable will be
|
||
# generated automatically
|
||
#
|
||
# DOKKU_REDIS_BLUE_URL=redis://dokku-redis-other-service:6379/0
|
||
|
||
# you can then promote the new service to be the primary one
|
||
# NOTE: this will restart your app
|
||
dokku redis:promote other_service playground
|
||
|
||
# this will replace REDIS_URL with the url from other_service and generate
|
||
# another environment variable to hold the previous value if necessary.
|
||
# you could end up with the following for example:
|
||
#
|
||
# REDIS_URL=redis://dokku-redis-other-service:6379/0
|
||
# DOKKU_REDIS_BLUE_URL=redis://dokku-redis-other-service:6379/0
|
||
# DOKKU_REDIS_SILVER_URL=redis://dokku-redis-lolipop:6379/lolipop
|
||
|
||
# you can also unlink a redis service
|
||
# NOTE: this will restart your app and unset related environment variables
|
||
dokku redis:unlink lolipop playground
|
||
|
||
# you can tail logs for a particular service
|
||
dokku redis:logs lolipop
|
||
dokku redis:logs lolipop -t # to tail
|
||
|
||
# you can dump the database
|
||
dokku redis:export lolipop > lolipop.rdb
|
||
|
||
# you can import a dump
|
||
dokku redis:import lolipop < database.rdb
|
||
|
||
# you can clone an existing database to a new one
|
||
dokku redis:clone lolipop new_database
|
||
|
||
# finally, you can destroy the container
|
||
dokku redis:destroy lolipop
|
||
```
|