comparison README.rst @ 847:75c425d0afeb beta

updated readme
author Marcin Kuzminski <marcin@python-works.com>
date Mon, 13 Dec 2010 01:06:48 +0100
parents 47d5781bfe8a
children 86cbf8e6d76a
comparison
equal deleted inserted replaced
846:121c17037d7a 847:75c425d0afeb
4 ================================================= 4 =================================================
5 5
6 ``RhodeCode`` (formerly hg-app) is Pylons framework based Mercurial repository 6 ``RhodeCode`` (formerly hg-app) is Pylons framework based Mercurial repository
7 browser/management with build in push/pull server and full text search. 7 browser/management with build in push/pull server and full text search.
8 It works on http/https, has build in permission/authentication(+ldap) features 8 It works on http/https, has build in permission/authentication(+ldap) features
9 It's similar to github or bitbucket, but it's suppose to run as standalone hosted 9 It's similar to github or bitbucket, but it's suppose to run as standalone
10 application, it's open source and focuses more on restricted access to 10 hosted application, it's open source and focuses more on restricted access to
11 repositories. It's powered by vcs_ library that we created to handle many 11 repositories. It's powered by vcs_ library that me na Lukasz Balcerzak created
12 various version control systems. 12 to handle many various version control systems.
13 13
14 RhodeCode uses `Semantic Versioning <http://semver.org/>`_ 14 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
15 15
16 RhodeCode demo 16 RhodeCode demo
17 -------------- 17 --------------
18 18
19 http://hg.python-works.com 19 http://hg.python-works.com
20 20
21 The default access is 21 The default access is anonymous but You can login to administrative account
22 using those credentials
22 23
23 - username: demo 24 - username: demo
24 - password: demo 25 - password: demo
25 26
26 Source code 27 Source code
27 ----------- 28 -----------
28 29
29 Source code is along with issue tracker is available at 30 The most up to date sources can be obtained from my own RhodeCode instance
31 https://rhodecode.org
32
33 Rarely updated source code and issue tracker is available at bitbcuket
30 http://bitbucket.org/marcinkuzminski/rhodecode 34 http://bitbucket.org/marcinkuzminski/rhodecode
31
32 Also a source codes can be obtained from demo RhodeCode instance
33 http://hg.python-works.com/rhodecode/summary
34 35
35 Installation 36 Installation
36 ------------ 37 ------------
37 38
38 Please visit http://packages.python.org/RhodeCode/installation.html 39 Please visit http://packages.python.org/RhodeCode/installation.html
39 40
40 41
41 Features 42 Features
42 -------- 43 --------
43 44
44 - Has it's own middleware to handle mercurial_ and git_ protocol request. 45 - Has it's own middleware to handle mercurial_ protocol request.
45 Each request can be logged and authenticated. Runs on threads unlikely to 46 Each request can be logged and authenticated. Runs on threads unlikely to
46 hgweb You can make multiple pulls/pushes simultaneous. Supports http/https 47 hgweb. You can make multiple pulls/pushes simultaneous. Supports http/https
47 both on git_ and mercurial_ 48 and ldap
48 - Full permissions and authentication per project private/read/write/admin. 49 - Full permissions (private/read/write/admin) and authentication per project.
49 One account for web interface and mercurial_ push/pull/clone. 50 One account for web interface and mercurial_ push/pull/clone operations.
50 - Mako templates let's you customize look and feel of application. 51 - Mako templates let's you customize look and feel of application.
51 - Beautiful diffs, annotations and source codes all colored by pygments. 52 - Beautiful diffs, annotations and source codes all colored by pygments.
52 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics 53 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics
53 - Admin interface with user/permission management. User activity journal logs 54 - Admin interface with user/permission management. Admin activity journal, logs
54 pulls, pushes, forks,registrations. Possible to disable built in hooks 55 pulls, pushes, forks, registrations and other actions made by all users.
55 - Server side forks, it's possible to fork a project and hack it free without 56 - Server side forks, it's possible to fork a project and hack it free without
56 breaking the main. 57 breaking the main repository.
57 - Full text search on source codes, search on file names. All powered by whoosh 58 - Full text search powered by Whoosh on source codes, and file names.
58 and build in indexing daemons 59 Build in indexing daemons, with optional incremental index build
59 (no external search servers required all in one application) 60 (no external search servers required all in one application)
60 - Rss / atom feeds, gravatar support, download sources as zip/tarballs 61 - Setup project descriptions and info inside built in db for easy, non
62 file-system operations
63 - Inteligent cache with invalidation after push or project change, provides high
64 performance and always up to date data.
65 - Rss / atom feeds, gravatar support, download sources as zip/tar/gz
61 - Async tasks for speed and performance using celery_ (works without them too) 66 - Async tasks for speed and performance using celery_ (works without them too)
62 - Backup scripts can do backup of whole app and send it over scp to desired 67 - Backup scripts can do backup of whole app and send it over scp to desired
63 location 68 location
64 - Setup project descriptions and info inside built in db for easy, non 69 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs
65 file-system operations
66 - Added cache with invalidation on push/repo management for high performance and
67 always up to date data.
68 - Based on pylons 1.0 / sqlalchemy 0.6 / sqlite
69 70
70 71
71 .. include:: ./docs/screenshots.rst 72 .. include:: ./docs/screenshots.rst
72 73
73 74
74 Incoming / Plans 75 Incoming / Plans
75 ---------------- 76 ----------------
76 77
78 - project grouping
79 - User groups/teams
77 - code review (probably based on hg-review) 80 - code review (probably based on hg-review)
78 - full git_ support, with push/pull server (currently in beta tests) 81 - full git_ support, with push/pull server (currently in beta tests)
79 - project grouping
80 - redmine integration 82 - redmine integration
83 - public accessible activity feeds
81 - commit based build in wiki system 84 - commit based build in wiki system
82 - clone points and cloning from remote repositories into rhodecode 85 - clone points and cloning from remote repositories into rhodecode
83 (git_ and mercurial_) 86 (git_ and mercurial_)
84 - more statistics and graph (global annotation + some more statistics) 87 - more statistics and graph (global annotation + some more statistics)
85 - other cools stuff that i can figure out (or You can help me figure out) 88 - other cools stuff that i can figure out (or You can help me figure out)