README.rst
102 lines
| 3.5 KiB
| text/x-rst
|
RstLexer
r572 | |||
RhodeCode (RhodiumCode) | |||
======================= | |||
``RhodeCode`` (formerly hg-app) is Pylons based repository management and | |||
r643 | 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. | |||
r572 | |||
RhodeCode uses `Semantic Versioning <http://semver.org/>`_ | |||
RhodeCode demo | |||
-------------- | |||
http://hg.python-works.com | |||
The default access is | |||
r254 | |||
r572 | - username: demo | ||
- password: demo | |||
Source code | |||
----------- | |||
Source code is along with issue tracker is available at | |||
http://bitbucket.org/marcinkuzminski/rhodecode | |||
r254 | |||
r572 | Also a source codes can be obtained from demo rhodecode instance | ||
http://hg.python-works.com/rhodecode/summary | |||
Instalation | |||
----------- | |||
r576 | Please visit http://packages.python.org/RhodeCode/installation.html | ||
r572 | |||
Features | |||
-------- | |||
r624 | - Has it's own middleware to handle mercurial_ 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 | |||
r564 | - Full permissions and authentication per project private/read/write/admin. | ||
r572 | One account for web interface and mercurial_ push/pull/clone. | ||
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 | ||
r564 | - 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 | |||
r549 | breaking the main. | ||
r564 | - Full text search on source codes, search on file names. All powered by whoosh | ||
and build in indexing daemons | |||
r498 | (no external search servers required all in one application) | ||
r564 | - Rss / atom feeds, gravatar support, download sources as zip/tarballs | ||
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 | ||
location | |||
- Setup project descriptions and info inside built in db for easy, non | |||
r290 | file-system operations | ||
r564 | - Added cache with invalidation on push/repo management for high performance and | ||
r540 | always up to date data. | ||
r564 | - Based on pylons 1.0 / sqlalchemy 0.6 / sqlite | ||
r253 | |||
r572 | Incoming | ||
-------- | |||
r253 | |||
r572 | - code review (probably based on hg-review) | ||
r624 | - full git_ support, with push/pull server | ||
r572 | - commit based build in wiki system | ||
r624 | - clone points and cloning from remote repositories into rhodecode | ||
(git_ and mercurial_) | |||
r572 | - some cache optimizations | ||
- other cools stuff that i can figure out (or You can help me figure out) | |||
r552 | |||
r572 | License | ||
------- | |||
``rhodecode`` is released under GPL_ license. | |||
Documentation | |||
------------- | |||
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 | |||
r576 | .. _virtualenv: http://pypi.python.org/pypi/virtualenv | ||
.. _python: http://www.python.org/ | |||
.. _django: http://www.djangoproject.com/ | |||
.. _mercurial: http://mercurial.selenic.com/ | |||
.. _subversion: http://subversion.tigris.org/ | |||
.. _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 |