README.rst
114 lines
| 4.0 KiB
| text/x-rst
|
RstLexer
r572 | ||||
r796 | ================================================= | |||
Welcome to RhodeCode (RhodiumCode) documentation! | ||||
================================================= | ||||
r572 | ||||
r796 | ``RhodeCode`` (formerly hg-app) is Pylons framework based Mercurial repository | |||
browser/management with build in push/pull server and full text search. | ||||
It works on http/https, has build in permission/authentication(+ldap) features | ||||
r847 | It's similar to github or bitbucket, but it's suppose to run as standalone | |||
hosted application, it's open source and focuses more on restricted access to | ||||
repositories. It's powered by vcs_ library that me na Lukasz Balcerzak created | ||||
to handle many various version control systems. | ||||
r572 | ||||
RhodeCode uses `Semantic Versioning <http://semver.org/>`_ | ||||
RhodeCode demo | ||||
-------------- | ||||
http://hg.python-works.com | ||||
r847 | The default access is anonymous but You can login to administrative account | |||
using those credentials | ||||
r254 | ||||
r572 | - username: demo | |||
- password: demo | ||||
Source code | ||||
----------- | ||||
r847 | The most up to date sources can be obtained from my own RhodeCode instance | |||
https://rhodecode.org | ||||
r254 | ||||
r847 | Rarely updated source code and issue tracker is available at bitbcuket | |||
http://bitbucket.org/marcinkuzminski/rhodecode | ||||
r572 | ||||
r796 | Installation | |||
------------ | ||||
r572 | ||||
r576 | Please visit http://packages.python.org/RhodeCode/installation.html | |||
r572 | ||||
Features | ||||
-------- | ||||
r847 | - Has it's own middleware to handle mercurial_ protocol request. | |||
r676 | Each request can be logged and authenticated. Runs on threads unlikely to | |||
r847 | 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. | ||||
r564 | - 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 | |||
r847 | - Admin interface with user/permission management. Admin activity journal, logs | |||
pulls, pushes, forks, registrations and other actions made by all users. | ||||
r564 | - Server side forks, it's possible to fork a project and hack it free without | |||
r847 | breaking the main repository. | |||
- Full text search powered by Whoosh on source codes, and file names. | ||||
Build in indexing daemons, with optional incremental index build | ||||
r498 | (no external search servers required all in one application) | |||
r847 | - Setup project descriptions and info inside built in db for easy, non | |||
file-system operations | ||||
- Inteligent cache with invalidation after push or project change, provides high | ||||
performance and always up to date data. | ||||
- Rss / atom feeds, gravatar support, download sources as zip/tar/gz | ||||
r572 | - Async tasks for speed and performance using celery_ (works without them too) | |||
r564 | - Backup scripts can do backup of whole app and send it over scp to desired | |||
r847 | location | |||
- Based on pylons / sqlalchemy / sqlite / whoosh / vcs | ||||
r253 | ||||
r796 | .. include:: ./docs/screenshots.rst | |||
r676 | Incoming / Plans | |||
---------------- | ||||
r253 | ||||
r847 | - project grouping | |||
- User groups/teams | ||||
r572 | - code review (probably based on hg-review) | |||
r796 | - full git_ support, with push/pull server (currently in beta tests) | |||
r727 | - redmine integration | |||
r847 | - public accessible activity feeds | |||
r572 | - commit based build in wiki system | |||
r624 | - clone points and cloning from remote repositories into rhodecode | |||
(git_ and mercurial_) | ||||
r676 | - more statistics and graph (global annotation + some more statistics) | |||
r572 | - other cools stuff that i can figure out (or You can help me figure out) | |||
r552 | ||||
r572 | License | |||
------- | ||||
``rhodecode`` is released under GPL_ license. | ||||
r676 | Mailing group Q&A | |||
----------------- | ||||
r796 | join the `Google group <http://groups.google.com/group/rhodecode>`_ | |||
r676 | ||||
r796 | open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_ | |||
r676 | ||||
r796 | join #rhodecode on FreeNode (irc.freenode.net) | |||
or use http://webchat.freenode.net/?channels=rhodecode for web access to irc. | ||||
Online documentation | ||||
-------------------- | ||||
r572 | ||||
Online documentation for current version is available at | ||||
r576 | http://packages.python.org/RhodeCode/. | |||
r572 | You may also build documentation for yourself - go into ``docs/`` and run:: | |||
make html | ||||