[main]

host = https://www.transifex.com

source_lang = en

type = PO

Copyright © 2012 Twitter, Inc.

and licensed under

[the Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).

A copy of the Apache License 2.0 is also included in this distribution in its

entirety in the file Apache-License-2.0.txt

Codemirror

----------

Kallithea incorporates parts of the Javascript system called

[Codemirror](http://codemirror.net/), which is primarily:

Copyright &copy; 2013 by Marijn Haverbeke <marijnh@gmail.com>

and licensed under the MIT-permissive license, which is

[included in this distribution](MIT-Permissive-License.txt).

Additional files from upstream Codemirror are copyrighted by various authors

and licensed under other permissive licenses.  The sub-directories under

license notice and information as they appeared in Codemirror's upstream

release.

jQuery

------

Kallithea incorporates the Javascript system called

[jQuery](http://jquery.org/),

Source can be found in https://github.com/jquery/jquery at tag 1.10.2

(mirrored at https://kallithea-scm.org/repos/mirror/jquery/files/1.10.2/ ).

It is Copyright 2013 jQuery Foundation and other contributors http://jquery.com/ and is under an

[MIT-permissive license](MIT-Permissive-License.txt).

Mousetrap

---------

Kallithea incorporates parts of the Javascript system called

[Mousetrap](http://craig.is/killing/mice/), which is:

   Copyright 2013 Craig Campbell

and licensed under

[the Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).

A [copy of the Apache License 2.0](Apache-License-2.0.txt) is also included

in this distribution.

available on

[https://kallithea-scm.org/repos/mirror](https://kallithea-scm.org/repos/mirror).

Flot

----

Kallithea incorporates some CSS from a system called

[Flot](http://code.google.com/p/flot/), which is:

Copyright 2006 Google Inc.

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

A [copy of the Apache License 2.0](Apache-License-2.0.txt) is also included

in this distribution.

Migrate

-------

system called [Migrate or sqlalchemy-migrate](https://github.com/stackforge/sqlalchemy-migrate),

which is:

Copyright (c) 2009 Evan Rosson, Jan Dittberner, Domen Kožar

and licensed under the MIT-permissive license, which is

[included in this distribution](MIT-Permissive-License.txt).

EOF

include README.rst

#docs

recursive-include docs *

#init.d

recursive-include init.d *

#images

#js

#templates

#cheaper-algo = spare

## minimum number of workers to keep at all times

#cheaper = 1

## number of workers to spawn at startup

#cheaper-initial = 1

## maximum number of workers that can be spawned

#workers = 4

## how many workers should be spawned at a time

#cheaper-step = 1

## COMMON ##

host = 0.0.0.0

port = 5000

## prefix middleware for rc

#[filter:proxy-prefix]

#use = egg:PasteDeploy#prefix

#prefix = /<your-prefix>

[app:main]

## enable proxy prefix middleware

#filter-with = proxy-prefix

full_stack = true

static_files = true

## Optional Languages

## en, fr, ja, pt_BR, zh_CN, zh_TW, pl

lang = en

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 = true

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

#archive_cache_dir = /tmp/tarballcache

## change this to unique ID for security

app_instance_uuid = rc-production

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

cut_off_limit = 256000

## handling that. Set this variable to 403 to return HTTPForbidden

auth_ret_code =

## locking return code. When repository is locked return this HTTP code. 2XX

## codes don't break the transactions while 4XX codes do

lock_ret_code = 423

## allows to change the repository location in settings page

allow_repo_location_change = True

## allows to setup custom hooks in settings page

allow_custom_hooks_settings = True

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

###        CELERY CONFIG        ####

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

use_celery = false

broker.host = localhost

broker.vhost = rabbitmqhost

broker.port = 5672

broker.user = rabbitmq

broker.password = qweqwe

celery.result.backend = amqp

celery.result.dburi = amqp://

celery.result.serialier = json

#celery.send.task.error.emails = true

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

celeryd.concurrency = 2

#celeryd.log.file = celeryd.log

celeryd.log.level = debug

celeryd.max.tasks.per.child = 1

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

celery.always.eager = false

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

###         BEAKER CACHE        ####

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

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

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

beaker.cache.regions=super_short_term,short_term,long_term,sql_cache_short,sql_cache_med,sql_cache_long

## HANDLERS ##

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

[handler_console]

class = StreamHandler

args = (sys.stderr,)

level = DEBUG

formatter = color_formatter

[handler_console_sql]

class = StreamHandler

args = (sys.stderr,)

level = DEBUG

formatter = color_formatter_sql

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

## FORMATTERS ##

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

[formatter_generic]

format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s

datefmt = %Y-%m-%d %H:%M:%S

[formatter_color_formatter]

format= %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s

datefmt = %Y-%m-%d %H:%M:%S

[formatter_color_formatter_sql]

format= %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s

datefmt = %Y-%m-%d %H:%M:%S

.. _models:

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

The :mod:`models` Module

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

   :members:

   :members:

   :members:

   :members:

   :members:

   :members:

   :members:

   :members:

   :members:

   :members:

# Add any paths that contain templates here, relative to this directory.

templates_path = ['_templates']

# The suffix of source filenames.

source_suffix = '.rst'

# The encoding of source files.

#source_encoding = 'utf-8-sig'

# The master toctree document.

master_doc = 'index'

# General information about the project.

project = u'RhodeCode'

copyright = u'%s, Marcin Kuzminski' % (datetime.datetime.now().year)

# The version info for the project you're documenting, acts as replacement for

# |version| and |release|, also used in various other places throughout the

# built documents.

#

# The short X.Y version.

root = os.path.dirname(os.path.dirname(__file__))

sys.path.append(root)

version = __version__

# The full version, including alpha/beta/rc tags.

release = __version__

# The language for content autogenerated by Sphinx. Refer to documentation

# for a list of supported languages.

#language = None

# There are two options for replacing |today|: either, you set today to some

# non-false value, then it is used:

#today = ''

# Else, today_fmt is used as the format for a strftime call.

#today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and

# directories to ignore when looking for source files.

exclude_patterns = ['_build']

# The reST default role (used for this markup: `text`) to use for all documents.

#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.

#add_function_parentheses = True

# not chapters.

#latex_use_parts = False

# If true, show page references after internal links.

#latex_show_pagerefs = False

# If true, show URL addresses after external links.

#latex_show_urls = False

# Additional stuff for the LaTeX preamble.

#latex_preamble = ''

# Documents to append as an appendix to all manuals.

#latex_appendices = []

# If false, no module index is generated.

#latex_domain_indices = True

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples

# (source start file, name, description, authors, manual section).

man_pages = [

     [u'Marcin Kuzminski'], 1)

]

# Example configuration for intersphinx: refer to the Python standard library.

intersphinx_mapping = {'http://docs.python.org/': None}

    hg clone https://kallithea-scm.org/repos/kallithea

after downloading/pulling RhodeCode make sure you run::

    python setup.py develop

command to install/verify all required packages, and prepare development

enviroment.

There are two files in the directory production.ini and developement.ini copy

the `development.ini` file as rc.ini (which is excluded from version controll)

and put all your changes like db connection or server port in there.

After finishing your changes make sure all tests passes ok. You can run

the testsuite running ``nosetest`` from the project root, or if you use tox

run tox for python2.5-2.7 with multiple database test. When using `nosetests`

test.ini file is used and by default it uses sqlite for tests, edit this file

to change your testing enviroment.

There's a special set of tests for push/pull operations, you can runn them using::

    paster serve test.ini --pid-file=test.pid --daemon

    kill -9 $(cat test.pid)

| Thank you for any contributions!

|  Marcin

.. _bitbucket: http://bitbucket.org/

    issue_prefix = #

`issue_pat` is the regular expression that will fetch issues from commit messages.

Default regex will match issues in format of #<number> eg. #300.

Matched issues will be replace with the link specified as `issue_server_link`

{id} will be replaced with issue id, and {repo} with repository name.

Since the # is striped `issue_prefix` is added as a prefix to url.

`issue_prefix` can be something different than # if you pass

ISSUE- as issue prefix this will generate an url in format::

  <a href="https://myissueserver.com/example_repo/issue/300">ISSUE-300</a>

Hook management

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

Hooks can be managed in similar way to this used in .hgrc files.

To access hooks setting click `advanced setup` on Hooks section of Mercurial

Settings in Admin.

There are 4 built in hooks that cannot be changed (only enable/disable by

checkboxes on previos section).

To add another custom hook simply fill in first section with

<name>.<hook_type> and the second one with hook path. Example hooks

Changing default encoding

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

By default RhodeCode uses utf8 encoding, starting from 1.3 series this

can be changed, simply edit default_encoding in .ini file to desired one.

This affects many parts in rhodecode including committers names, filenames,

encoding of commit messages. In addition RhodeCode can detect if `chardet`

library is installed. If `chardet` is detected RhodeCode will fallback to it

when there are encode/decode errors.

Setting Up Celery

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

Since version 1.1 celery is configured by the rhodecode ini configuration files.

Simply set use_celery=true in the ini file then add / change the configuration

variables inside the ini file.

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

So for example setting `BROKER_HOST` in celery means setting `broker.host` in

the config file.

       ssl_prefer_server_ciphers on;

       rewrite ^/(.+)$ https://your.kallithea.server/_admin/gists/$1;

       rewrite (.*)    https://your.kallithea.server/_admin/gists;

    }

    server {

       listen          443;

       server_name     your.kallithea.server;

       access_log      /var/log/nginx/rhodecode.access.log;

       error_log       /var/log/nginx/rhodecode.error.log;

       ssl on;

       ssl_certificate     your.kallithea.server.crt;

       ssl_certificate_key your.kallithea.server.key;

       ssl_session_timeout 5m;

       ssl_protocols SSLv3 TLSv1;

       ssl_ciphers DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:EDH-RSA-DES-CBC3-SHA:AES256-SHA:DES-CBC3-SHA:AES128-SHA:RC4-SHA:RC4-MD5;

       ssl_prefer_server_ciphers on;

       ## uncomment root directive if you want to serve static files by nginx

       ## requires static_files = false in .ini file

       include         /etc/nginx/proxy.conf;

       location / {

            try_files $uri @rhode;

       }

       location @rhode {

            proxy_pass      http://rc;

       }

    }

Here's the proxy.conf. It's tuned so it will not timeout on long

pushes or large pushes::

    proxy_redirect              off;

    proxy_set_header            Host $host;

    ## needed for container auth

    #proxy_set_header            REMOTE_USER $remote_user;

    #proxy_set_header            X-Forwarded-User $remote_user;

    proxy_set_header            X-Url-Scheme $scheme;

    proxy_set_header            X-Host $http_host;

    proxy_set_header            X-Real-IP $remote_addr;

    proxy_set_header            X-Forwarded-For $proxy_add_x_forwarded_for;

    proxy_set_header            Proxy-host $proxy_host;

Since ID are always the same moving the repository will not affect such url.

the _<ID> syntax can be used anywhere in the system so urls with repo_name

for changelogs, files and other can be exchanged with _<ID> syntax.

Mailing

-------

When administrator will fill up the mailing settings in .ini files

RhodeCode will send mails on user registration, or when RhodeCode errors occur

on errors the mails will have a detailed traceback of error.

Mails are also sent for code comments. If someone comments on a changeset

mail is sent to all participants, the person who commited the changeset

(if present in RhodeCode), and to all people mentioned with @mention system.

Trending source files

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

Trending source files are calculated based on pre defined dict of known

types and extensions. If You miss some extension or Would like to scan some

custom files it's possible to add new types in `LANGUAGES_EXTENSIONS_MAP` dict

Cloning remote repositories

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

RhodeCode has an ability to clone remote repos from given remote locations.

Currently it support following options:

- hg  -> hg clone

- svn -> hg clone

- git -> git clone

.. note::

    - *`svn -> hg` cloning requires `hgsubversion` library to be installed.*

If you need to clone repositories that are protected via basic auth, you

might pass the url with stored credentials inside eg.

`http://user:passw@remote.server/repo`, RhodeCode will try to login and clone

using given credentials. Please take a note that they will be stored as

plaintext inside the database. RhodeCode will remove auth info when showing the

clone url in summary page.

To use, simply change change the following in the .ini file::

    use = egg:Paste#http

to::

    use = egg:waitress#main

or::

    use = egg:gunicorn#main

And comment out bellow options::

    threadpool_workers =

    threadpool_max_requests =

    use_threadpool =

You can simply run `paster serve` as usual.

You can always disable git/hg support by editing a

.. code-block:: python

   BACKENDS = {

       'hg': 'Mercurial repository',

       #'git': 'Git repository',

   }

.. _waitress: http://pypi.python.org/pypi/waitress

.. _gunicorn: http://pypi.python.org/pypi/gunicorn

.. _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:

|

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

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

    Try out great celery docs for further help.

|

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

:A: Make sure you set a longer timeouts in your proxy/fcgi settings, timeouts

    are caused by https server and not RhodeCode.

|

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

#cheaper-algo = spare

## minimum number of workers to keep at all times

#cheaper = 1

## number of workers to spawn at startup

#cheaper-initial = 1

## maximum number of workers that can be spawned

#workers = 4

## how many workers should be spawned at a time

#cheaper-step = 1

## COMMON ##

host = 127.0.0.1

port = 5000

## prefix middleware for rc

#[filter:proxy-prefix]

#use = egg:PasteDeploy#prefix

#prefix = /<your-prefix>

[app:main]

## enable proxy prefix middleware

#filter-with = proxy-prefix

full_stack = true

static_files = true

## Optional Languages

## en, fr, ja, pt_BR, zh_CN, zh_TW, pl

lang = en

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 = true

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

#archive_cache_dir = /tmp/tarballcache

## change this to unique ID for security

app_instance_uuid = rc-production

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

cut_off_limit = 256000

## handling that. Set this variable to 403 to return HTTPForbidden

auth_ret_code =

## locking return code. When repository is locked return this HTTP code. 2XX

## codes don't break the transactions while 4XX codes do

lock_ret_code = 423

## allows to change the repository location in settings page

allow_repo_location_change = True

## allows to setup custom hooks in settings page

allow_custom_hooks_settings = True

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

###        CELERY CONFIG        ####

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

use_celery = false

broker.host = localhost

broker.vhost = rabbitmqhost

broker.port = 5672

broker.user = rabbitmq

broker.password = qweqwe

celery.result.backend = amqp

celery.result.dburi = amqp://

celery.result.serialier = json

#celery.send.task.error.emails = true

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

celeryd.concurrency = 2

#celeryd.log.file = celeryd.log

celeryd.log.level = debug

celeryd.max.tasks.per.child = 1

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

celery.always.eager = false

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

###         BEAKER CACHE        ####

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

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

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

beaker.cache.regions=super_short_term,short_term,long_term,sql_cache_short,sql_cache_med,sql_cache_long

## HANDLERS ##

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

[handler_console]