% GREENWAVE (1) Container Image Pages
% Matt Jia <mjia@redhat.com>
% Aug 2017

# 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/)