#filter-with = proxy-prefix

full_stack = true

static_files = true

## Available Languages:

## cs de fr hu ja nl_BE pl pt_BR ru sk zh_CN zh_TW

lang =

cache_dir = %(here)s/data

index_dir = %(here)s/data/index

## perform a full repository scan on each server start, this should be

## set to false after first startup, to allow faster server restarts.

#initial_repo_scan = false

initial_repo_scan = true

## uncomment and set this path to use archive download cache

archive_cache_dir = %(here)s/tarballcache

## change this to unique ID for security

app_instance_uuid = development-not-secret

## cut off limit for large diffs (size in bytes)

cut_off_limit = 256000

## force https in Kallithea, fixes https redirects, assumes it's always https

force_https = false

## use Strict-Transport-Security headers

use_htsts = false

## number of commits stats will parse on each iteration

commit_parse_limit = 25

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

.. _performance:

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

Optimizing Kallithea performance

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

When serving a large amount of big repositories, Kallithea can start

performing slower than expected. Because of the demanding nature of handling large

amounts of data from version control systems, here are some tips on how to get

the best performance.

Follow these few steps to improve performance of Kallithea system.

    Tweak beaker cache settings in the ini file. The actual effect of that

    is questionable.

    SQLite is a good option when having a small load on the system. But due to

    locking issues with SQLite, it is not recommended to use it for larger

    deployments. Switching to MySQL or PostgreSQL will result in an immediate

    performance increase. A tool like SQLAlchemyGrate_ can be used for

    migrating to another database platform.

    Scaling horizontally can give huge performance benefits when dealing with

    large amounts of traffic (many users, CI servers, etc.). Kallithea can be

    scaled horizontally on one (recommended) or multiple machines. In order

    to scale horizontally you need to do the following:

    - Each instance's ``data`` storage needs to be configured to be stored on a

      shared disk storage, preferably together with repositories. This ``data``

      dir contains template caches, sessions, whoosh index and is used for

      task locking (so it is safe across multiple instances). Set the

      ``cache_dir``, ``index_dir``, ``beaker.cache.data_dir``, ``beaker.cache.lock_dir``

      variables in each .ini file to a shared location across Kallithea instances

    - If celery is used each instance should run a separate Celery instance, but

      the message broker should be common to all of them (e.g.,  one

      shared RabbitMQ server)

    - Load balance using round robin or IP hash, recommended is writing LB rules

      that will separate regular user traffic from automated processes like CI

      servers or build bots.

.. _SQLAlchemyGrate: https://github.com/shazow/sqlalchemygrate

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

#filter-with = proxy-prefix

full_stack = true

static_files = true

<%text>## Available Languages:</%text>

<%text>## cs de fr hu ja nl_BE pl pt_BR ru sk zh_CN zh_TW</%text>

lang =

cache_dir = ${here}/data

index_dir = ${here}/data/index

<%text>## perform a full repository scan on each server start, this should be</%text>

<%text>## set to false after first startup, to allow faster server restarts.</%text>

initial_repo_scan = false

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

archive_cache_dir = ${here}/tarballcache

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

app_instance_uuid = ${uuid()}

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

cut_off_limit = 256000

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

force_https = false

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

use_htsts = false

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

commit_parse_limit = 25

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

git_path = git

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

#git_rev_filter = --branches --tags

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

rss_cut_off_limit = 256000

rss_items_per_page = 10

rss_include_diff = false

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

show_sha_length = 12

show_revision_number = false

## enable proxy prefix middleware

#filter-with = proxy-prefix

full_stack = true

static_files = true

## Available Languages:

## cs de fr hu ja nl_BE pl pt_BR ru sk zh_CN zh_TW

lang =

cache_dir = %(here)s/data

index_dir = %(here)s/data/index

## perform a full repository scan on each server start, this should be

## set to false after first startup, to allow faster server restarts.

initial_repo_scan = false

## uncomment and set this path to use archive download cache

archive_cache_dir = %(here)s/tarballcache

## change this to unique ID for security

app_instance_uuid = ${app_instance_uuid}

## cut off limit for large diffs (size in bytes)

cut_off_limit = 256000

## force https in Kallithea, fixes https redirects, assumes it's always https

force_https = false

## use Strict-Transport-Security headers

use_htsts = false

## number of commits stats will parse on each iteration

commit_parse_limit = 25

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

                pr_nice_id = PullRequest.make_nice_id(pr_id)

                pr_repo = stat.pull_request.other_repo.repo_name

            grouped[stat.revision] = [str(stat.status), stat.status_lbl,

                                      pr_id, pr_repo, pr_nice_id,

                                      stat.author]

        return grouped

    def _repo_size(self):

        from kallithea.lib import helpers as h

        log.debug('calculating repository size...')

        return h.format_byte_size(self.scm_instance.size)

    #==========================================================================

    # SCM CACHE INSTANCE

    #==========================================================================

    def set_invalidate(self):

        """

        Mark caches of this repo as invalid.

        """

        CacheInvalidation.set_invalidate(self.repo_name)

    @property

    def scm_instance(self):

    def scm_instance_cached(self, valid_cache_keys=None):

        @cache_region('long_term', 'scm_instance_cached')

        def _c(repo_name): # repo_name is just for the cache key

            log.debug('Creating new %s scm_instance and populating cache', repo_name)

            return self.scm_instance_no_cache()

        rn = self.repo_name

        valid = CacheInvalidation.test_and_set_valid(rn, None, valid_cache_keys=valid_cache_keys)

        if not valid:

            log.debug('Cache for %s invalidated, getting new object', rn)

            region_invalidate(_c, None, 'scm_instance_cached', rn)

        else:

            log.debug('Trying to get scm_instance of %s from cache', rn)

        return _c(rn)

    def scm_instance_no_cache(self):

        repo_full_path = safe_str(self.repo_full_path)

        alias = get_scm(repo_full_path)[0]

        log.debug('Creating instance of %s repository from %s',

                  alias, self.repo_full_path)

        backend = get_backend(alias)

        if alias == 'hg':

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

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

# Kallithea - config for tests:                                                #

# initial_repo_scan = true                                                     #

# sqlalchemy and kallithea_test.sqlite                                         #

# custom logging                                                               #

#                                                                              #

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

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

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

[DEFAULT]

debug = true

pdebug = false

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

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

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

## 'From' header for application emails. You can optionally add a name.

## Default:

#app_email_from = Kallithea

## Examples:

#filter-with = proxy-prefix

full_stack = true

static_files = true

## Available Languages:

## cs de fr hu ja nl_BE pl pt_BR ru sk zh_CN zh_TW

lang =

cache_dir = %(here)s/data

index_dir = %(here)s/data/index

## perform a full repository scan on each server start, this should be

## set to false after first startup, to allow faster server restarts.

#initial_repo_scan = false

initial_repo_scan = true

## uncomment and set this path to use archive download cache

archive_cache_dir = %(here)s/tarballcache

## change this to unique ID for security

app_instance_uuid = test

## cut off limit for large diffs (size in bytes)

cut_off_limit = 256000

## force https in Kallithea, fixes https redirects, assumes it's always https

force_https = false

## use Strict-Transport-Security headers

use_htsts = false

## number of commits stats will parse on each iteration

commit_parse_limit = 25

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

])

# the mako variables used in all other ini files and templates

mako_variable_values = {

    'host': '127.0.0.1',

    'port': '5000',

    'here': '%(here)s',

    'uuid()': '${app_instance_uuid}',

}

# files to be generated from the mako template

ini_files = [

    ('kallithea/config/deployment.ini_tmpl',

        '''

        Kallithea - Example config

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

        ''',

        {}, # exactly the same settings as template.ini.mako

    ),

    ('kallithea/tests/test.ini',

        '''

        Kallithea - config for tests:

        initial_repo_scan = true

        sqlalchemy and kallithea_test.sqlite

        custom logging

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

        ''',

        {

            '[server:main]': {

                'port': '4999',

            },

            '[app:main]': {

                'initial_repo_scan': 'true',

                'app_instance_uuid': 'test',

                'show_revision_number': 'true',

                'beaker.cache.sql_cache_short.expire': '1',

                'beaker.session.secret': '{74e0cd75-b339-478b-b129-07dd221def1f}',

                'sqlalchemy.db1.url': 'sqlite:///%(here)s/kallithea_test.sqlite',

            },

            '[logger_root]': {

                'level': 'DEBUG',

            },

            '[logger_sqlalchemy]': {

                'level': 'ERROR',

                'handlers': 'console',

            },

            '[handler_console]': {

                'level': 'NOTSET',

            },

        },

    ),

    ('development.ini',

        '''

        Kallithea - Development config:

        listening on *:5000

        sqlite and kallithea.db

        initial_repo_scan = true

        set debug = true