About

-----

with a built in push/pull server and full text search and code-review.

the ability to authenticate via LDAP or ActiveDirectory. RhodeCode also provides

simple API so it's easy integrable with existing external systems.

however RhodeCode can be run as standalone hosted application on your own server.

different version control systems.

RhodeCode uses `PEP386 versioning <http://www.python.org/dev/peps/pep-0386/>`_

Or::

Detailed instructions and links may be found on the Installation page.

-----------

The latest sources can be obtained from official RhodeCode instance

MIRRORS:

RhodeCode Features

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

  Each request is authenticated and logged together with IP address.

- Build for speed and performance. You can make multiple pulls/pushes simultaneous.

  Proven to work with 1000s of repositories and users

  changeset statuses, and notification system.

- Importing and syncing repositories from remote locations for GIT_, Mercurial_ and  SVN.

- Mako templates let's you customize the look and feel of the application.

  Raw diffs are made in git-diff format for both VCS systems, including GIT_ binary-patches

- Mercurial_ and Git_ DAG graphs and yui-flot powered graphs with zooming and statistics

  to track activity for repositories

- Admin interface with user/permission management. Admin activity journal, logs

  pulls, pushes, forks, registrations and other actions made by all users.

  without breaking the main repository.

- Full text search powered by Whoosh on the source files, commit messages, and file names.

  Build in indexing daemons, with optional incremental index build

  (no external search servers required all in one application)

  file-system operations.

  high performance and always up to date data.

- RSS / Atom feeds, gravatar support, downloadable sources as zip/tar/gz

- Based on pylons / sqlalchemy / sqlite / whoosh / vcs

Incoming / Plans

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

- Finer granular permissions per branch, or subrepo

- Web based merges for pull requests

- Tracking history for each lines in files

- SSH based authentication with server side key management

- Commit based built in wiki system

- Gist server

- More statistics and graph (global annotation + some more statistics)

  additions and or requests)

License

Listed bellow are various support resources that should help.

.. note::

   Please try to read the documentation before posting any issues, especially

   the **troubleshooting section**

- Join the `Google group <http://groups.google.com/group/rhodecode>`_ and ask

  any questions.

   make html

(You need to have sphinx_ installed to build the documentation. If you don't

``easy_install sphinx``)

.. _virtualenv: http://pypi.python.org/pypi/virtualenv

.. _python: http://www.python.org/

.. _sphinx: http://sphinx.pocoo.org/

.. _git: http://git-scm.com/

.. _celery: http://celeryproject.org/

.. _Sphinx: http://sphinx.pocoo.org/

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

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

, then it is set to id of user whos calling this method.

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

INPUT::

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>",

                "api_key" :     "<api_key>",

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.

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

add_user_to_users_group

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

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

belonging to user with admin rights

    id : <id_given_in_input>

    result: {

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

                      User is already in that group"

            }

    error:  null

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

Removes a user from a users group. If user is not in given group success will

using api_key belonging to user with admin rights

    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" :     [

                                    "type":        "user",

                                    "user_id" :    "<user_id>",

                                    "username" :   "<username>",

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

                                  },

                                  …

                                    "type":      "users_group",

                                    "id" :       "<usersgroupid>",

                                    "name" :     "<usersgroupname>",

                                    "active" :      "<bool>",

                                    "admin" :       "<bool>",

                                    "ldap_dn" :     "<ldap_dn>",

                                  },

                 ]

            }

    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

-----------

rights or regular user that have admin access to repository.

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

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 permission for users group on given repository, or update

api_key belonging to user with admin rights.

              "success": true

            }

    error:  null

revoke_users_group_permission

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

executed only using api_key belonging to user with admin rights.

INPUT::

              "msg" : "Revoked perm for group: `<usersgroupname>` in repo: `<reponame>`",

              "success": true

            }

.. automodule:: rhodecode.model

   :members:

.. automodule:: rhodecode.model.comment

   :members:

.. automodule:: rhodecode.model.notification

.. automodule:: rhodecode.model.permission

   :members:

.. automodule:: rhodecode.model.repo_permission

.. automodule:: rhodecode.model.repo

.. automodule:: rhodecode.model.repos_group

   :members:

.. automodule:: rhodecode.model.scm

   :members:

.. automodule:: rhodecode.model.user

.. automodule:: rhodecode.model.users_group

news

++++

  under-review status

- implemented #670 Implementation of Roles in Pull Request

- implemented #638 permissions overview to groups

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

  pages rendering

  encode to/decode from unicode

- added caching layer into RSS/ATOM feeds.

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

- 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

  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

  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

- 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 #570 explicit users group permissions can overwrite owner permissions

- fixed #578 set proper PATH with current Python for Git

- fixed issue with Git bare repos that ends with .git in name

1.4.2 (**2012-09-12**)

  groups. Now only write access to group allows to create a repostiory

  within that group

- #565 Add support for {netloc} and {scheme} to alternative_gravatar_url

fixes

+++++

++++

- always put a comment about code-review status change even if user send

- modified_on column saves repository update and it's going to be used

  later for light version of main page ref #500

- pull request notifications send much nicer emails with details about pull

+++++

- fixed migrations of permissions that can lead to inconsistency.

  with updating default permissions occurred. RhodeCode detects that now and

  resets default user permission to initial state if there is a need for that.

- #535 improved apache wsgi example configuration in docs

- fixes #550 mercurial repositories comparision failed when origin repo had

  additional not-common changesets

news

++++

- new codereview system

- email map, allowing users to have multiple email addresses mapped into

  their accounts

- #464 added links to groups in permission box

- #465 mentions autocomplete inside comments boxes

- #469 added --update-only option to whoosh to re-index only given list

- rhodecode-api CLI client

- new git http protocol replaced buggy dulwich implementation.

  Now based on pygrack & gitweb

  reformated based on user suggestions. Additional rss/atom feeds for user

  journal

- various i18n improvements

- File view now displays small gravatars off all authors of given file

- Implemented landing revisions. Each repository will get landing_rev attribute

  that defines 'default' revision/branch for generating readme files

  earliest possible call.

- Import remote svn repositories to mercurial using hgsubversion.

- Fixed #508 RhodeCode now has a option to explicitly set forking permissions

- RhodeCode can use alternative server for generating avatar icons

- implemented repositories locking. Pull locks, push unlocks. Also can be done

  via API calls

fixes

+++++

- improved translations

- fixes issue #455 Creating an archive generates an exception on Windows

  in out of disk space

- fixes issue #454 Search results under Windows include proceeding

  backslash

- fixed issue #459. Changed the way of obtaining logger in reindex task.

- fixed #453 added ID field in whoosh SCHEMA that solves the issue of

  reindexing modified files

- fixed #458 wrong count when no repos are present

  new chunk in html diff

- full text search now works also for commit messages

++++

- chinese traditional translation

fixes

+++++

- use ext_json for json module

- unified annotation view with file source view

- notification improvements, better inbox + css

  more compatible with LDAP servers

  Comments are now added via ajax and doesn't reload the page

- #374 LDAP config is discarded when LDAP can't be activated

- limited push/pull operations are now logged for git in the journal

- #418 cast to unicode fixes in notification objects

- #426 fixed mention extracting regex

- fixed remote-pulling for git remotes remopositories

  with submodules

- fixed issue with empty APIKEYS for users after registration ref. #438

- fixed issue with getting README files from git repositories

  post push/pull/create repo hooks callbacks

- implemented #377 Users view for his own permissions on account page

- #399 added inheritance of permissions for users group on repos groups

  inside a repository group

  solving issues with Mercurial and LDAP

  inside a group

- added gravatars into permission view and permissions autocomplete

  for all registered servers

fixes

- fixed #385 clone by ID url was loosing proxy prefix in URL

- fixed some unicode problems with waitress

- fixed issue with escaping < and > in changeset commits

  create_repo function

- fixed #393 py2.5 fixes for routes url generator

- fixed #397 Private repository groups shows up before login

- fixed #396 fixed problems with revoking users in nested groups

  utf8 charset

- #406 trim long branch/tag names in changelog to not break UI

1.3.3 (**2012-03-02**)

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

fixes

+++++

- fixed issues with removed repos was accidentally added as groups, after

  full rescan of paths

- fixes #376 Cannot edit user (using container auth)

  configuration

- fixed initial sorting of repos inside repo group

- fixes issue when user tried to resubmit same permission into user/user_groups

- fixed raw_changeset for git. It was generated with hg patch headers

- fixed vcs issue with last_changeset for filenodes

- fixed missing commit after hook delete

  for git repos

1.3.2 (**2012-02-28**)

- fixed git remote repos validator that prevented from cloning remote git repos

- fixes #370 ending slashes fixes for repo and groups

- fixes #368 improved git-protocol detection to handle other clients

  Moved To Root

- fixed #373 missing cascade drop on user_group_to_perm table

1.3.1 (**2012-02-27**)

+++++

- redirection loop occurs when remember-me wasn't checked during login

- don't fetch branch for git in file history dropdown. Causes unneeded slowness

1.3.0 (**2012-02-26**)

news

++++