index.rst
131 lines
| 3.9 KiB
| text/x-rst
|
RstLexer
/ docs / index.rst
r568 | .. _index: | |||
Welcome to RhodeCode (RhodiumCode) documentation! | ||||
================================================= | ||||
r572 | ``RhodeCode`` (formerly hg-app) is Pylons based repository management and | |||
r642 | serving for mercurial_ and git_. It's similar to github or bitbucket, but | |||
it's suppose to run as standalone app, it's open source and focuses more on | ||||
restricted access to repositories. There's no default free access to RhodeCode | ||||
You have to create an account in order to use the application. It's powered | ||||
by vcs_ library that we created to handle many various version control systems. | ||||
r568 | ||||
r572 | RhodeCode uses `Semantic Versioning <http://semver.org/>`_ | |||
RhodeCode demo | ||||
-------------- | ||||
r571 | ||||
http://hg.python-works.com | ||||
The default access is | ||||
- username: demo | ||||
- password: demo | ||||
r568 | ||||
r572 | Source code | |||
----------- | ||||
Source code is along with issue tracker is available at | ||||
http://bitbucket.org/marcinkuzminski/rhodecode | ||||
r568 | ||||
r642 | Also a source codes can be obtained from demo RhodeCode instance | |||
r572 | http://hg.python-works.com/rhodecode/summary | |||
r568 | ||||
r572 | Features | |||
-------- | ||||
r642 | - Has it's own middleware to handle mercurial_ and git_ protocol request. | |||
Each request can be logged and authenticated. Runs on threads unlikely to | ||||
hgweb You can make multiple pulls/pushes simultaneous. Supports http/https | ||||
both on git_ and mercurial_ | ||||
r568 | - Full permissions and authentication per project private/read/write/admin. | |||
r572 | One account for web interface and mercurial_ push/pull/clone. | |||
r568 | - Mako templates let's you customize look and feel of application. | |||
- Beautiful diffs, annotations and source codes all colored by pygments. | ||||
r572 | - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics | |||
r568 | - Admin interface with user/permission management. User activity journal logs | |||
pulls, pushes, forks,registrations. Possible to disable built in hooks | ||||
- Server side forks, it's possible to fork a project and hack it free without | ||||
breaking the main. | ||||
- Full text search on source codes, search on file names. All powered by whoosh | ||||
and build in indexing daemons | ||||
(no external search servers required all in one application) | ||||
- Rss / atom feeds, gravatar support, download sources as zip/tarballs | ||||
r572 | - Async tasks for speed and performance using celery_ (works without them too) | |||
r568 | - Backup scripts can do backup of whole app and send it over scp to desired | |||
location | ||||
- Setup project descriptions and info inside built in db for easy, non | ||||
file-system operations | ||||
- Added cache with invalidation on push/repo management for high performance and | ||||
always up to date data. | ||||
- Based on pylons 1.0 / sqlalchemy 0.6 / sqlite | ||||
.. figure:: images/screenshot1_main_page.png | ||||
:align: left | ||||
Main page of RhodeCode | ||||
.. figure:: images/screenshot2_summary_page.png | ||||
:align: left | ||||
Summary page | ||||
r676 | Incoming / Plans | |||
---------------- | ||||
r568 | ||||
r572 | - code review (probably based on hg-review) | |||
r624 | - full git_ support, with push/pull server | |||
r676 | - project grouping | |||
- anonymous access | ||||
- | ||||
r572 | - commit based build in wiki system | |||
r624 | - clone points and cloning from remote repositories into rhodecode | |||
(git_ and mercurial_) | ||||
r642 | - more statistics and graph (global annotation + some more statistics) | |||
- user customized activity dashboards | ||||
r572 | - some cache optimizations | |||
r568 | - other cools stuff that i can figure out (or You can help me figure out) | |||
r572 | License | |||
------- | ||||
``rhodecode`` is released under GPL_ license. | ||||
r676 | Mailing group Q&A | |||
----------------- | ||||
http://groups.google.com/group/rhodecode | ||||
r568 | Documentation | |||
r572 | ------------- | |||
r568 | ||||
**Installation:** | ||||
.. toctree:: | ||||
:maxdepth: 1 | ||||
installation | ||||
r642 | upgrade | |||
r568 | setup | |||
r585 | changelog | |||
r568 | ||||
Other topics | ||||
r572 | ------------ | |||
r568 | ||||
* :ref:`genindex` | ||||
* :ref:`search` | ||||
r572 | .. _virtualenv: http://pypi.python.org/pypi/virtualenv | |||
r568 | .. _python: http://www.python.org/ | |||
.. _django: http://www.djangoproject.com/ | ||||
.. _mercurial: http://mercurial.selenic.com/ | ||||
.. _subversion: http://subversion.tigris.org/ | ||||
r572 | .. _git: http://git-scm.com/ | |||
.. _celery: http://celeryproject.org/ | ||||
.. _Sphinx: http://sphinx.pocoo.org/ | ||||
.. _GPL: http://www.gnu.org/licenses/gpl.html | ||||
.. _vcs: http://pypi.python.org/pypi/vcs | ||||