README.rst
179 lines
| 6.4 KiB
| text/x-rst
|
RstLexer
r2020 | ========= | |||
RhodeCode | ||||
========= | ||||
About | ||||
----- | ||||
r572 | ||||
r3363 | ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_ | |||
with a built in push/pull server, full text search and code-review. | ||||
It works on http/https and has a built in permission/authentication system with | ||||
r1982 | the ability to authenticate via LDAP or ActiveDirectory. RhodeCode also provides | |||
r1750 | simple API so it's easy integrable with existing external systems. | |||
r1093 | ||||
r3363 | RhodeCode is similar in some respects to github_ or bitbucket_, | |||
r1750 | however RhodeCode can be run as standalone hosted application on your own server. | |||
r3363 | It is open source and donation ware and focuses more on providing a customized, | |||
self administered interface for Mercurial_ and GIT_ repositories. | ||||
RhodeCode works on \*nix systems and Windows it is powered by a vcs_ library | ||||
that Lukasz Balcerzak and Marcin Kuzminski created to handle multiple | ||||
r2117 | different version control systems. | |||
r572 | ||||
r2167 | RhodeCode uses `PEP386 versioning <http://www.python.org/dev/peps/pep-0386/>`_ | |||
r572 | ||||
r2020 | Installation | |||
------------ | ||||
Stable releases of RhodeCode are best installed via:: | ||||
easy_install rhodecode | ||||
Or:: | ||||
r3363 | pip install rhodecode | |||
r2020 | ||||
Detailed instructions and links may be found on the Installation page. | ||||
Please visit http://packages.python.org/RhodeCode/installation.html for | ||||
more details | ||||
r572 | RhodeCode demo | |||
-------------- | ||||
r1127 | http://demo.rhodecode.org | |||
r572 | ||||
r1093 | The default access is anonymous but you can login to an administrative account | |||
using the following credentials: | ||||
r254 | ||||
r572 | - username: demo | |||
r1488 | - password: demo12 | |||
r572 | ||||
Source code | ||||
----------- | ||||
r1167 | The latest sources can be obtained from official RhodeCode instance | |||
r3363 | https://secure.rhodecode.org | |||
r254 | ||||
r1167 | ||||
MIRRORS: | ||||
Issue tracker and sources at bitbucket_ | ||||
r847 | http://bitbucket.org/marcinkuzminski/rhodecode | |||
r572 | ||||
r1167 | Sources at github_ | |||
https://github.com/marcinkuzminski/rhodecode | ||||
r572 | ||||
r1093 | RhodeCode Features | |||
------------------ | ||||
r572 | ||||
r3363 | - Has its own middleware to handle mercurial_ and git_ protocol requests. | |||
r3342 | 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 | ||||
- 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. | ||||
- Users groups for easier permission management | ||||
r1405 | - Repository groups let you group repos and manage them easier. | |||
r3342 | - 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 | ||||
any issue tracker, and with an JSON-RPC API you can make much more | ||||
r1488 | - Build in commit-api let's you add, edit and commit files right from RhodeCode | |||
r3342 | web interface using simple editor or upload binary files using simple form. | |||
- Powerfull pull-request driven review system with inline commenting, | ||||
changeset statuses, and notification system. | ||||
- Importing and syncing repositories from remote locations for GIT_, Mercurial_ and SVN. | ||||
r1093 | - Mako templates let's you customize the look and feel of the application. | |||
r3363 | - Beautiful diffs, annotations and source code browsing all colored by pygments. | |||
r3342 | 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 | ||||
r847 | - Admin interface with user/permission management. Admin activity journal, logs | |||
pulls, pushes, forks, registrations and other actions made by all users. | ||||
r3363 | - Server side forks. It is possible to fork a project and modify it freely | |||
r3342 | without breaking the main repository. | |||
r3363 | - rst and markdown README support for repositories. | |||
r3342 | - Full text search powered by Whoosh on the source files, commit messages, and file names. | |||
r847 | Build in indexing daemons, with optional incremental index build | |||
r1093 | (no external search servers required all in one application) | |||
r3363 | - Setup project descriptions/tags and info inside built in db for easy, non | |||
r3342 | file-system operations. | |||
r3363 | - Intelligent cache with invalidation after push or project change, provides | |||
r1167 | high performance and always up to date data. | |||
r3342 | - RSS / Atom feeds, gravatar support, downloadable sources as zip/tar/gz | |||
r3363 | - Optional async tasks for speed and performance using celery_ | |||
- Backup scripts can do backup of whole app and send it over scp to desired | ||||
location | ||||
r847 | - Based on pylons / sqlalchemy / sqlite / whoosh / vcs | |||
r253 | ||||
r3363 | ||||
r676 | Incoming / Plans | |||
---------------- | ||||
r253 | ||||
r3342 | - Finer granular permissions per branch, or subrepo | |||
- Web based merges for pull requests | ||||
- Tracking history for each lines in files | ||||
r3363 | - Simple issue tracker | |||
r1093 | - SSH based authentication with server side key management | |||
- Commit based built in wiki system | ||||
r3342 | - Gist server | |||
r1093 | - More statistics and graph (global annotation + some more statistics) | |||
r3363 | - Other advancements as development continues (or you can of course make | |||
r1167 | additions and or requests) | |||
r552 | ||||
r572 | License | |||
------- | ||||
r1206 | ``RhodeCode`` is released under the GPLv3 license. | |||
r572 | ||||
r2020 | Getting help | |||
------------ | ||||
r676 | ||||
r2020 | Listed bellow are various support resources that should help. | |||
r676 | ||||
r2020 | .. note:: | |||
r3363 | ||||
r2601 | Please try to read the documentation before posting any issues, especially | |||
the **troubleshooting section** | ||||
r3363 | ||||
r2020 | - Join the `Google group <http://groups.google.com/group/rhodecode>`_ and ask | |||
any questions. | ||||
r676 | ||||
r2020 | - Open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_ | |||
- Join #rhodecode on FreeNode (irc.freenode.net) | ||||
or use http://webchat.freenode.net/?channels=rhodecode for web access to irc. | ||||
r2034 | - You can also follow me on twitter **@marcinkuzminski** where i often post some | |||
r2020 | news about RhodeCode | |||
r796 | ||||
Online documentation | ||||
-------------------- | ||||
r572 | ||||
r1093 | Online documentation for the current version of RhodeCode is available at | |||
r2020 | - http://packages.python.org/RhodeCode/ | |||
- http://rhodecode.readthedocs.org/en/latest/index.html | ||||
r1093 | You may also build the documentation for yourself - go into ``docs/`` and run:: | |||
r572 | ||||
make html | ||||
r1167 | (You need to have sphinx_ installed to build the documentation. If you don't | |||
r3363 | have sphinx_ installed you can install it via the command: | |||
r1167 | ``easy_install sphinx``) | |||
r3363 | ||||
r869 | .. _virtualenv: http://pypi.python.org/pypi/virtualenv | |||
.. _python: http://www.python.org/ | ||||
r1167 | .. _sphinx: http://sphinx.pocoo.org/ | |||
r869 | .. _mercurial: http://mercurial.selenic.com/ | |||
r1123 | .. _bitbucket: http://bitbucket.org/ | |||
r1167 | .. _github: http://github.com/ | |||
r869 | .. _subversion: http://subversion.tigris.org/ | |||
.. _git: http://git-scm.com/ | ||||
.. _celery: http://celeryproject.org/ | ||||
.. _Sphinx: http://sphinx.pocoo.org/ | ||||
r3363 | .. _vcs: http://pypi.python.org/pypi/vcs | |||