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

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

# Kallithea - Development config:                                              #

# listening on *:5000                                                          #

# sqlite and kallithea.db                                                      #

# initial_repo_scan = true                                                     #

# set debug = true                                                             #

# verbose and colorful logging                                                 #

#                                                                              #

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

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

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

[DEFAULT]

debug = true

pdebug = false

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

##                                                                            ##

##                                                                            ##

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

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

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

## Default:

#app_email_from = Kallithea

## Examples:

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

#app_email_from = kallithea-noreply@example.com

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

## Default:

#email_prefix =

## Example:

#email_prefix = [Kallithea]

## Multiple addresses can be specified, space-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

## Default:

#error_email_from = pylons@yourapp.com

## Examples:

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

#error_email_from = paste_error@example.com

## SMTP server settings

## Only smtp_server is mandatory. All other settings take the specified default

## values.

#smtp_server = mail.server.com

#smtp_username =

#smtp_password =

#smtp_port = 25

#smtp_use_tls = false

#smtp_use_ssl = false

## SMTP authentication parameters to use (e.g. LOGIN PLAIN CRAM-MD5, etc.).

## If empty, use any of the authentication parameters supported by the server.

#smtp_auth =

[server:main]

## PASTE ##

#use = egg:Paste#http

## nr of worker threads to spawn

#threadpool_workers = 5

We support both Python 2.6.x and 2.7.x and nothing else. For now we don't care

about Python 3 compatibility.

We try to support the most common modern web browsers. IE9 is still supported

to the extent it is feasible, IE8 is not.

We primarily support Linux and OS X on the server side but Windows should also work.

Html templates should use 2 spaces for indentation ... but be pragmatic. We

should use templates cleverly and avoid duplication. We should use reasonable

semantic markup with classes and ids that can be used for styling and testing.

We should only use inline styles in places where it really is semantic (such as

display:none).

JavaScript must use ';' between/after statements. Indentation 4 spaces. Inline

multiline functions should be indented two levels - one for the () and one for

{}. jQuery value arrays should have a leading $.

Commit messages should have a leading short line summarizing the changes. For

bug fixes, put "(Issue #123)" at the end of this line.

Contributions will be accepted in most formats - such as pull requests on

bitbucket, something hosted on your own Kallithea instance, or patches sent by

Make sure to test your changes both manually and with the automatic tests

before posting.

We care about quality and review and keeping a clean repository history. We

might give feedback that requests polishing contributions until they are

"perfect". We might also rebase and collapse and make minor adjustments to your

changes when we apply them.

We try to make sure we have consensus on the direction the project is taking.

Everything non-sensitive should be discussed in public - preferably on the

mailing list.  We aim at having all non-trivial changes reviewed by at least

one other core developer before pushing. Obvious non-controversial changes will

be handled more casually.

For now we just have one official branch ("default") and will keep it so stable

that it can be (and is) used in production. Experimental changes should live

elsewhere (for example in a pull request) until they are ready.

.. _translations:

.. include:: ./../kallithea/i18n/how_to

"Roadmap"

---------

   :maxdepth: 1

   overview

   installation

   installation_win

   installation_win_old

   installation_iis

   setup

**Usage**

.. toctree::

   :maxdepth: 1

   usage/general

   usage/vcs_support

   usage/locking

   usage/statistics

**Administrators Guide**

.. toctree::

   :maxdepth: 1

   usage/performance

   usage/backup

   usage/debugging

   usage/troubleshooting

**Develop**

.. toctree::

   :maxdepth: 1

   contributing

   changelog

**API**

.. toctree::

   :maxdepth: 1

   api/api

   api/models

Other topics

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

          least the ``openldap`` and ``sasl`` libraries.

LDAP settings are located in the Admin->LDAP section.

Here's a typical LDAP setup::

 Connection settings

 Enable LDAP          = checked

 Host                 = host.example.org

 Port                 = 389

 Account              = <account>

 Password             = <password>

 Connection Security  = LDAPS connection

 Certificate Checks   = DEMAND

 Search settings

 Base DN              = CN=users,DC=host,DC=example,DC=org

 LDAP Filter          = (&(objectClass=user)(!(objectClass=computer)))

 LDAP Search Scope    = SUBTREE

 Attribute mappings

 Login Attribute      = uid

 First Name Attribute = firstName

 Last Name Attribute  = lastName

If your user groups are placed in an Organisation Unit (OU) structure, the Search Settings configuration differs::

 Search settings

 Base DN              = DC=host,DC=example,DC=org

 LDAP Filter          = (&(memberOf=CN=your user group,OU=subunit,OU=unit,DC=host,DC=example,DC=org)(objectClass=user))

 LDAP Search Scope    = SUBTREE

.. _enable_ldap:

Enable LDAP : required

    Whether to use LDAP for authenticating users.

.. _ldap_host:

Host : required

    LDAP server hostname or IP address. Can be also a comma separated

    list of servers to support LDAP fail-over.

.. _Port:

Port : required

    389 for un-encrypted LDAP, 636 for SSL-encrypted LDAP.

    The LDAP record attribute which represents the user's email address.

If all data are entered correctly, and python-ldap_ is properly installed

users should be granted access to Kallithea with LDAP accounts.  At this

time user information is copied from LDAP into the Kallithea user database.

This means that updates of an LDAP user object may not be reflected as a

user update in Kallithea.

If You have problems with LDAP access and believe You entered correct

information check out the Kallithea logs, any error messages sent from LDAP

will be saved there.

Active Directory

''''''''''''''''

Kallithea can use Microsoft Active Directory for user authentication.  This

is done through an LDAP or LDAPS connection to Active Directory.  The

following LDAP configuration settings are typical for using Active

Directory ::

 Base DN              = OU=SBSUsers,OU=Users,OU=MyBusiness,DC=v3sys,DC=local

 Login Attribute      = sAMAccountName

 First Name Attribute = givenName

 Last Name Attribute  = sn

All other LDAP settings will likely be site-specific and should be

appropriately configured.

Authentication by container or reverse-proxy

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

Kallithea supports delegating the authentication

of users to its WSGI container, or to a reverse-proxy server through which all

clients access the application.

When these authentication methods are enabled in Kallithea, it uses the

username that the container/proxy (Apache/Nginx/etc) authenticated and doesn't

perform the authentication itself. The authorization, however, is still done by

Kallithea according to its settings.

When a user logs in for the first time using these authentication methods,

a matching user account is created in Kallithea with default permissions. An

administrator can then modify it using Kallithea's admin interface.

It's also possible for an administrator to create accounts and configure their

permissions before the user logs in for the first time.

of Mercurial Settings in Admin.

There are four built in hooks that cannot be changed (only enabled/disabled by

checkboxes in the previous section).

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

``<name>.<hook_type>`` and the second one with 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.

Celery configuration

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

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

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.*`` and ``broker.*`` configuration variables.

Remember that the ini files use the format with '.' and not with '_' like

Celery. So for example setting `BROKER_HOST` in Celery means setting

`broker.host` in the configuration file.

To start the Celery process, run::

 paster celeryd <configfile.ini>

.. _email:

cannot be sent, all mails will show up in the log output.

configuration file setting ``smtp_server``. If required for that server, specify

a username (``smtp_username``) and password (``smtp_password``), a non-standard

port (``smtp_port``), encryption settings (``smtp_use_tls`` or ``smtp_use_ssl``)

and/or specific authentication parameters (``smtp_auth``).

- when comments are given on one of their changesets

- when comments are given on changesets they are reviewer on or on which they

  commented regardless

- when they are invited as reviewer in pull requests

- when they request a password reset

Administrators are users with the ``Admin`` flag set in the ``Admin->Users``

section.

determine the intended recipients, the administrators and the addresses

specified in ``email_to`` in the configuration file are used as fallback.

``app_email_from`` setting in the configuration file. This setting can either

a name and an address in the following format: `Kallithea

optionally be prefixed with the value of ``email_prefix`` in the configuration

file.

When an exception occurs in Kallithea -- and unless interactive debugging is

enabled using ``set debug = true`` in the ``[app:main]`` section of the

``ErrorMiddleware`` to the addresses specified in ``email_to`` in the

configuration file.

``error_email_from`` setting in the configuration file. This setting can either

a name and an address in the following format: `Kallithea Errors

<kallithea-noreply@example.com>`.

*Note:* The WebError_ package does not respect ``smtp_port`` and assumes the

standard SMTP port (25). If you have a remote SMTP server with a different port,

you could set up a local forwarding SMTP server on port 25.

References

----------

- `Error Middleware (Pylons documentation) <http://pylons-webframework.readthedocs.org/en/latest/debugging.html#error-middleware>`_

- `ErrorHandler (Pylons modules documentation) <http://pylons-webframework.readthedocs.org/en/latest/modules/middleware.html#pylons.middleware.ErrorHandler>`_

.. _WebError: https://pypi.python.org/pypi/WebError

Due to the complicated nature of repository grouping, URLs of repositories

can often change. For example, a repository originally accessible from::

  http://server.com/repo_name

would get a new URL after moving it to test_group::

  http://server.com/test_group/repo_name

Such moving of a repository to a group can be an issue for build systems and

other scripts where the repository paths are hardcoded. To mitigate this,

Kallithea provides permanent URLs using the repository ID prefixed with an

underscore. In all Kallithea URLs, for example those for the changelog and the

file view, a repository name can be replaced by this ``_ID`` string. Since IDs

are always the same, moving the repository to a different group will not affect

such URLs.

In the example, the repository could also be accessible as::

  http://server.com/_<ID>

The ID of a given repository can be shown from the repository ``Summary`` page,

by selecting the ``Show by ID`` button next to ``Clone URL``.

errors occur.

to the committer of the changeset (if known to Kallithea), to all reviewers of

the pull request (if applicable) and to all people mentioned in the comment

using @mention notation.

Trending source files

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

Trending source files are calculated based on a predefined dictionary of known

types and extensions. If an extension is missing or you would like to scan

custom files, it is possible to extend the ``LANGUAGES_EXTENSIONS_MAP``

dictionary located in ``kallithea/config/conf.py`` with new types.

Cloning remote repositories

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

Kallithea has the ability to clone repositories from given remote locations.

Currently it supports the following options:

- hg  -> hg clone

- svn -> hg clone

- git -> git clone

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

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

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

# Kallithea - config file generated with kallithea-config                      #

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

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

[DEFAULT]

debug = true

pdebug = false

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

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

#app_email_from = Kallithea

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

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

#app_email_from = kallithea-noreply@example.com

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

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

#email_prefix =

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

#email_prefix = [Kallithea]

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

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

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

#email_to =

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

#email_to = admin@example.com

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

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

#error_email_from = pylons@yourapp.com

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

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

#error_email_from = paste_error@example.com

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

<%text>## Only smtp_server is mandatory. All other settings take the specified default</%text>

<%text>## values.</%text>

#smtp_server = mail.server.com

#smtp_username =

#smtp_password =

#smtp_port = 25

#smtp_use_tls = false

#smtp_use_ssl = false

<%text>## SMTP authentication parameters to use (e.g. LOGIN PLAIN CRAM-MD5, etc.).</%text>

<%text>## If empty, use any of the authentication parameters supported by the server.</%text>

#smtp_auth =

[server:main]

%if http_server == 'paste':

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

use = egg:Paste#http

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

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

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

# Kallithea - Example config                                                   #

#                                                                              #

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

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

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

[DEFAULT]

debug = true

pdebug = false

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

##                                                                            ##

##                                                                            ##

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

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

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

## Default:

#app_email_from = Kallithea

## Examples:

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

#app_email_from = kallithea-noreply@example.com

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

## Default:

#email_prefix =

## Example:

#email_prefix = [Kallithea]

## Multiple addresses can be specified, space-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

## Default:

#error_email_from = pylons@yourapp.com

## Examples:

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

#error_email_from = paste_error@example.com

## SMTP server settings

## Only smtp_server is mandatory. All other settings take the specified default

## values.

#smtp_server = mail.server.com

#smtp_username =

#smtp_password =

#smtp_port = 25

#smtp_use_tls = false

#smtp_use_ssl = false

## SMTP authentication parameters to use (e.g. LOGIN PLAIN CRAM-MD5, etc.).

## If empty, use any of the authentication parameters supported by the server.

#smtp_auth =

[server:main]

## PASTE ##

#use = egg:Paste#http

## nr of worker threads to spawn

#threadpool_workers = 5

msgid "Fork has to be the same type as parent"

msgstr "Тып форка будзе супадаць з бацькоўскім"

#: kallithea/model/validators.py:515

msgid "You don't have permissions to create repository in this group"

msgstr "У вас недастаткова мае рацыю для стварэння рэпазітароў у гэтай групе"

#: kallithea/model/validators.py:517

msgid "no permission to create repository in root location"

msgstr "недастаткова мае рацыю для стварэння рэпазітара ў каранёвым каталогу"

#: kallithea/model/validators.py:566

msgid "You don't have permissions to create a group in this location"

msgstr "У Вас недастаткова прывілеяў для стварэння групы ў гэтым месцы"

#: kallithea/model/validators.py:607

msgid "This username or user group name is not valid"

msgstr "Дадзенае імя карыстача ці групы карыстачоў недапушчальна"

#: kallithea/model/validators.py:700

msgid "This is not a valid path"

msgstr "Гэты шлях хібны"

#: kallithea/model/validators.py:715

msgstr "Гэты E-mail ужо заняты"

#: kallithea/model/validators.py:735

#, python-format

msgstr "\"%(email)s\" не існуе."

#: kallithea/model/validators.py:772

msgid ""

"The LDAP Login attribute of the CN must be specified - this is the name of "

"the attribute that is equivalent to \"username\""

msgstr ""

"Для ўваходу па LDAP павінна быць паказана значэнне атрыбута CN - гэта "

"эквівалент імя карыстача"

#: kallithea/model/validators.py:785

#, python-format

msgid "Revisions %(revs)s are already part of pull request or have set status"

msgstr "Рэвізіі %(revs)s ужо ўключаны ў pull-request ці маюць усталяваны статус"

#: kallithea/model/validators.py:817

msgid "Please enter a valid IPv4 or IPv6 address"

msgstr "Калі ласка, увядзіце існы IPv4 ці IPv6 адрас"

#: kallithea/model/validators.py:818

#, python-format

msgid "The network size (bits) must be within the range of 0-32 (not %(bits)r)"

msgstr ""

"Значэнне маскі падсеткі павінна быць у межах ад 0 да 32 (%(bits)r - няслушна)"

msgid "Fork has to be the same type as parent"

msgstr ""

#: kallithea/model/validators.py:515

msgid "You don't have permissions to create repository in this group"

msgstr ""

#: kallithea/model/validators.py:517

msgid "no permission to create repository in root location"

msgstr ""

#: kallithea/model/validators.py:566

msgid "You don't have permissions to create a group in this location"

msgstr ""

#: kallithea/model/validators.py:607

msgid "This username or user group name is not valid"

msgstr ""

#: kallithea/model/validators.py:700

msgid "This is not a valid path"

msgstr ""

#: kallithea/model/validators.py:715

msgstr ""

#: kallithea/model/validators.py:735

#, python-format

msgstr ""

#: kallithea/model/validators.py:772

msgid ""

"The LDAP Login attribute of the CN must be specified - this is the name "

"of the attribute that is equivalent to \"username\""

msgstr ""

#: kallithea/model/validators.py:785

#, python-format

msgid "Revisions %(revs)s are already part of pull request or have set status"

msgstr ""

#: kallithea/model/validators.py:817

msgid "Please enter a valid IPv4 or IPv6 address"

msgstr ""

#: kallithea/model/validators.py:818

#, python-format

msgid "The network size (bits) must be within the range of 0-32 (not %(bits)r)"

msgstr ""

#: kallithea/model/validators.py:851

msgid "Key name can only consist of letters, underscore, dash or numbers"

#: kallithea/model/validators.py:515

msgid "You don't have permissions to create repository in this group"

msgstr ""

"Du hast nicht die erforderlichen Berechtigungen, um in dieser Gruppe ein "

"Repository zu erzeugen"

#: kallithea/model/validators.py:517

msgid "no permission to create repository in root location"

msgstr "keine Berechtigung, um ein Repository auf höchster Ebene anzulegen"

#: kallithea/model/validators.py:566

msgid "You don't have permissions to create a group in this location"

msgstr "Sie haben keine Berechtigung, um an diesem Ort ein Repository anzulegen"

#: kallithea/model/validators.py:607

msgid "This username or user group name is not valid"

msgstr "Dieser Benutzername oder Benutzergruppenname ist nicht gültig"

#: kallithea/model/validators.py:700

msgid "This is not a valid path"

msgstr "Dies ist ein Ungültiger Pfad"

#: kallithea/model/validators.py:715

msgstr "Diese E-Mailaddresse ist bereits in Benutzung"

#: kallithea/model/validators.py:735

#, python-format

msgstr "E-MailAddresse \"%(email)s\" existiert nicht."

#: kallithea/model/validators.py:772

msgid ""

"The LDAP Login attribute of the CN must be specified - this is the name "

"of the attribute that is equivalent to \"username\""

msgstr ""

"Das LDAP-Login-Attribut des CN muss angeben werden - Es ist der Name des "

"Attributes äquivalent zu \"Benutzername\""

#: kallithea/model/validators.py:785

#, python-format

msgid "Revisions %(revs)s are already part of pull request or have set status"

msgstr ""

"Die Revisionen %(revs)s sind bereits Bestandteil des Pull Requests oder "

"haben den Status"

#: kallithea/model/validators.py:817

msgid "Please enter a valid IPv4 or IPv6 address"

msgstr "Bitte eine gültige IPv4- oder IPv6-Adresse angeben"

#: kallithea/model/validators.py:818

#, python-format

msgid "The network size (bits) must be within the range of 0-32 (not %(bits)r)"

msgid "Fork has to be the same type as parent"

msgstr "Le fork doit être du même type que le parent"

#: kallithea/model/validators.py:515

msgid "You don't have permissions to create repository in this group"

msgstr "Vous n’avez pas la permission de créer un dépôt dans ce"