Changeset - ef9fd1434270
Parent rev.
Child rev.
[Not reviewed]
default
0 3 0
Mads Kiilerich - 6 years ago 2020-04-22 20:47:02
mads@kiilerich.com
Grafted from: f06099fb8a68
ini: be more consistent about how # is used in the config template
3 files changed with 74 insertions and 67 deletions:
development.ini
31
31
kallithea/lib/paster_commands/template.ini.mako
36
36
scripts/generate-ini.py
7
0 comments (0 inline, 0 general)
development.ini
➞
Show inline comments
 
################################################################################
 
################################################################################
 
# Kallithea - config file generated with kallithea-config                      #
 
#                                                                              #
 
# The %(here)s variable will be replaced with the parent directory of this file#
 
################################################################################
 
################################################################################
 
###################################################################################
 
###################################################################################
 
## Kallithea config file generated with kallithea-config                         ##
 
##                                                                               ##
 
## The %(here)s variable will be replaced with the parent directory of this file ##
 
###################################################################################
 
###################################################################################
 

			




	
	
	
		
 
[DEFAULT]

			




	
	
	
		
 

			




	
	
	
		
 
################################################################################

			




	
	
	
		
 
## Email settings                                                             ##

			




	
	
	
		
 
##                                                                            ##

			




	
	
	
		
 
## Refer to the documentation ("Email settings") for more details.            ##

			




	
	
	
		
 
##                                                                            ##

			




	
	
	
		
 
## It is recommended to use a valid sender address that passes access         ##

			




	
	
	
		
 
## validation and spam filtering in mail servers.                             ##

			




	
	
	
		
 
################################################################################

			




	
	
	
		
 

			




	
	
		
 
@@ -117,25 +117,25 @@ force_https = false

			




	
	
	
		
 
use_htsts = false

			




	
	
	
		
 

			




	
	
	
		
 
## number of commits stats will parse on each iteration

			




	
	
	
		
 
commit_parse_limit = 25

			




	
	
	
		
 

			




	
	
	
		
 
## Path to Python executable to be used for git hooks.

			




	
	
	
		
 
## This value will be written inside the git hook scripts as the text

			




	
	
	
		
 
## after '#!' (shebang). When empty or not defined, the value of

			




	
	
	
		
 
## 'sys.executable' at the time of installation of the git hooks is

			




	
	
	
		
 
## used, which is correct in many cases but for example not when using uwsgi.

			




	
	
	
		
 
## If you change this setting, you should reinstall the Git hooks via

			




	
	
	
		
 
## Admin > Settings > Remap and Rescan.

			




	
	
	
		
 
# git_hook_interpreter = /srv/kallithea/venv/bin/python3

			




	
	
	
		
 
#git_hook_interpreter = /srv/kallithea/venv/bin/python3

			




	
	
	
		
 

			




	
	
	
		
 
## path to git executable

			




	
	
	
		
 
git_path = git

			




	
	
	
		
 

			




	
	
	
		
 
## git rev filter option, --all is the default filter, if you need to

			




	
	
	
		
 
## hide all refs in changelog switch this to --branches --tags

			




	
	
	
		
 
#git_rev_filter = --branches --tags

			




	
	
	
		
 

			




	
	
	
		
 
## RSS feed options

			




	
	
	
		
 
rss_cut_off_limit = 256000

			




	
	
	
		
 
rss_items_per_page = 10

			




	
	
	
		
 
rss_include_diff = false

			




	
	
		
 
@@ -189,48 +189,48 @@ issue_pat = #(\d+)

			




	
	
	
		
 
issue_server_link = https://issues.example.com/{repo}/issue/\1

			




	
	
	
		
 

			




	
	
	
		
 
## substitution pattern to use as the link text

			




	
	
	
		
 
## If issue_sub is empty, the text matched by issue_pat is retained verbatim

			




	
	
	
		
 
## for the link text. Otherwise, the link text is that of issue_sub, with any

			




	
	
	
		
 
## backreferences to groups in issue_pat replaced.

			




	
	
	
		
 

			




	
	
	
		
 
issue_sub =

			




	
	
	
		
 

			




	
	
	
		
 
## issue_pat, issue_server_link and issue_sub can have suffixes to specify

			




	
	
	
		
 
## multiple patterns, to other issues server, wiki or others

			




	
	
	
		
 
## below an example how to create a wiki pattern

			




	
	
	
		
 
# wiki-some-id -> https://wiki.example.com/some-id

			




	
	
	
		
 
## wiki-some-id -> https://wiki.example.com/some-id

			




	
	
	
		
 

			




	
	
	
		
 
#issue_pat_wiki = wiki-(\S+)

			




	
	
	
		
 
#issue_server_link_wiki = https://wiki.example.com/\1

			




	
	
	
		
 
#issue_sub_wiki = WIKI-\1

			




	
	
	
		
 

			




	
	
	
		
 
## alternative return HTTP header for failed authentication. Default HTTP

			




	
	
	
		
 
## response is 401 HTTPUnauthorized. Currently Mercurial clients have trouble with

			




	
	
	
		
 
## handling that. Set this variable to 403 to return HTTPForbidden

			




	
	
	
		
 
auth_ret_code =

			




	
	
	
		
 

			




	
	
	
		
 
## allows to change the repository location in settings page

			




	
	
	
		
 
allow_repo_location_change = True

			




	
	
	
		
 

			




	
	
	
		
 
## allows to setup custom hooks in settings page

			




	
	
	
		
 
allow_custom_hooks_settings = True

			




	
	
	
		
 

			




	
	
	
		
 
## extra extensions for indexing, space separated and without the leading '.'.

			




	
	
	
		
 
# index.extensions =

			




	
	
	
		
 
#index.extensions =

			




	
	
	
		
 
#    gemfile

			




	
	
	
		
 
#    lock

			




	
	
	
		
 

			




	
	
	
		
 
## extra filenames for indexing, space separated

			




	
	
	
		
 
# index.filenames =

			




	
	
	
		
 
#index.filenames =

			




	
	
	
		
 
#    .dockerignore

			




	
	
	
		
 
#    .editorconfig

			




	
	
	
		
 
#    INSTALL

			




	
	
	
		
 
#    CHANGELOG

			




	
	
	
		
 

			




	
	
	
		
 
####################################

			




	
	
	
		
 
###           SSH CONFIG        ####

			




	
	
	
		
 
####################################

			




	
	
	
		
 

			




	
	
	
		
 
## SSH is disabled by default, until an Administrator decides to enable it.

			




	
	
	
		
 
ssh_enabled = false

			




	
	
	
		
 

			




	
	
		
 
@@ -313,26 +313,26 @@ session.secret = development-not-secret

			




	
	
	
		
 
## Cookie only, store all session data inside the cookie. Requires secure secrets.

			




	
	
	
		
 
#session.type = cookie

			




	
	
	
		
 

			




	
	
	
		
 
## Database storage of session data.

			




	
	
	
		
 
#session.type = ext:database

			




	
	
	
		
 
#session.sa.url = postgresql://postgres:qwe@localhost/kallithea

			




	
	
	
		
 
#session.table_name = db_session

			




	
	
	
		
 

			




	
	
	
		
 
############################

			




	
	
	
		
 
## ERROR HANDLING SYSTEMS ##

			




	
	
	
		
 
############################

			




	
	
	
		
 

			




	
	
	
		
 
# Propagate email settings to ErrorReporter of TurboGears2

			




	
	
	
		
 
# You do not normally need to change these lines

			




	
	
	
		
 
## Propagate email settings to ErrorReporter of TurboGears2

			




	
	
	
		
 
## You do not normally need to change these lines

			




	
	
	
		
 
get trace_errors.smtp_server = smtp_server

			




	
	
	
		
 
get trace_errors.smtp_port = smtp_port

			




	
	
	
		
 
get trace_errors.from_address = error_email_from

			




	
	
	
		
 
get trace_errors.error_email = email_to

			




	
	
	
		
 
get trace_errors.smtp_username = smtp_username

			




	
	
	
		
 
get trace_errors.smtp_password = smtp_password

			




	
	
	
		
 
get trace_errors.smtp_use_tls = smtp_use_tls

			




	
	
	
		
 

			




	
	
	
		
 
################################################################################

			




	
	
	
		
 
## WARNING: *DEBUG MODE MUST BE OFF IN A PRODUCTION ENVIRONMENT*              ##

			




	
	
	
		
 
## Debug mode will enable the interactive debugging tool, allowing ANYONE to  ##

			




	
	
	
		
 
## execute malicious code after an exception is raised.                       ##

			




	
	
		
 
@@ -343,28 +343,28 @@ debug = true

			




	
	
	
		
 
##################################

			




	
	
	
		
 
###       LOGVIEW CONFIG       ###

			




	
	
	
		
 
##################################

			




	
	
	
		
 

			




	
	
	
		
 
logview.sqlalchemy = #faa

			




	
	
	
		
 
logview.pylons.templating = #bfb

			




	
	
	
		
 
logview.pylons.util = #eee

			




	
	
	
		
 

			




	
	
	
		
 
#########################################################

			




	
	
	
		
 
### DB CONFIGS - EACH DB WILL HAVE IT'S OWN CONFIG    ###

			




	
	
	
		
 
#########################################################

			




	
	
	
		
 

			




	
	
	
		
 
# SQLITE [default]

			




	
	
	
		
 
## SQLITE [default]

			




	
	
	
		
 
sqlalchemy.url = sqlite:///%(here)s/kallithea.db?timeout=60

			




	
	
	
		
 

			




	
	
	
		
 
# see sqlalchemy docs for others

			




	
	
	
		
 
## see sqlalchemy docs for other backends

			




	
	
	
		
 

			




	
	
	
		
 
sqlalchemy.pool_recycle = 3600

			




	
	
	
		
 

			




	
	
	
		
 
################################

			




	
	
	
		
 
### ALEMBIC CONFIGURATION   ####

			




	
	
	
		
 
################################

			




	
	
	
		
 

			




	
	
	
		
 
[alembic]

			




	
	
	
		
 
script_location = kallithea:alembic

			




	
	
	
		
 

			




	
	
	
		
 
################################

			




	
	
	
		
 
### LOGGING CONFIGURATION   ####

			




	
	
		
 
@@ -378,26 +378,26 @@ keys = console, console_color, console_c

			




	
	
	
		
 

			




	
	
	
		
 
[formatters]

			




	
	
	
		
 
keys = generic, color_formatter, color_formatter_sql

			




	
	
	
		
 

			




	
	
	
		
 
#############

			




	
	
	
		
 
## LOGGERS ##

			




	
	
	
		
 
#############

			




	
	
	
		
 

			




	
	
	
		
 
[logger_root]

			




	
	
	
		
 
level = NOTSET

			




	
	
	
		
 
#handlers = console

			




	
	
	
		
 
handlers = console_color

			




	
	
	
		
 
# For coloring based on log level:

			




	
	
	
		
 
# handlers = console_color

			




	
	
	
		
 
## For coloring based on log level:

			




	
	
	
		
 
#handlers = console_color

			




	
	
	
		
 

			




	
	
	
		
 
[logger_routes]

			




	
	
	
		
 
#level = WARN

			




	
	
	
		
 
level = DEBUG

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = routes.middleware

			




	
	
	
		
 
## "level = DEBUG" logs the route matched and routing variables.

			




	
	
	
		
 

			




	
	
	
		
 
[logger_beaker]

			




	
	
	
		
 
#level = WARN

			




	
	
	
		
 
level = DEBUG

			




	
	
	
		
 
handlers =

			




	
	
		
 
@@ -422,28 +422,28 @@ handlers =

			




	
	
	
		
 
qualname = tg

			




	
	
	
		
 

			




	
	
	
		
 
[logger_gearbox]

			




	
	
	
		
 
#level = WARN

			




	
	
	
		
 
level = DEBUG

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = gearbox

			




	
	
	
		
 

			




	
	
	
		
 
[logger_sqlalchemy]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = sqlalchemy.engine

			




	
	
	
		
 
# For coloring based on log level and pretty printing of SQL:

			




	
	
	
		
 
# level = INFO

			




	
	
	
		
 
# handlers = console_color_sql

			




	
	
	
		
 
# propagate = 0

			




	
	
	
		
 
## For coloring based on log level and pretty printing of SQL:

			




	
	
	
		
 
#level = INFO

			




	
	
	
		
 
#handlers = console_color_sql

			




	
	
	
		
 
#propagate = 0

			




	
	
	
		
 

			




	
	
	
		
 
[logger_whoosh_indexer]

			




	
	
	
		
 
#level = WARN

			




	
	
	
		
 
level = DEBUG

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = whoosh_indexer

			




	
	
	
		
 

			




	
	
	
		
 
[logger_werkzeug]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = werkzeug

			




	
	
	
		
 

			




	
	
		
 
@@ -453,31 +453,31 @@ handlers =

			




	
	
	
		
 
qualname = backlash

			




	
	
	
		
 

			




	
	
	
		
 
##############

			




	
	
	
		
 
## HANDLERS ##

			




	
	
	
		
 
##############

			




	
	
	
		
 

			




	
	
	
		
 
[handler_console]

			




	
	
	
		
 
class = StreamHandler

			




	
	
	
		
 
args = (sys.stderr,)

			




	
	
	
		
 
formatter = generic

			




	
	
	
		
 

			




	
	
	
		
 
[handler_console_color]

			




	
	
	
		
 
# ANSI color coding based on log level

			




	
	
	
		
 
## ANSI color coding based on log level

			




	
	
	
		
 
class = StreamHandler

			




	
	
	
		
 
args = (sys.stderr,)

			




	
	
	
		
 
formatter = color_formatter

			




	
	
	
		
 

			




	
	
	
		
 
[handler_console_color_sql]

			




	
	
	
		
 
# ANSI color coding and pretty printing of SQL statements

			




	
	
	
		
 
## ANSI color coding and pretty printing of SQL statements

			




	
	
	
		
 
class = StreamHandler

			




	
	
	
		
 
args = (sys.stderr,)

			




	
	
	
		
 
formatter = color_formatter_sql

			




	
	
	
		
 

			




	
	
	
		
 
[handler_null]

			




	
	
	
		
 
class = NullHandler

			




	
	
	
		
 
args = ()

			




	
	
	
		
 

			




	
	
	
		
 
################

			




	
	
	
		
 
## FORMATTERS ##

			




	
	
	
		
 
################

			




	
	
	
		
 

			




	
	
		
 
@@ -490,25 +490,25 @@ class = kallithea.lib.colored_formatter.

			




	
	
	
		
 
format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s

			




	
	
	
		
 
datefmt = %Y-%m-%d %H:%M:%S

			




	
	
	
		
 

			




	
	
	
		
 
[formatter_color_formatter_sql]

			




	
	
	
		
 
class = kallithea.lib.colored_formatter.ColorFormatterSql

			




	
	
	
		
 
format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s

			




	
	
	
		
 
datefmt = %Y-%m-%d %H:%M:%S

			




	
	
	
		
 

			




	
	
	
		
 
#################

			




	
	
	
		
 
## SSH LOGGING ##

			




	
	
	
		
 
#################

			




	
	
	
		
 

			




	
	
	
		
 
# The default loggers use 'handler_console' that uses StreamHandler with

			




	
	
	
		
 
# destination 'sys.stderr'. In the context of the SSH server process, these log

			




	
	
	
		
 
# messages would be sent to the client, which is normally not what you want.

			




	
	
	
		
 
# By default, when running ssh-serve, just use NullHandler and disable logging

			




	
	
	
		
 
# completely. For other logging options, see:

			




	
	
	
		
 
# https://docs.python.org/2/library/logging.handlers.html

			




	
	
	
		
 
## The default loggers use 'handler_console' that uses StreamHandler with

			




	
	
	
		
 
## destination 'sys.stderr'. In the context of the SSH server process, these log

			




	
	
	
		
 
## messages would be sent to the client, which is normally not what you want.

			




	
	
	
		
 
## By default, when running ssh-serve, just use NullHandler and disable logging

			




	
	
	
		
 
## completely. For other logging options, see:

			




	
	
	
		
 
## https://docs.python.org/2/library/logging.handlers.html

			




	
	
	
		
 

			




	
	
	
		
 
[ssh_serve:logger_root]

			




	
	
	
		
 
level = CRITICAL

			




	
	
	
		
 
handlers = null

			




	
	
	
		
 

			




	
	
	
		
 
# Note: If logging is configured with other handlers, they might need similar

			




	
	
	
		
 
# muting for ssh-serve too.

			




	
	
	
		
 
## Note: If logging is configured with other handlers, they might need similar

			




	
	
	
		
 
## muting for ssh-serve too.

			




        

    


    
    

    

        

                

                    kallithea/lib/paster_commands/template.ini.mako
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
	
		
 
## -*- coding: utf-8 -*-

			




	
	
	
		
 
<%text>################################################################################</%text>

			




	
	
	
		
 
<%text>################################################################################</%text>

			




	
	
	
		
 
# Kallithea - config file generated with kallithea-config                      #

			




	
	
	
		
 
#                                                                              #

			




	
	
	
		
 
# The %(here)s variable will be replaced with the parent directory of this file#

			




	
	
	
		
 
<%text>################################################################################</%text>

			




	
	
	
		
 
<%text>################################################################################</%text>

			




	
	
	
		
 
<%text>###################################################################################</%text>

			




	
	
	
		
 
<%text>###################################################################################</%text>

			




	
	
	
		
 
<%text>## Kallithea config file generated with kallithea-config                         ##</%text>

			




	
	
	
		
 
<%text>##                                                                               ##</%text>

			




	
	
	
		
 
<%text>## The %(here)s variable will be replaced with the parent directory of this file ##</%text>

			




	
	
	
		
 
<%text>###################################################################################</%text>

			




	
	
	
		
 
<%text>###################################################################################</%text>

			




	
	
	
		
 

			




	
	
	
		
 
[DEFAULT]

			




	
	
	
		
 

			




	
	
	
		
 
<%text>################################################################################</%text>

			




	
	
	
		
 
<%text>## Email settings                                                             ##</%text>

			




	
	
	
		
 
<%text>##                                                                            ##</%text>

			




	
	
	
		
 
<%text>## Refer to the documentation ("Email settings") for more details.            ##</%text>

			




	
	
	
		
 
<%text>##                                                                            ##</%text>

			




	
	
	
		
 
<%text>## It is recommended to use a valid sender address that passes access         ##</%text>

			




	
	
	
		
 
<%text>## validation and spam filtering in mail servers.                             ##</%text>

			




	
	
	
		
 
<%text>################################################################################</%text>

			




	
	
	
		
 

			




	
	
		
 
@@ -106,37 +106,37 @@ worker_class = sync

			




	
	
	
		
 
max_requests = 1000

			




	
	
	
		
 
<%text>## amount of time a worker can handle request before it gets killed and</%text>

			




	
	
	
		
 
<%text>## restarted</%text>

			




	
	
	
		
 
timeout = 3600

			




	
	
	
		
 

			




	
	
	
		
 
%endif

			




	
	
	
		
 
%else:

			




	
	
	
		
 
<%text>## UWSGI ##</%text>

			




	
	
	
		
 
[uwsgi]

			




	
	
	
		
 
<%text>## Note: this section is parsed by the uWSGI .ini parser when run as:</%text>

			




	
	
	
		
 
<%text>## uwsgi --venv /srv/kallithea/venv --ini-paste-logged my.ini</%text>

			




	
	
	
		
 

			




	
	
	
		
 
# HTTP Basics:

			




	
	
	
		
 
<%text>## HTTP Basics:</%text>

			




	
	
	
		
 
http-socket = ${host}:${port}

			




	
	
	
		
 
buffer-size = 65535                    ; Mercurial will use huge GET headers for discovery

			




	
	
	
		
 

			




	
	
	
		
 
# Scaling:

			




	
	
	
		
 
<%text>## Scaling:</%text>

			




	
	
	
		
 
master = true                          ; Use separate master and worker processes

			




	
	
	
		
 
auto-procname = true                   ; Name worker processes accordingly

			




	
	
	
		
 
lazy = true                            ; App *must* be loaded in workers - db connections can't be shared

			




	
	
	
		
 
workers = 4                            ; On demand scaling up to this many worker processes

			




	
	
	
		
 
cheaper = 1                            ; Initial and on demand scaling down to this many worker processes

			




	
	
	
		
 
max-requests = 1000                    ; Graceful reload of worker processes to avoid leaks

			




	
	
	
		
 

			




	
	
	
		
 
# Tweak defaults:

			




	
	
	
		
 
<%text>## Tweak defaults:</%text>

			




	
	
	
		
 
strict = true                          ; Fail on unknown config directives

			




	
	
	
		
 
enable-threads = true                  ; Enable Python threads (not threaded workers)

			




	
	
	
		
 
vacuum = true                          ; Delete sockets during shutdown

			




	
	
	
		
 
single-interpreter = true

			




	
	
	
		
 
die-on-term = true                     ; Shutdown when receiving SIGTERM (default is respawn)

			




	
	
	
		
 
need-app = true                        ; Exit early if no app can be loaded.

			




	
	
	
		
 

			




	
	
	
		
 
%endif

			




	
	
	
		
 
<%text>## middleware for hosting the WSGI application under a URL prefix</%text>

			




	
	
	
		
 
#[filter:proxy-prefix]

			




	
	
	
		
 
#use = egg:PasteDeploy#prefix

			




	
	
	
		
 
#prefix = /<your-prefix>

			




	
	
		
 
@@ -176,25 +176,25 @@ force_https = false

			




	
	
	
		
 
use_htsts = false

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## number of commits stats will parse on each iteration</%text>

			




	
	
	
		
 
commit_parse_limit = 25

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## Path to Python executable to be used for git hooks.</%text>

			




	
	
	
		
 
<%text>## This value will be written inside the git hook scripts as the text</%text>

			




	
	
	
		
 
<%text>## after '#!' (shebang). When empty or not defined, the value of</%text>

			




	
	
	
		
 
<%text>## 'sys.executable' at the time of installation of the git hooks is</%text>

			




	
	
	
		
 
<%text>## used, which is correct in many cases but for example not when using uwsgi.</%text>

			




	
	
	
		
 
<%text>## If you change this setting, you should reinstall the Git hooks via</%text>

			




	
	
	
		
 
<%text>## Admin > Settings > Remap and Rescan.</%text>

			




	
	
	
		
 
# git_hook_interpreter = /srv/kallithea/venv/bin/python3

			




	
	
	
		
 
#git_hook_interpreter = /srv/kallithea/venv/bin/python3

			




	
	
	
		
 
%if git_hook_interpreter:

			




	
	
	
		
 
git_hook_interpreter = ${git_hook_interpreter}

			




	
	
	
		
 
%endif

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## path to git executable</%text>

			




	
	
	
		
 
git_path = git

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## git rev filter option, --all is the default filter, if you need to</%text>

			




	
	
	
		
 
<%text>## hide all refs in changelog switch this to --branches --tags</%text>

			




	
	
	
		
 
#git_rev_filter = --branches --tags

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## RSS feed options</%text>

			




	
	
		
 
@@ -251,48 +251,48 @@ issue_pat = #(\d+)

			




	
	
	
		
 
issue_server_link = https://issues.example.com/{repo}/issue/\1

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## substitution pattern to use as the link text</%text>

			




	
	
	
		
 
<%text>## If issue_sub is empty, the text matched by issue_pat is retained verbatim</%text>

			




	
	
	
		
 
<%text>## for the link text. Otherwise, the link text is that of issue_sub, with any</%text>

			




	
	
	
		
 
<%text>## backreferences to groups in issue_pat replaced.</%text>

			




	
	
	
		
 

			




	
	
	
		
 
issue_sub =

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## issue_pat, issue_server_link and issue_sub can have suffixes to specify</%text>

			




	
	
	
		
 
<%text>## multiple patterns, to other issues server, wiki or others</%text>

			




	
	
	
		
 
<%text>## below an example how to create a wiki pattern</%text>

			




	
	
	
		
 
# wiki-some-id -> https://wiki.example.com/some-id

			




	
	
	
		
 
<%text>## wiki-some-id -> https://wiki.example.com/some-id</%text>

			




	
	
	
		
 

			




	
	
	
		
 
#issue_pat_wiki = wiki-(\S+)

			




	
	
	
		
 
#issue_server_link_wiki = https://wiki.example.com/\1

			




	
	
	
		
 
#issue_sub_wiki = WIKI-\1

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## alternative return HTTP header for failed authentication. Default HTTP</%text>

			




	
	
	
		
 
<%text>## response is 401 HTTPUnauthorized. Currently Mercurial clients have trouble with</%text>

			




	
	
	
		
 
<%text>## handling that. Set this variable to 403 to return HTTPForbidden</%text>

			




	
	
	
		
 
auth_ret_code =

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## allows to change the repository location in settings page</%text>

			




	
	
	
		
 
allow_repo_location_change = True

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## allows to setup custom hooks in settings page</%text>

			




	
	
	
		
 
allow_custom_hooks_settings = True

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## extra extensions for indexing, space separated and without the leading '.'.</%text>

			




	
	
	
		
 
# index.extensions =

			




	
	
	
		
 
#index.extensions =

			




	
	
	
		
 
#    gemfile

			




	
	
	
		
 
#    lock

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## extra filenames for indexing, space separated</%text>

			




	
	
	
		
 
# index.filenames =

			




	
	
	
		
 
#index.filenames =

			




	
	
	
		
 
#    .dockerignore

			




	
	
	
		
 
#    .editorconfig

			




	
	
	
		
 
#    INSTALL

			




	
	
	
		
 
#    CHANGELOG

			




	
	
	
		
 

			




	
	
	
		
 
<%text>####################################</%text>

			




	
	
	
		
 
<%text>###           SSH CONFIG        ####</%text>

			




	
	
	
		
 
<%text>####################################</%text>

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## SSH is disabled by default, until an Administrator decides to enable it.</%text>

			




	
	
	
		
 
ssh_enabled = false

			




	
	
	
		
 

			




	
	
		
 
@@ -383,26 +383,26 @@ session.secret = ${uuid()}

			




	
	
	
		
 
<%text>## Cookie only, store all session data inside the cookie. Requires secure secrets.</%text>

			




	
	
	
		
 
#session.type = cookie

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## Database storage of session data.</%text>

			




	
	
	
		
 
#session.type = ext:database

			




	
	
	
		
 
#session.sa.url = postgresql://postgres:qwe@localhost/kallithea

			




	
	
	
		
 
#session.table_name = db_session

			




	
	
	
		
 

			




	
	
	
		
 
<%text>############################</%text>

			




	
	
	
		
 
<%text>## ERROR HANDLING SYSTEMS ##</%text>

			




	
	
	
		
 
<%text>############################</%text>

			




	
	
	
		
 

			




	
	
	
		
 
# Propagate email settings to ErrorReporter of TurboGears2

			




	
	
	
		
 
# You do not normally need to change these lines

			




	
	
	
		
 
<%text>## Propagate email settings to ErrorReporter of TurboGears2</%text>

			




	
	
	
		
 
<%text>## You do not normally need to change these lines</%text>

			




	
	
	
		
 
get trace_errors.smtp_server = smtp_server

			




	
	
	
		
 
get trace_errors.smtp_port = smtp_port

			




	
	
	
		
 
get trace_errors.from_address = error_email_from

			




	
	
	
		
 
get trace_errors.error_email = email_to

			




	
	
	
		
 
get trace_errors.smtp_username = smtp_username

			




	
	
	
		
 
get trace_errors.smtp_password = smtp_password

			




	
	
	
		
 
get trace_errors.smtp_use_tls = smtp_use_tls

			




	
	
	
		
 

			




	
	
	
		
 
%if error_aggregation_service == 'appenlight':

			




	
	
	
		
 
<%text>####################</%text>

			




	
	
	
		
 
<%text>### [appenlight] ###</%text>

			




	
	
	
		
 
<%text>####################</%text>

			




	
	
		
 
@@ -489,37 +489,37 @@ debug = false

			




	
	
	
		
 
<%text>###       LOGVIEW CONFIG       ###</%text>

			




	
	
	
		
 
<%text>##################################</%text>

			




	
	
	
		
 

			




	
	
	
		
 
logview.sqlalchemy = #faa

			




	
	
	
		
 
logview.pylons.templating = #bfb

			




	
	
	
		
 
logview.pylons.util = #eee

			




	
	
	
		
 

			




	
	
	
		
 
<%text>#########################################################</%text>

			




	
	
	
		
 
<%text>### DB CONFIGS - EACH DB WILL HAVE IT'S OWN CONFIG    ###</%text>

			




	
	
	
		
 
<%text>#########################################################</%text>

			




	
	
	
		
 

			




	
	
	
		
 
%if database_engine == 'sqlite':

			




	
	
	
		
 
# SQLITE [default]

			




	
	
	
		
 
<%text>## SQLITE [default]</%text>

			




	
	
	
		
 
sqlalchemy.url = sqlite:///%(here)s/kallithea.db?timeout=60

			




	
	
	
		
 

			




	
	
	
		
 
%elif database_engine == 'postgres':

			




	
	
	
		
 
# POSTGRESQL

			




	
	
	
		
 
<%text>## POSTGRESQL</%text>

			




	
	
	
		
 
sqlalchemy.url = postgresql://user:pass@localhost/kallithea

			




	
	
	
		
 

			




	
	
	
		
 
%elif database_engine == 'mysql':

			




	
	
	
		
 
# MySQL

			




	
	
	
		
 
<%text>## MySQL</%text>

			




	
	
	
		
 
sqlalchemy.url = mysql://user:pass@localhost/kallithea?charset=utf8

			




	
	
	
		
 

			




	
	
	
		
 
%endif

			




	
	
	
		
 
# see sqlalchemy docs for others

			




	
	
	
		
 
<%text>## see sqlalchemy docs for other backends</%text>

			




	
	
	
		
 

			




	
	
	
		
 
sqlalchemy.pool_recycle = 3600

			




	
	
	
		
 

			




	
	
	
		
 
<%text>################################</%text>

			




	
	
	
		
 
<%text>### ALEMBIC CONFIGURATION   ####</%text>

			




	
	
	
		
 
<%text>################################</%text>

			




	
	
	
		
 

			




	
	
	
		
 
[alembic]

			




	
	
	
		
 
script_location = kallithea:alembic

			




	
	
	
		
 

			




	
	
	
		
 
<%text>################################</%text>

			




	
	
	
		
 
<%text>### LOGGING CONFIGURATION   ####</%text>

			




	
	
		
 
@@ -532,26 +532,26 @@ keys = root, routes, kallithea, sqlalche

			




	
	
	
		
 
keys = console, console_color, console_color_sql, null

			




	
	
	
		
 

			




	
	
	
		
 
[formatters]

			




	
	
	
		
 
keys = generic, color_formatter, color_formatter_sql

			




	
	
	
		
 

			




	
	
	
		
 
<%text>#############</%text>

			




	
	
	
		
 
<%text>## LOGGERS ##</%text>

			




	
	
	
		
 
<%text>#############</%text>

			




	
	
	
		
 

			




	
	
	
		
 
[logger_root]

			




	
	
	
		
 
level = NOTSET

			




	
	
	
		
 
handlers = console

			




	
	
	
		
 
# For coloring based on log level:

			




	
	
	
		
 
# handlers = console_color

			




	
	
	
		
 
<%text>## For coloring based on log level:</%text>

			




	
	
	
		
 
#handlers = console_color

			




	
	
	
		
 

			




	
	
	
		
 
[logger_routes]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = routes.middleware

			




	
	
	
		
 
<%text>## "level = DEBUG" logs the route matched and routing variables.</%text>

			




	
	
	
		
 

			




	
	
	
		
 
[logger_beaker]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = beaker.container

			




	
	
	
		
 

			




	
	
		
 
@@ -570,28 +570,28 @@ level = WARN

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = tg

			




	
	
	
		
 

			




	
	
	
		
 
[logger_gearbox]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = gearbox

			




	
	
	
		
 

			




	
	
	
		
 
[logger_sqlalchemy]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = sqlalchemy.engine

			




	
	
	
		
 
# For coloring based on log level and pretty printing of SQL:

			




	
	
	
		
 
# level = INFO

			




	
	
	
		
 
# handlers = console_color_sql

			




	
	
	
		
 
# propagate = 0

			




	
	
	
		
 
<%text>## For coloring based on log level and pretty printing of SQL:</%text>

			




	
	
	
		
 
#level = INFO

			




	
	
	
		
 
#handlers = console_color_sql

			




	
	
	
		
 
#propagate = 0

			




	
	
	
		
 

			




	
	
	
		
 
[logger_whoosh_indexer]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = whoosh_indexer

			




	
	
	
		
 

			




	
	
	
		
 
[logger_werkzeug]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = werkzeug

			




	
	
	
		
 

			




	
	
	
		
 
[logger_backlash]

			




	
	
		
 
@@ -600,31 +600,31 @@ handlers =

			




	
	
	
		
 
qualname = backlash

			




	
	
	
		
 

			




	
	
	
		
 
<%text>##############</%text>

			




	
	
	
		
 
<%text>## HANDLERS ##</%text>

			




	
	
	
		
 
<%text>##############</%text>

			




	
	
	
		
 

			




	
	
	
		
 
[handler_console]

			




	
	
	
		
 
class = StreamHandler

			




	
	
	
		
 
args = (sys.stderr,)

			




	
	
	
		
 
formatter = generic

			




	
	
	
		
 

			




	
	
	
		
 
[handler_console_color]

			




	
	
	
		
 
# ANSI color coding based on log level

			




	
	
	
		
 
<%text>## ANSI color coding based on log level</%text>

			




	
	
	
		
 
class = StreamHandler

			




	
	
	
		
 
args = (sys.stderr,)

			




	
	
	
		
 
formatter = color_formatter

			




	
	
	
		
 

			




	
	
	
		
 
[handler_console_color_sql]

			




	
	
	
		
 
# ANSI color coding and pretty printing of SQL statements

			




	
	
	
		
 
<%text>## ANSI color coding and pretty printing of SQL statements</%text>

			




	
	
	
		
 
class = StreamHandler

			




	
	
	
		
 
args = (sys.stderr,)

			




	
	
	
		
 
formatter = color_formatter_sql

			




	
	
	
		
 

			




	
	
	
		
 
[handler_null]

			




	
	
	
		
 
class = NullHandler

			




	
	
	
		
 
args = ()

			




	
	
	
		
 

			




	
	
	
		
 
<%text>################</%text>

			




	
	
	
		
 
<%text>## FORMATTERS ##</%text>

			




	
	
	
		
 
<%text>################</%text>

			




	
	
	
		
 

			




	
	
		
 
@@ -637,25 +637,25 @@ class = kallithea.lib.colored_formatter.

			




	
	
	
		
 
format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s

			




	
	
	
		
 
datefmt = %Y-%m-%d %H:%M:%S

			




	
	
	
		
 

			




	
	
	
		
 
[formatter_color_formatter_sql]

			




	
	
	
		
 
class = kallithea.lib.colored_formatter.ColorFormatterSql

			




	
	
	
		
 
format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s

			




	
	
	
		
 
datefmt = %Y-%m-%d %H:%M:%S

			




	
	
	
		
 

			




	
	
	
		
 
<%text>#################</%text>

			




	
	
	
		
 
<%text>## SSH LOGGING ##</%text>

			




	
	
	
		
 
<%text>#################</%text>

			




	
	
	
		
 

			




	
	
	
		
 
# The default loggers use 'handler_console' that uses StreamHandler with

			




	
	
	
		
 
# destination 'sys.stderr'. In the context of the SSH server process, these log

			




	
	
	
		
 
# messages would be sent to the client, which is normally not what you want.

			




	
	
	
		
 
# By default, when running ssh-serve, just use NullHandler and disable logging

			




	
	
	
		
 
# completely. For other logging options, see:

			




	
	
	
		
 
# https://docs.python.org/2/library/logging.handlers.html

			




	
	
	
		
 
<%text>## The default loggers use 'handler_console' that uses StreamHandler with</%text>

			




	
	
	
		
 
<%text>## destination 'sys.stderr'. In the context of the SSH server process, these log</%text>

			




	
	
	
		
 
<%text>## messages would be sent to the client, which is normally not what you want.</%text>

			




	
	
	
		
 
<%text>## By default, when running ssh-serve, just use NullHandler and disable logging</%text>

			




	
	
	
		
 
<%text>## completely. For other logging options, see:</%text>

			




	
	
	
		
 
<%text>## https://docs.python.org/2/library/logging.handlers.html</%text>

			




	
	
	
		
 

			




	
	
	
		
 
[ssh_serve:logger_root]

			




	
	
	
		
 
level = CRITICAL

			




	
	
	
		
 
handlers = null

			




	
	
	
		
 

			




	
	
	
		
 
# Note: If logging is configured with other handlers, they might need similar

			




	
	
	
		
 
# muting for ssh-serve too.

			




	
	
	
		
 
<%text>## Note: If logging is configured with other handlers, they might need similar</%text>

			




	
	
	
		
 
<%text>## muting for ssh-serve too.</%text>

			




        

    


    
    

    

        

                

                    scripts/generate-ini.py
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -51,20 +51,27 @@ ini_files = [

			




	
	
	
		
 

			




	
	
	
		
 
def main():

			




	
	
	
		
 
    # make sure all mako lines starting with '#' (the '##' comments) are marked up as <text>

			




	
	
	
		
 
    makofile = inifile.template_file

			




	
	
	
		
 
    print('reading:', makofile)

			




	
	
	
		
 
    mako_org = open(makofile).read()

			




	
	
	
		
 
    mako_no_text_markup = re.sub(r'</?%text>', '', mako_org)

			




	
	
	
		
 
    mako_marked_up = re.sub(r'\n(##.*)', r'\n<%text>\1</%text>', mako_no_text_markup, flags=re.MULTILINE)

			




	
	
	
		
 
    if mako_marked_up != mako_org:

			




	
	
	
		
 
        print('writing:', makofile)

			




	
	
	
		
 
        open(makofile, 'w').write(mako_marked_up)

			




	
	
	
		
 

			




	
	
	
		
 
    lines = re.findall(r'\n(# [^ ].*)', mako_marked_up)

			




	
	
	
		
 
    if lines:

			




	
	
	
		
 
        print('ERROR: the template .ini file convention is to use "## Foo Bar" for text comments and "#foo = bar" for disabled settings')

			




	
	
	
		
 
        for line in lines:

			




	
	
	
		
 
            print(line)

			




	
	
	
		
 
        raise SystemExit(1)

			




	
	
	
		
 

			




	
	
	
		
 
    # create ini files

			




	
	
	
		
 
    for fn, settings in ini_files:

			




	
	
	
		
 
        print('updating:', fn)

			




	
	
	
		
 
        inifile.create(fn, None, settings)

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
if __name__ == '__main__':

			




	
	
	
		
 
    main()

			




        

    



    


    



    



      

      





    
    0 comments (0 inline, 0 general)
    





    


  

  







  


    




    








    
        
    
    
        This site is powered by
            Kallithea 0.7.0,
        which is
        © 2010–2025 by various authors & licensed under GPLv3.