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

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

## 'From' header for application emails. You can optionally add a name.

## Default:

#app_email_from = Kallithea

## Examples:

#app_email_from = Kallithea <kallithea-noreply@example.com>

#app_email_from = kallithea-noreply@example.com

## Subject prefix for application emails.

## A space between this prefix and the real subject is automatically added.

## Default:

#email_prefix =

## Example:

#email_prefix = [Kallithea]

## Recipients for error emails and fallback recipients of application mails.

## Multiple addresses can be specified, comma-separated.

## Only addresses are allowed, do not add any name part.

## Default:

#email_to =

## Examples:

#email_to = admin@example.com

#email_to = admin@example.com,another_admin@example.com

email_to =

## 'From' header for error emails. You can optionally add a name.

## Default: (none)

## Examples:

#error_email_from = Kallithea Errors <kallithea-noreply@example.com>

#error_email_from = kallithea_errors@example.com

error_email_from =

## SMTP server settings

## If specifying credentials, make sure to use secure connections.

## Default: Send unencrypted unauthenticated mails to the specified smtp_server.

## For "SSL", use smtp_use_ssl = true and smtp_port = 465.

## For "STARTTLS", use smtp_use_tls = true and smtp_port = 587.

smtp_server =

smtp_username =

smtp_password =

smtp_port =

smtp_use_ssl = false

smtp_use_tls = false

## Entry point for 'gearbox serve'

[server:main]

#host = 127.0.0.1

host = 0.0.0.0

port = 5000

## Gearbox serve uses the Waitress web server ##

use = egg:waitress#main

## avoid multi threading

threads = 1

## allow push of repos bigger than the default of 1 GB

max_request_body_size = 107374182400

## use poll instead of select, fixes fd limits, may not work on old

## windows systems.

#asyncore_use_poll = True

## middleware for hosting the WSGI application under a URL prefix

#[filter:proxy-prefix]

#use = egg:PasteDeploy#prefix

#prefix = /<your-prefix>

[app:main]

use = egg:kallithea

## enable proxy prefix middleware

#filter-with = proxy-prefix

full_stack = true

static_files = true

## Internationalization (see setup documentation for details)

## By default, the languages requested by the browser are used if available, with English as default.

## Set i18n.enabled=false to disable automatic language choice.

#i18n.enabled = true

## To Force a language, set i18n.enabled=false and specify the language in i18n.lang.

## Valid values are the names of subdirectories in kallithea/i18n with a LC_MESSAGES/kallithea.mo

#i18n.lang = en

cache_dir = %(here)s/data

index_dir = %(here)s/data/index

## uncomment and set this path to use archive download cache

archive_cache_dir = %(here)s/data/tarballcache

## change this to unique ID for security

#app_instance_uuid = VERY-SECRET

app_instance_uuid = development-not-secret

## cut off limit for large diffs (size in bytes)

cut_off_limit = 256000

## 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

## 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

## options for showing and identifying changesets

show_sha_length = 12

show_revision_number = false

## Canonical URL to use when creating full URLs in UI and texts.

## Useful when the site is available under different names or protocols.

## Defaults to what is provided in the WSGI environment.

#canonical_url = https://kallithea.example.com/repos

## gist URL alias, used to create nicer urls for gist. This should be an

## url that does rewrites to _admin/gists/<gistid>.

## example: http://gist.example.com/{gistid}. Empty means use the internal

## Kallithea url, ie. http[s]://kallithea.example.com/_admin/gists/<gistid>

gist_alias_url =

## default encoding used to convert from and to unicode

## can be also a comma separated list of encoding in case of mixed encodings

default_encoding = utf-8

## Set Mercurial encoding, similar to setting HGENCODING before launching Kallithea

hgencoding = utf-8

## issue tracker for Kallithea (leave blank to disable, absent for default)

#bugtracker = https://bitbucket.org/conservancy/kallithea/issues

## issue tracking mapping for commit messages, comments, PR descriptions, ...

## Refer to the documentation ("Integration with issue trackers") for more details.

## regular expression to match issue references

## This pattern may/should contain parenthesized groups, that can

## be referred to in issue_server_link or issue_sub using Python backreferences

## (e.g. \1, \2, ...). You can also create named groups with '(?P<groupname>)'.

## To require mandatory whitespace before the issue pattern, use:

## (?:^|(?<=\s)) before the actual pattern, and for mandatory whitespace

## behind the issue pattern, use (?:$|(?=\s)) after the actual pattern.

issue_pat = #(\d+)

## server url to the issue

## This pattern may/should contain backreferences to parenthesized groups in issue_pat.

## A backreference can be \1, \2, ... or \g<groupname> if you specified a named group

## called 'groupname' in issue_pat.

## The special token {repo} is replaced with the full repository name

## including repository groups, while {repo_name} is replaced with just

## the name of the repository.

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

#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

    issue_server_link_wiki = https://wiki.example.com/\g<pagename>

    issue_sub_wiki = WIKI-\g<pagename>

With these settings, wiki pages can be referenced as wiki-some-id, and every

such reference will be transformed into:

.. code-block:: html

  <a href="https://wiki.example.com/some-id">WIKI-some-id</a>

Refer to the `Python regular expression documentation`_ for more details about

the supported syntax in ``issue_pat``, ``issue_server_link`` and ``issue_sub``.

Hook management

---------------

Custom Mercurial hooks can be managed in a similar way to that used in ``.hgrc`` files.

To manage hooks, choose *Admin > Settings > Hooks*.

To add another custom hook simply fill in the first textbox with

``<name>.<hook_type>`` and the second with the hook path. Example hooks

can be found in ``kallithea.lib.hooks``.

Kallithea will also use some hooks internally. They cannot be modified, but

some of them can be enabled or disabled in the *VCS* section.

Kallithea does not actively support custom Git hooks, but hooks can be installed

manually in the file system. Kallithea will install and use the

``post-receive`` Git hook internally, but it will then invoke

``post-receive-custom`` if present.

Changing default encoding

-------------------------

By default, Kallithea uses UTF-8 encoding.

This is configurable as ``default_encoding`` in the .ini file.

This affects many parts in Kallithea including user names, filenames, and

encoding of commit messages. In addition Kallithea can detect if the ``chardet``

library is installed. If ``chardet`` is detected Kallithea will fallback to it

when there are encode/decode errors.

The Mercurial encoding is configurable as ``hgencoding``. It is similar to

setting the ``HGENCODING`` environment variable, but will override it.

Celery configuration

--------------------

Kallithea can use the distributed task queue system Celery_ to run tasks like

cloning repositories or sending emails.

Kallithea will in most setups work perfectly fine out of the box (without

Celery), executing all tasks in the web server process. Some tasks can however

take some time to run and it can be better to run such tasks asynchronously in

a separate process so the web server can focus on serving web requests.

For installation and configuration of Celery, see the `Celery documentation`_.

Note that Celery requires a message broker service like RabbitMQ_ (recommended)

or Redis_.

The use of Celery is configured in the Kallithea ini configuration file.

To enable it, simply set::

  use_celery = true

and add or change the ``celery.*`` configuration variables.

Configuration settings are prefixed with 'celery.', so for example setting

`broker_url` in Celery means setting `celery.broker_url` in the configuration

file.

To start the Celery process, run::

  kallithea-cli celery-run -c my.ini

Extra options to the Celery worker can be passed after ``--`` - see ``-- -h``

for more info.

.. note::

   Make sure you run this command from the same virtualenv, and with the same

   user that Kallithea runs.

HTTPS support

-------------

Kallithea will by default generate URLs based on the WSGI environment.

Alternatively, you can use some special configuration settings to control

directly which scheme/protocol Kallithea will use when generating URLs:

- With ``https_fixup = true``, the scheme will be taken from the

  ``X-Url-Scheme``, ``X-Forwarded-Scheme`` or ``X-Forwarded-Proto`` HTTP header

  (default ``http``).

- With ``use_htsts = true``, Kallithea will set ``Strict-Transport-Security`` when using https.

.. _nginx_virtual_host:

Nginx virtual host example

--------------------------

Sample config for Nginx using proxy:

.. code-block:: nginx

    upstream kallithea {

        server 127.0.0.1:5000;

        # add more instances for load balancing

        #server 127.0.0.1:5001;

        #server 127.0.0.1:5002;

    }

    ## gist alias

    server {

       listen          443;

       server_name     gist.example.com;

       access_log      /var/log/nginx/gist.access.log;

       error_log       /var/log/nginx/gist.error.log;

       ssl on;

       ssl_certificate     gist.your.kallithea.server.crt;

       ssl_certificate_key gist.your.kallithea.server.key;

       ssl_session_timeout 5m;

       ssl_protocols SSLv3 TLSv1;

       ssl_ciphers DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:EDH-RSA-DES-CBC3-SHA:AES256-SHA:DES-CBC3-SHA:AES128-SHA:RC4-SHA:RC4-MD5;

       ssl_prefer_server_ciphers on;

       rewrite ^/(.+)$ https://kallithea.example.com/_admin/gists/$1;

       rewrite (.*)    https://kallithea.example.com/_admin/gists;

    }

    server {

       listen          443;

       server_name     kallithea.example.com

       access_log      /var/log/nginx/kallithea.access.log;

       error_log       /var/log/nginx/kallithea.error.log;

       ssl on;

       ssl_certificate     your.kallithea.server.crt;

       ssl_certificate_key your.kallithea.server.key;

       ssl_session_timeout 5m;

       ssl_protocols SSLv3 TLSv1;

       ssl_ciphers DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:EDH-RSA-DES-CBC3-SHA:AES256-SHA:DES-CBC3-SHA:AES128-SHA:RC4-SHA:RC4-MD5;

       ssl_prefer_server_ciphers on;

       ## uncomment root directive if you want to serve static files by nginx

       ## requires static_files = false in .ini file

       #root /srv/kallithea/kallithea/kallithea/public;

       include         /etc/nginx/proxy.conf;

       location / {

            try_files $uri @kallithea;

       }

       location @kallithea {

            proxy_pass      http://127.0.0.1:5000;

       }

    }

Here's the proxy.conf. It's tuned so it will not timeout on long

pushes or large pushes::

    proxy_redirect              off;

    proxy_set_header            Host $host;

    ## needed for container auth

    #proxy_set_header            REMOTE_USER $remote_user;

    #proxy_set_header            X-Forwarded-User $remote_user;

    proxy_set_header            X-Url-Scheme $scheme;

    proxy_set_header            X-Host $http_host;

    proxy_set_header            X-Real-IP $remote_addr;

    proxy_set_header            X-Forwarded-For $proxy_add_x_forwarded_for;

    proxy_set_header            Proxy-host $proxy_host;

    proxy_buffering             off;

    proxy_connect_timeout       7200;

    proxy_send_timeout          7200;

    proxy_read_timeout          7200;

    proxy_buffers               8 32k;

    client_max_body_size        1024m;

    client_body_buffer_size     128k;

    large_client_header_buffers 8 64k;

.. _apache_virtual_host_reverse_proxy:

Apache virtual host reverse proxy example

%elif http_server == 'gevent':

<%text>##</%text> Gearbox serve uses the gevent web server ##

use = egg:gearbox#gevent

%elif http_server == 'waitress':

<%text>##</%text> Gearbox serve uses the Waitress web server ##

use = egg:waitress#main

<%text>##</%text> avoid multi threading

threads = 1

<%text>##</%text> allow push of repos bigger than the default of 1 GB

max_request_body_size = 107374182400

<%text>##</%text> use poll instead of select, fixes fd limits, may not work on old

<%text>##</%text> windows systems.

#asyncore_use_poll = True

%elif http_server == 'gunicorn':

<%text>##</%text> Gearbox serve uses the Gunicorn web server ##

use = egg:gunicorn#main

<%text>##</%text> number of process workers. You must set `instance_id = *` when this option

<%text>##</%text> is set to more than one worker

workers = 4

<%text>##</%text> process name

proc_name = kallithea

<%text>##</%text> type of worker class, one of sync, eventlet, gevent, tornado

<%text>##</%text> recommended for bigger setup is using of of other than sync one

worker_class = sync

max_requests = 1000

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

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

timeout = 3600

%endif

%else:

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

[uwsgi]

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

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

<%text>##</%text> Note: in uWSGI 2.0.18 or older, pastescript needs to be installed to

<%text>##</%text> get correct application logging. In later versions this is not necessary.

<%text>##</%text> pip install pastescript

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

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

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

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

master = true                          ; Use separate master and worker processes

auto-procname = true                   ; Name worker processes accordingly

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

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

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

strict = true                          ; Fail on unknown config directives

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

vacuum = true                          ; Delete sockets during shutdown

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.

reload-on-exception = true             ; Don't assume that the application worker can process more requests after a severe error

%endif

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

#[filter:proxy-prefix]

#use = egg:PasteDeploy#prefix

#prefix = /<your-prefix>

[app:main]

use = egg:kallithea

<%text>##</%text> enable proxy prefix middleware

#filter-with = proxy-prefix

full_stack = true

static_files = true

<%text>##</%text> Internationalization (see setup documentation for details)

<%text>##</%text> By default, the languages requested by the browser are used if available, with English as default.

<%text>##</%text> Set i18n.enabled=false to disable automatic language choice.

#i18n.enabled = true

<%text>##</%text> To Force a language, set i18n.enabled=false and specify the language in i18n.lang.

<%text>##</%text> Valid values are the names of subdirectories in kallithea/i18n with a LC_MESSAGES/kallithea.mo

#i18n.lang = en

cache_dir = %(here)s/data

index_dir = %(here)s/data/index

<%text>##</%text> uncomment and set this path to use archive download cache

archive_cache_dir = %(here)s/data/tarballcache

<%text>##</%text> change this to unique ID for security

app_instance_uuid = ${uuid()}

<%text>##</%text> cut off limit for large diffs (size in bytes)

cut_off_limit = 256000

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

commit_parse_limit = 25

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

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

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

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

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

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

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

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

%if git_hook_interpreter:

git_hook_interpreter = ${git_hook_interpreter}

%endif

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

git_path = git

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

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

#git_rev_filter = --branches --tags

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

rss_cut_off_limit = 256000

rss_items_per_page = 10

rss_include_diff = false

<%text>##</%text> options for showing and identifying changesets

show_sha_length = 12

show_revision_number = false

<%text>##</%text> Canonical URL to use when creating full URLs in UI and texts.

<%text>##</%text> Useful when the site is available under different names or protocols.

<%text>##</%text> Defaults to what is provided in the WSGI environment.

#canonical_url = https://kallithea.example.com/repos

<%text>##</%text> gist URL alias, used to create nicer urls for gist. This should be an

<%text>##</%text> url that does rewrites to _admin/gists/<gistid>.

<%text>##</%text> example: http://gist.example.com/{gistid}. Empty means use the internal

<%text>##</%text> Kallithea url, ie. http[s]://kallithea.example.com/_admin/gists/<gistid>

gist_alias_url =

<%text>##</%text> default encoding used to convert from and to unicode

<%text>##</%text> can be also a comma separated list of encoding in case of mixed encodings

default_encoding = utf-8

<%text>##</%text> Set Mercurial encoding, similar to setting HGENCODING before launching Kallithea

hgencoding = utf-8

<%text>##</%text> issue tracker for Kallithea (leave blank to disable, absent for default)

#bugtracker = https://bitbucket.org/conservancy/kallithea/issues

<%text>##</%text> issue tracking mapping for commit messages, comments, PR descriptions, ...

<%text>##</%text> Refer to the documentation ("Integration with issue trackers") for more details.

<%text>##</%text> regular expression to match issue references

<%text>##</%text> This pattern may/should contain parenthesized groups, that can

<%text>##</%text> be referred to in issue_server_link or issue_sub using Python backreferences

<%text>##</%text> (e.g. \1, \2, ...). You can also create named groups with '(?P<groupname>)'.

<%text>##</%text> To require mandatory whitespace before the issue pattern, use:

<%text>##</%text> (?:^|(?<=\s)) before the actual pattern, and for mandatory whitespace

<%text>##</%text> behind the issue pattern, use (?:$|(?=\s)) after the actual pattern.

issue_pat = #(\d+)

<%text>##</%text> server url to the issue

<%text>##</%text> This pattern may/should contain backreferences to parenthesized groups in issue_pat.

<%text>##</%text> A backreference can be \1, \2, ... or \g<groupname> if you specified a named group

<%text>##</%text> called 'groupname' in issue_pat.

<%text>##</%text> The special token {repo} is replaced with the full repository name

<%text>##</%text> including repository groups, while {repo_name} is replaced with just

<%text>##</%text> the name of the repository.

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

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

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

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

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

issue_sub =

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

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

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

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

#issue_pat_wiki = wiki-(\S+)

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

#issue_sub_wiki = WIKI-\1

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

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

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

auth_ret_code =