annotate development.ini @ 8887:070b8c39736f

auth: only use X- headers instead of wsgi.url_scheme if explicitly told so in url_scheme_header - drop https_fixup setting Before, several X- headers would be trusted to overrule the actual connection protocol (http or https) seen by the Kallithea WSGI server. That was mainly when https_fixup were set, but it incorrectly also kicked in if https_fixup or use_htsts were configured. The ambiguity of which headers were used also made it less reliable. The proxy server not only had to be configured to set one of the headers correctly, it also had to make sure other headers were not passed on from the client. It would thus in some cases be possible for clients to fake the connection scheme, and thus potentially be possible to bypass restrictions configured in Kallithea. Fixed by making it configurable which WSGI environment variable to use for the protocol. Users can configure url_scheme_header to for example HTTP_X_FORWARDED_PROTO instead of using the default wsgi.url_scheme . This change is a bit similar to what is going on in the https_fixup middleware, but is doing a bit more of what for example is happening in similar code in werkzeug/middleware/proxy_fix.py . The semantics of the old https_fixup were unsafe, so it has been dropped. Admins that are upgrading must change their configuration to use the new url_scheme_header option.
author Mads Kiilerich <mads@kiilerich.com>
date Sun, 09 May 2021 22:40:56 +0200
parents 3d7ba590f6f5
children d483e2df546f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8354
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
1 ###################################################################################
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
2 ###################################################################################
8435
e3a3fae57343 cleanup: drop last traces of kallithea-config
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 8431
diff changeset
3 ## Kallithea config file generated with kallithea-cli ##
8354
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
4 ## ##
8431
0f3a584edcb3 ini: explain how % must be escaped as %% (Issue #375)
Mads Kiilerich <mads@kiilerich.com>
parents: 8428
diff changeset
5 ## The %(here)s variable will generally be replaced with the parent directory of ##
0f3a584edcb3 ini: explain how % must be escaped as %% (Issue #375)
Mads Kiilerich <mads@kiilerich.com>
parents: 8428
diff changeset
6 ## this file. Other use of % must be escaped as %% . ##
8354
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
7 ###################################################################################
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
8 ###################################################################################
10
525ed90e4577 major app speedup moved the wsgi creation to app globals, in order to make it run only once.
Marcin Kuzminski
parents: 5
diff changeset
9
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
10 [DEFAULT]
4225
3e6291d99a6f Align and update the outdated ini files and templates
Mads Kiilerich <madski@unity3d.com>
parents: 4212
diff changeset
11
474
a3d9d24acbec Implemented password reset(forms/models/ tasks) and mailing tasks.
Marcin Kuzminski <marcin@python-works.com>
parents: 471
diff changeset
12 ################################################################################
5412
2079e864ce51 spelling: use "email" consistently
Søren Løvborg <sorenl@unity3d.com>
parents: 5400
diff changeset
13 ## Email settings ##
5366
ce72c36f7a0e e-mail: add documentation about configuration settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5365
diff changeset
14 ## ##
5412
2079e864ce51 spelling: use "email" consistently
Søren Løvborg <sorenl@unity3d.com>
parents: 5400
diff changeset
15 ## Refer to the documentation ("Email settings") for more details. ##
5366
ce72c36f7a0e e-mail: add documentation about configuration settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5365
diff changeset
16 ## ##
ce72c36f7a0e e-mail: add documentation about configuration settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5365
diff changeset
17 ## It is recommended to use a valid sender address that passes access ##
ce72c36f7a0e e-mail: add documentation about configuration settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5365
diff changeset
18 ## validation and spam filtering in mail servers. ##
474
a3d9d24acbec Implemented password reset(forms/models/ tasks) and mailing tasks.
Marcin Kuzminski <marcin@python-works.com>
parents: 471
diff changeset
19 ################################################################################
5366
ce72c36f7a0e e-mail: add documentation about configuration settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5365
diff changeset
20
5412
2079e864ce51 spelling: use "email" consistently
Søren Løvborg <sorenl@unity3d.com>
parents: 5400
diff changeset
21 ## 'From' header for application emails. You can optionally add a name.
5366
ce72c36f7a0e e-mail: add documentation about configuration settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5365
diff changeset
22 ## Default:
5365
ef64905223f5 e-mail: add some default values and some examples to .ini file as comments
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5364
diff changeset
23 #app_email_from = Kallithea
5366
ce72c36f7a0e e-mail: add documentation about configuration settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5365
diff changeset
24 ## Examples:
5365
ef64905223f5 e-mail: add some default values and some examples to .ini file as comments
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5364
diff changeset
25 #app_email_from = Kallithea <kallithea-noreply@example.com>
ef64905223f5 e-mail: add some default values and some examples to .ini file as comments
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5364
diff changeset
26 #app_email_from = kallithea-noreply@example.com
5366
ce72c36f7a0e e-mail: add documentation about configuration settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5365
diff changeset
27
5412
2079e864ce51 spelling: use "email" consistently
Søren Løvborg <sorenl@unity3d.com>
parents: 5400
diff changeset
28 ## Subject prefix for application emails.
5366
ce72c36f7a0e e-mail: add documentation about configuration settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5365
diff changeset
29 ## A space between this prefix and the real subject is automatically added.
ce72c36f7a0e e-mail: add documentation about configuration settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5365
diff changeset
30 ## Default:
5365
ef64905223f5 e-mail: add some default values and some examples to .ini file as comments
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5364
diff changeset
31 #email_prefix =
5366
ce72c36f7a0e e-mail: add documentation about configuration settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5365
diff changeset
32 ## Example:
5365
ef64905223f5 e-mail: add some default values and some examples to .ini file as comments
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5364
diff changeset
33 #email_prefix = [Kallithea]
ef64905223f5 e-mail: add some default values and some examples to .ini file as comments
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5364
diff changeset
34
5412
2079e864ce51 spelling: use "email" consistently
Søren Løvborg <sorenl@unity3d.com>
parents: 5400
diff changeset
35 ## Recipients for error emails and fallback recipients of application mails.
7129
e12c4a3ce996 ini: error email settings are comma-separated under backlash
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 6933
diff changeset
36 ## Multiple addresses can be specified, comma-separated.
5366
ce72c36f7a0e e-mail: add documentation about configuration settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5365
diff changeset
37 ## Only addresses are allowed, do not add any name part.
ce72c36f7a0e e-mail: add documentation about configuration settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5365
diff changeset
38 ## Default:
ce72c36f7a0e e-mail: add documentation about configuration settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5365
diff changeset
39 #email_to =
ce72c36f7a0e e-mail: add documentation about configuration settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5365
diff changeset
40 ## Examples:
5365
ef64905223f5 e-mail: add some default values and some examples to .ini file as comments
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5364
diff changeset
41 #email_to = admin@example.com
7129
e12c4a3ce996 ini: error email settings are comma-separated under backlash
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 6933
diff changeset
42 #email_to = admin@example.com,another_admin@example.com
6576
b4c27fe6438c TurboGears2 migration: update ini files for error email settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 6573
diff changeset
43 email_to =
5366
ce72c36f7a0e e-mail: add documentation about configuration settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5365
diff changeset
44
5412
2079e864ce51 spelling: use "email" consistently
Søren Løvborg <sorenl@unity3d.com>
parents: 5400
diff changeset
45 ## 'From' header for error emails. You can optionally add a name.
6576
b4c27fe6438c TurboGears2 migration: update ini files for error email settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 6573
diff changeset
46 ## Default: (none)
5366
ce72c36f7a0e e-mail: add documentation about configuration settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5365
diff changeset
47 ## Examples:
5365
ef64905223f5 e-mail: add some default values and some examples to .ini file as comments
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5364
diff changeset
48 #error_email_from = Kallithea Errors <kallithea-noreply@example.com>
6576
b4c27fe6438c TurboGears2 migration: update ini files for error email settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 6573
diff changeset
49 #error_email_from = kallithea_errors@example.com
b4c27fe6438c TurboGears2 migration: update ini files for error email settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 6573
diff changeset
50 error_email_from =
474
a3d9d24acbec Implemented password reset(forms/models/ tasks) and mailing tasks.
Marcin Kuzminski <marcin@python-works.com>
parents: 471
diff changeset
51
5366
ce72c36f7a0e e-mail: add documentation about configuration settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5365
diff changeset
52 ## SMTP server settings
5881
a5ad2900985b docs: tweak email documentation - add gmail example
Mads Kiilerich <madski@unity3d.com>
parents: 5864
diff changeset
53 ## If specifying credentials, make sure to use secure connections.
a5ad2900985b docs: tweak email documentation - add gmail example
Mads Kiilerich <madski@unity3d.com>
parents: 5864
diff changeset
54 ## Default: Send unencrypted unauthenticated mails to the specified smtp_server.
a5ad2900985b docs: tweak email documentation - add gmail example
Mads Kiilerich <madski@unity3d.com>
parents: 5864
diff changeset
55 ## For "SSL", use smtp_use_ssl = true and smtp_port = 465.
a5ad2900985b docs: tweak email documentation - add gmail example
Mads Kiilerich <madski@unity3d.com>
parents: 5864
diff changeset
56 ## For "STARTTLS", use smtp_use_tls = true and smtp_port = 587.
6576
b4c27fe6438c TurboGears2 migration: update ini files for error email settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 6573
diff changeset
57 smtp_server =
8233
34846d33498d mails: make error reporting by mail work with secure mail servers
Mads Kiilerich <mads@kiilerich.com>
parents: 8095
diff changeset
58 smtp_username =
34846d33498d mails: make error reporting by mail work with secure mail servers
Mads Kiilerich <mads@kiilerich.com>
parents: 8095
diff changeset
59 smtp_password =
6576
b4c27fe6438c TurboGears2 migration: update ini files for error email settings
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 6573
diff changeset
60 smtp_port =
8233
34846d33498d mails: make error reporting by mail work with secure mail servers
Mads Kiilerich <mads@kiilerich.com>
parents: 8095
diff changeset
61 smtp_use_ssl = false
34846d33498d mails: make error reporting by mail work with secure mail servers
Mads Kiilerich <mads@kiilerich.com>
parents: 8095
diff changeset
62 smtp_use_tls = false
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
63
6933
2c0e7e1d2584 config: tweak template http_server conditionals - don't leave an empty section when using UWSGI
Mads Kiilerich <mads@kiilerich.com>
parents: 6893
diff changeset
64 ## Entry point for 'gearbox serve'
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
65 [server:main]
6933
2c0e7e1d2584 config: tweak template http_server conditionals - don't leave an empty section when using UWSGI
Mads Kiilerich <mads@kiilerich.com>
parents: 6893
diff changeset
66 #host = 127.0.0.1
2c0e7e1d2584 config: tweak template http_server conditionals - don't leave an empty section when using UWSGI
Mads Kiilerich <mads@kiilerich.com>
parents: 6893
diff changeset
67 host = 0.0.0.0
2c0e7e1d2584 config: tweak template http_server conditionals - don't leave an empty section when using UWSGI
Mads Kiilerich <mads@kiilerich.com>
parents: 6893
diff changeset
68 port = 5000
2c0e7e1d2584 config: tweak template http_server conditionals - don't leave an empty section when using UWSGI
Mads Kiilerich <mads@kiilerich.com>
parents: 6893
diff changeset
69
8563
8cd0c12758e6 ini: tweak .ini web server templates to make it more clear that it is about which web server gearbox will use for serve
Mads Kiilerich <mads@kiilerich.com>
parents: 8562
diff changeset
70 ## Gearbox serve uses the Waitress web server ##
3902
056827d78073 Added use_poll option for latest waitress release.
Marcin Kuzminski <marcin@python-works.com>
parents: 3850
diff changeset
71 use = egg:waitress#main
8563
8cd0c12758e6 ini: tweak .ini web server templates to make it more clear that it is about which web server gearbox will use for serve
Mads Kiilerich <mads@kiilerich.com>
parents: 8562
diff changeset
72 ## avoid multi threading
6153
d6942b2b421c config: clarify that we only recommend and support single threaded operation
Mads Kiilerich <madski@unity3d.com>
parents: 6019
diff changeset
73 threads = 1
8563
8cd0c12758e6 ini: tweak .ini web server templates to make it more clear that it is about which web server gearbox will use for serve
Mads Kiilerich <mads@kiilerich.com>
parents: 8562
diff changeset
74 ## allow push of repos bigger than the default of 1 GB
3376
e67b2ef07a8e git executable is now configurable via .ini files
Marcin Kuzminski <marcin@python-works.com>
parents: 3359
diff changeset
75 max_request_body_size = 107374182400
3902
056827d78073 Added use_poll option for latest waitress release.
Marcin Kuzminski <marcin@python-works.com>
parents: 3850
diff changeset
76 ## use poll instead of select, fixes fd limits, may not work on old
056827d78073 Added use_poll option for latest waitress release.
Marcin Kuzminski <marcin@python-works.com>
parents: 3850
diff changeset
77 ## windows systems.
3938
c27967598e0c removed yet unavailable option for waitress
Marcin Kuzminski <marcin@python-works.com>
parents: 3935
diff changeset
78 #asyncore_use_poll = True
3087
a797ada9d2ad added option to ini file to define lightweight dashboard items per page before pagination
Marcin Kuzminski <marcin@python-works.com>
parents: 3028
diff changeset
79
5079
fc71103e16b7 config: don't use rc in description of prefix middleware
Mads Kiilerich <madski@unity3d.com>
parents: 4985
diff changeset
80 ## middleware for hosting the WSGI application under a URL prefix
3557
58dcef7eef03 Implemented show_id function that is a configurable way to display sha hashes in the changelog.
Marcin Kuzminski <marcin@python-works.com>
parents: 3522
diff changeset
81 #[filter:proxy-prefix]
58dcef7eef03 Implemented show_id function that is a configurable way to display sha hashes in the changelog.
Marcin Kuzminski <marcin@python-works.com>
parents: 3522
diff changeset
82 #use = egg:PasteDeploy#prefix
58dcef7eef03 Implemented show_id function that is a configurable way to display sha hashes in the changelog.
Marcin Kuzminski <marcin@python-works.com>
parents: 3522
diff changeset
83 #prefix = /<your-prefix>
2615
6f44b6d5aa60 added comments into beaker session,
Marcin Kuzminski <marcin@python-works.com>
parents: 2597
diff changeset
84
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
85 [app:main]
4186
7e5f8c12a3fc First step in two-part process to rename directories to kallithea.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4182
diff changeset
86 use = egg:kallithea
3557
58dcef7eef03 Implemented show_id function that is a configurable way to display sha hashes in the changelog.
Marcin Kuzminski <marcin@python-works.com>
parents: 3522
diff changeset
87 ## enable proxy prefix middleware
2615
6f44b6d5aa60 added comments into beaker session,
Marcin Kuzminski <marcin@python-works.com>
parents: 2597
diff changeset
88 #filter-with = proxy-prefix
3557
58dcef7eef03 Implemented show_id function that is a configurable way to display sha hashes in the changelog.
Marcin Kuzminski <marcin@python-works.com>
parents: 3522
diff changeset
89
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
90 full_stack = true
253
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 241
diff changeset
91 static_files = true
6694
f2f7a8c1281e i18n: use TG2 compatible settings names i18n.lang and i18n.enabled
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 6625
diff changeset
92
f2f7a8c1281e i18n: use TG2 compatible settings names i18n.lang and i18n.enabled
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 6625
diff changeset
93 ## Internationalization (see setup documentation for details)
8095
7c7d6b5c07c7 i18n: make sure 'en' in Accept-Language is recognized as having 100% coverage - i18n.lang is for source language
Mads Kiilerich <mads@kiilerich.com>
parents: 7788
diff changeset
94 ## By default, the languages requested by the browser are used if available, with English as default.
7c7d6b5c07c7 i18n: make sure 'en' in Accept-Language is recognized as having 100% coverage - i18n.lang is for source language
Mads Kiilerich <mads@kiilerich.com>
parents: 7788
diff changeset
95 ## Set i18n.enabled=false to disable automatic language choice.
7c7d6b5c07c7 i18n: make sure 'en' in Accept-Language is recognized as having 100% coverage - i18n.lang is for source language
Mads Kiilerich <mads@kiilerich.com>
parents: 7788
diff changeset
96 #i18n.enabled = true
7c7d6b5c07c7 i18n: make sure 'en' in Accept-Language is recognized as having 100% coverage - i18n.lang is for source language
Mads Kiilerich <mads@kiilerich.com>
parents: 7788
diff changeset
97 ## To Force a language, set i18n.enabled=false and specify the language in i18n.lang.
7c7d6b5c07c7 i18n: make sure 'en' in Accept-Language is recognized as having 100% coverage - i18n.lang is for source language
Mads Kiilerich <mads@kiilerich.com>
parents: 7788
diff changeset
98 ## Valid values are the names of subdirectories in kallithea/i18n with a LC_MESSAGES/kallithea.mo
7c7d6b5c07c7 i18n: make sure 'en' in Accept-Language is recognized as having 100% coverage - i18n.lang is for source language
Mads Kiilerich <mads@kiilerich.com>
parents: 7788
diff changeset
99 #i18n.lang = en
6694
f2f7a8c1281e i18n: use TG2 compatible settings names i18n.lang and i18n.enabled
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 6625
diff changeset
100
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
101 cache_dir = %(here)s/data
683
341beaa9edba Implemented whoosh index building as paster command.
Marcin Kuzminski <marcin@python-works.com>
parents: 667
diff changeset
102 index_dir = %(here)s/data/index
3557
58dcef7eef03 Implemented show_id function that is a configurable way to display sha hashes in the changelog.
Marcin Kuzminski <marcin@python-works.com>
parents: 3522
diff changeset
103
58dcef7eef03 Implemented show_id function that is a configurable way to display sha hashes in the changelog.
Marcin Kuzminski <marcin@python-works.com>
parents: 3522
diff changeset
104 ## uncomment and set this path to use archive download cache
8614
43d9615facc6 ini: move archive_cache_dir to the data directory
Mads Kiilerich <mads@kiilerich.com>
parents: 8594
diff changeset
105 archive_cache_dir = %(here)s/data/tarballcache
3557
58dcef7eef03 Implemented show_id function that is a configurable way to display sha hashes in the changelog.
Marcin Kuzminski <marcin@python-works.com>
parents: 3522
diff changeset
106
58dcef7eef03 Implemented show_id function that is a configurable way to display sha hashes in the changelog.
Marcin Kuzminski <marcin@python-works.com>
parents: 3522
diff changeset
107 ## change this to unique ID for security
6891
7292c5976752 ini: simplify preservation of old settings - just keep the old line as comment
Mads Kiilerich <mads@kiilerich.com>
parents: 6887
diff changeset
108 #app_instance_uuid = VERY-SECRET
4225
3e6291d99a6f Align and update the outdated ini files and templates
Mads Kiilerich <madski@unity3d.com>
parents: 4212
diff changeset
109 app_instance_uuid = development-not-secret
3557
58dcef7eef03 Implemented show_id function that is a configurable way to display sha hashes in the changelog.
Marcin Kuzminski <marcin@python-works.com>
parents: 3522
diff changeset
110
58dcef7eef03 Implemented show_id function that is a configurable way to display sha hashes in the changelog.
Marcin Kuzminski <marcin@python-works.com>
parents: 3522
diff changeset
111 ## cut off limit for large diffs (size in bytes)
812
30ad41c76fae fixes #79 cut off limit was added into .ini config files
Marcin Kuzminski <marcin@python-works.com>
parents: 776
diff changeset
112 cut_off_limit = 256000
3557
58dcef7eef03 Implemented show_id function that is a configurable way to display sha hashes in the changelog.
Marcin Kuzminski <marcin@python-works.com>
parents: 3522
diff changeset
113
8886
3d7ba590f6f5 auth: only use X- headers instead of REMOTE_ADDR if explicitly told so in remote_addr_header
Mads Kiilerich <mads@kiilerich.com>
parents: 8883
diff changeset
114 ## WSGI environment variable to get the IP address of the client (default REMOTE_ADDR)
3d7ba590f6f5 auth: only use X- headers instead of REMOTE_ADDR if explicitly told so in remote_addr_header
Mads Kiilerich <mads@kiilerich.com>
parents: 8883
diff changeset
115 #remote_addr_variable = HTTP_X_FORWARDED_FOR
3d7ba590f6f5 auth: only use X- headers instead of REMOTE_ADDR if explicitly told so in remote_addr_header
Mads Kiilerich <mads@kiilerich.com>
parents: 8883
diff changeset
116
8887
070b8c39736f auth: only use X- headers instead of wsgi.url_scheme if explicitly told so in url_scheme_header - drop https_fixup setting
Mads Kiilerich <mads@kiilerich.com>
parents: 8886
diff changeset
117 ## WSGI environment variable to get the protocol (http or https) of the client connection (default wsgi.url_scheme)
070b8c39736f auth: only use X- headers instead of wsgi.url_scheme if explicitly told so in url_scheme_header - drop https_fixup setting
Mads Kiilerich <mads@kiilerich.com>
parents: 8886
diff changeset
118 #url_scheme_variable = HTTP_X_FORWARDED_PROTO
070b8c39736f auth: only use X- headers instead of wsgi.url_scheme if explicitly told so in url_scheme_header - drop https_fixup setting
Mads Kiilerich <mads@kiilerich.com>
parents: 8886
diff changeset
119
8883
fb40978c1afb docs: clarify that force_https trumps anything else
Mads Kiilerich <mads@kiilerich.com>
parents: 8822
diff changeset
120 ## always pretend the client connected using HTTPS (default false)
fb40978c1afb docs: clarify that force_https trumps anything else
Mads Kiilerich <mads@kiilerich.com>
parents: 8822
diff changeset
121 #force_https = true
3557
58dcef7eef03 Implemented show_id function that is a configurable way to display sha hashes in the changelog.
Marcin Kuzminski <marcin@python-works.com>
parents: 3522
diff changeset
122
8883
fb40978c1afb docs: clarify that force_https trumps anything else
Mads Kiilerich <mads@kiilerich.com>
parents: 8822
diff changeset
123 ## use Strict-Transport-Security headers (default false)
fb40978c1afb docs: clarify that force_https trumps anything else
Mads Kiilerich <mads@kiilerich.com>
parents: 8822
diff changeset
124 #use_htsts = true
3557
58dcef7eef03 Implemented show_id function that is a configurable way to display sha hashes in the changelog.
Marcin Kuzminski <marcin@python-works.com>
parents: 3522
diff changeset
125
58dcef7eef03 Implemented show_id function that is a configurable way to display sha hashes in the changelog.
Marcin Kuzminski <marcin@python-works.com>
parents: 3522
diff changeset
126 ## number of commits stats will parse on each iteration
1076
db71228a4c23 moved statistics parse_limit into .ini files
Marcin Kuzminski <marcin@python-works.com>
parents: 964
diff changeset
127 commit_parse_limit = 25
3557
58dcef7eef03 Implemented show_id function that is a configurable way to display sha hashes in the changelog.
Marcin Kuzminski <marcin@python-works.com>
parents: 3522
diff changeset
128
7633
1bafb2d07709 hooks: make the Python interpreter for Git hooks configurable as 'git_hook_interpreter' (Issue #333)
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7629
diff changeset
129 ## Path to Python executable to be used for git hooks.
1bafb2d07709 hooks: make the Python interpreter for Git hooks configurable as 'git_hook_interpreter' (Issue #333)
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7629
diff changeset
130 ## This value will be written inside the git hook scripts as the text
1bafb2d07709 hooks: make the Python interpreter for Git hooks configurable as 'git_hook_interpreter' (Issue #333)
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7629
diff changeset
131 ## after '#!' (shebang). When empty or not defined, the value of
1bafb2d07709 hooks: make the Python interpreter for Git hooks configurable as 'git_hook_interpreter' (Issue #333)
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7629
diff changeset
132 ## 'sys.executable' at the time of installation of the git hooks is
1bafb2d07709 hooks: make the Python interpreter for Git hooks configurable as 'git_hook_interpreter' (Issue #333)
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7629
diff changeset
133 ## used, which is correct in many cases but for example not when using uwsgi.
1bafb2d07709 hooks: make the Python interpreter for Git hooks configurable as 'git_hook_interpreter' (Issue #333)
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7629
diff changeset
134 ## If you change this setting, you should reinstall the Git hooks via
1bafb2d07709 hooks: make the Python interpreter for Git hooks configurable as 'git_hook_interpreter' (Issue #333)
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7629
diff changeset
135 ## Admin > Settings > Remap and Rescan.
8354
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
136 #git_hook_interpreter = /srv/kallithea/venv/bin/python3
7633
1bafb2d07709 hooks: make the Python interpreter for Git hooks configurable as 'git_hook_interpreter' (Issue #333)
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7629
diff changeset
137
3557
58dcef7eef03 Implemented show_id function that is a configurable way to display sha hashes in the changelog.
Marcin Kuzminski <marcin@python-works.com>
parents: 3522
diff changeset
138 ## path to git executable
3376
e67b2ef07a8e git executable is now configurable via .ini files
Marcin Kuzminski <marcin@python-works.com>
parents: 3359
diff changeset
139 git_path = git
e67b2ef07a8e git executable is now configurable via .ini files
Marcin Kuzminski <marcin@python-works.com>
parents: 3359
diff changeset
140
3561
c04d1d9b6193 made git refs filter configurable ref issue #797
Marcin Kuzminski <marcin@python-works.com>
parents: 3557
diff changeset
141 ## git rev filter option, --all is the default filter, if you need to
c04d1d9b6193 made git refs filter configurable ref issue #797
Marcin Kuzminski <marcin@python-works.com>
parents: 3557
diff changeset
142 ## hide all refs in changelog switch this to --branches --tags
4225
3e6291d99a6f Align and update the outdated ini files and templates
Mads Kiilerich <madski@unity3d.com>
parents: 4212
diff changeset
143 #git_rev_filter = --branches --tags
3561
c04d1d9b6193 made git refs filter configurable ref issue #797
Marcin Kuzminski <marcin@python-works.com>
parents: 3557
diff changeset
144
3028
30a226406fa4 Implemented #661 Add option to include diff in RSS feed
Marcin Kuzminski <marcin@python-works.com>
parents: 3025
diff changeset
145 ## RSS feed options
30a226406fa4 Implemented #661 Add option to include diff in RSS feed
Marcin Kuzminski <marcin@python-works.com>
parents: 3025
diff changeset
146 rss_cut_off_limit = 256000
30a226406fa4 Implemented #661 Add option to include diff in RSS feed
Marcin Kuzminski <marcin@python-works.com>
parents: 3025
diff changeset
147 rss_items_per_page = 10
30a226406fa4 Implemented #661 Add option to include diff in RSS feed
Marcin Kuzminski <marcin@python-works.com>
parents: 3025
diff changeset
148 rss_include_diff = false
30a226406fa4 Implemented #661 Add option to include diff in RSS feed
Marcin Kuzminski <marcin@python-works.com>
parents: 3025
diff changeset
149
3651
659bd922520e config: rename options to show_revision_number and show_sha_length
Mads Kiilerich <madski@unity3d.com>
parents: 3588
diff changeset
150 ## options for showing and identifying changesets
659bd922520e config: rename options to show_revision_number and show_sha_length
Mads Kiilerich <madski@unity3d.com>
parents: 3588
diff changeset
151 show_sha_length = 12
4549
dc3f0731b2f7 config: the default for show_revision_number should be false
domruf <dominikruf@gmail.com>
parents: 4527
diff changeset
152 show_revision_number = false
3557
58dcef7eef03 Implemented show_id function that is a configurable way to display sha hashes in the changelog.
Marcin Kuzminski <marcin@python-works.com>
parents: 3522
diff changeset
153
5882
110b504916b6 ini: document canonical_url - it was introduced long time ago but seems useful
Mads Kiilerich <madski@unity3d.com>
parents: 5881
diff changeset
154 ## Canonical URL to use when creating full URLs in UI and texts.
110b504916b6 ini: document canonical_url - it was introduced long time ago but seems useful
Mads Kiilerich <madski@unity3d.com>
parents: 5881
diff changeset
155 ## Useful when the site is available under different names or protocols.
110b504916b6 ini: document canonical_url - it was introduced long time ago but seems useful
Mads Kiilerich <madski@unity3d.com>
parents: 5881
diff changeset
156 ## Defaults to what is provided in the WSGI environment.
110b504916b6 ini: document canonical_url - it was introduced long time ago but seems useful
Mads Kiilerich <madski@unity3d.com>
parents: 5881
diff changeset
157 #canonical_url = https://kallithea.example.com/repos
110b504916b6 ini: document canonical_url - it was introduced long time ago but seems useful
Mads Kiilerich <madski@unity3d.com>
parents: 5881
diff changeset
158
3850
7a4df261a375 added alias configuration option for gists.
Marcin Kuzminski <marcin@python-works.com>
parents: 3778
diff changeset
159 ## gist URL alias, used to create nicer urls for gist. This should be an
4066
ef252630aad8 config: added example uwsgi configuration with auto-scaling
Marcin Kuzminski <marcin@python-works.com>
parents: 4045
diff changeset
160 ## url that does rewrites to _admin/gists/<gistid>.
5497
12b47803189f cleanup: use example.com for tests and examples
Søren Løvborg <sorenl@unity3d.com>
parents: 5412
diff changeset
161 ## example: http://gist.example.com/{gistid}. Empty means use the internal
12b47803189f cleanup: use example.com for tests and examples
Søren Løvborg <sorenl@unity3d.com>
parents: 5412
diff changeset
162 ## Kallithea url, ie. http[s]://kallithea.example.com/_admin/gists/<gistid>
3850
7a4df261a375 added alias configuration option for gists.
Marcin Kuzminski <marcin@python-works.com>
parents: 3778
diff changeset
163 gist_alias_url =
7a4df261a375 added alias configuration option for gists.
Marcin Kuzminski <marcin@python-works.com>
parents: 3778
diff changeset
164
3008
6e76b4892d72 Implemented #647, option to pass list of default encoding used to encode to/decode from unicode
Marcin Kuzminski <marcin@python-works.com>
parents: 2940
diff changeset
165 ## default encoding used to convert from and to unicode
5864
1906a1389cdd spelling: separated
timeless@gmail.com
parents: 5821
diff changeset
166 ## can be also a comma separated list of encoding in case of mixed encodings
7328
e2519d2e74c2 unicode: consistently use the preferred Python spelling 'utf-8' instead of the alias 'utf8'
Mads Kiilerich <mads@kiilerich.com>
parents: 7327
diff changeset
167 default_encoding = utf-8
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
168
7327
9937ae52f167 hg: set encoding to utf-8 by default to always show unicode characters correctly
Mads Kiilerich <mads@kiilerich.com>
parents: 7260
diff changeset
169 ## Set Mercurial encoding, similar to setting HGENCODING before launching Kallithea
9937ae52f167 hg: set encoding to utf-8 by default to always show unicode characters correctly
Mads Kiilerich <mads@kiilerich.com>
parents: 7260
diff changeset
170 hgencoding = utf-8
9937ae52f167 hg: set encoding to utf-8 by default to always show unicode characters correctly
Mads Kiilerich <mads@kiilerich.com>
parents: 7260
diff changeset
171
4212
24c0d584ba86 General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4210
diff changeset
172 ## issue tracker for Kallithea (leave blank to disable, absent for default)
4179
010e9532801a Change bitbucket and hosting URL
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4092
diff changeset
173 #bugtracker = https://bitbucket.org/conservancy/kallithea/issues
4006
cdf10b3df899 Allow RhodeCode maintainers to specify a custom bug tracker.
Jonathan Sternberg <jonathansternberg@gmail.com>
parents: 3965
diff changeset
174
7230
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
175 ## issue tracking mapping for commit messages, comments, PR descriptions, ...
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
176 ## Refer to the documentation ("Integration with issue trackers") for more details.
1837
a6a30c919513 #73 mapping of commited issues from commit message into issue tracker url.
Marcin Kuzminski <marcin@python-works.com>
parents: 1831
diff changeset
177
7230
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
178 ## regular expression to match issue references
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
179 ## This pattern may/should contain parenthesized groups, that can
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
180 ## be referred to in issue_server_link or issue_sub using Python backreferences
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
181 ## (e.g. \1, \2, ...). You can also create named groups with '(?P<groupname>)'.
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
182 ## To require mandatory whitespace before the issue pattern, use:
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
183 ## (?:^|(?<=\s)) before the actual pattern, and for mandatory whitespace
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
184 ## behind the issue pattern, use (?:$|(?=\s)) after the actual pattern.
1837
a6a30c919513 #73 mapping of commited issues from commit message into issue tracker url.
Marcin Kuzminski <marcin@python-works.com>
parents: 1831
diff changeset
185
7159
9cef5615da7b issues: simplify example in ini file
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7129
diff changeset
186 issue_pat = #(\d+)
1837
a6a30c919513 #73 mapping of commited issues from commit message into issue tracker url.
Marcin Kuzminski <marcin@python-works.com>
parents: 1831
diff changeset
187
7230
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
188 ## server url to the issue
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
189 ## This pattern may/should contain backreferences to parenthesized groups in issue_pat.
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
190 ## A backreference can be \1, \2, ... or \g<groupname> if you specified a named group
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
191 ## called 'groupname' in issue_pat.
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
192 ## The special token {repo} is replaced with the full repository name
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
193 ## including repository groups, while {repo_name} is replaced with just
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
194 ## the name of the repository.
1837
a6a30c919513 #73 mapping of commited issues from commit message into issue tracker url.
Marcin Kuzminski <marcin@python-works.com>
parents: 1831
diff changeset
195
7230
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
196 issue_server_link = https://issues.example.com/{repo}/issue/\1
1837
a6a30c919513 #73 mapping of commited issues from commit message into issue tracker url.
Marcin Kuzminski <marcin@python-works.com>
parents: 1831
diff changeset
197
7230
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
198 ## substitution pattern to use as the link text
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
199 ## If issue_sub is empty, the text matched by issue_pat is retained verbatim
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
200 ## for the link text. Otherwise, the link text is that of issue_sub, with any
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
201 ## backreferences to groups in issue_pat replaced.
1837
a6a30c919513 #73 mapping of commited issues from commit message into issue tracker url.
Marcin Kuzminski <marcin@python-works.com>
parents: 1831
diff changeset
202
7230
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
203 issue_sub =
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
204
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
205 ## issue_pat, issue_server_link and issue_sub can have suffixes to specify
2866
736678a8c881 #518 multiple issues patterns
Marcin Kuzminski <marcin@python-works.com>
parents: 2836
diff changeset
206 ## multiple patterns, to other issues server, wiki or others
4068
17e3926c3753 added ini files into codecleaner
Marcin Kuzminski <marcin@python-works.com>
parents: 4066
diff changeset
207 ## below an example how to create a wiki pattern
8354
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
208 ## wiki-some-id -> https://wiki.example.com/some-id
2866
736678a8c881 #518 multiple issues patterns
Marcin Kuzminski <marcin@python-works.com>
parents: 2836
diff changeset
209
7230
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
210 #issue_pat_wiki = wiki-(\S+)
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
211 #issue_server_link_wiki = https://wiki.example.com/\1
d24051ce961c issues: support generic regex replacements in issue_url and issue_prefix
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7194
diff changeset
212 #issue_sub_wiki = WIKI-\1
2866
736678a8c881 #518 multiple issues patterns
Marcin Kuzminski <marcin@python-works.com>
parents: 2836
diff changeset
213
2132
9f5582151d53 Alternative HTTP response codes when client failed to Authenticate correctly
Marcin Kuzminski <marcin@python-works.com>
parents: 2102
diff changeset
214 ## alternative return HTTP header for failed authentication. Default HTTP
4527
dacdea9fda2a Correct capitalization and improved English text in the UI
Na'Tosha Bard <natosha@unity3d.com>
parents: 4501
diff changeset
215 ## response is 401 HTTPUnauthorized. Currently Mercurial clients have trouble with
2132
9f5582151d53 Alternative HTTP response codes when client failed to Authenticate correctly
Marcin Kuzminski <marcin@python-works.com>
parents: 2102
diff changeset
216 ## handling that. Set this variable to 403 to return HTTPForbidden
9f5582151d53 Alternative HTTP response codes when client failed to Authenticate correctly
Marcin Kuzminski <marcin@python-works.com>
parents: 2102
diff changeset
217 auth_ret_code =
9f5582151d53 Alternative HTTP response codes when client failed to Authenticate correctly
Marcin Kuzminski <marcin@python-works.com>
parents: 2102
diff changeset
218
4045
9b4ba12ef8c3 Add ini option to controll custom advanced hooks settings
Marcin Kuzminski <marcin@python-works.com>
parents: 4006
diff changeset
219 ## allows to change the repository location in settings page
3920
985db7f7b9b2 Added flag to controll option for changing the repos path location
Marcin Kuzminski <marcin@python-works.com>
parents: 3904
diff changeset
220 allow_repo_location_change = True
3522
7174ee850baa configurable locking codes.
Marcin Kuzminski <marcin@python-works.com>
parents: 3490
diff changeset
221
4045
9b4ba12ef8c3 Add ini option to controll custom advanced hooks settings
Marcin Kuzminski <marcin@python-works.com>
parents: 4006
diff changeset
222 ## allows to setup custom hooks in settings page
9b4ba12ef8c3 Add ini option to controll custom advanced hooks settings
Marcin Kuzminski <marcin@python-works.com>
parents: 4006
diff changeset
223 allow_custom_hooks_settings = True
9b4ba12ef8c3 Add ini option to controll custom advanced hooks settings
Marcin Kuzminski <marcin@python-works.com>
parents: 4006
diff changeset
224
5560
6ed126ef71af indexers: load additional indexers settings from ini
Takumi IINO <trot.thunder@gmail.com>
parents: 5536
diff changeset
225 ## extra extensions for indexing, space separated and without the leading '.'.
8354
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
226 #index.extensions =
5560
6ed126ef71af indexers: load additional indexers settings from ini
Takumi IINO <trot.thunder@gmail.com>
parents: 5536
diff changeset
227 # gemfile
6ed126ef71af indexers: load additional indexers settings from ini
Takumi IINO <trot.thunder@gmail.com>
parents: 5536
diff changeset
228 # lock
6ed126ef71af indexers: load additional indexers settings from ini
Takumi IINO <trot.thunder@gmail.com>
parents: 5536
diff changeset
229
6ed126ef71af indexers: load additional indexers settings from ini
Takumi IINO <trot.thunder@gmail.com>
parents: 5536
diff changeset
230 ## extra filenames for indexing, space separated
8354
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
231 #index.filenames =
5560
6ed126ef71af indexers: load additional indexers settings from ini
Takumi IINO <trot.thunder@gmail.com>
parents: 5536
diff changeset
232 # .dockerignore
6ed126ef71af indexers: load additional indexers settings from ini
Takumi IINO <trot.thunder@gmail.com>
parents: 5536
diff changeset
233 # .editorconfig
6ed126ef71af indexers: load additional indexers settings from ini
Takumi IINO <trot.thunder@gmail.com>
parents: 5536
diff changeset
234 # INSTALL
6ed126ef71af indexers: load additional indexers settings from ini
Takumi IINO <trot.thunder@gmail.com>
parents: 5536
diff changeset
235 # CHANGELOG
6ed126ef71af indexers: load additional indexers settings from ini
Takumi IINO <trot.thunder@gmail.com>
parents: 5536
diff changeset
236
49
3ada2f409c1c Added sqlalchemy support
Marcin Kuzminski <marcin@python-blog.com>
parents: 46
diff changeset
237 ####################################
8428
6eb1f66ac23f ini: tweak mako comment markup - prepare for variable expansion in ## lines by only "quoting" ##
Mads Kiilerich <mads@kiilerich.com>
parents: 8358
diff changeset
238 ## SSH CONFIG ##
7770
6da70f4569bf ssh: introduce ini setting 'ssh_enabled', disabled by default
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7768
diff changeset
239 ####################################
6da70f4569bf ssh: introduce ini setting 'ssh_enabled', disabled by default
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7768
diff changeset
240
6da70f4569bf ssh: introduce ini setting 'ssh_enabled', disabled by default
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7768
diff changeset
241 ## SSH is disabled by default, until an Administrator decides to enable it.
6da70f4569bf ssh: introduce ini setting 'ssh_enabled', disabled by default
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7768
diff changeset
242 ssh_enabled = false
6da70f4569bf ssh: introduce ini setting 'ssh_enabled', disabled by default
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7768
diff changeset
243
7777
b27e515df83c ssh: introduce 'kallithea-cli ssh-update-authorized-keys' command for updating authorized_keys file
Christian Oyarzun <oyarzun@gmail.com>
parents: 7770
diff changeset
244 ## File where users' SSH keys will be stored *if* ssh_enabled is true.
b27e515df83c ssh: introduce 'kallithea-cli ssh-update-authorized-keys' command for updating authorized_keys file
Christian Oyarzun <oyarzun@gmail.com>
parents: 7770
diff changeset
245 #ssh_authorized_keys = /home/kallithea/.ssh/authorized_keys
b27e515df83c ssh: introduce 'kallithea-cli ssh-update-authorized-keys' command for updating authorized_keys file
Christian Oyarzun <oyarzun@gmail.com>
parents: 7770
diff changeset
246
b27e515df83c ssh: introduce 'kallithea-cli ssh-update-authorized-keys' command for updating authorized_keys file
Christian Oyarzun <oyarzun@gmail.com>
parents: 7770
diff changeset
247 ## Path to be used in ssh_authorized_keys file to invoke kallithea-cli with ssh-serve.
b27e515df83c ssh: introduce 'kallithea-cli ssh-update-authorized-keys' command for updating authorized_keys file
Christian Oyarzun <oyarzun@gmail.com>
parents: 7770
diff changeset
248 #kallithea_cli_path = /srv/kallithea/venv/bin/kallithea-cli
b27e515df83c ssh: introduce 'kallithea-cli ssh-update-authorized-keys' command for updating authorized_keys file
Christian Oyarzun <oyarzun@gmail.com>
parents: 7770
diff changeset
249
7785
b5b91e854308 ssh: set a valid locale in the ssh-serve process
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7777
diff changeset
250 ## Locale to be used in the ssh-serve command.
b5b91e854308 ssh: set a valid locale in the ssh-serve process
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7777
diff changeset
251 ## This is needed because an SSH client may try to use its own locale
b5b91e854308 ssh: set a valid locale in the ssh-serve process
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7777
diff changeset
252 ## settings, which may not be available on the server.
b5b91e854308 ssh: set a valid locale in the ssh-serve process
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7777
diff changeset
253 ## See `locale -a` for valid values on this system.
b5b91e854308 ssh: set a valid locale in the ssh-serve process
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7777
diff changeset
254 #ssh_locale = C.UTF-8
b5b91e854308 ssh: set a valid locale in the ssh-serve process
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7777
diff changeset
255
7770
6da70f4569bf ssh: introduce ini setting 'ssh_enabled', disabled by default
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7768
diff changeset
256 ####################################
8428
6eb1f66ac23f ini: tweak mako comment markup - prepare for variable expansion in ## lines by only "quoting" ##
Mads Kiilerich <mads@kiilerich.com>
parents: 8358
diff changeset
257 ## CELERY CONFIG ##
776
f6c613fba757 Celery is configured by the .ini files and run from paster now
Marcin Kuzminski <marcin@python-works.com>
parents: 716
diff changeset
258 ####################################
4225
3e6291d99a6f Align and update the outdated ini files and templates
Mads Kiilerich <madski@unity3d.com>
parents: 4212
diff changeset
259
8268
f8f50d3b6512 celery: upgrade to Celery 4
Mads Kiilerich <mads@kiilerich.com>
parents: 8265
diff changeset
260 ## Note: Celery doesn't support Windows.
776
f6c613fba757 Celery is configured by the .ini files and run from paster now
Marcin Kuzminski <marcin@python-works.com>
parents: 716
diff changeset
261 use_celery = false
6175
d3957c90499b celery: use Celery 3 config settings instead of deprecated
Mads Kiilerich <madski@unity3d.com>
parents: 6153
diff changeset
262
8269
e1d4a0d8520f celery: use celery 4 setting names in generated .ini files
Mads Kiilerich <mads@kiilerich.com>
parents: 8268
diff changeset
263 ## Celery config settings from https://docs.celeryproject.org/en/4.4.0/userguide/configuration.html prefixed with 'celery.'.
e1d4a0d8520f celery: use celery 4 setting names in generated .ini files
Mads Kiilerich <mads@kiilerich.com>
parents: 8268
diff changeset
264
8264
09a317dfa793 celery: tweak the RabbitMQ example in generated config
Mads Kiilerich <mads@kiilerich.com>
parents: 8263
diff changeset
265 ## Example: use the message queue on the local virtual host 'kallitheavhost' as the RabbitMQ user 'kallithea':
8269
e1d4a0d8520f celery: use celery 4 setting names in generated .ini files
Mads Kiilerich <mads@kiilerich.com>
parents: 8268
diff changeset
266 celery.broker_url = amqp://kallithea:thepassword@localhost:5672/kallitheavhost
776
f6c613fba757 Celery is configured by the .ini files and run from paster now
Marcin Kuzminski <marcin@python-works.com>
parents: 716
diff changeset
267
8269
e1d4a0d8520f celery: use celery 4 setting names in generated .ini files
Mads Kiilerich <mads@kiilerich.com>
parents: 8268
diff changeset
268 celery.worker_concurrency = 2
8799
d2d787d881db celery: default to more than 1 task per worker
Mads Kiilerich <mads@kiilerich.com>
parents: 8761
diff changeset
269 celery.worker_max_tasks_per_child = 100
776
f6c613fba757 Celery is configured by the .ini files and run from paster now
Marcin Kuzminski <marcin@python-works.com>
parents: 716
diff changeset
270
f6c613fba757 Celery is configured by the .ini files and run from paster now
Marcin Kuzminski <marcin@python-works.com>
parents: 716
diff changeset
271 ####################################
8428
6eb1f66ac23f ini: tweak mako comment markup - prepare for variable expansion in ## lines by only "quoting" ##
Mads Kiilerich <mads@kiilerich.com>
parents: 8358
diff changeset
272 ## BEAKER CACHE ##
49
3ada2f409c1c Added sqlalchemy support
Marcin Kuzminski <marcin@python-blog.com>
parents: 46
diff changeset
273 ####################################
4225
3e6291d99a6f Align and update the outdated ini files and templates
Mads Kiilerich <madski@unity3d.com>
parents: 4212
diff changeset
274
5364
a478cad966b1 ini: consistently write #-disabled lines without space after # and with single space around =
Mads Kiilerich <madski@unity3d.com>
parents: 5363
diff changeset
275 beaker.cache.data_dir = %(here)s/data/cache/data
a478cad966b1 ini: consistently write #-disabled lines without space after # and with single space around =
Mads Kiilerich <madski@unity3d.com>
parents: 5363
diff changeset
276 beaker.cache.lock_dir = %(here)s/data/cache/lock
1076
db71228a4c23 moved statistics parse_limit into .ini files
Marcin Kuzminski <marcin@python-works.com>
parents: 964
diff changeset
277
8346
f787c028ffc0 utils: drop conditional_cache - an unused beaker cache
Mads Kiilerich <mads@kiilerich.com>
parents: 8343
diff changeset
278 beaker.cache.regions = long_term,long_term_file
609
c1c1cf772337 moved out sqlalchemy cache from meta to the config files.
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
279
5364
a478cad966b1 ini: consistently write #-disabled lines without space after # and with single space around =
Mads Kiilerich <madski@unity3d.com>
parents: 5363
diff changeset
280 beaker.cache.long_term.type = memory
a478cad966b1 ini: consistently write #-disabled lines without space after # and with single space around =
Mads Kiilerich <madski@unity3d.com>
parents: 5363
diff changeset
281 beaker.cache.long_term.expire = 36000
1607
e886f91fcb71 Cached readme generation
Marcin Kuzminski <marcin@python-works.com>
parents: 1582
diff changeset
282 beaker.cache.long_term.key_length = 256
597
53128b6b9a4d added password validation, second try on paster setup-app,
Marcin Kuzminski <marcin@python-works.com>
parents: 592
diff changeset
283
8342
dd3171263afd db: introduce long_term_file beaker cache to store README and RSS cache on disk where it is reusable between processes - not in worker memory
Mads Kiilerich <mads@kiilerich.com>
parents: 8269
diff changeset
284 beaker.cache.long_term_file.type = file
dd3171263afd db: introduce long_term_file beaker cache to store README and RSS cache on disk where it is reusable between processes - not in worker memory
Mads Kiilerich <mads@kiilerich.com>
parents: 8269
diff changeset
285 beaker.cache.long_term_file.expire = 604800
dd3171263afd db: introduce long_term_file beaker cache to store README and RSS cache on disk where it is reusable between processes - not in worker memory
Mads Kiilerich <mads@kiilerich.com>
parents: 8269
diff changeset
286 beaker.cache.long_term_file.key_length = 256
dd3171263afd db: introduce long_term_file beaker cache to store README and RSS cache on disk where it is reusable between processes - not in worker memory
Mads Kiilerich <mads@kiilerich.com>
parents: 8269
diff changeset
287
436
28f19fa562df updated config files,
Marcin Kuzminski <marcin@python-works.com>
parents: 343
diff changeset
288 ####################################
8428
6eb1f66ac23f ini: tweak mako comment markup - prepare for variable expansion in ## lines by only "quoting" ##
Mads Kiilerich <mads@kiilerich.com>
parents: 8358
diff changeset
289 ## BEAKER SESSION ##
436
28f19fa562df updated config files,
Marcin Kuzminski <marcin@python-works.com>
parents: 343
diff changeset
290 ####################################
5400
6257de126ec7 docs: improve documentation of beaker session configuration
Mads Kiilerich <madski@unity3d.com>
parents: 5399
diff changeset
291
6257de126ec7 docs: improve documentation of beaker session configuration
Mads Kiilerich <madski@unity3d.com>
parents: 5399
diff changeset
292 ## Name of session cookie. Should be unique for a given host and path, even when running
6257de126ec7 docs: improve documentation of beaker session configuration
Mads Kiilerich <madski@unity3d.com>
parents: 5399
diff changeset
293 ## on different ports. Otherwise, cookie sessions will be shared and messed up.
7738
bbf7be28a11e config: rename .ini settings to avoid beaker-session deprecation warnings
Mads Kiilerich <mads@kiilerich.com>
parents: 7737
diff changeset
294 session.key = kallithea
5400
6257de126ec7 docs: improve documentation of beaker session configuration
Mads Kiilerich <madski@unity3d.com>
parents: 5399
diff changeset
295 ## Sessions should always only be accessible by the browser, not directly by JavaScript.
7738
bbf7be28a11e config: rename .ini settings to avoid beaker-session deprecation warnings
Mads Kiilerich <mads@kiilerich.com>
parents: 7737
diff changeset
296 session.httponly = true
5400
6257de126ec7 docs: improve documentation of beaker session configuration
Mads Kiilerich <madski@unity3d.com>
parents: 5399
diff changeset
297 ## Session lifetime. 2592000 seconds is 30 days.
7738
bbf7be28a11e config: rename .ini settings to avoid beaker-session deprecation warnings
Mads Kiilerich <mads@kiilerich.com>
parents: 7737
diff changeset
298 session.timeout = 2592000
5400
6257de126ec7 docs: improve documentation of beaker session configuration
Mads Kiilerich <madski@unity3d.com>
parents: 5399
diff changeset
299
6257de126ec7 docs: improve documentation of beaker session configuration
Mads Kiilerich <madski@unity3d.com>
parents: 5399
diff changeset
300 ## Server secret used with HMAC to ensure integrity of cookies.
7738
bbf7be28a11e config: rename .ini settings to avoid beaker-session deprecation warnings
Mads Kiilerich <mads@kiilerich.com>
parents: 7737
diff changeset
301 #session.secret = VERY-SECRET
bbf7be28a11e config: rename .ini settings to avoid beaker-session deprecation warnings
Mads Kiilerich <mads@kiilerich.com>
parents: 7737
diff changeset
302 session.secret = development-not-secret
5400
6257de126ec7 docs: improve documentation of beaker session configuration
Mads Kiilerich <madski@unity3d.com>
parents: 5399
diff changeset
303 ## Further, encrypt the data with AES.
7738
bbf7be28a11e config: rename .ini settings to avoid beaker-session deprecation warnings
Mads Kiilerich <mads@kiilerich.com>
parents: 7737
diff changeset
304 #session.encrypt_key = <key_for_encryption>
bbf7be28a11e config: rename .ini settings to avoid beaker-session deprecation warnings
Mads Kiilerich <mads@kiilerich.com>
parents: 7737
diff changeset
305 #session.validate_key = <validation_key>
5400
6257de126ec7 docs: improve documentation of beaker session configuration
Mads Kiilerich <madski@unity3d.com>
parents: 5399
diff changeset
306
4068
17e3926c3753 added ini files into codecleaner
Marcin Kuzminski <marcin@python-works.com>
parents: 4066
diff changeset
307 ## Type of storage used for the session, current types are
17e3926c3753 added ini files into codecleaner
Marcin Kuzminski <marcin@python-works.com>
parents: 4066
diff changeset
308 ## dbm, file, memcached, database, and memory.
5400
6257de126ec7 docs: improve documentation of beaker session configuration
Mads Kiilerich <madski@unity3d.com>
parents: 5399
diff changeset
309
6257de126ec7 docs: improve documentation of beaker session configuration
Mads Kiilerich <madski@unity3d.com>
parents: 5399
diff changeset
310 ## File system storage of session data. (default)
7738
bbf7be28a11e config: rename .ini settings to avoid beaker-session deprecation warnings
Mads Kiilerich <mads@kiilerich.com>
parents: 7737
diff changeset
311 #session.type = file
1660
5568b0cea3cc db based session example for .ini
Marcin Kuzminski <marcin@python-works.com>
parents: 1652
diff changeset
312
5400
6257de126ec7 docs: improve documentation of beaker session configuration
Mads Kiilerich <madski@unity3d.com>
parents: 5399
diff changeset
313 ## Cookie only, store all session data inside the cookie. Requires secure secrets.
7738
bbf7be28a11e config: rename .ini settings to avoid beaker-session deprecation warnings
Mads Kiilerich <mads@kiilerich.com>
parents: 7737
diff changeset
314 #session.type = cookie
5400
6257de126ec7 docs: improve documentation of beaker session configuration
Mads Kiilerich <madski@unity3d.com>
parents: 5399
diff changeset
315
6257de126ec7 docs: improve documentation of beaker session configuration
Mads Kiilerich <madski@unity3d.com>
parents: 5399
diff changeset
316 ## Database storage of session data.
7738
bbf7be28a11e config: rename .ini settings to avoid beaker-session deprecation warnings
Mads Kiilerich <mads@kiilerich.com>
parents: 7737
diff changeset
317 #session.type = ext:database
bbf7be28a11e config: rename .ini settings to avoid beaker-session deprecation warnings
Mads Kiilerich <mads@kiilerich.com>
parents: 7737
diff changeset
318 #session.sa.url = postgresql://postgres:qwe@localhost/kallithea
bbf7be28a11e config: rename .ini settings to avoid beaker-session deprecation warnings
Mads Kiilerich <mads@kiilerich.com>
parents: 7737
diff changeset
319 #session.table_name = db_session
1660
5568b0cea3cc db based session example for .ini
Marcin Kuzminski <marcin@python-works.com>
parents: 1652
diff changeset
320
8358
4869a8bb1237 ini: tweak template configuration for TG's handling of application errors
Mads Kiilerich <mads@kiilerich.com>
parents: 8357
diff changeset
321 ####################################
8428
6eb1f66ac23f ini: tweak mako comment markup - prepare for variable expansion in ## lines by only "quoting" ##
Mads Kiilerich <mads@kiilerich.com>
parents: 8358
diff changeset
322 ## ERROR HANDLING ##
8358
4869a8bb1237 ini: tweak template configuration for TG's handling of application errors
Mads Kiilerich <mads@kiilerich.com>
parents: 8357
diff changeset
323 ####################################
4869a8bb1237 ini: tweak template configuration for TG's handling of application errors
Mads Kiilerich <mads@kiilerich.com>
parents: 8357
diff changeset
324
4869a8bb1237 ini: tweak template configuration for TG's handling of application errors
Mads Kiilerich <mads@kiilerich.com>
parents: 8357
diff changeset
325 ## Show a nice error page for application HTTP errors and exceptions (default true)
4869a8bb1237 ini: tweak template configuration for TG's handling of application errors
Mads Kiilerich <mads@kiilerich.com>
parents: 8357
diff changeset
326 #errorpage.enabled = true
4869a8bb1237 ini: tweak template configuration for TG's handling of application errors
Mads Kiilerich <mads@kiilerich.com>
parents: 8357
diff changeset
327
4869a8bb1237 ini: tweak template configuration for TG's handling of application errors
Mads Kiilerich <mads@kiilerich.com>
parents: 8357
diff changeset
328 ## Enable Backlash client-side interactive debugger (default false)
4869a8bb1237 ini: tweak template configuration for TG's handling of application errors
Mads Kiilerich <mads@kiilerich.com>
parents: 8357
diff changeset
329 ## WARNING: *THIS MUST BE false IN PRODUCTION ENVIRONMENTS!!!*
4869a8bb1237 ini: tweak template configuration for TG's handling of application errors
Mads Kiilerich <mads@kiilerich.com>
parents: 8357
diff changeset
330 ## This debug mode will allow all visitors to execute malicious code.
4869a8bb1237 ini: tweak template configuration for TG's handling of application errors
Mads Kiilerich <mads@kiilerich.com>
parents: 8357
diff changeset
331 #debug = false
4869a8bb1237 ini: tweak template configuration for TG's handling of application errors
Mads Kiilerich <mads@kiilerich.com>
parents: 8357
diff changeset
332 debug = true
4869a8bb1237 ini: tweak template configuration for TG's handling of application errors
Mads Kiilerich <mads@kiilerich.com>
parents: 8357
diff changeset
333
4869a8bb1237 ini: tweak template configuration for TG's handling of application errors
Mads Kiilerich <mads@kiilerich.com>
parents: 8357
diff changeset
334 ## Enable Backlash server-side error reporting (unless debug mode handles it client-side) (default true)
4869a8bb1237 ini: tweak template configuration for TG's handling of application errors
Mads Kiilerich <mads@kiilerich.com>
parents: 8357
diff changeset
335 #trace_errors.enable = true
4869a8bb1237 ini: tweak template configuration for TG's handling of application errors
Mads Kiilerich <mads@kiilerich.com>
parents: 8357
diff changeset
336 ## Errors will be reported by mail if trace_errors.error_email is set.
7737
cbdc0c3a5406 config: change default .ini to always include trace_errors settings and thus avoid deprecation warnings
Mads Kiilerich <mads@kiilerich.com>
parents: 7692
diff changeset
337
8354
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
338 ## Propagate email settings to ErrorReporter of TurboGears2
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
339 ## You do not normally need to change these lines
7737
cbdc0c3a5406 config: change default .ini to always include trace_errors settings and thus avoid deprecation warnings
Mads Kiilerich <mads@kiilerich.com>
parents: 7692
diff changeset
340 get trace_errors.smtp_server = smtp_server
cbdc0c3a5406 config: change default .ini to always include trace_errors settings and thus avoid deprecation warnings
Mads Kiilerich <mads@kiilerich.com>
parents: 7692
diff changeset
341 get trace_errors.smtp_port = smtp_port
cbdc0c3a5406 config: change default .ini to always include trace_errors settings and thus avoid deprecation warnings
Mads Kiilerich <mads@kiilerich.com>
parents: 7692
diff changeset
342 get trace_errors.from_address = error_email_from
8233
34846d33498d mails: make error reporting by mail work with secure mail servers
Mads Kiilerich <mads@kiilerich.com>
parents: 8095
diff changeset
343 get trace_errors.error_email = email_to
34846d33498d mails: make error reporting by mail work with secure mail servers
Mads Kiilerich <mads@kiilerich.com>
parents: 8095
diff changeset
344 get trace_errors.smtp_username = smtp_username
34846d33498d mails: make error reporting by mail work with secure mail servers
Mads Kiilerich <mads@kiilerich.com>
parents: 8095
diff changeset
345 get trace_errors.smtp_password = smtp_password
34846d33498d mails: make error reporting by mail work with secure mail servers
Mads Kiilerich <mads@kiilerich.com>
parents: 8095
diff changeset
346 get trace_errors.smtp_use_tls = smtp_use_tls
7737
cbdc0c3a5406 config: change default .ini to always include trace_errors settings and thus avoid deprecation warnings
Mads Kiilerich <mads@kiilerich.com>
parents: 7692
diff changeset
347
49
3ada2f409c1c Added sqlalchemy support
Marcin Kuzminski <marcin@python-blog.com>
parents: 46
diff changeset
348 ##################################
8428
6eb1f66ac23f ini: tweak mako comment markup - prepare for variable expansion in ## lines by only "quoting" ##
Mads Kiilerich <mads@kiilerich.com>
parents: 8358
diff changeset
349 ## LOGVIEW CONFIG ##
49
3ada2f409c1c Added sqlalchemy support
Marcin Kuzminski <marcin@python-blog.com>
parents: 46
diff changeset
350 ##################################
4225
3e6291d99a6f Align and update the outdated ini files and templates
Mads Kiilerich <madski@unity3d.com>
parents: 4212
diff changeset
351
49
3ada2f409c1c Added sqlalchemy support
Marcin Kuzminski <marcin@python-blog.com>
parents: 46
diff changeset
352 logview.sqlalchemy = #faa
3ada2f409c1c Added sqlalchemy support
Marcin Kuzminski <marcin@python-blog.com>
parents: 46
diff changeset
353 logview.pylons.templating = #bfb
3ada2f409c1c Added sqlalchemy support
Marcin Kuzminski <marcin@python-blog.com>
parents: 46
diff changeset
354 logview.pylons.util = #eee
3ada2f409c1c Added sqlalchemy support
Marcin Kuzminski <marcin@python-blog.com>
parents: 46
diff changeset
355
8428
6eb1f66ac23f ini: tweak mako comment markup - prepare for variable expansion in ## lines by only "quoting" ##
Mads Kiilerich <mads@kiilerich.com>
parents: 8358
diff changeset
356 #########################
6eb1f66ac23f ini: tweak mako comment markup - prepare for variable expansion in ## lines by only "quoting" ##
Mads Kiilerich <mads@kiilerich.com>
parents: 8358
diff changeset
357 ## DB CONFIG ##
6eb1f66ac23f ini: tweak mako comment markup - prepare for variable expansion in ## lines by only "quoting" ##
Mads Kiilerich <mads@kiilerich.com>
parents: 8358
diff changeset
358 #########################
4225
3e6291d99a6f Align and update the outdated ini files and templates
Mads Kiilerich <madski@unity3d.com>
parents: 4212
diff changeset
359
6214
f973b866fffc Turbogears2 migration: use sqlalchemy.url iso sqlalchemy.db1.url
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 6175
diff changeset
360 sqlalchemy.url = sqlite:///%(here)s/kallithea.db?timeout=60
8578
ff8651b2f14f docs: augment setup description with more details of http server and database
Mads Kiilerich <mads@kiilerich.com>
parents: 8568
diff changeset
361 #sqlalchemy.url = postgresql://kallithea:password@localhost/kallithea
8594
3c503044e9f1 mysql: bump sqlalchemy.url MariaDB/MySQL charset to to 'utf8mb4' to get full UTF-8 support
Mads Kiilerich <mads@kiilerich.com>
parents: 8578
diff changeset
362 #sqlalchemy.url = mysql://kallithea:password@localhost/kallithea?charset=utf8mb4
8568
a04d6926d694 merge stable
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 8563
diff changeset
363 ## Note: the mysql:// prefix should also be used for MariaDB
4225
3e6291d99a6f Align and update the outdated ini files and templates
Mads Kiilerich <madski@unity3d.com>
parents: 4212
diff changeset
364
6214
f973b866fffc Turbogears2 migration: use sqlalchemy.url iso sqlalchemy.db1.url
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 6175
diff changeset
365 sqlalchemy.pool_recycle = 3600
49
3ada2f409c1c Added sqlalchemy support
Marcin Kuzminski <marcin@python-blog.com>
parents: 46
diff changeset
366
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents: 10
diff changeset
367 ################################
8428
6eb1f66ac23f ini: tweak mako comment markup - prepare for variable expansion in ## lines by only "quoting" ##
Mads Kiilerich <mads@kiilerich.com>
parents: 8358
diff changeset
368 ## ALEMBIC CONFIGURATION ##
6019
ccc66ed2f85b db: enable use of main Kallithea config as Alembic config
Søren Løvborg <sorenl@unity3d.com>
parents: 5882
diff changeset
369 ################################
ccc66ed2f85b db: enable use of main Kallithea config as Alembic config
Søren Løvborg <sorenl@unity3d.com>
parents: 5882
diff changeset
370
ccc66ed2f85b db: enable use of main Kallithea config as Alembic config
Søren Løvborg <sorenl@unity3d.com>
parents: 5882
diff changeset
371 [alembic]
ccc66ed2f85b db: enable use of main Kallithea config as Alembic config
Søren Løvborg <sorenl@unity3d.com>
parents: 5882
diff changeset
372 script_location = kallithea:alembic
49
3ada2f409c1c Added sqlalchemy support
Marcin Kuzminski <marcin@python-blog.com>
parents: 46
diff changeset
373
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents: 10
diff changeset
374 ################################
8428
6eb1f66ac23f ini: tweak mako comment markup - prepare for variable expansion in ## lines by only "quoting" ##
Mads Kiilerich <mads@kiilerich.com>
parents: 8358
diff changeset
375 ## LOGGING CONFIGURATION ##
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents: 10
diff changeset
376 ################################
4225
3e6291d99a6f Align and update the outdated ini files and templates
Mads Kiilerich <madski@unity3d.com>
parents: 4212
diff changeset
377
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
378 [loggers]
7194
6ae76150acbd logging: add missing logging config for werkzeug and backlash
domruf <dominikruf@gmail.com>
parents: 7193
diff changeset
379 keys = root, routes, kallithea, sqlalchemy, tg, gearbox, beaker, templates, whoosh_indexer, werkzeug, backlash
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
380
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
381 [handlers]
7768
609d52bbf917 ini: create separate log handlers for color and null, and add comments hinting how they can be used
Mads Kiilerich <mads@kiilerich.com>
parents: 7767
diff changeset
382 keys = console, console_color, console_color_sql, null
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
383
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
384 [formatters]
1186
b9ea10d3e419 timperproxy will just measure the time of queries, and formatting will be handled by the new sql_formatter of queries from sqlalchemy itself. Updated ini files for new way logging
Marcin Kuzminski <marcin@python-works.com>
parents: 1116
diff changeset
385 keys = generic, color_formatter, color_formatter_sql
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
386
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents: 10
diff changeset
387 #############
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
388 ## LOGGERS ##
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents: 10
diff changeset
389 #############
4225
3e6291d99a6f Align and update the outdated ini files and templates
Mads Kiilerich <madski@unity3d.com>
parents: 4212
diff changeset
390
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
391 [logger_root]
15
c8265b4f0c2a added log4j to development,
Marcin Kuzminski
parents: 14
diff changeset
392 level = NOTSET
7768
609d52bbf917 ini: create separate log handlers for color and null, and add comments hinting how they can be used
Mads Kiilerich <mads@kiilerich.com>
parents: 7767
diff changeset
393 #handlers = console
8357
238885eaead4 inifile: new implementation of setting updates to optimize reuse of comments and append location
Mads Kiilerich <mads@kiilerich.com>
parents: 8354
diff changeset
394 ## For coloring based on log level:
7768
609d52bbf917 ini: create separate log handlers for color and null, and add comments hinting how they can be used
Mads Kiilerich <mads@kiilerich.com>
parents: 7767
diff changeset
395 handlers = console_color
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
396
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
397 [logger_routes]
7193
150173a027ee ini: set default log level to WARN
domruf <dominikruf@gmail.com>
parents: 7159
diff changeset
398 #level = WARN
69
76b23189f987 Updated logginf of routes
Marcin Kuzminski <marcin@python-blog.com>
parents: 60
diff changeset
399 level = DEBUG
4068
17e3926c3753 added ini files into codecleaner
Marcin Kuzminski <marcin@python-works.com>
parents: 4066
diff changeset
400 handlers =
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
401 qualname = routes.middleware
3557
58dcef7eef03 Implemented show_id function that is a configurable way to display sha hashes in the changelog.
Marcin Kuzminski <marcin@python-works.com>
parents: 3522
diff changeset
402 ## "level = DEBUG" logs the route matched and routing variables.
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
403
716
1f8546ccccdd some logging extras for development config files
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
404 [logger_beaker]
7193
150173a027ee ini: set default log level to WARN
domruf <dominikruf@gmail.com>
parents: 7159
diff changeset
405 #level = WARN
1186
b9ea10d3e419 timperproxy will just measure the time of queries, and formatting will be handled by the new sql_formatter of queries from sqlalchemy itself. Updated ini files for new way logging
Marcin Kuzminski <marcin@python-works.com>
parents: 1116
diff changeset
406 level = DEBUG
4068
17e3926c3753 added ini files into codecleaner
Marcin Kuzminski <marcin@python-works.com>
parents: 4066
diff changeset
407 handlers =
716
1f8546ccccdd some logging extras for development config files
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
408 qualname = beaker.container
1f8546ccccdd some logging extras for development config files
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
409
1f8546ccccdd some logging extras for development config files
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
410 [logger_templates]
7193
150173a027ee ini: set default log level to WARN
domruf <dominikruf@gmail.com>
parents: 7159
diff changeset
411 #level = WARN
716
1f8546ccccdd some logging extras for development config files
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
412 level = INFO
4068
17e3926c3753 added ini files into codecleaner
Marcin Kuzminski <marcin@python-works.com>
parents: 4066
diff changeset
413 handlers =
716
1f8546ccccdd some logging extras for development config files
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
414 qualname = pylons.templating
1f8546ccccdd some logging extras for development config files
Marcin Kuzminski <marcin@python-works.com>
parents: 683
diff changeset
415
4207
58e390e0cea4 Rename some strings in init files and logger names
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4186
diff changeset
416 [logger_kallithea]
7193
150173a027ee ini: set default log level to WARN
domruf <dominikruf@gmail.com>
parents: 7159
diff changeset
417 #level = WARN
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
418 level = DEBUG
4068
17e3926c3753 added ini files into codecleaner
Marcin Kuzminski <marcin@python-works.com>
parents: 4066
diff changeset
419 handlers =
4207
58e390e0cea4 Rename some strings in init files and logger names
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4186
diff changeset
420 qualname = kallithea
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents: 10
diff changeset
421
6569
e1ab82613133 backend: replace Pylons with TurboGears2
Alessandro Molina <alessandro.molina@axant.it>
parents: 6554
diff changeset
422 [logger_tg]
7193
150173a027ee ini: set default log level to WARN
domruf <dominikruf@gmail.com>
parents: 7159
diff changeset
423 #level = WARN
6569
e1ab82613133 backend: replace Pylons with TurboGears2
Alessandro Molina <alessandro.molina@axant.it>
parents: 6554
diff changeset
424 level = DEBUG
e1ab82613133 backend: replace Pylons with TurboGears2
Alessandro Molina <alessandro.molina@axant.it>
parents: 6554
diff changeset
425 handlers =
e1ab82613133 backend: replace Pylons with TurboGears2
Alessandro Molina <alessandro.molina@axant.it>
parents: 6554
diff changeset
426 qualname = tg
e1ab82613133 backend: replace Pylons with TurboGears2
Alessandro Molina <alessandro.molina@axant.it>
parents: 6554
diff changeset
427
6554
2c3d30095d5e gearbox: replace paster with something TurboGears2-ish that still works with the Pylons stack
Mads Kiilerich <madski@unity3d.com>
parents: 6377
diff changeset
428 [logger_gearbox]
7193
150173a027ee ini: set default log level to WARN
domruf <dominikruf@gmail.com>
parents: 7159
diff changeset
429 #level = WARN
6554
2c3d30095d5e gearbox: replace paster with something TurboGears2-ish that still works with the Pylons stack
Mads Kiilerich <madski@unity3d.com>
parents: 6377
diff changeset
430 level = DEBUG
2c3d30095d5e gearbox: replace paster with something TurboGears2-ish that still works with the Pylons stack
Mads Kiilerich <madski@unity3d.com>
parents: 6377
diff changeset
431 handlers =
2c3d30095d5e gearbox: replace paster with something TurboGears2-ish that still works with the Pylons stack
Mads Kiilerich <madski@unity3d.com>
parents: 6377
diff changeset
432 qualname = gearbox
2c3d30095d5e gearbox: replace paster with something TurboGears2-ish that still works with the Pylons stack
Mads Kiilerich <madski@unity3d.com>
parents: 6377
diff changeset
433
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents: 10
diff changeset
434 [logger_sqlalchemy]
6625
05d09cec7b26 logging: don't change the log level in the handler config
domruf <dominikruf@gmail.com>
parents: 6623
diff changeset
435 level = WARN
7768
609d52bbf917 ini: create separate log handlers for color and null, and add comments hinting how they can be used
Mads Kiilerich <mads@kiilerich.com>
parents: 7767
diff changeset
436 handlers =
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents: 10
diff changeset
437 qualname = sqlalchemy.engine
8354
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
438 ## For coloring based on log level and pretty printing of SQL:
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
439 #level = INFO
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
440 #handlers = console_color_sql
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
441 #propagate = 0
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents: 10
diff changeset
442
2102
04d26165c3d9 Whoosh logging is now controlled by the .ini files logging setup
Marcin Kuzminski <marcin@python-works.com>
parents: 2016
diff changeset
443 [logger_whoosh_indexer]
7193
150173a027ee ini: set default log level to WARN
domruf <dominikruf@gmail.com>
parents: 7159
diff changeset
444 #level = WARN
2102
04d26165c3d9 Whoosh logging is now controlled by the .ini files logging setup
Marcin Kuzminski <marcin@python-works.com>
parents: 2016
diff changeset
445 level = DEBUG
4068
17e3926c3753 added ini files into codecleaner
Marcin Kuzminski <marcin@python-works.com>
parents: 4066
diff changeset
446 handlers =
2102
04d26165c3d9 Whoosh logging is now controlled by the .ini files logging setup
Marcin Kuzminski <marcin@python-works.com>
parents: 2016
diff changeset
447 qualname = whoosh_indexer
04d26165c3d9 Whoosh logging is now controlled by the .ini files logging setup
Marcin Kuzminski <marcin@python-works.com>
parents: 2016
diff changeset
448
7194
6ae76150acbd logging: add missing logging config for werkzeug and backlash
domruf <dominikruf@gmail.com>
parents: 7193
diff changeset
449 [logger_werkzeug]
6ae76150acbd logging: add missing logging config for werkzeug and backlash
domruf <dominikruf@gmail.com>
parents: 7193
diff changeset
450 level = WARN
6ae76150acbd logging: add missing logging config for werkzeug and backlash
domruf <dominikruf@gmail.com>
parents: 7193
diff changeset
451 handlers =
6ae76150acbd logging: add missing logging config for werkzeug and backlash
domruf <dominikruf@gmail.com>
parents: 7193
diff changeset
452 qualname = werkzeug
6ae76150acbd logging: add missing logging config for werkzeug and backlash
domruf <dominikruf@gmail.com>
parents: 7193
diff changeset
453
6ae76150acbd logging: add missing logging config for werkzeug and backlash
domruf <dominikruf@gmail.com>
parents: 7193
diff changeset
454 [logger_backlash]
6ae76150acbd logging: add missing logging config for werkzeug and backlash
domruf <dominikruf@gmail.com>
parents: 7193
diff changeset
455 level = WARN
6ae76150acbd logging: add missing logging config for werkzeug and backlash
domruf <dominikruf@gmail.com>
parents: 7193
diff changeset
456 handlers =
6ae76150acbd logging: add missing logging config for werkzeug and backlash
domruf <dominikruf@gmail.com>
parents: 7193
diff changeset
457 qualname = backlash
6ae76150acbd logging: add missing logging config for werkzeug and backlash
domruf <dominikruf@gmail.com>
parents: 7193
diff changeset
458
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents: 10
diff changeset
459 ##############
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
460 ## HANDLERS ##
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents: 10
diff changeset
461 ##############
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
462
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
463 [handler_console]
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
464 class = StreamHandler
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
465 args = (sys.stderr,)
7768
609d52bbf917 ini: create separate log handlers for color and null, and add comments hinting how they can be used
Mads Kiilerich <mads@kiilerich.com>
parents: 7767
diff changeset
466 formatter = generic
609d52bbf917 ini: create separate log handlers for color and null, and add comments hinting how they can be used
Mads Kiilerich <mads@kiilerich.com>
parents: 7767
diff changeset
467
609d52bbf917 ini: create separate log handlers for color and null, and add comments hinting how they can be used
Mads Kiilerich <mads@kiilerich.com>
parents: 7767
diff changeset
468 [handler_console_color]
8354
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
469 ## ANSI color coding based on log level
7768
609d52bbf917 ini: create separate log handlers for color and null, and add comments hinting how they can be used
Mads Kiilerich <mads@kiilerich.com>
parents: 7767
diff changeset
470 class = StreamHandler
609d52bbf917 ini: create separate log handlers for color and null, and add comments hinting how they can be used
Mads Kiilerich <mads@kiilerich.com>
parents: 7767
diff changeset
471 args = (sys.stderr,)
153
a5a3bcc5ee89 Added colored formatter to project, and configs
Marcin Kuzminski <marcin@python-works.com>
parents: 107
diff changeset
472 formatter = color_formatter
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
473
7768
609d52bbf917 ini: create separate log handlers for color and null, and add comments hinting how they can be used
Mads Kiilerich <mads@kiilerich.com>
parents: 7767
diff changeset
474 [handler_console_color_sql]
8354
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
475 ## ANSI color coding and pretty printing of SQL statements
1186
b9ea10d3e419 timperproxy will just measure the time of queries, and formatting will be handled by the new sql_formatter of queries from sqlalchemy itself. Updated ini files for new way logging
Marcin Kuzminski <marcin@python-works.com>
parents: 1116
diff changeset
476 class = StreamHandler
b9ea10d3e419 timperproxy will just measure the time of queries, and formatting will be handled by the new sql_formatter of queries from sqlalchemy itself. Updated ini files for new way logging
Marcin Kuzminski <marcin@python-works.com>
parents: 1116
diff changeset
477 args = (sys.stderr,)
b9ea10d3e419 timperproxy will just measure the time of queries, and formatting will be handled by the new sql_formatter of queries from sqlalchemy itself. Updated ini files for new way logging
Marcin Kuzminski <marcin@python-works.com>
parents: 1116
diff changeset
478 formatter = color_formatter_sql
b9ea10d3e419 timperproxy will just measure the time of queries, and formatting will be handled by the new sql_formatter of queries from sqlalchemy itself. Updated ini files for new way logging
Marcin Kuzminski <marcin@python-works.com>
parents: 1116
diff changeset
479
7768
609d52bbf917 ini: create separate log handlers for color and null, and add comments hinting how they can be used
Mads Kiilerich <mads@kiilerich.com>
parents: 7767
diff changeset
480 [handler_null]
609d52bbf917 ini: create separate log handlers for color and null, and add comments hinting how they can be used
Mads Kiilerich <mads@kiilerich.com>
parents: 7767
diff changeset
481 class = NullHandler
609d52bbf917 ini: create separate log handlers for color and null, and add comments hinting how they can be used
Mads Kiilerich <mads@kiilerich.com>
parents: 7767
diff changeset
482 args = ()
609d52bbf917 ini: create separate log handlers for color and null, and add comments hinting how they can be used
Mads Kiilerich <mads@kiilerich.com>
parents: 7767
diff changeset
483
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents: 10
diff changeset
484 ################
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
485 ## FORMATTERS ##
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents: 10
diff changeset
486 ################
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
487
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
488 [formatter_generic]
153
a5a3bcc5ee89 Added colored formatter to project, and configs
Marcin Kuzminski <marcin@python-works.com>
parents: 107
diff changeset
489 format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s
46
9db7782727b3 Static files for production fixed
Marcin Kuzminski <marcin@python-blog.com>
parents: 41
diff changeset
490 datefmt = %Y-%m-%d %H:%M:%S
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
491
153
a5a3bcc5ee89 Added colored formatter to project, and configs
Marcin Kuzminski <marcin@python-works.com>
parents: 107
diff changeset
492 [formatter_color_formatter]
5364
a478cad966b1 ini: consistently write #-disabled lines without space after # and with single space around =
Mads Kiilerich <madski@unity3d.com>
parents: 5363
diff changeset
493 class = kallithea.lib.colored_formatter.ColorFormatter
a478cad966b1 ini: consistently write #-disabled lines without space after # and with single space around =
Mads Kiilerich <madski@unity3d.com>
parents: 5363
diff changeset
494 format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s
1186
b9ea10d3e419 timperproxy will just measure the time of queries, and formatting will be handled by the new sql_formatter of queries from sqlalchemy itself. Updated ini files for new way logging
Marcin Kuzminski <marcin@python-works.com>
parents: 1116
diff changeset
495 datefmt = %Y-%m-%d %H:%M:%S
b9ea10d3e419 timperproxy will just measure the time of queries, and formatting will be handled by the new sql_formatter of queries from sqlalchemy itself. Updated ini files for new way logging
Marcin Kuzminski <marcin@python-works.com>
parents: 1116
diff changeset
496
b9ea10d3e419 timperproxy will just measure the time of queries, and formatting will be handled by the new sql_formatter of queries from sqlalchemy itself. Updated ini files for new way logging
Marcin Kuzminski <marcin@python-works.com>
parents: 1116
diff changeset
497 [formatter_color_formatter_sql]
5364
a478cad966b1 ini: consistently write #-disabled lines without space after # and with single space around =
Mads Kiilerich <madski@unity3d.com>
parents: 5363
diff changeset
498 class = kallithea.lib.colored_formatter.ColorFormatterSql
a478cad966b1 ini: consistently write #-disabled lines without space after # and with single space around =
Mads Kiilerich <madski@unity3d.com>
parents: 5363
diff changeset
499 format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s
1278
2b098619e238 changed dafault to use sqlite for dev
Marcin Kuzminski <marcin@python-works.com>
parents: 1186
diff changeset
500 datefmt = %Y-%m-%d %H:%M:%S
7788
3ea66ef563f2 kallithea-cli: use null handler to mute all console logging for ssh-serve
Mads Kiilerich <mads@kiilerich.com>
parents: 7785
diff changeset
501
3ea66ef563f2 kallithea-cli: use null handler to mute all console logging for ssh-serve
Mads Kiilerich <mads@kiilerich.com>
parents: 7785
diff changeset
502 #################
3ea66ef563f2 kallithea-cli: use null handler to mute all console logging for ssh-serve
Mads Kiilerich <mads@kiilerich.com>
parents: 7785
diff changeset
503 ## SSH LOGGING ##
3ea66ef563f2 kallithea-cli: use null handler to mute all console logging for ssh-serve
Mads Kiilerich <mads@kiilerich.com>
parents: 7785
diff changeset
504 #################
3ea66ef563f2 kallithea-cli: use null handler to mute all console logging for ssh-serve
Mads Kiilerich <mads@kiilerich.com>
parents: 7785
diff changeset
505
8354
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
506 ## The default loggers use 'handler_console' that uses StreamHandler with
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
507 ## destination 'sys.stderr'. In the context of the SSH server process, these log
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
508 ## messages would be sent to the client, which is normally not what you want.
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
509 ## By default, when running ssh-serve, just use NullHandler and disable logging
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
510 ## completely. For other logging options, see:
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
511 ## https://docs.python.org/2/library/logging.handlers.html
7788
3ea66ef563f2 kallithea-cli: use null handler to mute all console logging for ssh-serve
Mads Kiilerich <mads@kiilerich.com>
parents: 7785
diff changeset
512
3ea66ef563f2 kallithea-cli: use null handler to mute all console logging for ssh-serve
Mads Kiilerich <mads@kiilerich.com>
parents: 7785
diff changeset
513 [ssh_serve:logger_root]
3ea66ef563f2 kallithea-cli: use null handler to mute all console logging for ssh-serve
Mads Kiilerich <mads@kiilerich.com>
parents: 7785
diff changeset
514 level = CRITICAL
3ea66ef563f2 kallithea-cli: use null handler to mute all console logging for ssh-serve
Mads Kiilerich <mads@kiilerich.com>
parents: 7785
diff changeset
515 handlers = null
3ea66ef563f2 kallithea-cli: use null handler to mute all console logging for ssh-serve
Mads Kiilerich <mads@kiilerich.com>
parents: 7785
diff changeset
516
8354
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
517 ## Note: If logging is configured with other handlers, they might need similar
ef9fd1434270 ini: be more consistent about how # is used in the config template
Mads Kiilerich <mads@kiilerich.com>
parents: 8346
diff changeset
518 ## muting for ssh-serve too.