#email_prefix = [RhodeCode]

#smtp_server = mail.server.com

#smtp_username = 

#smtp_password = 

#smtp_port = 

#smtp_use_tls = false

#smtp_use_ssl = true

# Specify available auth parameters here (e.g. LOGIN PLAIN CRAM-MD5, etc.)

#smtp_auth = 

[server:main]

## PASTE

##nr of threads to spawn

#threadpool_workers = 5

##max request before thread respawn

#threadpool_max_requests = 10

##option to use threads of process

#use_threadpool = true

#use = egg:Paste#http

#WAITRESS

threads = 5

#100GB

max_request_body_size = 107374182400

use = egg:waitress#main

host = 0.0.0.0

port = 5000

[filter:proxy-prefix]

# prefix middleware for rc

use = egg:PasteDeploy#prefix

prefix = /<your-prefix>

[app:main]

use = egg:rhodecode

#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

app_instance_uuid = rc-develop

cut_off_limit = 256000

vcs_full_cache = True

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

force_https = false

# use Strict-Transport-Security headers

use_htsts = false

commit_parse_limit = 25

# number of items displayed in lightweight dashboard before paginating

dashboard_items = 100

use_gravatar = true

# path to git executable

git_path = git

## RSS feed options

rss_cut_off_limit = 256000

rss_items_per_page = 10

rss_include_diff = false

## alternative_gravatar_url allows you to use your own avatar server application

## the following parts of the URL will be replaced

## {email}        user email

## {md5email}     md5 hash of the user email (like at gravatar.com)

## {size}         size of the image that is expected from the server application

## {scheme}       http/https from RhodeCode server

## {netloc}       network location from RhodeCode server

#alternative_gravatar_url = http://myavatarserver.com/getbyemail/{email}/{size}

#alternative_gravatar_url = http://myavatarserver.com/getbymd5/{md5email}?s={size}

container_auth_enabled = false

proxypass_auth_enabled = false

## default encoding used to convert from and to unicode

## can be also a comma seperated list of encoding in case of mixed encodings

default_encoding = utf8

## overwrite schema of clone url

## available vars:

## scheme - http/https

## user - current user

## pass - password 

## netloc - network location

## path - usually repo_name

#clone_uri = {scheme}://{user}{pass}{netloc}{path}

## issue tracking mapping for commits messages

## comment out issue_pat, issue_server, issue_prefix to enable

## pattern to get the issues from commit messages

## default one used here is #<numbers> with a regex passive group for `#`

## {id} will be all groups matched from this pattern

issue_pat = (?:\s*#)(\d+)

## server url to the issue, each {id} will be replaced with match

## fetched from the regex and {repo} is replaced with full repository name

## including groups {repo_name} is replaced with just name of repo

issue_server_link = https://myissueserver.com/{repo}/issue/{id}

## prefix to add to link to indicate it's an url

## #314 will be replaced by <issue_prefix><id>

issue_prefix = #

## issue_pat, issue_server_link, issue_prefix can have suffixes to specify

## multiple patterns, to other issues server, wiki or others

## below an example how to create a wiki pattern 

#  #wiki-some-id -> https://mywiki.com/some-id

#issue_pat_wiki = (?:wiki-)(.+)

#issue_server_link_wiki = https://mywiki.com/{id}

#issue_prefix_wiki = WIKI-

## instance-id prefix

## a prefix key for this instance used for cache invalidation when running 

## multiple instances of rhodecode, make sure it's globally unique for 

## all running rhodecode instances. Leave empty if you don't use it

instance_id = 

## alternative return HTTP header for failed authentication. Default HTTP

## response is 401 HTTPUnauthorized. Currently HG clients have troubles with 

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

auth_ret_code =

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

###        CELERY CONFIG        ####

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

use_celery = false

broker.host = localhost

broker.vhost = rabbitmqhost

broker.port = 5672

broker.user = rabbitmq

broker.password = qweqwe

celery.imports = rhodecode.lib.celerylib.tasks

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

beaker.cache.super_short_term.type=memory

beaker.cache.super_short_term.expire=10

beaker.cache.super_short_term.key_length = 256

beaker.cache.short_term.type=memory

beaker.cache.short_term.expire=60

beaker.cache.short_term.key_length = 256

beaker.cache.long_term.type=memory

beaker.cache.long_term.expire=36000

beaker.cache.long_term.key_length = 256

beaker.cache.sql_cache_short.type=memory

Dispatch rescan repositories action. If remove_obsolete is set

RhodeCode will delete repos that are in database but not in the filesystem.

This command can be executed only using api_key belonging to user with admin

rights.

INPUT::

    id : <id_for_response>

    api_key : "<api_key>"

    method :  "rescan_repos"

    args :    {

                "remove_obsolete" : "<boolean = Optional(False)>"

              }

OUTPUT::

    id : <id_given_in_input>

    result : "{'added': [<list of names of added repos>],

               'removed': [<list of names of removed repos>]}"

    error :  null

invalidate_cache

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

Invalidate cache for repository.

This command can be executed only using api_key belonging to user with admin

rights or regular user that have write or admin or write access to repository.

INPUT::

    id : <id_for_response>

    api_key : "<api_key>"

    method :  "invalidate_cache"

    args :    {

                "repoid" : "<reponame or repo_id>"

              }

OUTPUT::

    id : <id_given_in_input>

    result : "Cache for repository `<reponame>` was invalidated: invalidated cache keys: <list_of_cache_keys>"

    error :  null

lock

----

Set locking state on given repository by given user. If userid param is skipped

This command can be executed only using api_key belonging to user with admin

rights or regular user that have admin or write access to repository.

INPUT::

    id : <id_for_response>

    api_key : "<api_key>"

    method :  "lock"

    args :    {

                "repoid" : "<reponame or repo_id>"

                "userid" : "<user_id or username = Optional(=apiuser)>",

              }

OUTPUT::

    id : <id_given_in_input>

    result : "User `<username>` set lock state for repo `<reponame>` to `true|false`"

    error :  null

show_ip

-------

Shows IP address as seen from RhodeCode server, together with all

defined IP addresses for given user.

This command can be executed only using api_key belonging to user with admin

rights.

INPUT::

    id : <id_for_response>

    api_key : "<api_key>"

    method :  "show_ip"

    args :    {

                "userid" : "<user_id or username>",

              }

OUTPUT::

    id : <id_given_in_input>

    result : {

                 "ip_addr_server": <ip_from_clien>",

                 "user_ips": [

                                {

                                   "ip_addr": "<ip_with_mask>",

                                   "ip_range": ["<start_ip>", "<end_ip>"],

                                },

                                ...

                             ]

             }

    error :  null

get_user

--------

Get's an user by username or user_id, Returns empty result if user is not found.

If userid param is skipped it is set to id of user who is calling this method.

.. _changelog:

=========

Changelog

=========

1.6.0 (**2013-XX-XX**)

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

:status: in-progress

:branch: beta

news

++++

fixes

+++++

1.5.3 (**2013-02-12**)

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

news

++++

- IP restrictions now also enabled for IPv6

fixes

+++++

- fixed issues with private checkbox not always working

- fixed #746 unicodeDedode errors on feed controllers

- fixes issue #756 cleanup repos didn't properly compose paths of repos to be cleaned up.

- fixed cache invalidation issues together with vcs_full_cache option

- repo scan should skip directories with starting with '.'

- fixes for issue #731, update-repoinfo sometimes failed to update data when changesets

  were initial commits

- recursive mode of setting permission skips private repositories

1.5.2 (**2013-01-14**)

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

news

++++

- IP restrictions for users. Each user can get a set of whitelist IP+mask for

  extra protection. Useful for buildbots etc.

- added full last changeset info to lightweight dashboard. lightweight dashboard

  is now fully functional replacement of original dashboard.

- implemented certain API calls for non-admin users.

- enabled all Markdown Extra plugins

- implemented #725 Pull Request View - Show origin repo URL

- show comments from pull requests into associated changesets

fixes

+++++

- update repoinfo script is more failsafe

- fixed #687  Lazy loaded tooltip bug with simultaneous ajax requests

- fixed #691: Notifications for pull requests: move link to top for better

  readability

- fixed #699: fix missing fork docs for API

- fixed #693 Opening changeset from pull request fails

- fixed #710 File view stripping empty lines from beginning and end of file

- fixed issues with getting repos by path on windows, caused GIT hooks to fail

- fixed issues with groups paginator on main dashboard

- improved fetch/pull command for git repos, now pulling all refs

news

++++

- new rewritten from scratch diff engine. 10x faster in edge cases. Handling

  of file renames, copies, change flags and binary files

- added lightweight dashboard option. ref #500. New version of dashboard

  page that doesn't use any VCS data and is super fast to render. Recommended

  for large amount of repositories.

- implements #648 write Script for updating last modification time for

  lightweight dashboard

- implemented compare engine for git repositories.

- LDAP failover, option to specify multiple servers

- added Errormator and Sentry support for monitoring RhodeCode

- implemented #628: Pass server URL to rc-extensions hooks

- new tooltip implementation - added lazy loading of changesets from journal

  pages. This can significantly improve speed of rendering the page

- implements #632,added branch/tag/bookmarks info into feeds

  added changeset link to body of message

- implemented #638 permissions overview to groups

- implements #636, lazy loading of history and authors to speed up source

  pages rendering

- implemented #647, option to pass list of default encoding used to

  encode to/decode from unicode

- added caching layer into RSS/ATOM feeds.

- basic implementation of cherry picking changesets for pull request, ref #575

- implemented #661 Add option to include diff in RSS feed

- implemented file history page for showing detailed changelog for a given file

- implemented #663 Admin/permission: specify default repogroup perms

- implemented #379 defaults settings page for creation of repositories, locking

  statistics, downloads, repository type

- implemented #210 filtering of admin journal based on Whoosh Query language

- added parents/children links in changeset viewref #650

fixes

+++++

- fixed git version checker

- #586 patched basic auth handler to fix issues with git behind proxy

- #589 search urlgenerator didn't properly escape special characters

- fixed issue #614 Include repo name in delete confirmation dialog

- fixed #623: Lang meta-tag doesn't work with C#/C++

- fixes #612 Double quotes to Single quotes result in bad html in diff

- fixes #630 git statistics do too much work making them slow.

- fixes #625 Git-Tags are not displayed in Shortlog

- fix for issue #602, enforce str when setting mercurial UI object.

  When this is used together with mercurial internal translation system

  it can lead to UnicodeDecodeErrors

- fixes #645 Fix git handler when doing delete remote branch

- fix issue #504 RhodeCode is showing different versions of README on

  different summary page loads

- implemented #658 Changing username in LDAP-Mode should not be allowed.

- fixes #652 switch to generator approach when doing file annotation to prevent

  huge memory consumption

- fixes #666 move lockkey path location to cache_dir to ensure this path is

  always writable for rhodecode server

- many more small fixes and improvements

- fixed issues with recursive scans on removed repositories that could take

  long time on instance start

1.4.4 (**2012-10-08**)

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

news

++++

- obfuscate db password in logs for engine connection string

- #574 Show pull request status also in shortlog (if any)

- remember selected tab in my account page

- Bumped mercurial version to 2.3.2

- #595 rcextension hook for repository delete

fixes

+++++

- Add git version detection to warn users that Git used in system is to

  old. Ref #588 - also show git version in system details in settings page

- fixed files quick filter links

- #590 Add GET flag that controls the way the diff are generated, for pull

  requests we want to use non-bundle based diffs, That are far better for

  doing code reviews. The /compare url still uses bundle compare for full

  comparison including the incoming changesets

- Fixed #585, checks for status of revision where to strict, and made

  opening pull request with those revision impossible due to previously set

  status. Checks now are made also for the repository.

- fixes #591 git backend was causing encoding errors when handling binary

  files - added a test case for VCS lib tests

- fixed #597 commits in future get negative age.

- fixed #598 API docs methods had wrong members parameter as returned data

1.4.3 (**2012-09-28**)

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

news

++++

- #558 Added config file to hooks extra data

.. note::

   If you enable proxy pass-through authentication, make sure your server is

   only accessible through the proxy. Otherwise, any client would be able to

   forge the authentication header and could effectively become authenticated

   using any account of their liking.

Integration with Issue trackers

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

RhodeCode provides a simple integration with issue trackers. It's possible

to define a regular expression that will fetch issue id stored in commit

messages and replace that with an url to this issue. To enable this simply

uncomment following variables in the ini file::

    url_pat = (?:^#|\s#)(\w+)

    issue_server_link = https://myissueserver.com/{repo}/issue/{id}

    issue_prefix = #

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

can be found at *rhodecode.lib.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.

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.

In order to start using celery run::

 paster celeryd <configfile.ini>

.. note::

   Make sure you run this command from the same virtualenv, and with the same

   user that rhodecode runs.

HTTPS support

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

There are two ways to enable https:

- Set HTTP_X_URL_SCHEME in your http server headers, than rhodecode will

  recognize this headers and make proper https redirections

- Alternatively, change the `force_https = true` flag in the ini configuration

  to force using https, no headers are needed than to enable https

Nginx virtual host example

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

Sample config for nginx using proxy::

    upstream rc {

        server 127.0.0.1:5000;

        # add more instances for load balancing

        #server 127.0.0.1:5001;

        #server 127.0.0.1:5002;

    }

.c1 { color: #999988; font-style: italic } /* Comment.Single */

.gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */

.ge { font-style: italic } /* Generic.Emph */

.gr { color: #aa0000 } /* Generic.Error */

.gh { color: #999999 } /* Generic.Heading */

.gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */

.go { color: #111 } /* Generic.Output */

.gp { color: #555555 } /* Generic.Prompt */

.gs { font-weight: bold } /* Generic.Strong */

.gu { color: #aaaaaa } /* Generic.Subheading */

.gt { color: #aa0000 } /* Generic.Traceback */

.kc { font-weight: bold } /* Keyword.Constant */

.kd { font-weight: bold } /* Keyword.Declaration */

.kp { font-weight: bold } /* Keyword.Pseudo */

.kr { font-weight: bold } /* Keyword.Reserved */

.kt { color: #445588; font-weight: bold } /* Keyword.Type */

.m { color: #009999 } /* Literal.Number */

.s { color: #bb8844 } /* Literal.String */

.na { color: #008080 } /* Name.Attribute */

.nb { color: #999999 } /* Name.Builtin */

.nc { color: #445588; font-weight: bold } /* Name.Class */

.no { color: #ff99ff } /* Name.Constant */

.ni { color: #800080 } /* Name.Entity */

.ne { color: #990000; font-weight: bold } /* Name.Exception */

.nf { color: #990000; font-weight: bold } /* Name.Function */

.nn { color: #555555 } /* Name.Namespace */

.nt { color: #000080 } /* Name.Tag */

.nv { color: purple } /* Name.Variable */

.ow { font-weight: bold } /* Operator.Word */

.mf { color: #009999 } /* Literal.Number.Float */

.mh { color: #009999 } /* Literal.Number.Hex */

.mi { color: #009999 } /* Literal.Number.Integer */

.mo { color: #009999 } /* Literal.Number.Oct */

.sb { color: #bb8844 } /* Literal.String.Backtick */

.sc { color: #bb8844 } /* Literal.String.Char */

.sd { color: #bb8844 } /* Literal.String.Doc */

.s2 { color: #bb8844 } /* Literal.String.Double */

.se { color: #bb8844 } /* Literal.String.Escape */

.sh { color: #bb8844 } /* Literal.String.Heredoc */

.si { color: #bb8844 } /* Literal.String.Interpol */

.sx { color: #bb8844 } /* Literal.String.Other */

.sr { color: #808000 } /* Literal.String.Regex */

.s1 { color: #bb8844 } /* Literal.String.Single */

.ss { color: #bb8844 } /* Literal.String.Symbol */

.bp { color: #999999 } /* Name.Builtin.Pseudo */

.vc { color: #ff99ff } /* Name.Variable.Class */

.vg { color: #ff99ff } /* Name.Variable.Global */

.vi { color: #ff99ff } /* Name.Variable.Instance */

#email_prefix = [RhodeCode]

#smtp_server = mail.server.com

#smtp_username = 

#smtp_password = 

#smtp_port = 

#smtp_use_tls = false

#smtp_use_ssl = true

# Specify available auth parameters here (e.g. LOGIN PLAIN CRAM-MD5, etc.)

#smtp_auth = 

[server:main]

## PASTE

##nr of threads to spawn

#threadpool_workers = 5

##max request before thread respawn

#threadpool_max_requests = 10

##option to use threads of process

#use_threadpool = true

#use = egg:Paste#http

#WAITRESS

threads = 5

#100GB

max_request_body_size = 107374182400

use = egg:waitress#main

host = 127.0.0.1

port = 8001

[filter:proxy-prefix]

# prefix middleware for rc

use = egg:PasteDeploy#prefix

prefix = /<your-prefix>

[app:main]

use = egg:rhodecode

#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

app_instance_uuid = rc-production

cut_off_limit = 256000

vcs_full_cache = True

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

force_https = false

# use Strict-Transport-Security headers

use_htsts = false

commit_parse_limit = 50

# number of items displayed in lightweight dashboard before paginating

dashboard_items = 100

use_gravatar = true

# path to git executable

git_path = git

## RSS feed options

rss_cut_off_limit = 256000

rss_items_per_page = 10

rss_include_diff = false

## alternative_gravatar_url allows you to use your own avatar server application

## the following parts of the URL will be replaced

## {email}        user email

## {md5email}     md5 hash of the user email (like at gravatar.com)

## {size}         size of the image that is expected from the server application

## {scheme}       http/https from RhodeCode server

## {netloc}       network location from RhodeCode server

#alternative_gravatar_url = http://myavatarserver.com/getbyemail/{email}/{size}

#alternative_gravatar_url = http://myavatarserver.com/getbymd5/{md5email}?s={size}

container_auth_enabled = false

proxypass_auth_enabled = false

## default encoding used to convert from and to unicode

## can be also a comma seperated list of encoding in case of mixed encodings

default_encoding = utf8

## overwrite schema of clone url

## available vars:

## scheme - http/https

## user - current user

## pass - password 

## netloc - network location

## path - usually repo_name

#clone_uri = {scheme}://{user}{pass}{netloc}{path}

## issue tracking mapping for commits messages

## comment out issue_pat, issue_server, issue_prefix to enable

## pattern to get the issues from commit messages

## default one used here is #<numbers> with a regex passive group for `#`

## {id} will be all groups matched from this pattern

issue_pat = (?:\s*#)(\d+)

## server url to the issue, each {id} will be replaced with match

## fetched from the regex and {repo} is replaced with full repository name

## including groups {repo_name} is replaced with just name of repo

issue_server_link = https://myissueserver.com/{repo}/issue/{id}

## prefix to add to link to indicate it's an url

## #314 will be replaced by <issue_prefix><id>

issue_prefix = #

## issue_pat, issue_server_link, issue_prefix can have suffixes to specify

## multiple patterns, to other issues server, wiki or others

## below an example how to create a wiki pattern 

#  #wiki-some-id -> https://mywiki.com/some-id

#issue_pat_wiki = (?:wiki-)(.+)

#issue_server_link_wiki = https://mywiki.com/{id}

#issue_prefix_wiki = WIKI-

## instance-id prefix

## a prefix key for this instance used for cache invalidation when running 

## multiple instances of rhodecode, make sure it's globally unique for 

## all running rhodecode instances. Leave empty if you don't use it

instance_id = 

## alternative return HTTP header for failed authentication. Default HTTP

## response is 401 HTTPUnauthorized. Currently HG clients have troubles with 

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

auth_ret_code =

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

###        CELERY CONFIG        ####

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

use_celery = false

broker.host = localhost

broker.vhost = rabbitmqhost

broker.port = 5672

broker.user = rabbitmq

broker.password = qweqwe

celery.imports = rhodecode.lib.celerylib.tasks