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

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

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;

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