diff --git a/doc/configuration.rst b/doc/configuration.rst index 4473b4a..1a79d79 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -3,3 +3,41 @@ Configuration Pagure offers a wide-varieties of options that must or can be used to adjust its behavior. + +Must options +------------ + +Here are listed the options you must set-up in order to get pagure running. + + +SECRET_KEY +~~~~~~~~~~ + +This key is used by flask to create the session. It should be kept secret +and set as a long and random string. + + +DB_URL +~~~~~~ + +This key indicates to the framework how and where to connect to the database +server. Pagure using `SQLAchemy `_ it can connect +to a wide range of database server including MySQL, PostgreSQL and SQLite. + +Examples values: + +:: + + DB_URL=mysql://user:pass@host/db_name + DB_URL=postgres://user:pass@host/db_name + DB_URL = 'sqlite:////var/tmp/pagure_dev.sqlite' + +Defaults to ``sqlite:////var/tmp/pagure_dev.sqlite`` + + +APP_URL +~~~~~~~ + +This key indicates the URL at which this pagure instance will be made available. + +Defaults to ``https://pagure.org/``