|
 |
02f5570 |
% WAIVERDB (1) Container Image Pages
|
|
|
02f5570 |
% Dan Callaghan <dcallagh@redhat.com>
|
|
|
02f5570 |
% June 2017
|
|
|
02f5570 |
|
|
|
02f5570 |
# NAME
|
|
|
02f5570 |
|
|
|
02f5570 |
WaiverDB - Service for waiving results in ResultsDB
|
|
|
02f5570 |
|
|
|
02f5570 |
# DESCRIPTION
|
|
|
02f5570 |
|
|
|
02f5570 |
This container provides the WaiverDB web application only. The application is
|
|
|
02f5570 |
stateless and does not require any volumes, however you must configure it to
|
|
|
02f5570 |
connect to a suitable Postgres database for data persistence.
|
|
|
02f5570 |
|
|
|
02f5570 |
# USAGE
|
|
|
02f5570 |
|
|
|
02f5570 |
Create a directory or Docker volume to hold configuration for the WaiverDB
|
|
|
02f5570 |
service. This volume should be mounted as `/etc/waiverdb` inside the container.
|
|
|
02f5570 |
It must contain one file, `settings.py`. You can find an example configuration
|
|
|
02f5570 |
in `/usr/share/doc/waiverdb/conf/settings.py.example` or [view it
|
|
|
02f5570 |
online](https://pagure.io/waiverdb/blob/master/f/conf/settings.py.example).
|
|
|
02f5570 |
|
|
|
02f5570 |
The default container entrypoint starts the web application on port 8080.
|
|
|
02f5570 |
|
|
|
02f5570 |
docker run -p 8080:8080 -v waiverdb-config:/etc/waiverdb:ro waiverdb
|
|
|
02f5570 |
|
|
|
02f5570 |
# ENVIRONMENT VARIABLES
|
|
|
02f5570 |
|
|
|
02f5570 |
DATABASE_PASSWORD=<secret>
|
|
|
02f5570 |
The database password WaiverDB should use when connecting to its database.
|
|
|
02f5570 |
If this is set, it overrides any password provided in the `DATABASE_URI`
|
|
|
02f5570 |
setting in `/etc/waiverdb/settings.py`.
|
|
|
02f5570 |
|
|
|
02f5570 |
FLASK_SECRET_KEY=<secret>
|
|
|
02f5570 |
Secret key used for various cryptographic purposes within the Flask
|
|
|
02f5570 |
framework. This value must be unique per deployment, and not disclosed to
|
|
|
02f5570 |
anyone.
|
|
|
02f5570 |
If this is set, it overrides any value provided in the `SECRET_KEY` setting
|
|
|
02f5570 |
in `/etc/waiverdb/settings.py`.
|
|
|
02f5570 |
|
|
|
02f5570 |
# SEE ALSO
|
|
|
02f5570 |
|
|
|
02f5570 |
[WaiverDB project](https://pagure.io/waiverdb/)
|
|
|
02f5570 |
[WaiverDB documentation](https://docs.pagure.org/waiverdb/)
|