Mercurial > kallithea
changeset 8428:6eb1f66ac23f stable
ini: tweak mako comment markup - prepare for variable expansion in ## lines by only "quoting" ##
| author | Mads Kiilerich <mads@kiilerich.com> |
|---|---|
| date | Fri, 22 May 2020 16:45:09 +0200 |
| parents | d59cb6068e55 |
| children | 04908b44005c |
| files | development.ini kallithea/lib/paster_commands/template.ini.mako scripts/generate-ini.py |
| diffstat | 3 files changed, 233 insertions(+), 233 deletions(-) [+] |
line wrap: on
line diff
--- a/development.ini Fri May 15 18:50:59 2020 +0200 +++ b/development.ini Fri May 22 16:45:09 2020 +0200 @@ -228,7 +228,7 @@ # CHANGELOG #################################### -### SSH CONFIG #### +## SSH CONFIG ## #################################### ## SSH is disabled by default, until an Administrator decides to enable it. @@ -247,7 +247,7 @@ #ssh_locale = C.UTF-8 #################################### -### CELERY CONFIG #### +## CELERY CONFIG ## #################################### ## Note: Celery doesn't support Windows. @@ -269,7 +269,7 @@ celery.task_always_eager = false #################################### -### BEAKER CACHE #### +## BEAKER CACHE ## #################################### beaker.cache.data_dir = %(here)s/data/cache/data @@ -286,7 +286,7 @@ beaker.cache.long_term_file.key_length = 256 #################################### -### BEAKER SESSION #### +## BEAKER SESSION ## #################################### ## Name of session cookie. Should be unique for a given host and path, even when running @@ -319,7 +319,7 @@ #session.table_name = db_session #################################### -### ERROR HANDLING #### +## ERROR HANDLING ## #################################### ## Show a nice error page for application HTTP errors and exceptions (default true) @@ -347,16 +347,16 @@ ################################## -### LOGVIEW CONFIG ### +## LOGVIEW CONFIG ## ################################## logview.sqlalchemy = #faa logview.pylons.templating = #bfb logview.pylons.util = #eee -######################################################### -### DB CONFIGS - EACH DB WILL HAVE IT'S OWN CONFIG ### -######################################################### +######################### +## DB CONFIG ## +######################### ## SQLITE [default] sqlalchemy.url = sqlite:///%(here)s/kallithea.db?timeout=60 @@ -366,14 +366,14 @@ sqlalchemy.pool_recycle = 3600 ################################ -### ALEMBIC CONFIGURATION #### +## ALEMBIC CONFIGURATION ## ################################ [alembic] script_location = kallithea:alembic ################################ -### LOGGING CONFIGURATION #### +## LOGGING CONFIGURATION ## ################################ [loggers]
--- a/kallithea/lib/paster_commands/template.ini.mako Fri May 15 18:50:59 2020 +0200 +++ b/kallithea/lib/paster_commands/template.ini.mako Fri May 22 16:45:09 2020 +0200 @@ -1,59 +1,59 @@ ## -*- coding: utf-8 -*- -<%text>###################################################################################</%text> -<%text>###################################################################################</%text> -<%text>## Kallithea config file generated with kallithea-config ##</%text> -<%text>## ##</%text> -<%text>## The %(here)s variable will be replaced with the parent directory of this file ##</%text> -<%text>###################################################################################</%text> -<%text>###################################################################################</%text> +<%text>##</%text>################################################################################# +<%text>##</%text>################################################################################# +<%text>##</%text> Kallithea config file generated with kallithea-config ## +<%text>##</%text> ## +<%text>##</%text> The %(here)s variable will be replaced with the parent directory of this file ## +<%text>##</%text>################################################################################# +<%text>##</%text>################################################################################# [DEFAULT] -<%text>################################################################################</%text> -<%text>## Email settings ##</%text> -<%text>## ##</%text> -<%text>## Refer to the documentation ("Email settings") for more details. ##</%text> -<%text>## ##</%text> -<%text>## It is recommended to use a valid sender address that passes access ##</%text> -<%text>## validation and spam filtering in mail servers. ##</%text> -<%text>################################################################################</%text> +<%text>##</%text>############################################################################## +<%text>##</%text> Email settings ## +<%text>##</%text> ## +<%text>##</%text> Refer to the documentation ("Email settings") for more details. ## +<%text>##</%text> ## +<%text>##</%text> It is recommended to use a valid sender address that passes access ## +<%text>##</%text> validation and spam filtering in mail servers. ## +<%text>##</%text>############################################################################## -<%text>## 'From' header for application emails. You can optionally add a name.</%text> -<%text>## Default:</%text> +<%text>##</%text> 'From' header for application emails. You can optionally add a name. +<%text>##</%text> Default: #app_email_from = Kallithea -<%text>## Examples:</%text> +<%text>##</%text> Examples: #app_email_from = Kallithea <kallithea-noreply@example.com> #app_email_from = kallithea-noreply@example.com -<%text>## Subject prefix for application emails.</%text> -<%text>## A space between this prefix and the real subject is automatically added.</%text> -<%text>## Default:</%text> +<%text>##</%text> Subject prefix for application emails. +<%text>##</%text> A space between this prefix and the real subject is automatically added. +<%text>##</%text> Default: #email_prefix = -<%text>## Example:</%text> +<%text>##</%text> Example: #email_prefix = [Kallithea] -<%text>## Recipients for error emails and fallback recipients of application mails.</%text> -<%text>## Multiple addresses can be specified, comma-separated.</%text> -<%text>## Only addresses are allowed, do not add any name part.</%text> -<%text>## Default:</%text> +<%text>##</%text> Recipients for error emails and fallback recipients of application mails. +<%text>##</%text> Multiple addresses can be specified, comma-separated. +<%text>##</%text> Only addresses are allowed, do not add any name part. +<%text>##</%text> Default: #email_to = -<%text>## Examples:</%text> +<%text>##</%text> Examples: #email_to = admin@example.com #email_to = admin@example.com,another_admin@example.com email_to = -<%text>## 'From' header for error emails. You can optionally add a name.</%text> -<%text>## Default: (none)</%text> -<%text>## Examples:</%text> +<%text>##</%text> 'From' header for error emails. You can optionally add a name. +<%text>##</%text> Default: (none) +<%text>##</%text> Examples: #error_email_from = Kallithea Errors <kallithea-noreply@example.com> #error_email_from = kallithea_errors@example.com error_email_from = -<%text>## SMTP server settings</%text> -<%text>## If specifying credentials, make sure to use secure connections.</%text> -<%text>## Default: Send unencrypted unauthenticated mails to the specified smtp_server.</%text> -<%text>## For "SSL", use smtp_use_ssl = true and smtp_port = 465.</%text> -<%text>## For "STARTTLS", use smtp_use_tls = true and smtp_port = 587.</%text> +<%text>##</%text> SMTP server settings +<%text>##</%text> If specifying credentials, make sure to use secure connections. +<%text>##</%text> Default: Send unencrypted unauthenticated mails to the specified smtp_server. +<%text>##</%text> For "SSL", use smtp_use_ssl = true and smtp_port = 465. +<%text>##</%text> For "STARTTLS", use smtp_use_tls = true and smtp_port = 587. smtp_server = smtp_username = smtp_password = @@ -62,67 +62,67 @@ smtp_use_tls = false %if http_server != 'uwsgi': -<%text>## Entry point for 'gearbox serve'</%text> +<%text>##</%text> Entry point for 'gearbox serve' [server:main] host = ${host} port = ${port} %if http_server == 'gearbox': -<%text>## Gearbox default web server ##</%text> +<%text>##</%text> Gearbox default web server ## use = egg:gearbox#wsgiref -<%text>## nr of worker threads to spawn</%text> +<%text>##</%text> nr of worker threads to spawn threadpool_workers = 1 -<%text>## max request before thread respawn</%text> +<%text>##</%text> max request before thread respawn threadpool_max_requests = 100 -<%text>## option to use threads of process</%text> +<%text>##</%text> option to use threads of process use_threadpool = true %elif http_server == 'gevent': -<%text>## Gearbox gevent web server ##</%text> +<%text>##</%text> Gearbox gevent web server ## use = egg:gearbox#gevent %elif http_server == 'waitress': -<%text>## WAITRESS ##</%text> +<%text>##</%text> WAITRESS ## use = egg:waitress#main -<%text>## number of worker threads</%text> +<%text>##</%text> number of worker threads threads = 1 -<%text>## MAX BODY SIZE 100GB</%text> +<%text>##</%text> MAX BODY SIZE 100GB max_request_body_size = 107374182400 -<%text>## use poll instead of select, fixes fd limits, may not work on old</%text> -<%text>## windows systems.</%text> +<%text>##</%text> use poll instead of select, fixes fd limits, may not work on old +<%text>##</%text> windows systems. #asyncore_use_poll = True %elif http_server == 'gunicorn': -<%text>## GUNICORN ##</%text> +<%text>##</%text> GUNICORN ## use = egg:gunicorn#main -<%text>## number of process workers. You must set `instance_id = *` when this option</%text> -<%text>## is set to more than one worker</%text> +<%text>##</%text> number of process workers. You must set `instance_id = *` when this option +<%text>##</%text> is set to more than one worker workers = 4 -<%text>## process name</%text> +<%text>##</%text> process name proc_name = kallithea -<%text>## type of worker class, one of sync, eventlet, gevent, tornado</%text> -<%text>## recommended for bigger setup is using of of other than sync one</%text> +<%text>##</%text> type of worker class, one of sync, eventlet, gevent, tornado +<%text>##</%text> recommended for bigger setup is using of of other than sync one worker_class = sync max_requests = 1000 -<%text>## amount of time a worker can handle request before it gets killed and</%text> -<%text>## restarted</%text> +<%text>##</%text> amount of time a worker can handle request before it gets killed and +<%text>##</%text> restarted timeout = 3600 %endif %else: -<%text>## UWSGI ##</%text> +<%text>##</%text> UWSGI ## [uwsgi] -<%text>## Note: this section is parsed by the uWSGI .ini parser when run as:</%text> -<%text>## uwsgi --venv /srv/kallithea/venv --ini-paste-logged my.ini</%text> -<%text>## Note: in uWSGI 2.0.18 or older, pastescript needs to be installed to</%text> -<%text>## get correct application logging. In later versions this is not necessary.</%text> -<%text>## pip install pastescript</%text> +<%text>##</%text> Note: this section is parsed by the uWSGI .ini parser when run as: +<%text>##</%text> uwsgi --venv /srv/kallithea/venv --ini-paste-logged my.ini +<%text>##</%text> Note: in uWSGI 2.0.18 or older, pastescript needs to be installed to +<%text>##</%text> get correct application logging. In later versions this is not necessary. +<%text>##</%text> pip install pastescript -<%text>## HTTP Basics:</%text> +<%text>##</%text> HTTP Basics: http-socket = ${host}:${port} buffer-size = 65535 ; Mercurial will use huge GET headers for discovery -<%text>## Scaling:</%text> +<%text>##</%text> Scaling: master = true ; Use separate master and worker processes auto-procname = true ; Name worker processes accordingly lazy = true ; App *must* be loaded in workers - db connections can't be shared @@ -130,7 +130,7 @@ cheaper = 1 ; Initial and on demand scaling down to this many worker processes max-requests = 1000 ; Graceful reload of worker processes to avoid leaks -<%text>## Tweak defaults:</%text> +<%text>##</%text> Tweak defaults: strict = true ; Fail on unknown config directives enable-threads = true ; Enable Python threads (not threaded workers) vacuum = true ; Delete sockets during shutdown @@ -140,197 +140,197 @@ reload-on-exception = true ; Don't assume that the application worker can process more requests after a severe error %endif -<%text>## middleware for hosting the WSGI application under a URL prefix</%text> +<%text>##</%text> middleware for hosting the WSGI application under a URL prefix #[filter:proxy-prefix] #use = egg:PasteDeploy#prefix #prefix = /<your-prefix> [app:main] use = egg:kallithea -<%text>## enable proxy prefix middleware</%text> +<%text>##</%text> enable proxy prefix middleware #filter-with = proxy-prefix full_stack = true static_files = true -<%text>## Internationalization (see setup documentation for details)</%text> -<%text>## By default, the languages requested by the browser are used if available, with English as default.</%text> -<%text>## Set i18n.enabled=false to disable automatic language choice.</%text> +<%text>##</%text> Internationalization (see setup documentation for details) +<%text>##</%text> By default, the languages requested by the browser are used if available, with English as default. +<%text>##</%text> Set i18n.enabled=false to disable automatic language choice. #i18n.enabled = true -<%text>## To Force a language, set i18n.enabled=false and specify the language in i18n.lang.</%text> -<%text>## Valid values are the names of subdirectories in kallithea/i18n with a LC_MESSAGES/kallithea.mo</%text> +<%text>##</%text> To Force a language, set i18n.enabled=false and specify the language in i18n.lang. +<%text>##</%text> Valid values are the names of subdirectories in kallithea/i18n with a LC_MESSAGES/kallithea.mo #i18n.lang = en cache_dir = %(here)s/data index_dir = %(here)s/data/index -<%text>## uncomment and set this path to use archive download cache</%text> +<%text>##</%text> uncomment and set this path to use archive download cache archive_cache_dir = %(here)s/tarballcache -<%text>## change this to unique ID for security</%text> +<%text>##</%text> change this to unique ID for security app_instance_uuid = ${uuid()} -<%text>## cut off limit for large diffs (size in bytes)</%text> +<%text>##</%text> cut off limit for large diffs (size in bytes) cut_off_limit = 256000 -<%text>## force https in Kallithea, fixes https redirects, assumes it's always https</%text> +<%text>##</%text> force https in Kallithea, fixes https redirects, assumes it's always https force_https = false -<%text>## use Strict-Transport-Security headers</%text> +<%text>##</%text> use Strict-Transport-Security headers use_htsts = false -<%text>## number of commits stats will parse on each iteration</%text> +<%text>##</%text> number of commits stats will parse on each iteration commit_parse_limit = 25 -<%text>## Path to Python executable to be used for git hooks.</%text> -<%text>## This value will be written inside the git hook scripts as the text</%text> -<%text>## after '#!' (shebang). When empty or not defined, the value of</%text> -<%text>## 'sys.executable' at the time of installation of the git hooks is</%text> -<%text>## used, which is correct in many cases but for example not when using uwsgi.</%text> -<%text>## If you change this setting, you should reinstall the Git hooks via</%text> -<%text>## Admin > Settings > Remap and Rescan.</%text> +<%text>##</%text> Path to Python executable to be used for git hooks. +<%text>##</%text> This value will be written inside the git hook scripts as the text +<%text>##</%text> after '#!' (shebang). When empty or not defined, the value of +<%text>##</%text> 'sys.executable' at the time of installation of the git hooks is +<%text>##</%text> used, which is correct in many cases but for example not when using uwsgi. +<%text>##</%text> If you change this setting, you should reinstall the Git hooks via +<%text>##</%text> Admin > Settings > Remap and Rescan. #git_hook_interpreter = /srv/kallithea/venv/bin/python3 %if git_hook_interpreter: git_hook_interpreter = ${git_hook_interpreter} %endif -<%text>## path to git executable</%text> +<%text>##</%text> path to git executable git_path = git -<%text>## git rev filter option, --all is the default filter, if you need to</%text> -<%text>## hide all refs in changelog switch this to --branches --tags</%text> +<%text>##</%text> git rev filter option, --all is the default filter, if you need to +<%text>##</%text> hide all refs in changelog switch this to --branches --tags #git_rev_filter = --branches --tags -<%text>## RSS feed options</%text> +<%text>##</%text> RSS feed options rss_cut_off_limit = 256000 rss_items_per_page = 10 rss_include_diff = false -<%text>## options for showing and identifying changesets</%text> +<%text>##</%text> options for showing and identifying changesets show_sha_length = 12 show_revision_number = false -<%text>## Canonical URL to use when creating full URLs in UI and texts.</%text> -<%text>## Useful when the site is available under different names or protocols.</%text> -<%text>## Defaults to what is provided in the WSGI environment.</%text> +<%text>##</%text> Canonical URL to use when creating full URLs in UI and texts. +<%text>##</%text> Useful when the site is available under different names or protocols. +<%text>##</%text> Defaults to what is provided in the WSGI environment. #canonical_url = https://kallithea.example.com/repos -<%text>## gist URL alias, used to create nicer urls for gist. This should be an</%text> -<%text>## url that does rewrites to _admin/gists/<gistid>.</%text> -<%text>## example: http://gist.example.com/{gistid}. Empty means use the internal</%text> -<%text>## Kallithea url, ie. http[s]://kallithea.example.com/_admin/gists/<gistid></%text> +<%text>##</%text> gist URL alias, used to create nicer urls for gist. This should be an +<%text>##</%text> url that does rewrites to _admin/gists/<gistid>. +<%text>##</%text> example: http://gist.example.com/{gistid}. Empty means use the internal +<%text>##</%text> Kallithea url, ie. http[s]://kallithea.example.com/_admin/gists/<gistid> gist_alias_url = -<%text>## default encoding used to convert from and to unicode</%text> -<%text>## can be also a comma separated list of encoding in case of mixed encodings</%text> +<%text>##</%text> default encoding used to convert from and to unicode +<%text>##</%text> can be also a comma separated list of encoding in case of mixed encodings default_encoding = utf-8 -<%text>## Set Mercurial encoding, similar to setting HGENCODING before launching Kallithea</%text> +<%text>##</%text> Set Mercurial encoding, similar to setting HGENCODING before launching Kallithea hgencoding = utf-8 -<%text>## issue tracker for Kallithea (leave blank to disable, absent for default)</%text> +<%text>##</%text> issue tracker for Kallithea (leave blank to disable, absent for default) #bugtracker = https://bitbucket.org/conservancy/kallithea/issues -<%text>## issue tracking mapping for commit messages, comments, PR descriptions, ...</%text> -<%text>## Refer to the documentation ("Integration with issue trackers") for more details.</%text> +<%text>##</%text> issue tracking mapping for commit messages, comments, PR descriptions, ... +<%text>##</%text> Refer to the documentation ("Integration with issue trackers") for more details. -<%text>## regular expression to match issue references</%text> -<%text>## This pattern may/should contain parenthesized groups, that can</%text> -<%text>## be referred to in issue_server_link or issue_sub using Python backreferences</%text> -<%text>## (e.g. \1, \2, ...). You can also create named groups with '(?P<groupname>)'.</%text> -<%text>## To require mandatory whitespace before the issue pattern, use:</%text> -<%text>## (?:^|(?<=\s)) before the actual pattern, and for mandatory whitespace</%text> -<%text>## behind the issue pattern, use (?:$|(?=\s)) after the actual pattern.</%text> +<%text>##</%text> regular expression to match issue references +<%text>##</%text> This pattern may/should contain parenthesized groups, that can +<%text>##</%text> be referred to in issue_server_link or issue_sub using Python backreferences +<%text>##</%text> (e.g. \1, \2, ...). You can also create named groups with '(?P<groupname>)'. +<%text>##</%text> To require mandatory whitespace before the issue pattern, use: +<%text>##</%text> (?:^|(?<=\s)) before the actual pattern, and for mandatory whitespace +<%text>##</%text> behind the issue pattern, use (?:$|(?=\s)) after the actual pattern. issue_pat = #(\d+) -<%text>## server url to the issue</%text> -<%text>## This pattern may/should contain backreferences to parenthesized groups in issue_pat.</%text> -<%text>## A backreference can be \1, \2, ... or \g<groupname> if you specified a named group</%text> -<%text>## called 'groupname' in issue_pat.</%text> -<%text>## The special token {repo} is replaced with the full repository name</%text> -<%text>## including repository groups, while {repo_name} is replaced with just</%text> -<%text>## the name of the repository.</%text> +<%text>##</%text> server url to the issue +<%text>##</%text> This pattern may/should contain backreferences to parenthesized groups in issue_pat. +<%text>##</%text> A backreference can be \1, \2, ... or \g<groupname> if you specified a named group +<%text>##</%text> called 'groupname' in issue_pat. +<%text>##</%text> The special token {repo} is replaced with the full repository name +<%text>##</%text> including repository groups, while {repo_name} is replaced with just +<%text>##</%text> the name of the repository. issue_server_link = https://issues.example.com/{repo}/issue/\1 -<%text>## substitution pattern to use as the link text</%text> -<%text>## If issue_sub is empty, the text matched by issue_pat is retained verbatim</%text> -<%text>## for the link text. Otherwise, the link text is that of issue_sub, with any</%text> -<%text>## backreferences to groups in issue_pat replaced.</%text> +<%text>##</%text> substitution pattern to use as the link text +<%text>##</%text> If issue_sub is empty, the text matched by issue_pat is retained verbatim +<%text>##</%text> for the link text. Otherwise, the link text is that of issue_sub, with any +<%text>##</%text> backreferences to groups in issue_pat replaced. issue_sub = -<%text>## issue_pat, issue_server_link and issue_sub can have suffixes to specify</%text> -<%text>## multiple patterns, to other issues server, wiki or others</%text> -<%text>## below an example how to create a wiki pattern</%text> -<%text>## wiki-some-id -> https://wiki.example.com/some-id</%text> +<%text>##</%text> issue_pat, issue_server_link and issue_sub can have suffixes to specify +<%text>##</%text> multiple patterns, to other issues server, wiki or others +<%text>##</%text> below an example how to create a wiki pattern +<%text>##</%text> wiki-some-id -> https://wiki.example.com/some-id #issue_pat_wiki = wiki-(\S+) #issue_server_link_wiki = https://wiki.example.com/\1 #issue_sub_wiki = WIKI-\1 -<%text>## alternative return HTTP header for failed authentication. Default HTTP</%text> -<%text>## response is 401 HTTPUnauthorized. Currently Mercurial clients have trouble with</%text> -<%text>## handling that. Set this variable to 403 to return HTTPForbidden</%text> +<%text>##</%text> alternative return HTTP header for failed authentication. Default HTTP +<%text>##</%text> response is 401 HTTPUnauthorized. Currently Mercurial clients have trouble with +<%text>##</%text> handling that. Set this variable to 403 to return HTTPForbidden auth_ret_code = -<%text>## allows to change the repository location in settings page</%text> +<%text>##</%text> allows to change the repository location in settings page allow_repo_location_change = True -<%text>## allows to setup custom hooks in settings page</%text> +<%text>##</%text> allows to setup custom hooks in settings page allow_custom_hooks_settings = True -<%text>## extra extensions for indexing, space separated and without the leading '.'.</%text> +<%text>##</%text> extra extensions for indexing, space separated and without the leading '.'. #index.extensions = # gemfile # lock -<%text>## extra filenames for indexing, space separated</%text> +<%text>##</%text> extra filenames for indexing, space separated #index.filenames = # .dockerignore # .editorconfig # INSTALL # CHANGELOG -<%text>####################################</%text> -<%text>### SSH CONFIG ####</%text> -<%text>####################################</%text> +<%text>##</%text>################################## +<%text>##</%text> SSH CONFIG ## +<%text>##</%text>################################## -<%text>## SSH is disabled by default, until an Administrator decides to enable it.</%text> +<%text>##</%text> SSH is disabled by default, until an Administrator decides to enable it. ssh_enabled = false -<%text>## File where users' SSH keys will be stored *if* ssh_enabled is true.</%text> +<%text>##</%text> File where users' SSH keys will be stored *if* ssh_enabled is true. #ssh_authorized_keys = /home/kallithea/.ssh/authorized_keys %if user_home_path: ssh_authorized_keys = ${user_home_path}/.ssh/authorized_keys %endif -<%text>## Path to be used in ssh_authorized_keys file to invoke kallithea-cli with ssh-serve.</%text> +<%text>##</%text> Path to be used in ssh_authorized_keys file to invoke kallithea-cli with ssh-serve. #kallithea_cli_path = /srv/kallithea/venv/bin/kallithea-cli %if kallithea_cli_path: kallithea_cli_path = ${kallithea_cli_path} %endif -<%text>## Locale to be used in the ssh-serve command.</%text> -<%text>## This is needed because an SSH client may try to use its own locale</%text> -<%text>## settings, which may not be available on the server.</%text> -<%text>## See `locale -a` for valid values on this system.</%text> +<%text>##</%text> Locale to be used in the ssh-serve command. +<%text>##</%text> This is needed because an SSH client may try to use its own locale +<%text>##</%text> settings, which may not be available on the server. +<%text>##</%text> See `locale -a` for valid values on this system. #ssh_locale = C.UTF-8 %if ssh_locale: ssh_locale = ${ssh_locale} %endif -<%text>####################################</%text> -<%text>### CELERY CONFIG ####</%text> -<%text>####################################</%text> +<%text>##</%text>################################## +<%text>##</%text> CELERY CONFIG ## +<%text>##</%text>################################## -<%text>## Note: Celery doesn't support Windows.</%text> +<%text>##</%text> Note: Celery doesn't support Windows. use_celery = false -<%text>## Celery config settings from https://docs.celeryproject.org/en/4.4.0/userguide/configuration.html prefixed with 'celery.'.</%text> +<%text>##</%text> Celery config settings from https://docs.celeryproject.org/en/4.4.0/userguide/configuration.html prefixed with 'celery.'. -<%text>## Example: use the message queue on the local virtual host 'kallitheavhost' as the RabbitMQ user 'kallithea':</%text> +<%text>##</%text> Example: use the message queue on the local virtual host 'kallitheavhost' as the RabbitMQ user 'kallithea': celery.broker_url = amqp://kallithea:thepassword@localhost:5672/kallitheavhost celery.result.backend = db+sqlite:///celery-results.db @@ -340,12 +340,12 @@ celery.worker_concurrency = 2 celery.worker_max_tasks_per_child = 1 -<%text>## If true, tasks will never be sent to the queue, but executed locally instead.</%text> +<%text>##</%text> If true, tasks will never be sent to the queue, but executed locally instead. celery.task_always_eager = false -<%text>####################################</%text> -<%text>### BEAKER CACHE ####</%text> -<%text>####################################</%text> +<%text>##</%text>################################## +<%text>##</%text> BEAKER CACHE ## +<%text>##</%text>################################## beaker.cache.data_dir = %(here)s/data/cache/data beaker.cache.lock_dir = %(here)s/data/cache/lock @@ -360,56 +360,56 @@ beaker.cache.long_term_file.expire = 604800 beaker.cache.long_term_file.key_length = 256 -<%text>####################################</%text> -<%text>### BEAKER SESSION ####</%text> -<%text>####################################</%text> +<%text>##</%text>################################## +<%text>##</%text> BEAKER SESSION ## +<%text>##</%text>################################## -<%text>## Name of session cookie. Should be unique for a given host and path, even when running</%text> -<%text>## on different ports. Otherwise, cookie sessions will be shared and messed up.</%text> +<%text>##</%text> Name of session cookie. Should be unique for a given host and path, even when running +<%text>##</%text> on different ports. Otherwise, cookie sessions will be shared and messed up. session.key = kallithea -<%text>## Sessions should always only be accessible by the browser, not directly by JavaScript.</%text> +<%text>##</%text> Sessions should always only be accessible by the browser, not directly by JavaScript. session.httponly = true -<%text>## Session lifetime. 2592000 seconds is 30 days.</%text> +<%text>##</%text> Session lifetime. 2592000 seconds is 30 days. session.timeout = 2592000 -<%text>## Server secret used with HMAC to ensure integrity of cookies.</%text> +<%text>##</%text> Server secret used with HMAC to ensure integrity of cookies. session.secret = ${uuid()} -<%text>## Further, encrypt the data with AES.</%text> +<%text>##</%text> Further, encrypt the data with AES. #session.encrypt_key = <key_for_encryption> #session.validate_key = <validation_key> -<%text>## Type of storage used for the session, current types are</%text> -<%text>## dbm, file, memcached, database, and memory.</%text> +<%text>##</%text> Type of storage used for the session, current types are +<%text>##</%text> dbm, file, memcached, database, and memory. -<%text>## File system storage of session data. (default)</%text> +<%text>##</%text> File system storage of session data. (default) #session.type = file -<%text>## Cookie only, store all session data inside the cookie. Requires secure secrets.</%text> +<%text>##</%text> Cookie only, store all session data inside the cookie. Requires secure secrets. #session.type = cookie -<%text>## Database storage of session data.</%text> +<%text>##</%text> Database storage of session data. #session.type = ext:database #session.sa.url = postgresql://postgres:qwe@localhost/kallithea #session.table_name = db_session -<%text>####################################</%text> -<%text>### ERROR HANDLING ####</%text> -<%text>####################################</%text> +<%text>##</%text>################################## +<%text>##</%text> ERROR HANDLING ## +<%text>##</%text>################################## -<%text>## Show a nice error page for application HTTP errors and exceptions (default true)</%text> +<%text>##</%text> Show a nice error page for application HTTP errors and exceptions (default true) #errorpage.enabled = true -<%text>## Enable Backlash client-side interactive debugger (default false)</%text> -<%text>## WARNING: *THIS MUST BE false IN PRODUCTION ENVIRONMENTS!!!*</%text> -<%text>## This debug mode will allow all visitors to execute malicious code.</%text> +<%text>##</%text> Enable Backlash client-side interactive debugger (default false) +<%text>##</%text> WARNING: *THIS MUST BE false IN PRODUCTION ENVIRONMENTS!!!* +<%text>##</%text> This debug mode will allow all visitors to execute malicious code. #debug = false -<%text>## Enable Backlash server-side error reporting (unless debug mode handles it client-side) (default true)</%text> +<%text>##</%text> Enable Backlash server-side error reporting (unless debug mode handles it client-side) (default true) #trace_errors.enable = true -<%text>## Errors will be reported by mail if trace_errors.error_email is set.</%text> +<%text>##</%text> Errors will be reported by mail if trace_errors.error_email is set. -<%text>## Propagate email settings to ErrorReporter of TurboGears2</%text> -<%text>## You do not normally need to change these lines</%text> +<%text>##</%text> Propagate email settings to ErrorReporter of TurboGears2 +<%text>##</%text> You do not normally need to change these lines get trace_errors.smtp_server = smtp_server get trace_errors.smtp_port = smtp_port get trace_errors.from_address = error_email_from @@ -419,12 +419,12 @@ get trace_errors.smtp_use_tls = smtp_use_tls %if error_aggregation_service == 'sentry': -<%text>################</%text> -<%text>### [sentry] ###</%text> -<%text>################</%text> +<%text>##</%text>############## +<%text>##</%text> [sentry] ## +<%text>##</%text>############## -<%text>## sentry is a alternative open source error aggregator</%text> -<%text>## you must install python packages `sentry` and `raven` to enable</%text> +<%text>##</%text> sentry is a alternative open source error aggregator +<%text>##</%text> you must install python packages `sentry` and `raven` to enable sentry.dsn = YOUR_DNS sentry.servers = @@ -439,45 +439,45 @@ %endif -<%text>##################################</%text> -<%text>### LOGVIEW CONFIG ###</%text> -<%text>##################################</%text> +<%text>##</%text>################################ +<%text>##</%text> LOGVIEW CONFIG ## +<%text>##</%text>################################ logview.sqlalchemy = #faa logview.pylons.templating = #bfb logview.pylons.util = #eee -<%text>#########################################################</%text> -<%text>### DB CONFIGS - EACH DB WILL HAVE IT'S OWN CONFIG ###</%text> -<%text>#########################################################</%text> +<%text>##</%text>####################### +<%text>##</%text> DB CONFIG ## +<%text>##</%text>####################### %if database_engine == 'sqlite': -<%text>## SQLITE [default]</%text> +<%text>##</%text> SQLITE [default] sqlalchemy.url = sqlite:///%(here)s/kallithea.db?timeout=60 %elif database_engine == 'postgres': -<%text>## POSTGRESQL</%text> +<%text>##</%text> POSTGRESQL sqlalchemy.url = postgresql://user:pass@localhost/kallithea %elif database_engine == 'mysql': -<%text>## MySQL</%text> +<%text>##</%text> MySQL sqlalchemy.url = mysql://user:pass@localhost/kallithea?charset=utf8 %endif -<%text>## see sqlalchemy docs for other backends</%text> +<%text>##</%text> see sqlalchemy docs for other backends sqlalchemy.pool_recycle = 3600 -<%text>################################</%text> -<%text>### ALEMBIC CONFIGURATION ####</%text> -<%text>################################</%text> +<%text>##</%text>############################## +<%text>##</%text> ALEMBIC CONFIGURATION ## +<%text>##</%text>############################## [alembic] script_location = kallithea:alembic -<%text>################################</%text> -<%text>### LOGGING CONFIGURATION ####</%text> -<%text>################################</%text> +<%text>##</%text>############################## +<%text>##</%text> LOGGING CONFIGURATION ## +<%text>##</%text>############################## [loggers] keys = root, routes, kallithea, sqlalchemy, tg, gearbox, beaker, templates, whoosh_indexer, werkzeug, backlash @@ -488,21 +488,21 @@ [formatters] keys = generic, color_formatter, color_formatter_sql -<%text>#############</%text> -<%text>## LOGGERS ##</%text> -<%text>#############</%text> +<%text>##</%text>########### +<%text>##</%text> LOGGERS ## +<%text>##</%text>########### [logger_root] level = NOTSET handlers = console -<%text>## For coloring based on log level:</%text> +<%text>##</%text> For coloring based on log level: #handlers = console_color [logger_routes] level = WARN handlers = qualname = routes.middleware -<%text>## "level = DEBUG" logs the route matched and routing variables.</%text> +<%text>##</%text> "level = DEBUG" logs the route matched and routing variables. [logger_beaker] level = WARN @@ -533,7 +533,7 @@ level = WARN handlers = qualname = sqlalchemy.engine -<%text>## For coloring based on log level and pretty printing of SQL:</%text> +<%text>##</%text> For coloring based on log level and pretty printing of SQL: #level = INFO #handlers = console_color_sql #propagate = 0 @@ -553,9 +553,9 @@ handlers = qualname = backlash -<%text>##############</%text> -<%text>## HANDLERS ##</%text> -<%text>##############</%text> +<%text>##</%text>############ +<%text>##</%text> HANDLERS ## +<%text>##</%text>############ [handler_console] class = StreamHandler @@ -563,13 +563,13 @@ formatter = generic [handler_console_color] -<%text>## ANSI color coding based on log level</%text> +<%text>##</%text> ANSI color coding based on log level class = StreamHandler args = (sys.stderr,) formatter = color_formatter [handler_console_color_sql] -<%text>## ANSI color coding and pretty printing of SQL statements</%text> +<%text>##</%text> ANSI color coding and pretty printing of SQL statements class = StreamHandler args = (sys.stderr,) formatter = color_formatter_sql @@ -578,9 +578,9 @@ class = NullHandler args = () -<%text>################</%text> -<%text>## FORMATTERS ##</%text> -<%text>################</%text> +<%text>##</%text>############## +<%text>##</%text> FORMATTERS ## +<%text>##</%text>############## [formatter_generic] format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s @@ -596,20 +596,20 @@ format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s datefmt = %Y-%m-%d %H:%M:%S -<%text>#################</%text> -<%text>## SSH LOGGING ##</%text> -<%text>#################</%text> +<%text>##</%text>############### +<%text>##</%text> SSH LOGGING ## +<%text>##</%text>############### -<%text>## The default loggers use 'handler_console' that uses StreamHandler with</%text> -<%text>## destination 'sys.stderr'. In the context of the SSH server process, these log</%text> -<%text>## messages would be sent to the client, which is normally not what you want.</%text> -<%text>## By default, when running ssh-serve, just use NullHandler and disable logging</%text> -<%text>## completely. For other logging options, see:</%text> -<%text>## https://docs.python.org/2/library/logging.handlers.html</%text> +<%text>##</%text> The default loggers use 'handler_console' that uses StreamHandler with +<%text>##</%text> destination 'sys.stderr'. In the context of the SSH server process, these log +<%text>##</%text> messages would be sent to the client, which is normally not what you want. +<%text>##</%text> By default, when running ssh-serve, just use NullHandler and disable logging +<%text>##</%text> completely. For other logging options, see: +<%text>##</%text> https://docs.python.org/2/library/logging.handlers.html [ssh_serve:logger_root] level = CRITICAL handlers = null -<%text>## Note: If logging is configured with other handlers, they might need similar</%text> -<%text>## muting for ssh-serve too.</%text> +<%text>##</%text> Note: If logging is configured with other handlers, they might need similar +<%text>##</%text> muting for ssh-serve too.
--- a/scripts/generate-ini.py Fri May 15 18:50:59 2020 +0200 +++ b/scripts/generate-ini.py Fri May 22 16:45:09 2020 +0200 @@ -55,7 +55,7 @@ print('reading:', makofile) mako_org = open(makofile).read() mako_no_text_markup = re.sub(r'</?%text>', '', mako_org) - mako_marked_up = re.sub(r'\n(##.*)', r'\n<%text>\1</%text>', mako_no_text_markup, flags=re.MULTILINE) + mako_marked_up = re.sub(r'\n##(.*)', r'\n<%text>##</%text>\1', mako_no_text_markup, flags=re.MULTILINE) if mako_marked_up != mako_org: print('writing:', makofile) open(makofile, 'w').write(mako_marked_up)