a22edac2be58eaf68d1940d4dfeb88fadbabb43a 0.6.1

## Kallithea config file generated with kallithea-cli                            ##

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

## this file. Other use of % must be escaped as %% .                             ##

##            SSH CONFIG          ##

##         CELERY CONFIG          ##

##          BEAKER CACHE          ##

##        BEAKER SESSION          ##

##        ERROR HANDLING          ##

##        LOGVIEW CONFIG        ##

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

##      DB CONFIG      ##

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

##   ALEMBIC CONFIGURATION    ##

##   LOGGING CONFIGURATION    ##

1. **Prepare environment and external dependencies.**

    Kallithea needs:

    * A filesystem where the Mercurial and Git repositories can be stored.

    * A database where meta data can be stored.

    * A Python environment where the Kallithea application and its dependencies

      can be installed.

    * A web server that can host the Kallithea web application using the WSGI

      API.

2. **Install Kallithea software.**

    This makes the ``kallithea-cli`` command line tool available.

3. **Create low level configuration file.**

    Use ``kallithea-cli config-create`` to create a ``.ini`` file with database

    connection info, mail server information, some web server configuration,

    etc.

4. **Populate the database.**

    Use ``kallithea-cli db-create`` with the ``.ini`` file to create the

    database schema and insert the most basic information: the location of the

    repository store and an initial local admin user.

5. **Configure the web server.**

    The web server must invoke the WSGI entrypoint for the Kallithea software

    using the ``.ini`` file (and thus the database). This makes the web

    application available so the local admin user can log in and tweak the

    configuration further.

6. **Configure users.**

    The initial admin user can create additional local users, or configure how

    users can be created and authenticated from other user directories.

See the subsequent sections, the separate OS-specific instructions, and

:ref:`setup` for details on these steps.

{% endblock %}

        'version': kallithea.__version__,

    def _request(self, url, body=None):

        msg = None

            msg = rdoc.read()

                    "error": "%s\n%r" % (e, msg)}

    'version': '',

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

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

<%text>##</%text> Kallithea config file generated with kallithea-cli ${'%-27s' % version       }##

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

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

<%text>##</%text> this file. Other use of % must be escaped as %% .                             ##

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

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

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

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

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

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

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

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

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

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

<%text>##</%text> 'From' header for application emails. You can optionally add a name.

<%text>##</%text> Default:

<%text>##</%text> Examples:

<%text>##</%text> Subject prefix for application emails.

<%text>##</%text> A space between this prefix and the real subject is automatically added.

<%text>##</%text> Default:

<%text>##</%text> Example:

<%text>##</%text> Recipients for error emails and fallback recipients of application mails.

<%text>##</%text> Multiple addresses can be specified, comma-separated.

<%text>##</%text> Only addresses are allowed, do not add any name part.

<%text>##</%text> Default:

<%text>##</%text> Examples:

<%text>##</%text> 'From' header for error emails. You can optionally add a name.

<%text>##</%text> Default: (none)

<%text>##</%text> Examples:

<%text>##</%text> SMTP server settings

<%text>##</%text> If specifying credentials, make sure to use secure connections.

<%text>##</%text> Default: Send unencrypted unauthenticated mails to the specified smtp_server.

<%text>##</%text> For "SSL", use smtp_use_ssl = true and smtp_port = 465.

<%text>##</%text> For "STARTTLS", use smtp_use_tls = true and smtp_port = 587.

<%text>##</%text> Entry point for 'gearbox serve'

<%text>##</%text> Gearbox default web server ##

<%text>##</%text> nr of worker threads to spawn

<%text>##</%text> max request before thread respawn

<%text>##</%text> option to use threads of process

<%text>##</%text> Gearbox gevent web server ##

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

<%text>##</%text> number of worker threads

<%text>##</%text> MAX BODY SIZE 100GB

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

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

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

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

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

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

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

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

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

<%text>##</%text> 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:

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

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

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

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

<%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.

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

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

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

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

<%text>##</%text> force https in Kallithea, fixes https redirects, assumes it's always https

<%text>##</%text> use Strict-Transport-Security headers

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

<%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.

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

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

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

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

<%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.

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

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

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

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

<%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.

<%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.

<%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.

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

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

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

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

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

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

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

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

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

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

<%text>##</%text> File where users' SSH keys will be stored *if* ssh_enabled is true.

<%text>##</%text> Path to be used in ssh_authorized_keys file to invoke kallithea-cli with ssh-serve.

<%text>##</%text> Locale to be used in the ssh-serve command.

<%text>##</%text> This is needed because an SSH client may try to use its own locale

<%text>##</%text> settings, which may not be available on the server.

<%text>##</%text> See `locale -a` for valid values on this system.

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

<%text>##</%text>         CELERY CONFIG          ##

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

<%text>##</%text> Note: Celery doesn't support Windows.

<%text>##</%text> Celery config settings from https://docs.celeryproject.org/en/4.4.0/userguide/configuration.html prefixed with 'celery.'.

<%text>##</%text> Example: use the message queue on the local virtual host 'kallitheavhost' as the RabbitMQ user 'kallithea':

<%text>##</%text> If true, tasks will never be sent to the queue, but executed locally instead.

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

<%text>##</%text>          BEAKER CACHE          ##

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

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

<%text>##</%text>        BEAKER SESSION          ##

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

<%text>##</%text> Name of session cookie. Should be unique for a given host and path, even when running

<%text>##</%text> on different ports. Otherwise, cookie sessions will be shared and messed up.

<%text>##</%text> Sessions should always only be accessible by the browser, not directly by JavaScript.

<%text>##</%text> Session lifetime. 2592000 seconds is 30 days.

<%text>##</%text> Server secret used with HMAC to ensure integrity of cookies.

<%text>##</%text> Further, encrypt the data with AES.

<%text>##</%text> Type of storage used for the session, current types are

<%text>##</%text> dbm, file, memcached, database, and memory.

<%text>##</%text> File system storage of session data. (default)