Philip Jameson <philip.j@hostdime.com>

    Mads Kiilerich <madski@unity3d.com>

    Dan Sheridan <djs@adelard.com>

- Supports http/https, LDAP, AD, proxy-pass authentication.

- Full permissions (private/read/write/admin) together with IP restrictions for each repository,

  additional explicit forking and repository creation permissions.

- Repository groups let you group repos and manage them easier.

- Users can fork other users repos, and compare them at any time.

- Integrates easily with other systems, with custom created mappers you can connect it to almost

#smtp_port = 

#smtp_use_tls = false

#smtp_use_ssl = true

#smtp_auth = 

[server:main]

## PASTE

#threadpool_workers = 5

#threadpool_max_requests = 10

#use_threadpool = true

#use = egg:Paste#http

threads = 5

use = egg:waitress#main

host = 0.0.0.0

port = 5000

[app:main]

use = egg:rhodecode

#filter-with = proxy-prefix

full_stack = true

static_files = true

lang = en

cache_dir = %(here)s/data

index_dir = %(here)s/data/index

cut_off_limit = 256000

force_https = false

commit_parse_limit = 25

dashboard_items = 100

use_gravatar = true

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

#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

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

auth_ret_code =

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

###        CELERY CONFIG        ####

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

celeryd.log.level = debug

celeryd.max.tasks.per.child = 1

celery.always.eager = false

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

beaker.session.key = rhodecode

## sets session as invalid if it haven't been accessed for given amount of time

beaker.session.timeout = 2592000

beaker.session.httponly = true

#beaker.session.cookie_path = /<your-prefix>

beaker.session.secure = false

beaker.session.auto = False

## default cookie expiration time in seconds `true` expire at browser close ##

### [errormator] ###

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

errormator.server_url = https://api.errormator.com

errormator.api_key = YOUR_API_KEY

errormator.report_404 = false

errormator.slow_request_time = 1

errormator.slow_requests = true

# errormator.logging = true

# errormator.logging.level = WARNING

errormator.logging_on_error = false

errormator.environ_keys_whitelist = 

errormator.request_keys_blacklist =

errormator.log_namespace_blacklist =  

### [sentry] ###

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

sentry.dsn = YOUR_DNS

sentry.servers =

level = DEBUG

handlers = 

qualname = routes.middleware

propagate = 1

[logger_beaker]

API ACCESS FOR WEB VIEWS

++++++++++++++++++++++++

GET parameter `?api_key=<api_key>` to url. By default this is only

enabled on RSS/ATOM feed views.

All clients are required to send JSON-RPC spec JSON data::

        "id:"<id>",

        "api_key":"<api_key>",

        "method":"<method_name>",

RhodeCode API will return always a JSON-RPC response::

        "id":<id>, # matching id sent by request

        "result": "<result>"|null, # JSON formatted result, null if any errors

        "error": "null"|<error_message> # JSON formatted error (if any)

To get started quickly simply run::

  rhodecode-api _create_config --apikey=<youapikey> --apihost=<rhodecode host>

This will create a file named .config in the directory you executed it storing

json config file with credentials. You can skip this step and always provide

both of the arguments to be able to communicate with server

after that simply run any api command for example get_repo::

 rhodecode-api get_repo

 calling {"api_key": "<apikey>", "id": 75, "args": {}, "method": "get_repo"} to http://127.0.0.1:5000

Let's try again now giving the repoid as parameters::

    calling {"api_key": "<apikey>", "id": 39, "args": {"repoid": "rhodecode"}, "method": "get_repo"} to http://127.0.0.1:5000

    rhodecode said:

    {'error': None,

Dispatch rescan repositories action. If remove_obsolete is set

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

rights.

INPUT::

OUTPUT::

    id : <id_given_in_input>

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

    error :  null

lock

----

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

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

INPUT::

    args :    {

                "repoid" : "<reponame or repo_id>"

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

              }

OUTPUT::

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

defined IP addresses for given user.

rights.

INPUT::

                                ...

                             ]

             }

    error :  null

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.

rights, or regular users that cannot specify different userid than theirs

    id : <id_for_response>

    api_key : "<api_key>"

    method :  "get_user"

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

              }

OUTPUT::

    id : <id_given_in_input>

            {

                "user_id" :     "<user_id>",

                "username" :    "<username>",

                "firstname":    "<firstname>",

                "lastname" :    "<lastname>",

                "ldap_dn" :     "<ldap_dn>",

                "last_login":   "<last_login>",

              },

            ]

    error:  null

create_user

-----------

be executed only using api_key belonging to user with admin rights.

update_user

-----------

be executed only using api_key belonging to user with admin rights.

                "admin" :    "<bool>",

                "ldap_dn" :  "<ldap_dn>",

                "last_login": "<last_login>",

            }

    error:  null

-----------

be executed only using api_key belonging to user with admin rights.

get_users_group

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

belonging to user with admin rights.

    api_key : "<api_key>"

    method :  "get_users_group"

    args :    {

              }

OUTPUT::

               "group_name" :     "<groupname>",

               "active":          "<bool>",

               "members" :  [

                                "user_id" :  "<user_id>",

                                "username" : "<username>",

                                "firstname": "<firstname>",

get_users_groups

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

api_key belonging to user with admin rights.

create_users_group

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

belonging to user with admin rights

    id : <id_given_in_input>

    result: {

              "users_group": {

                     "users_group_id" : "<id>",

                     "group_name" :     "<groupname>",

add_user_to_users_group

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

`false`. This command can be executed only using api_key

belonging to user with admin rights

    api_key : "<api_key>"

    method :  "add_user_users_group"

    args:     {

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

              }

    id : <id_given_in_input>

    result: {

              "success": True|False # depends on if member is in group

                      User is already in that group"

            }

    error:  null

remove_user_from_users_group

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

using api_key belonging to user with admin rights

    api_key : "<api_key>"

    method :  "remove_user_from_users_group"

    args:     {

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

              }

    id : <id_given_in_input>

    result: {

              "success":  True|False,  # depends on if member is in group

                      User wasn't in group"

            }

    error:  null

--------

Gets an existing repository by it's name or repository_id. Members will return

rights or regular user that have at least read access to repository.

                "clone_uri" :        "<clone_uri>",

                "enable_downloads":  "<bool>",

                "enable_locking":    "<bool>",

                "private":           "<bool>",

                "description" :      "<description>",

                "landing_rev":       "<landing_rev>",

                "last_changeset":    {

                "owner":             "<repo_owner>",

                "fork_of":           "<name_of_fork_parent>",

                "members" :     [

                                    "user_id" :    "<user_id>",

                                    "username" :   "<username>",

                                    "firstname":   "<firstname>",

                                    "permission" : "repository.(read|write|admin)"

                                  },

                                  …

                                    "id" :       "<usersgroupid>",

                                    "name" :     "<usersgroupname>",

                                    "active":    "<bool>",

                                  },

                                  …

                                ]

            }

    error:  null

get_repos

---------

admin, write or read access to repository.

                "repo_type" :        "<repo_type>",

                "clone_uri" :        "<clone_uri>",

                "private": :         "<bool>",

                "description" :      "<description>",

                "landing_rev":       "<landing_rev>",

                "owner":             "<repo_owner>",

                "fork_of":           "<name_of_fork_parent>",

                "enable_downloads":  "<bool>",

                "enable_locking":    "<bool>",

              },

              …

            ]

get_repo_nodes

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

with admin rights

-----------

Creates a repository. If repository name contains "/", all needed repository

rights or regular user that have create repository permission. Regular users

cannot specify owner parameter

                "repo_type" :        "<repo_type>",

                "clone_uri" :        "<clone_uri>",

                "private": :         "<bool>",

                "description" :      "<description>",

                "landing_rev":       "<landing_rev>",

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

                "fork_of":           "<name_of_fork_parent>",

                "enable_downloads":  "<bool>",

                "enable_locking":    "<bool>",

              },

            }

    error:  null

                "copy_permissions": "<bool>",

                "private":          "<bool>",

                "landing_rev":      "<landing_rev>"

              }

OUTPUT::

delete_repo

-----------

INPUT::

    api_key : "<api_key>"

    method :  "delete_repo"

    args:     {

              }

OUTPUT::

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

Grant permission for user on given repository, or update existing one

with admin rights.

revoke_user_permission

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

only using api_key belonging to user with admin rights.

grant_users_group_permission

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

api_key belonging to user with admin rights.

    method :  "grant_users_group_permission"

    args:     {

                "repoid" : "<reponame or repo_id>"

                "perm" : "(repository.(none|read|write|admin))",

              }

              "success": true

            }

    error:  null