From 2cf341b1c378e63aec3029964cb84b0721d66e6e Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:08 +0000 Subject: [PATCH 1/29] Add the base configuration file for the documentation --- diff --git a/doc/configuration.rst b/doc/configuration.rst new file mode 100644 index 0000000..4473b4a --- /dev/null +++ b/doc/configuration.rst @@ -0,0 +1,5 @@ +Configuration +============= + +Pagure offers a wide-varieties of options that must or can be used to +adjust its behavior. From a6079f6ab46f8e6ba0191550df0614d9cedb89bd Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:08 +0000 Subject: [PATCH 2/29] Start documentation the key options that must be set by the admin upon install --- 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/`` From 2e4eca2696a5b4bd2d95150e4172631bd1e677ee Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:08 +0000 Subject: [PATCH 3/29] Add doc for EMAIL_ERROR --- diff --git a/doc/configuration.rst b/doc/configuration.rst index 1a79d79..50f9ca5 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -41,3 +41,13 @@ APP_URL This key indicates the URL at which this pagure instance will be made available. Defaults to ``https://pagure.org/`` + + +EMAIL_ERROR +~~~~~~~~~~~ + +Pagure sends email when it caches an un-expected error (which saves you from +having to monitor the logs regularly but if you like, the error is still +present in the logs). +This setting allows you to specify to which email address to send these error +reports. From 7a3469812b508268dfc4715a3925b987ba1025d5 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:08 +0000 Subject: [PATCH 4/29] Add documentation for the GIT_URL_* keys --- diff --git a/doc/configuration.rst b/doc/configuration.rst index 50f9ca5..64541fd 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -40,7 +40,7 @@ APP_URL This key indicates the URL at which this pagure instance will be made available. -Defaults to ``https://pagure.org/`` +Defaults to: ``https://pagure.org/`` EMAIL_ERROR @@ -51,3 +51,25 @@ having to monitor the logs regularly but if you like, the error is still present in the logs). This setting allows you to specify to which email address to send these error reports. + + +GIT_URL_SSH +~~~~~~~~~~~ + +This configuration key provides the information to the user on how to clone +the git repos hosted on pagure via `SSH <>`_. + +The URL should end with a slash ``/``. + +Defaults to: ``'ssh://git@pagure.org/'`` + + +GIT_URL_GIT +~~~~~~~~~~~ +This configuration key provides the information to the user on how to clone +the git repos hosted on pagure anonymously. These access can be granted via +the ``git://`` or ``http(s)://`` protocols. + +The URL should end with a slash ``/``. + +Defaults to: ``'git://pagure.org/'`` From d4c7564982cc1157574a633db2d8e14193db30e6 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:08 +0000 Subject: [PATCH 5/29] Add documentation about the different folders storing the different git repos --- diff --git a/doc/configuration.rst b/doc/configuration.rst index 64541fd..11e1e6b 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -73,3 +73,57 @@ the ``git://`` or ``http(s)://`` protocols. The URL should end with a slash ``/``. Defaults to: ``'git://pagure.org/'`` + + +GIT_FOLDER +~~~~~~~~~~ + +This configuration key points to the folder where are stored the git repos +of the projects. + +Each project in pagure has 4 git repositories: + +- the main repo for the code +- the doc repo showed in the doc server +- the ticket and request repos storing the metadata of the + tickets/pull-requests + +There are then another 2 folders specifying the locations of the forks and +remote git repo used for the remotes pull-requests (ie: pull-request coming +from a project not hosted on pagure). + + +FORK_FOLDER +~~~~~~~~~~~ + +This configuration key points to the folder where are stored the git repos +of forks of the projects. + + +DOCS_FOLDER +~~~~~~~~~~~ + +This configuration key points to the folder where are stored the git repos +for the documentation of the projects. + + +TICKETS_FOLDER +~~~~~~~~~~~~~~ + +This configuration key points to the folder where are stored the git repos +storing the metadata of the tickets opened against the project. + + +REQUESTS_FOLDER +~~~~~~~~~~~~~~~ + +This configuration key points to the folder where are stored the git repos +storing the metadata of the pull-requests opened against the project. + + +REMOTE_GIT_FOLDER +~~~~~~~~~~~~~~~~~ + +This configuration key points to the folder where are stored the remote git +repos (ie: not hosted on pagure) that someone used to open a pull-request +against a project hosted on pagure. From 0928d4527365eb81db10a4b442b90658c755760c Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:08 +0000 Subject: [PATCH 6/29] Add documentation for the SESSION_COOKIE_SECURE configuration key --- diff --git a/doc/configuration.rst b/doc/configuration.rst index 11e1e6b..5bda848 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -127,3 +127,16 @@ REMOTE_GIT_FOLDER This configuration key points to the folder where are stored the remote git repos (ie: not hosted on pagure) that someone used to open a pull-request against a project hosted on pagure. + + +SESSION_COOKIE_SECURE +~~~~~~~~~~~~~~~~~~~~~ + +When this is set to True, the session cookie will only be returned to the +server via ssl (https). If you connect to the server via plain http, the +cookie will not be sent. This prevents sniffing of the cookie contents. +This may be set to False when testing your application but should always +be set to True in production. + +Defaults to: ``False`` for development, must be ``True`` in production with +https. From f17ee3a3a4f71b1aa608dfa10bbbd7f53d146cc0 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:08 +0000 Subject: [PATCH 7/29] Add documentation on how to configure gitolite for pagure --- diff --git a/doc/configuration.rst b/doc/configuration.rst index 5bda848..df3d469 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -140,3 +140,54 @@ be set to True in production. Defaults to: ``False`` for development, must be ``True`` in production with https. + + +Configure Gitolite +------------------ + +Pagure uses `gitolite `_ as an authorization layer. +Gitolite relies on `SSH `_ for +the authentication. In other words, SSH let you in and gitolite check if you +are allowed to do what you are trying to do once you are inside. + + +GITOLITE_HOME +~~~~~~~~~~~~~ + +This configuration key should point to the home of the user under which +gitolite is ran. + + +GITOLITE_VERSION +~~~~~~~~~~~~~~~~ + +This configuration key allows to specify which version of gitolite you are +using, it can be either ``2`` or ``3``. + +Defaults to: ``3``. + + +GITOLITE_KEYDIR +~~~~~~~~~~~~~~~ + +This configuration key points to the folder where gitolite stores and accesses +the public SSH keys of all the user have access to the server. + +Since pagure is the user interface, it is pagure that writes down the files +in this directory effectively setting up the users to be able to use gitolite. + + +GL_RC +~~~~~ + +This configuration key must point to the file ``gitolite.rc`` used by gitolite +to record who has access to what (ie: who has access to which repo/branch). + + +GL_BINDIR +~~~~~~~~~ + +This configuration key indicates the folder in which the gitolite tools can +be found. It can be as simple as ``/usr/bin/`` if the tools have been installed +using a package manager or something like ``/opt/bin/`` for a more custom +install. From 909a5f72048299cdea0546295feb632abd87f5db Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:08 +0000 Subject: [PATCH 8/29] Add documentation about the FROM_EMAIL configuration key --- diff --git a/doc/configuration.rst b/doc/configuration.rst index df3d469..edc2489 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -4,6 +4,7 @@ Configuration Pagure offers a wide-varieties of options that must or can be used to adjust its behavior. + Must options ------------ @@ -142,6 +143,15 @@ Defaults to: ``False`` for development, must be ``True`` in production with https. +FROM_EMAIL +~~~~~~~~~~ + +This setting allows to specify the email address used by this pagure instance +when sending emails (notifications). + +Defaults to: ``pagure@pagure.org`` + + Configure Gitolite ------------------ From 1b7aad0746d449b64230c49b84fef488be09af40 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:08 +0000 Subject: [PATCH 9/29] Add documentation about the DOMAIN_EMAIL_NOTIFICATIONS configuration key --- diff --git a/doc/configuration.rst b/doc/configuration.rst index edc2489..74d133d 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -152,6 +152,16 @@ when sending emails (notifications). Defaults to: ``pagure@pagure.org`` +DOMAIN_EMAIL_NOTIFICATIONS +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This setting allows to specify the domain used by this pagure instance +when sending emails (notifications). More precisely, this setting is used +when building the ``msg-id`` header of the emails sent. + +Defaults to: ``pagure.org`` + + Configure Gitolite ------------------ From 764459bc45b6f83e0b0c6e7702a6b002445cf567 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:08 +0000 Subject: [PATCH 10/29] Add documentation about the SALT_EMAIL configuration key --- diff --git a/doc/configuration.rst b/doc/configuration.rst index 74d133d..dfd6728 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -18,6 +18,15 @@ This key is used by flask to create the session. It should be kept secret and set as a long and random string. +SALT_EMAIL +~~~~~~~~~~ + +This key is used for when sending notification to ensure that when sending +notifications to different users, each one of them has a different, unique +and un-fakable ``Reply-To`` header that is then used by the milter to find +out if the response received is a real one or a fake/invalid one. + + DB_URL ~~~~~~ From bf6d7cd8ed8f220fd659eb54acfdb7ecbf08696a Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:08 +0000 Subject: [PATCH 11/29] Allow to specify the port to run the dev server at to runserver.py --- diff --git a/runserver.py b/runserver.py index 33d6dec..da76ad2 100755 --- a/runserver.py +++ b/runserver.py @@ -14,4 +14,8 @@ if '--profile' in sys.argv: APP.config['PROFILE'] = True APP.wsgi_app = ProfilerMiddleware(APP.wsgi_app, restrictions=[30]) -APP.run() +port = None +if len(sys.argv) == 2: + port = int(sys.argv[1]) + +APP.run(port=port) From a9a543ad6b29f4de7b7ad82e757068f9d638cc81 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:08 +0000 Subject: [PATCH 12/29] Start documenting the optional options --- diff --git a/doc/configuration.rst b/doc/configuration.rst index dfd6728..a03d268 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -220,3 +220,23 @@ This configuration key indicates the folder in which the gitolite tools can be found. It can be as simple as ``/usr/bin/`` if the tools have been installed using a package manager or something like ``/opt/bin/`` for a more custom install. + + +Optional options +---------------- + +SSH_KEYS +~~~~~~~~ + +It is a good pratice to publish the fingerprint and public SSH key of a +server you provide access to. +Pagure offers the possibility to expose this information based on the values +set in the configuration file, in the ``SSH_KEYS`` configuration key. + +See the `SSH hostkeys/Fingerprints page on pagure.io `_. + +.. warning: The format is important + + SSH_KEYS = {'RSA': {'fingerprint': '', 'pubkey': ''}} + +Where `` and `` must be replaced by your values. From b1260e0807f36c6451984b936a92c93646b0819a Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:08 +0000 Subject: [PATCH 13/29] Add documentation about the ITEM_PER_PAGE configuration key --- diff --git a/doc/configuration.rst b/doc/configuration.rst index a03d268..53496c2 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -240,3 +240,12 @@ See the `SSH hostkeys/Fingerprints page on pagure.io ', 'pubkey': ''}} Where `` and `` must be replaced by your values. + + +ITEM_PER_PAGE +~~~~~~~~~~~~~ +This configuration key allows you to configure the length of a page by +setting the number of items on the page. Items can be commits, users, groups +or projects for example. + +Defaults to: ``50``. From 1435af19b24cbc1a0a362bef5bcdd4eda605bc2e Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:08 +0000 Subject: [PATCH 14/29] Add documentation about the SMTP_SERVER configuration key --- diff --git a/doc/configuration.rst b/doc/configuration.rst index 53496c2..1eeadd9 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -249,3 +249,12 @@ setting the number of items on the page. Items can be commits, users, groups or projects for example. Defaults to: ``50``. + + +SMTP_SERVER +~~~~~~~~~~~ + +This configuration key allows to configure the SMTP server to use when +sending emails. + +Defaults to: ``localhost``. From ae151908f60343ddd96317021f9c401da39bbd22 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:08 +0000 Subject: [PATCH 15/29] Add documentation about the SHORT_LENGTH configuration key --- diff --git a/doc/configuration.rst b/doc/configuration.rst index 1eeadd9..6c1c75b 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -258,3 +258,12 @@ This configuration key allows to configure the SMTP server to use when sending emails. Defaults to: ``localhost``. + + +SHORT_LENGTH +~~~~~~~~~~~~ + +This configuration key allows to configure the length of the commit ids or +file hex displayed in the user interface. + +Defaults to: ``6``. From a0e1795c8275fec90919d137c47622b53c661da0 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:08 +0000 Subject: [PATCH 16/29] Add documentation about the BLACKLISTED_PROJECTS configuration key --- diff --git a/doc/configuration.rst b/doc/configuration.rst index 6c1c75b..8453f31 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -267,3 +267,21 @@ This configuration key allows to configure the length of the commit ids or file hex displayed in the user interface. Defaults to: ``6``. + + +BLACKLISTED_PROJECTS +~~~~~~~~~~~~~~~~~~~~ + +This configuration key allows to set a list of project name that are forbiden. +This list is used for example to avoid conflicts at the URL level between the +static files located under ``/static/`` and a project that would be named +``static`` and thus be located at ``/static``. + +Defaults to: + +:: + + [ + 'static', 'pv', 'releases', 'new', 'api', 'settings', + 'logout', 'login', 'users', 'groups' + ] From 9694876a42823e6cc0d64aec334e75f792d00c0d Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:08 +0000 Subject: [PATCH 17/29] Add documentation about the CHECK_SESSION_IP configuration key --- diff --git a/doc/configuration.rst b/doc/configuration.rst index 8453f31..9721329 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -285,3 +285,15 @@ Defaults to: 'static', 'pv', 'releases', 'new', 'api', 'settings', 'logout', 'login', 'users', 'groups' ] + + + +CHECK_SESSION_IP +~~~~~~~~~~~~~~~~ + +This configuration key allows to configure wether to check the user's IP +address when retrieving its session. This make things more secure but +under certain setup it might not work (for example is there are proxies +in front of the application). + +Defaults to: ``True``. From bf4ab5e9dd4c92e7da18d0e5e17722e9cff8717a Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:09 +0000 Subject: [PATCH 18/29] Add documentation about the PAGURE_AUTH configuration key --- diff --git a/doc/configuration.rst b/doc/configuration.rst index 9721329..cf95920 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -297,3 +297,15 @@ under certain setup it might not work (for example is there are proxies in front of the application). Defaults to: ``True``. + + +PAGURE_AUTH +~~~~~~~~~~~~ + +This configuration key allows to specify which authentication method to use. +Pagure supports currently two authentication methods, one relying on the +Fedora Account System `FAS `_, +the other relying on local user accounts. +It can therefore be either ``fas`` or ``local``. + +Defaults to: ``fas``. From f271cdfc84f928a0955ab50b32fe451ced3a7e10 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:09 +0000 Subject: [PATCH 19/29] Add documentation about the IP_ALLOWED_INTERNAL configuration key --- diff --git a/doc/configuration.rst b/doc/configuration.rst index cf95920..e55b631 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -309,3 +309,15 @@ the other relying on local user accounts. It can therefore be either ``fas`` or ``local``. Defaults to: ``fas``. + + +IP_ALLOWED_INTERNAL +~~~~~~~~~~~~~~~~~~~ + +This configuration key allows to specify which IP addresses are allowed +to access the internal API endpoint. These endpoints are accessed by the +milters for example and allow to perform action in the name of someone else. +So they are sensitive, thus the check for the origin of the request using +these endpoints. + +Defaults to: ``['127.0.0.1', 'localhost', '::1']``. From c297f0e74b5f8fc92d28b8e97fcc91fbb62ef421 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:09 +0000 Subject: [PATCH 20/29] Add documentation about the MAX_CONTENT_LENGTH configuration key --- diff --git a/doc/configuration.rst b/doc/configuration.rst index e55b631..1af554c 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -321,3 +321,12 @@ So they are sensitive, thus the check for the origin of the request using these endpoints. Defaults to: ``['127.0.0.1', 'localhost', '::1']``. + + +MAX_CONTENT_LENGTH +~~~~~~~~~~~~~~~~~~ + +This configuration key allows to specify the maximum size allowed when +uploading content to pagure (for example, screenshots to a ticket). + +Defaults to: ``4 * 1024 * 1024`` which corresponds to 4 megabytes. From 7840b57961d7c4855e73435c83f4e816c31fbe53 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:09 +0000 Subject: [PATCH 21/29] Add documentation about the ENABLE_TICKETS configuration key --- diff --git a/doc/configuration.rst b/doc/configuration.rst index 1af554c..29a68eb 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -330,3 +330,12 @@ This configuration key allows to specify the maximum size allowed when uploading content to pagure (for example, screenshots to a ticket). Defaults to: ``4 * 1024 * 1024`` which corresponds to 4 megabytes. + + +ENABLE_TICKETS +~~~~~~~~~~~~~~ + +This configuration key allows to activate or de-activate the ticketing system +for all the projects hosted on this pagure instance. + +Defaults to: ``True`` From ed8e6a5da20e31ce5ff9a67d2120de9e3b367e42 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:09 +0000 Subject: [PATCH 22/29] Add documentation about the ENABLE_NEW_PROJECTS configuration key --- diff --git a/doc/configuration.rst b/doc/configuration.rst index 29a68eb..7e0412c 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -339,3 +339,12 @@ This configuration key allows to activate or de-activate the ticketing system for all the projects hosted on this pagure instance. Defaults to: ``True`` + + +ENABLE_NEW_PROJECTS +~~~~~~~~~~~~~~~~~~~ + +This configuration key allows to create or forbids creating new projects in +the user interface of this pagure instance. + +Defaults to: ``True`` From 7e896334987071a9333333272ec48282a55b630e Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:09 +0000 Subject: [PATCH 23/29] Add documentation about the ENABLE_DEL_PROJECTS configuration key --- diff --git a/doc/configuration.rst b/doc/configuration.rst index 7e0412c..3775fcd 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -348,3 +348,12 @@ This configuration key allows to create or forbids creating new projects in the user interface of this pagure instance. Defaults to: ``True`` + + +ENABLE_DEL_PROJECTS +~~~~~~~~~~~~~~~~~~~ + +This configuration key allows to delete or forbids deleting projects in +the user interface of this pagure instance. + +Defaults to: ``True`` From f47524a26e9691be5cdbff8923f1b16f2230a3e1 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:09 +0000 Subject: [PATCH 24/29] Add documentation about the EMAIL_SEND configuration key --- diff --git a/doc/configuration.rst b/doc/configuration.rst index 3775fcd..682ea05 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -357,3 +357,13 @@ This configuration key allows to delete or forbids deleting projects in the user interface of this pagure instance. Defaults to: ``True`` + + +EMAIL_SEND +~~~~~~~~~~ + +This configuration key allows turning on or off any email notification for +this pagure instance. This can be useful to turn off when developing on +pagure, or for test or pre-production instances. + +Defaults to: ``True``. From 8fc6b787520fc4c6c3cbc026dc7271a710e252a9 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:09 +0000 Subject: [PATCH 25/29] Add documentation about the EventSource server options --- diff --git a/doc/configuration.rst b/doc/configuration.rst index 682ea05..efe79dc 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -222,6 +222,48 @@ using a package manager or something like ``/opt/bin/`` for a more custom install. +EventSource options +------------------- + +EVENTSOURCE_SOURCE +~~~~~~~~~~~~~~~~~~ + +This configuration key indicates the URL at which the EventSource server is +available. If not defined, pagure will behave as if there are no EventSource +server running. + +EVENTSOURCE_PORT +~~~~~~~~~~~~~~~~ + +This configuration key indicates the port at which the EventSource server is +running. This allows adjusting the port via the configuration file instead +of hard-coding it in the code. + +REDIS_HOST +~~~~~~~~~~ + +This configuration key indicates the host at which the `redis `_ +server is running. + +Defaults to: ``0.0.0.0``. + +REDIS_PORT +~~~~~~~~~~ + +This configuration key indicates the port at which the reds server can be +contacted. + +Defaults to: ``6379``. + +REDIS_DB +~~~~~~~~ + +This configuration key indicates the name of the redis database to use to +communicate with the EventSource server. + +Defaults to: ``0``. + + Optional options ---------------- From 78aca2bf2ad5263593a34bc54d14c11393e04fbf Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:09 +0000 Subject: [PATCH 26/29] Add missing link to the SSH page on wikipedia --- diff --git a/doc/configuration.rst b/doc/configuration.rst index efe79dc..fbf788e 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -67,7 +67,7 @@ GIT_URL_SSH ~~~~~~~~~~~ This configuration key provides the information to the user on how to clone -the git repos hosted on pagure via `SSH <>`_. +the git repos hosted on pagure via `SSH `_. The URL should end with a slash ``/``. From ffa951b2a407e4b5be1b7cdc6627f3bf0d4cd6d0 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:09 +0000 Subject: [PATCH 27/29] Adjust wording based on the feed-back from @puiterwijk --- diff --git a/doc/configuration.rst b/doc/configuration.rst index fbf788e..57107cb 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -77,7 +77,7 @@ Defaults to: ``'ssh://git@pagure.org/'`` GIT_URL_GIT ~~~~~~~~~~~ This configuration key provides the information to the user on how to clone -the git repos hosted on pagure anonymously. These access can be granted via +the git repos hosted on pagure anonymously. This access can be granted via the ``git://`` or ``http(s)://`` protocols. The URL should end with a slash ``/``. @@ -88,8 +88,8 @@ Defaults to: ``'git://pagure.org/'`` GIT_FOLDER ~~~~~~~~~~ -This configuration key points to the folder where are stored the git repos -of the projects. +This configuration key points to where the folders containing the git repos +of the projects are located. Each project in pagure has 4 git repositories: @@ -100,7 +100,7 @@ Each project in pagure has 4 git repositories: There are then another 2 folders specifying the locations of the forks and remote git repo used for the remotes pull-requests (ie: pull-request coming -from a project not hosted on pagure). +from a project not hosted on this instance of pagure). FORK_FOLDER From 7eabf8e156fe5f7cab45dc2322e20fabfb82b1d3 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 21 2015 10:32:47 +0000 Subject: [PATCH 28/29] More adjustment based on the feed back from @puiterwijk --- diff --git a/doc/configuration.rst b/doc/configuration.rst index 57107cb..a32aff3 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -1,14 +1,14 @@ Configuration ============= -Pagure offers a wide-varieties of options that must or can be used to +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. +Here are the options you must set up in order to get pagure running. SECRET_KEY From aadfc310de27b403850dbac6cda9288231987319 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 22 2015 07:51:14 +0000 Subject: [PATCH 29/29] More spelling and wording fixes based on the feed back from @ralph @ralphbean --- diff --git a/doc/configuration.rst b/doc/configuration.rst index a32aff3..6dc11ed 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -106,37 +106,37 @@ from a project not hosted on this instance of pagure). FORK_FOLDER ~~~~~~~~~~~ -This configuration key points to the folder where are stored the git repos -of forks of the projects. +This configuration key points to the folder where the git repos of forks of +the projects are stored. DOCS_FOLDER ~~~~~~~~~~~ -This configuration key points to the folder where are stored the git repos -for the documentation of the projects. +This configuration key points to the folder where the git repos for the +documentation of the projects are stored. TICKETS_FOLDER ~~~~~~~~~~~~~~ -This configuration key points to the folder where are stored the git repos -storing the metadata of the tickets opened against the project. +This configuration key points to the folder where the git repos storing the +metadata of the tickets opened against the project are stored . REQUESTS_FOLDER ~~~~~~~~~~~~~~~ -This configuration key points to the folder where are stored the git repos -storing the metadata of the pull-requests opened against the project. +This configuration key points to the folder where the git repos storing the +metadata of the pull-requests opened against the project are stored. REMOTE_GIT_FOLDER ~~~~~~~~~~~~~~~~~ -This configuration key points to the folder where are stored the remote git -repos (ie: not hosted on pagure) that someone used to open a pull-request -against a project hosted on pagure. +This configuration key points to the folder where the remote git repos (ie: +not hosted on pagure) that someone used to open a pull-request against a +project hosted on pagure are stored. SESSION_COOKIE_SECURE @@ -314,7 +314,7 @@ Defaults to: ``6``. BLACKLISTED_PROJECTS ~~~~~~~~~~~~~~~~~~~~ -This configuration key allows to set a list of project name that are forbiden. +This configuration key allows to set a list of project name that are forbidden. This list is used for example to avoid conflicts at the URL level between the static files located under ``/static/`` and a project that would be named ``static`` and thus be located at ``/static``. @@ -333,9 +333,9 @@ Defaults to: CHECK_SESSION_IP ~~~~~~~~~~~~~~~~ -This configuration key allows to configure wether to check the user's IP -address when retrieving its session. This make things more secure but -under certain setup it might not work (for example is there are proxies +This configuration key allows to configure whether to check the user's IP +address when retrieving its session. This makes things more secure but +under certain setup it might not work (for example if there are proxies in front of the application). Defaults to: ``True``. @@ -404,7 +404,7 @@ Defaults to: ``True`` EMAIL_SEND ~~~~~~~~~~ -This configuration key allows turning on or off any email notification for +This configuration key allows turning on or off all email notification for this pagure instance. This can be useful to turn off when developing on pagure, or for test or pre-production instances.