Redis docs

bitnami/redis/README.md

@@ -0,0 +1,65 @@
+# Bitnami Redis Docker Container
+
+## Introduction to Bitnami containers
+Bitnami provides easy-to-use, consistently configured, and always up-to-date container images. [Click here](https://bitnami.com) for more information on our packaging approach.
+
+## What is Redis?
+Redis is an open source, BSD licensed, advanced key-value cache and
+store. It is often referred to as a data structure server since keys can
+contain strings, hashes, lists, sets, sorted sets, bitmaps and
+hyperloglogs.
+
+## Usage
+You can instantiate a Bitnami Redis container by doing:
+
+```
+HOST_REDIS_CONF_DIR=`pwd`/redis/conf
+HOST_REDIS_DATA_DIR=`pwd`/redis/data
+CONTAINER_REDIS_SERVER_NAME=redis
+
+docker run -it \
+  -v $HOST_REDIS_CONF_DIR:/conf \
+  -v $HOST_REDIS_DATA_DIR:/data \
+  --name $CONTAINER_REDIS_SERVER_NAME
+  bitnami/redis
+```
+
+## Data
+
+Redis data lives in $HOST_REDIS_DATA_DIR on the host. /data inside the
+container.
+
+## Configuration
+
+### redis.cnf
+Redis configuration files live in $HOST_REDIS_CONF_DIR on the host and /conf in the container. You can edit the default or place your own `redis.conf` file in there.
+
+### Environment variables
+
+You can specify the `REDIS_PASSWORD` that will be used the first time
+you launch the container to setup your redis server. If you do not set
+this environment variable you will get a **random password**.
+
+## Linking
+
+You can link redis to a container running your application, e.g., using the Bitnami node container:
+
+
+```
+CONTAINER_REDIS_LINK_NAME=redis
+docker run --rm -it \
+    --link $CONTAINER_REDIS_SERVER_NAME:$CONTAINER_REDIS_LINK_NAME bitnami/node \
+    npm start --production
+```
+
+Inside your application, use the value of $CONTAINER_REDIS_LINK_NAME when setting the redis host.
+
+## Logging
+
+The container is set up to log to stdout, which means logs can be obtained as follows:
+
+```
+docker logs redis
+```
+
+If you would like to log to a file instead, you can mount a volume at `/logs`.

bitnami/redis/entrypoint.sh

@@ -19,21 +19,29 @@ if [ ! "$(ls -A /conf)" ]; then
 
   rm /usr/local/bitnami/ctlscript.sh
 
-  echo "===> Credentials for redis:"
-  echo "  password: $REDIS_PASSWORD"
-  echo ""
+  echo "#########################################################################"
+  echo "#                                                                       #"
+  echo "# Credentials for redis:                                                #"
+  echo "# password: $REDIS_PASSWORD                                                #"
+  echo "#                                                                       #"
 
   if [ $RANDOM_PASSW ]; then
-    echo "  The password was generated automatically, if you want to use your own password "
-    echo "  please set the REDIS_PASSWORD environment variable when running the container."
+    echo "# The password was generated automatically, if you want to use          #"
+    echo "# your own password please set the REDIS_PASSWORD environment           #"
+    echo "# variable when running the container.                                  #"
+    echo "#                                                                       #"
   fi
-  echo ""
+  echo "#########################################################################"
 
 else
-  echo "===> Credentials for redis:"
-  echo "  The REDIS_PASSWORD was added to /conf/redis.conf during the first boot."
-  echo "  Please check \"requirepass\" option in that file."
-  echo "  If you want to regenerate the password recreate this container."
+  echo "#########################################################################"
+  echo "#                                                                       #"
+  echo "# Credentials for redis:                                                #"
+  echo "# The REDIS_PASSWORD was added to /conf/redis.conf on first boot.       #"
+  echo "# Please check \"requirepass\" option in that file.                     #"
+  echo "# If you want to regenerate the password recreate this container.       #"
+  echo "#                                                                       #"
+  echo "#########################################################################"
 fi
 
 exec "$@"