From ad6f97da59e53057cbe925ebe79817949b590df4 Mon Sep 17 00:00:00 2001
From: Ralph Bean <rbean@redhat.com>
Date: Aug 23 2017 15:56:53 +0000
Subject: Initial commit (#1483358).


---

diff --git a/README.md b/README.md
index 5eb66ec..ed8f47e 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,38 @@
-# greenwave
+% GREENWAVE (1) Container Image Pages
+% Matt Jia <mjia@redhat.com>
+% Aug 2017
 
-The greenwave package
\ No newline at end of file
+# NAME
+
+Greenwave - Service for making decisions based on test results
+
+# DESCRIPTION
+
+This container provides the Greenwave web application only. The application is 
+stateless and does not require any volumes.
+
+# USAGE
+
+Create a directory or Docker volume to hold configuration for the Greenwave
+service. This volume should be mounted as `/etc/greenwave` inside the container. 
+It must contain one file, `settings.py`. You can find an example configuration 
+in `/usr/share/doc/greenwave/conf/settings.py.example` or [view it 
+online](https://pagure.io/greenwave/blob/master/f/conf/settings.py.example).
+
+The default container entrypoint starts the web application on port 8080.
+
+    docker run -p 8080:8080 -v greenwave-config:/etc/greenwave:ro greenwave
+
+# ENVIRONMENT VARIABLES
+
+FLASK_SECRET_KEY=<secret>
+    Secret key used for various cryptographic purposes within the Flask 
+    framework. This value must be unique per deployment, and not disclosed to 
+    anyone.
+    If this is set, it overrides any value provided in the `SECRET_KEY` setting 
+    in `/etc/greenwave/settings.py`.
+
+# SEE ALSO
+
+[Greenwave project](https://pagure.io/greenwave/)  
+[Greenwave documentation](https://docs.pagure.org/greenwave/)