Blame README.md

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