backreferences to the groups specified in ``issue_pat``. If ``issue_sub`` is

empty, then the text matched by ``issue_pat`` is used verbatim.

The example settings shown above match issues in the format ``#<number>``.

This will cause the text ``#300`` to be transformed into a link:

.. code-block:: html

  <a href="https://issues.example.com/example_repo/issue/300">#300</a>

The following example transforms a text starting with either of 'pullrequest',

'pull request' or 'PR', followed by an optional space, then a pound character

(#) and one or more digits, into a link with the text 'PR #' followed by the

digits::

    issue_pat = (pullrequest|pull request|PR) ?#(\d+)

    issue_server_link = https://issues.example.com/\2

    issue_sub = PR #\2

The following example demonstrates how to require whitespace before the issue

reference in order for it to be recognized, such that the text ``issue#123`` will

not cause a match, but ``issue #123`` will::

    issue_pat = (?:^|(?<=\s))#(\d+)

    issue_server_link = https://issues.example.com/\1

    issue_sub =

If needed, more than one pattern can be specified by appending a unique suffix to

the variables. For example, also demonstrating the use of named groups::

    issue_pat_wiki = wiki-(?P<pagename>\S+)

    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

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

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

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.

If Alembic complains specifically about a missing ``alembic.ini``, it is

likely because you did not specify a config file using the ``-c`` option.

On the other hand, if the mentioned config file actually exists, you

need to append the following lines to it::

    [alembic]

    script_location = kallithea:alembic

Your config file should now work with Alembic.

7. Prepare the front-end

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

Starting with Kallithea 0.4, external front-end dependencies are no longer

shipped but need to be downloaded and/or generated at installation time. Run the

following command::

    kallithea-cli front-end-build

8. Rebuild the Whoosh full-text index

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

It is recommended that you rebuild the Whoosh index after upgrading since

new Whoosh versions can introduce incompatible index changes.

9. Start the Kallithea web application

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

This step once again depends entirely on the web server software used to

serve Kallithea.

If you were running Kallithea 0.3.x or older and were using ``paster serve

my.ini`` before, then the corresponding command in Kallithea 0.4 and later is::

    gearbox serve -c new.ini

Before starting the new version of Kallithea, you may find it helpful to

clear out your log file so that new errors are readily apparent.

.. note::

    If you're using Celery, make sure you restart all instances of it after

    upgrade.

It is possible that an upgrade involves changes to the Git hooks installed by

Kallithea. As these hooks are created inside the repositories on the server

filesystem, they are not updated automatically when upgrading Kallithea itself.

To update the hooks of your Git repositories, run::

    kallithea-cli repo-scan -c my.ini --install-git-hooks

Or:

* Go to *Admin > Settings > Remap and Rescan*

* Select the checkbox *Install Git hooks*

* Click the button *Rescan repositories*

.. note::

    Kallithea does not use hooks on Mercurial repositories. This step is thus

    not necessary if you only have Mercurial repositories.

.. _troubleshooting:

===============

Troubleshooting

===============

:Q: **Missing static files?**

:A: Make sure either to set the ``static_files = true`` in the .ini file or

   double check the root path for your http setup. It should point to

   for example:

   ``/home/my-virtual-python/lib/python3.7/site-packages/kallithea/public``

|

:Q: **Can't install celery/rabbitmq?**

:A: Don't worry. Kallithea works without them, too. No extra setup is required.

    Try out the great Celery docs for further help.

|

:Q: **Long lasting push timeouts?**

:A: Make sure you set a longer timeout in your proxy/fcgi settings. Timeouts

    are caused by the http server and not Kallithea.

|

:Q: **Large pushes timeouts?**

:A: Make sure you set a proper ``max_body_size`` for the http server. Very often

    Apache, Nginx, or other http servers kill the connection due to to large

    body.

|

:Q: **Apache doesn't pass basicAuth on pull/push?**

:A: Make sure you added ``WSGIPassAuthorization true``.

|

:Q: **Git fails on push/pull?**

:A: Make sure you're using a WSGI http server that can handle chunked encoding

    such as ``waitress`` or ``gunicorn``.

|

:Q: **How can I use hooks in Kallithea?**

|

:Q: **Kallithea is slow for me, how can I make it faster?**

:A: See the :ref:`performance` section.

|

:Q: **UnicodeDecodeError on Apache mod_wsgi**

:A: Please read: https://docs.djangoproject.com/en/dev/howto/deployment/wsgi/modwsgi/#if-you-get-a-unicodeencodeerror.

|

:Q: **Requests hanging on Windows**

:A: Please try out with disabled Antivirus software, there are some known problems with Eset Antivirus. Make sure

    you have installed the latest Windows patches (especially KB2789397).

.. _python: http://www.python.org/

.. _mercurial: https://www.mercurial-scm.org/

.. _celery: http://celeryproject.org/

.. _rabbitmq: http://www.rabbitmq.com/

.. _python-ldap: http://www.python-ldap.org/

% if c.visual.allow_custom_hooks_settings:

${h.form(url('admin_settings_hooks'), method='post')}

<div class="form">

      <div class="form-group">

        <span class="help-block">${_('Hooks can be used to trigger actions on certain events such as push / pull. They can trigger Python functions or external applications.')}</span>

        %for hook in c.custom_hooks:

            <div class="form-group form-inline" id="${'id%s' % hook.ui_id }">

                <% input_id = hook.ui_key.replace('.', '_') %>

                    <label class="control-label" for="${input_id}" title="${hook.ui_key}">${hook.ui_key}</label>

                    <div>

                        ${h.hidden('hook_ui_key',hook.ui_key,id='hook_ui_key_'+input_id)}

                        ${h.hidden('hook_ui_value',hook.ui_value,id='hook_ui_value_'+input_id)}

                        ${h.text('hook_ui_value_new',hook.ui_value,id=input_id,size=50,class_='form-control')}

                        <button type="button" class="btn btn-default btn-xs"

                            onclick="delete_hook(${hook.ui_id},'${'id%s' % hook.ui_id }')">

                            <i class="icon-trashcan"></i>

                            ${_('Delete')}

                        </button>

                    </div>

            </div>

        %endfor

        <div class="form-group form-inline">

            <label>

                ${h.text('new_hook_ui_key',size=15,class_='form-control')}

            </label>

            <div>

                ${h.text('new_hook_ui_value',size=50,class_='form-control')}

            </div>

        </div>

        <div class="form-group">

            <div class="buttons">

                ${h.submit('save',_('Save'),class_="btn btn-default")}

            </div>

        </div>

      </div>

</div>

${h.end_form()}

% endif

<script>

'use strict';

function delete_hook(hook_id, field_id) {

    var sUrl = ${h.js(h.url('admin_settings_hooks_delete'))};

    function success() {

            $('#' + field_id).remove();

        }

    function failure() {

            alert(${h.js(_('Failed to remove hook'))});

        }

    var postData = {'hook_id': hook_id};

    ajaxPOST(sUrl, postData, success, failure);

}

</script>

${h.form(url('admin_settings'), method='post')}

    <div class="form">

            <div class="form-group">

                <div>

                    <div class="checkbox">

                        <label>

                            ${h.checkbox('hooks_changegroup_kallithea_repo_size','True')}

                            ${_('Show repository size after push')}

                        </label>

                    </div>

                    <div class="checkbox">

                        <label>

                            ${h.checkbox('hooks_changegroup_kallithea_update','True')}

                            ${_('Update repository after push (hg update)')}

                        </label>

                    </div>

                </div>

            </div>

            <div class="form-group">

                <label class="control-label">${_('Mercurial extensions')}:</label>

                <div>

                    <div class="checkbox">

                        <label>

                            ${h.checkbox('extensions_largefiles','True')}

                            ${_('Enable largefiles extension')}

                        </label>

                    </div>

                    ##<div class="checkbox">

                    ##    <label>

                    ##        ${h.checkbox('extensions_hggit','True')}

                    ##        ${_('Enable hg-git extension')}

                    ##    </label>

                    ##</div>

                    ##<span class="help-block">${_('Requires hg-git library to be installed. Enables cloning of remote Git repositories while converting them to Mercurial.')}</span>

                </div>

            </div>

            %if c.visual.allow_repo_location_change:

            <div class="form-group">

                <label class="control-label" for="paths_root_path">${_('Location of repositories')}:</label>

                <div>

                    <div class="input-group">

                        ${h.text('paths_root_path',size=60,readonly="readonly",class_='form-control')}

                        <span id="path_unlock" data-toggle="tooltip" class="input-group-btn"

                            title="${_('Click to unlock. You must restart Kallithea in order to make this setting take effect.')}">

                            <button type="button" class="btn btn-default btn-sm"><i id="path_unlock_icon" class="icon-lock"></i></button>

                        </span>

                    </div>

                    <span class="help-block">${_('Filesystem location where repositories are stored. After changing this value, a restart and rescan of the repository folder are both required.')}</span>

                </div>

            </div>

            %else: