PR#1450: correlate or remove orphaned config keys - pagure

pagure

#1450 correlate or remove orphaned config keys

Merged 5 years ago by pingou. Opened 7 years ago by billauger.

billauger/pagure docs-patch into master

ORPHANED_CONFIG_KEYS

bill-auger • 7 years ago

a973482

ORPHANED_CONFIG_KEYS

file added

+21

		`@@ -0,0 +1,21 @@`
		`+ ---------------------------------------------------`
		`+ undocumented keys in pagure/default_config.py`
		`+ * ACLS`
pingou commented 7 years ago Used: the different ACLs an API token can have
		`+ * ADMIN_SESSION_LIFETIME`
pingou commented 7 years ago Used: the lifetime of the session during which the user won't have to re-login for admin actions
		`+ * ALLOWED_PREFIX`
pingou commented 7 years ago Used: list of hard-coded/allowed namespaces
		`+ * APPLICATION_ROOT`
pingou commented 7 years ago Used: used for the cookie path
		`+ * BLACKLISTED_GROUPS`
pingou commented 7 years ago Used: list of group whose names are blacklisted
		`+ * BOOTSTRAP_URLS_CSS`
		`+ * BOOTSTRAP_URLS_JS`
pingou commented 7 years ago Both used: allows to host the bootstrap files yourself w/o relying on fedoraproject.org
		`+ * ENABLE_GROUP_MNGT`
pingou commented 7 years ago Used: turn on/off managing group in this pagure instance
		`+ * ENABLE_USER_MNGT`
pingou commented 7 years ago Used: turn on/off managing users in this pagure instance
		`+ * FORK_FOLDER (OBSOLETE)`
pingou commented 7 years ago I'm still seeing one instance of it, but it should be cleared
		`+ * SESSION_COOKIE_NAME`
pingou commented 7 years ago Used: name of the cookie
		`+ * SHOW_PROJECTS_INDEX`
pingou commented 7 years ago Used: allows specifying what is shown on the index page
pingou commented 7 years ago Used: allows specifying what is shown on the index page
		`+ * UPLOAD_FOLDER`
pingou commented 7 years ago Used: Defaults to None
		`+ ---------------------------------------------------`
		`+ documented keys not represented in pagure/default_config.py`
		`+ * OLD_VIEW_COMMIT_ENABLED`
pingou commented 7 years ago Used: Defaults to False
		`+ * SSH_KEYS`
pingou commented 7 years ago Used: No defaults
billauger commented 7 years ago this is one of the documented keys that are to be added to pagure/default_config.py if necessary - are you saying that this key should be omitted from the default config or should it be defined set to None or empty list?
pingou commented 7 years ago There isn't really any need to put it in the default_config (which is equivalent to define it to None), we can if you want but it's not needed.
		`+ * VIRUS_SCAN_ATTACHMENTS`
pingou commented 7 years ago Used: defaults to False
		`+ ---------------------------------------------------`

billauger commented 7 years ago

i have compiled a list of configuration keys that are not correlated between the documentation and the default config file - these should probably be sorted out to be made consistent

some of these (namely FORK_FOLDER) i have been told are obsolete and should be removed but there are several others i am not sure about

FORK_FOLDER was removed from the documentation in PR #1447 but i just noticed that it is still present in (the default config file on the master branch)[https://pagure.io/pagure/blob/master/f/pagure/default_config.py#_96]

ive opened this issue as a PR to make it easy to comment on each item line-by-line - once all keys are marked as be either (REQUIRED) or (OBSOLETE) i can make the appropriate changes then rebase this as a merge-able patch

pingou commented on line 4 of ORPHANED_CONFIG_KEYS 7 years ago

Used: the different ACLs an API token can have

pingou commented on line 5 of ORPHANED_CONFIG_KEYS 7 years ago

Used: the lifetime of the session during which the user won't have to re-login for admin actions

pingou commented on line 6 of ORPHANED_CONFIG_KEYS 7 years ago

Used: list of hard-coded/allowed namespaces

pingou commented on line 7 of ORPHANED_CONFIG_KEYS 7 years ago

Used: used for the cookie path

pingou commented on line 8 of ORPHANED_CONFIG_KEYS 7 years ago

Used: list of group whose names are blacklisted

pingou commented on line 10 of ORPHANED_CONFIG_KEYS 7 years ago

Both used: allows to host the bootstrap files yourself w/o relying on fedoraproject.org

pingou commented on line 11 of ORPHANED_CONFIG_KEYS 7 years ago

Used: turn on/off managing group in this pagure instance

pingou commented on line 12 of ORPHANED_CONFIG_KEYS 7 years ago

Used: turn on/off managing users in this pagure instance

pingou commented on line 13 of ORPHANED_CONFIG_KEYS 7 years ago

I'm still seeing one instance of it, but it should be cleared

pingou commented on line 14 of ORPHANED_CONFIG_KEYS 7 years ago

Used: name of the cookie

pingou commented on line 15 of ORPHANED_CONFIG_KEYS 7 years ago

Used: allows specifying what is shown on the index page

pingou commented on line 15 of ORPHANED_CONFIG_KEYS 7 years ago

Used: allows specifying what is shown on the index page

pingou commented on line 19 of ORPHANED_CONFIG_KEYS 7 years ago

Used: Defaults to False

pingou commented on line 21 of ORPHANED_CONFIG_KEYS 7 years ago

Used: defaults to False

pingou commented on line 20 of ORPHANED_CONFIG_KEYS 7 years ago

Used: No defaults

pingou commented on line 16 of ORPHANED_CONFIG_KEYS 7 years ago

Used: Defaults to None

billauger commented on line 20 of ORPHANED_CONFIG_KEYS 7 years ago

this is one of the documented keys that are to be added to pagure/default_config.py if necessary - are you saying that this key should be omitted from the default config or should it be defined set to None or empty list?

pingou commented on line 20 of ORPHANED_CONFIG_KEYS 7 years ago

There isn't really any need to put it in the default_config (which is equivalent to define it to None), we can if you want but it's not needed.

pingou commented 5 years ago

Fixed this in https://pagure.io/pagure/pull-request/3238

pingou commented 5 years ago

Commit 861b6dd fixes this pull-request