cf635c823ea059cc3a1581b82d8672e46b682384 0.3.4

4cca4cc6a0a97f4c4763317184cd41aca4297630 0.3.5

082c9b8f0f17bd34740eb90c69bdc4c80d4b5b31 0.3.6

a18445b85d407294da0b7f1d8be3bedef5ffdea6 0.3.7

8db761c407685e7b08b800c947890035b0d67025 0.4.0rc1

60f726162fd6c515bd819feb423be73cad01d7d3 0.4.0rc2

19086c5de05f4984d7a90cd31624c45dd893f6bb 0.4.0

da65398a62fff50f3d241796cbf17acdea2092ef 0.4.1

bfa0b0a814644f0af3f492d17a9ed169cc3b89fe 0.5.0

d01a8e92936dbd62c76505432f60efba432e9397 0.5.1

aa0a637fa6f635a5e024fa56b19ed2a2dacca857 0.5.2

9f5ca9088067618d79129d224c35c818bd2d2f12 0.6.0

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

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

##                                                                               ##

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

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

[DEFAULT]

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

## Email settings                                                             ##

##                                                                            ##

## Refer to the documentation ("Email settings") for more details.            ##

##                                                                            ##

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

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

#index.extensions =

#    gemfile

#    lock

## extra filenames for indexing, space separated

#index.filenames =

#    .dockerignore

#    .editorconfig

#    INSTALL

#    CHANGELOG

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

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

## SSH is disabled by default, until an Administrator decides to enable it.

ssh_enabled = false

## File where users' SSH keys will be stored *if* ssh_enabled is true.

#ssh_authorized_keys = /home/kallithea/.ssh/authorized_keys

## Path to be used in ssh_authorized_keys file to invoke kallithea-cli with ssh-serve.

#kallithea_cli_path = /srv/kallithea/venv/bin/kallithea-cli

## Locale to be used in the ssh-serve command.

## This is needed because an SSH client may try to use its own locale

## settings, which may not be available on the server.

## See `locale -a` for valid values on this system.

#ssh_locale = C.UTF-8

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

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

## Note: Celery doesn't support Windows.

use_celery = false

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

## Example: use the message queue on the local virtual host 'kallitheavhost' as the RabbitMQ user 'kallithea':

celery.broker_url = amqp://kallithea:thepassword@localhost:5672/kallitheavhost

celery.result.backend = db+sqlite:///celery-results.db

#celery.amqp.task.result.expires = 18000

celery.worker_concurrency = 2

celery.worker_max_tasks_per_child = 1

## If true, tasks will never be sent to the queue, but executed locally instead.

celery.task_always_eager = false

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

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

beaker.cache.data_dir = %(here)s/data/cache/data

beaker.cache.lock_dir = %(here)s/data/cache/lock

beaker.cache.regions = long_term,long_term_file

beaker.cache.long_term.type = memory

beaker.cache.long_term.expire = 36000

beaker.cache.long_term.key_length = 256

beaker.cache.long_term_file.type = file

beaker.cache.long_term_file.expire = 604800

beaker.cache.long_term_file.key_length = 256

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

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

## Name of session cookie. Should be unique for a given host and path, even when running

## on different ports. Otherwise, cookie sessions will be shared and messed up.

session.key = kallithea

## Sessions should always only be accessible by the browser, not directly by JavaScript.

session.httponly = true

## Session lifetime. 2592000 seconds is 30 days.

session.timeout = 2592000

## Server secret used with HMAC to ensure integrity of cookies.

#session.secret = VERY-SECRET

## File system storage of session data. (default)

#session.type = file

## Cookie only, store all session data inside the cookie. Requires secure secrets.

#session.type = cookie

## Database storage of session data.

#session.type = ext:database

#session.sa.url = postgresql://postgres:qwe@localhost/kallithea

#session.table_name = db_session

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

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

## Show a nice error page for application HTTP errors and exceptions (default true)

#errorpage.enabled = true

## Enable Backlash client-side interactive debugger (default false)

## WARNING: *THIS MUST BE false IN PRODUCTION ENVIRONMENTS!!!*

## This debug mode will allow all visitors to execute malicious code.

#debug = false

debug = true

## Enable Backlash server-side error reporting (unless debug mode handles it client-side) (default true)

## Propagate email settings to ErrorReporter of TurboGears2

## You do not normally need to change these lines

get trace_errors.smtp_server = smtp_server

get trace_errors.smtp_port = smtp_port

get trace_errors.from_address = error_email_from

get trace_errors.error_email = email_to

get trace_errors.smtp_username = smtp_username

get trace_errors.smtp_password = smtp_password

get trace_errors.smtp_use_tls = smtp_use_tls

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

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

logview.sqlalchemy = #faa

logview.pylons.templating = #bfb

logview.pylons.util = #eee

## SQLITE [default]

sqlalchemy.url = sqlite:///%(here)s/kallithea.db?timeout=60

## see sqlalchemy docs for other backends

sqlalchemy.pool_recycle = 3600

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

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

[alembic]

script_location = kallithea:alembic

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

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

[loggers]

keys = root, routes, kallithea, sqlalchemy, tg, gearbox, beaker, templates, whoosh_indexer, werkzeug, backlash

[handlers]

keys = console, console_color, console_color_sql, null

[formatters]

keys = generic, color_formatter, color_formatter_sql

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

.. _overview:

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

Installation overview

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

Some overview and some details that can help understanding the options when

installing Kallithea.

Python environment

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

**Kallithea** is written entirely in Python_ and requires Python version

3.6 or higher.

Given a Python installation, there are different ways of providing the

environment for running Python applications. Each of them pretty much

corresponds to a ``site-packages`` directory somewhere where packages can be

installed.

<div style="text-align:center">

<form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">

<input type="hidden" name="cmd" value="_s-xclick">

<input type="hidden" name="hosted_button_id" value="EYXFS3SQPHYUL">

<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif" border="0" name="submit" alt="PayPal &ndash; The safer, easier way to pay online!">

<img alt="" border="0" src="https://www.paypalobjects.com/en_US/i/scr/pixel.gif" width="1" height="1">

</form>

    <div style="padding:5px">

     <a href="https://flattr.com/thing/922714/Donate-to-Software-Freedom-Conservancy" target="_blank">

     <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0" /></a>

    </div>

</div>

    settings you specify.

    The primary high level configuration keys and their default values are

    shown with --show-defaults . Custom values for these keys can be specified

    on the command line as key=value arguments.

    Additional key=value arguments will be patched/inserted in the [app:main]

    section ... until another section name specifies where any following values

    should go.

    """

    mako_variable_values = {

        'git_hook_interpreter': sys.executable,

        'user_home_path': os.path.expanduser('~'),

        'kallithea_cli_path': cli_base.kallithea_cli_path,

        'ssh_locale': kallithea.lib.locale.get_current_locale(),

    }

    ini_settings = defaultdict(dict)

    section_name = None

    for parameter in key_value_pairs:

        parts = parameter.split('=', 1)

        if len(parts) == 1 and parameter.startswith('[') and parameter.endswith(']'):

            section_name = parameter

    def set_credentials(self, user, passwd):

        self.user = user

        self.passwd = passwd

        self._make_opener()

    def _make_opener(self):

        mgr = urllib.request.HTTPPasswordMgrWithDefaultRealm()

        mgr.add_password(None, self._uri, self.user, self.passwd)

        handler = urllib.request.HTTPBasicAuthHandler(mgr)

        self.opener = urllib.request.build_opener(handler)

        _headers = {"Content-type": "application/json",

                    "Accept": "application/json"}

        if self.user and self.passwd:

            authstring = ascii_str(base64.b64encode(safe_bytes("%s:%s" % (self.user, self.passwd))))

            _headers["Authorization"] = "Basic %s" % authstring

        log.debug("Sent to crowd at %s:\nHeaders: %s\nBody:\n%s", url, _headers, body)

        req = urllib.request.Request(url, body, _headers)

        global msg

        try:

            rdoc = self.opener.open(req)

        except Exception as e:

        return rval

    def user_auth(self, username, password):

        """Authenticate a user against crowd. Returns brief information about

        the user."""

        url = ("%s/rest/usermanagement/%s/authentication?username=%s"

               % (self._uri, self._version, urllib.parse.quote(username)))

        body = ascii_bytes(ext_json.dumps({"value": password}))

        return self._request(url, body)

    def user_groups(self, username):

        """Retrieve a list of groups to which this user belongs."""

template_file = os.path.join(

    os.path.dirname(os.path.dirname(os.path.dirname(__file__))),

    'kallithea/lib/paster_commands/template.ini.mako')

default_variables = {

    'database_engine': 'sqlite',

    'http_server': 'waitress',

    'host': '127.0.0.1',

    'port': '5000',

    'uuid': lambda: 'VERY-SECRET',

}

variable_options = {

    'database_engine': ['sqlite', 'postgres', 'mysql'],

    'http_server': ['waitress', 'gearbox', 'gevent', 'gunicorn', 'uwsgi'],

}

def expand(template, mako_variable_values, settings):

    """Expand mako template and tweak it.

    Not entirely stable for random templates as input, but good enough for our

    single template.

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

[DEFAULT]

#app_email_from = Kallithea

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

#app_email_from = kallithea-noreply@example.com

#email_prefix =

#email_prefix = [Kallithea]

#email_to =

#email_to = admin@example.com

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

email_to =

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

#error_email_from = kallithea_errors@example.com

error_email_from =

smtp_server =

smtp_username =

smtp_password =

smtp_port =

smtp_use_ssl = false

smtp_use_tls = false

%if http_server != 'uwsgi':

[server:main]

host = ${host}

port = ${port}

%if http_server == 'gearbox':

use = egg:gearbox#wsgiref

threadpool_workers = 1

threadpool_max_requests = 100

use_threadpool = true

%elif http_server == 'gevent':

use = egg:gearbox#gevent

%elif http_server == 'waitress':

use = egg:waitress#main

threads = 1

max_request_body_size = 107374182400

#asyncore_use_poll = True

%elif http_server == 'gunicorn':

use = egg:gunicorn#main

workers = 4

proc_name = kallithea

worker_class = sync

max_requests = 1000

timeout = 3600

%endif

%else:

[uwsgi]

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

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

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

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

#[filter:proxy-prefix]

#use = egg:PasteDeploy#prefix

#prefix = /<your-prefix>

[app:main]

use = egg:kallithea

#filter-with = proxy-prefix

full_stack = true

static_files = true

#i18n.enabled = true

#i18n.lang = en

cache_dir = %(here)s/data

index_dir = %(here)s/data/index

archive_cache_dir = %(here)s/tarballcache

app_instance_uuid = ${uuid()}

cut_off_limit = 256000

force_https = false

use_htsts = false

commit_parse_limit = 25

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

%if git_hook_interpreter:

git_hook_interpreter = ${git_hook_interpreter}

%endif

git_path = git

#git_rev_filter = --branches --tags

rss_cut_off_limit = 256000

rss_items_per_page = 10

rss_include_diff = false

show_sha_length = 12

show_revision_number = false

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

gist_alias_url =

default_encoding = utf-8

hgencoding = utf-8

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

issue_pat = #(\d+)

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

issue_sub =

#issue_pat_wiki = wiki-(\S+)

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

#issue_sub_wiki = WIKI-\1

auth_ret_code =

allow_repo_location_change = True

allow_custom_hooks_settings = True

#index.extensions =

#    gemfile

#    lock

#index.filenames =

#    .dockerignore

#    .editorconfig

#    INSTALL

#    CHANGELOG