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

Welcome to RhodeCode (RhodiumCode) documentation!

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

``RhodeCode`` (formerly hg-app) is a Pylons framework based Mercurial repository 

browser/management tool with a built in push/pull server and full text search.

It works on http/https and has a built in permission/authentication system with 

the ability to authenticate via LDAP.

RhodeCode is similar in some respects to github or bitbucket_, 

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

It is open source and donation ware and focuses more on providing a customized, 

RhodeCode Features

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

- Has it's own middleware to handle mercurial_ protocol requests. 

  Each request can be logged and authenticated.

- Runs on threads unlike hgweb. You can make multiple pulls/pushes simultaneous.

  Supports http/https and LDAP

- Full permissions (private/read/write/admin) and authentication per project. 

  One account for web interface and mercurial_ push/pull/clone operations.

- Have built in users groups for easier permission management

- Users can fork other users repo. RhodeCode have also compare view to see

  combined changeset for all changeset made within single push.

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

- Beautiful diffs, annotations and source code browsing all colored by pygments. 

  Raw diffs are made in git-diff format, including git_ binary-patches

- Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics

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

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

- Server side forks. It is possible to fork a project and modify it freely 

  without breaking the main repository. You can even write Your own hooks 

  and install them

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

  Build in indexing daemons, with optional incremental index build

  (no external search servers required all in one application)

- Async tasks for speed and performance using celery_ (works without them too)  

- Backup scripts can do backup of whole app and send it over scp to desired 

  location 

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

.. include:: ./docs/screenshots.rst

Incoming / Plans

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

- Finer granular permissions (per branch or subrepo)

- SSH based authentication with server side key management

- Code review (probably based on hg-review)

- Full git_ support, with push/pull server (currently in beta tests)

- Commit based built in wiki system

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

- Other advancements as development continues (or you can of course make 

  additions and or requests)

License

-------

``RhodeCode`` is released under the GPLv3 license.

Mailing group Q&A