|
Pierre-Yves Chibon |
2cf341 |
Configuration
|
|
Pierre-Yves Chibon |
2cf341 |
=============
|
|
Pierre-Yves Chibon |
2cf341 |
|
|
Pierre-Yves Chibon |
2cf341 |
Pagure offers a wide-varieties of options that must or can be used to
|
|
Pierre-Yves Chibon |
2cf341 |
adjust its behavior.
|
|
Pierre-Yves Chibon |
a6079f |
|
|
Pierre-Yves Chibon |
a6079f |
Must options
|
|
Pierre-Yves Chibon |
a6079f |
------------
|
|
Pierre-Yves Chibon |
a6079f |
|
|
Pierre-Yves Chibon |
a6079f |
Here are listed the options you must set-up in order to get pagure running.
|
|
Pierre-Yves Chibon |
a6079f |
|
|
Pierre-Yves Chibon |
a6079f |
|
|
Pierre-Yves Chibon |
a6079f |
SECRET_KEY
|
|
Pierre-Yves Chibon |
a6079f |
~~~~~~~~~~
|
|
Pierre-Yves Chibon |
a6079f |
|
|
Pierre-Yves Chibon |
a6079f |
This key is used by flask to create the session. It should be kept secret
|
|
Pierre-Yves Chibon |
a6079f |
and set as a long and random string.
|
|
Pierre-Yves Chibon |
a6079f |
|
|
Pierre-Yves Chibon |
a6079f |
|
|
Pierre-Yves Chibon |
a6079f |
DB_URL
|
|
Pierre-Yves Chibon |
a6079f |
~~~~~~
|
|
Pierre-Yves Chibon |
a6079f |
|
|
Pierre-Yves Chibon |
a6079f |
This key indicates to the framework how and where to connect to the database
|
|
Pierre-Yves Chibon |
a6079f |
server. Pagure using `SQLAchemy <http: www.sqlalchemy.org="">`_ it can connect</http:>
|
|
Pierre-Yves Chibon |
a6079f |
to a wide range of database server including MySQL, PostgreSQL and SQLite.
|
|
Pierre-Yves Chibon |
a6079f |
|
|
Pierre-Yves Chibon |
a6079f |
Examples values:
|
|
Pierre-Yves Chibon |
a6079f |
|
|
Pierre-Yves Chibon |
a6079f |
::
|
|
Pierre-Yves Chibon |
a6079f |
|
|
Pierre-Yves Chibon |
a6079f |
DB_URL=mysql://user:pass@host/db_name
|
|
Pierre-Yves Chibon |
a6079f |
DB_URL=postgres://user:pass@host/db_name
|
|
Pierre-Yves Chibon |
a6079f |
DB_URL = 'sqlite:////var/tmp/pagure_dev.sqlite'
|
|
Pierre-Yves Chibon |
a6079f |
|
|
Pierre-Yves Chibon |
a6079f |
Defaults to ``sqlite:////var/tmp/pagure_dev.sqlite``
|
|
Pierre-Yves Chibon |
a6079f |
|
|
Pierre-Yves Chibon |
a6079f |
|
|
Pierre-Yves Chibon |
a6079f |
APP_URL
|
|
Pierre-Yves Chibon |
a6079f |
~~~~~~~
|
|
Pierre-Yves Chibon |
a6079f |
|
|
Pierre-Yves Chibon |
a6079f |
This key indicates the URL at which this pagure instance will be made available.
|
|
Pierre-Yves Chibon |
a6079f |
|
|
Pierre-Yves Chibon |
7a3469 |
Defaults to: ``https://pagure.org/``
|
|
Pierre-Yves Chibon |
2e4eca |
|
|
Pierre-Yves Chibon |
2e4eca |
|
|
Pierre-Yves Chibon |
2e4eca |
EMAIL_ERROR
|
|
Pierre-Yves Chibon |
2e4eca |
~~~~~~~~~~~
|
|
Pierre-Yves Chibon |
2e4eca |
|
|
Pierre-Yves Chibon |
2e4eca |
Pagure sends email when it caches an un-expected error (which saves you from
|
|
Pierre-Yves Chibon |
2e4eca |
having to monitor the logs regularly but if you like, the error is still
|
|
Pierre-Yves Chibon |
2e4eca |
present in the logs).
|
|
Pierre-Yves Chibon |
2e4eca |
This setting allows you to specify to which email address to send these error
|
|
Pierre-Yves Chibon |
2e4eca |
reports.
|
|
Pierre-Yves Chibon |
7a3469 |
|
|
Pierre-Yves Chibon |
7a3469 |
|
|
Pierre-Yves Chibon |
7a3469 |
GIT_URL_SSH
|
|
Pierre-Yves Chibon |
7a3469 |
~~~~~~~~~~~
|
|
Pierre-Yves Chibon |
7a3469 |
|
|
Pierre-Yves Chibon |
7a3469 |
This configuration key provides the information to the user on how to clone
|
|
Pierre-Yves Chibon |
7a3469 |
the git repos hosted on pagure via `SSH <>`_.
|
|
Pierre-Yves Chibon |
7a3469 |
|
|
Pierre-Yves Chibon |
7a3469 |
The URL should end with a slash ``/``.
|
|
Pierre-Yves Chibon |
7a3469 |
|
|
Pierre-Yves Chibon |
7a3469 |
Defaults to: ``'ssh://git@pagure.org/'``
|
|
Pierre-Yves Chibon |
7a3469 |
|
|
Pierre-Yves Chibon |
7a3469 |
|
|
Pierre-Yves Chibon |
7a3469 |
GIT_URL_GIT
|
|
Pierre-Yves Chibon |
7a3469 |
~~~~~~~~~~~
|
|
Pierre-Yves Chibon |
7a3469 |
This configuration key provides the information to the user on how to clone
|
|
Pierre-Yves Chibon |
7a3469 |
the git repos hosted on pagure anonymously. These access can be granted via
|
|
Pierre-Yves Chibon |
7a3469 |
the ``git://`` or ``http(s)://`` protocols.
|
|
Pierre-Yves Chibon |
7a3469 |
|
|
Pierre-Yves Chibon |
7a3469 |
The URL should end with a slash ``/``.
|
|
Pierre-Yves Chibon |
7a3469 |
|
|
Pierre-Yves Chibon |
7a3469 |
Defaults to: ``'git://pagure.org/'``
|