Show More
@@ -1,103 +1,104 b'' | |||
|
1 | 1 | |
|
2 | 2 | RhodeCode (RhodiumCode) |
|
3 | 3 | ======================= |
|
4 | 4 | |
|
5 | 5 | ``RhodeCode`` (formerly hg-app) is Pylons based repository management and |
|
6 | 6 | serving for mercurial_. It's similar to github or bitbucket, but it's suppose to run |
|
7 | 7 | as standalone app, it's open source and focuses more on restricted access to repositories |
|
8 | 8 | There's no default free access to RhodeCode You have to create an account in order |
|
9 | 9 | to use the application. It's powered by vcs_ library that we created to handle |
|
10 | 10 | many various version control systems. |
|
11 | 11 | |
|
12 | 12 | RhodeCode uses `Semantic Versioning <http://semver.org/>`_ |
|
13 | 13 | |
|
14 | 14 | |
|
15 | 15 | RhodeCode demo |
|
16 | 16 | -------------- |
|
17 | 17 | |
|
18 | 18 | http://hg.python-works.com |
|
19 | 19 | |
|
20 | 20 | The default access is |
|
21 | 21 | |
|
22 | 22 | - username: demo |
|
23 | 23 | - password: demo |
|
24 | 24 | |
|
25 | 25 | Source code |
|
26 | 26 | ----------- |
|
27 | 27 | |
|
28 | 28 | Source code is along with issue tracker is available at |
|
29 | 29 | http://bitbucket.org/marcinkuzminski/rhodecode |
|
30 | 30 | |
|
31 | 31 | Also a source codes can be obtained from demo rhodecode instance |
|
32 | 32 | http://hg.python-works.com/rhodecode/summary |
|
33 | 33 | |
|
34 | 34 | Instalation |
|
35 | 35 | ----------- |
|
36 | 36 | |
|
37 | 37 | Please visit http://packages.python.org/RhodeCode/installation.html |
|
38 | 38 | |
|
39 | 39 | |
|
40 | 40 | Features |
|
41 | 41 | -------- |
|
42 | 42 | |
|
43 |
- Has it's own middleware to handle mercurial_ protocol request. Each request |
|
|
44 |
be logged and authenticated. Runs on threads unlikely to hgweb You can |
|
|
45 | multiple pulls/pushes simultaneous | |
|
43 | - Has it's own middleware to handle mercurial_ protocol request. Each request | |
|
44 | can be logged and authenticated. Runs on threads unlikely to hgweb You can | |
|
45 | make multiple pulls/pushes simultaneous. Supports http/https | |
|
46 | 46 | - Full permissions and authentication per project private/read/write/admin. |
|
47 | 47 | One account for web interface and mercurial_ push/pull/clone. |
|
48 | 48 | - Mako templates let's you customize look and feel of application. |
|
49 | 49 | - Beautiful diffs, annotations and source codes all colored by pygments. |
|
50 | 50 | - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics |
|
51 | 51 | - Admin interface with user/permission management. User activity journal logs |
|
52 | 52 | pulls, pushes, forks,registrations. Possible to disable built in hooks |
|
53 | 53 | - Server side forks, it's possible to fork a project and hack it free without |
|
54 | 54 | breaking the main. |
|
55 | 55 | - Full text search on source codes, search on file names. All powered by whoosh |
|
56 | 56 | and build in indexing daemons |
|
57 | 57 | (no external search servers required all in one application) |
|
58 | 58 | - Rss / atom feeds, gravatar support, download sources as zip/tarballs |
|
59 | 59 | - Async tasks for speed and performance using celery_ (works without them too) |
|
60 | 60 | - Backup scripts can do backup of whole app and send it over scp to desired |
|
61 | 61 | location |
|
62 | 62 | - Setup project descriptions and info inside built in db for easy, non |
|
63 | 63 | file-system operations |
|
64 | 64 | - Added cache with invalidation on push/repo management for high performance and |
|
65 | 65 | always up to date data. |
|
66 | 66 | - Based on pylons 1.0 / sqlalchemy 0.6 / sqlite |
|
67 | 67 | |
|
68 | 68 | |
|
69 | 69 | Incoming |
|
70 | 70 | -------- |
|
71 | 71 | |
|
72 | 72 | - code review (probably based on hg-review) |
|
73 | - git_ support (when vcs_ can handle it - it's almost there !) | |
|
73 | - full git_ support, with push/pull server | |
|
74 | 74 | - commit based build in wiki system |
|
75 |
- clone points and cloning from remote repositories into rhodecode |
|
|
75 | - clone points and cloning from remote repositories into rhodecode | |
|
76 | (git_ and mercurial_) | |
|
76 | 77 | - some cache optimizations |
|
77 | 78 | - other cools stuff that i can figure out (or You can help me figure out) |
|
78 | 79 | |
|
79 | 80 | License |
|
80 | 81 | ------- |
|
81 | 82 | |
|
82 | 83 | ``rhodecode`` is released under GPL_ license. |
|
83 | 84 | |
|
84 | 85 | |
|
85 | 86 | Documentation |
|
86 | 87 | ------------- |
|
87 | 88 | |
|
88 | 89 | Online documentation for current version is available at |
|
89 | 90 | http://packages.python.org/RhodeCode/. |
|
90 | 91 | You may also build documentation for yourself - go into ``docs/`` and run:: |
|
91 | 92 | |
|
92 | 93 | make html |
|
93 | 94 | |
|
94 | 95 | .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
|
95 | 96 | .. _python: http://www.python.org/ |
|
96 | 97 | .. _django: http://www.djangoproject.com/ |
|
97 | 98 | .. _mercurial: http://mercurial.selenic.com/ |
|
98 | 99 | .. _subversion: http://subversion.tigris.org/ |
|
99 | 100 | .. _git: http://git-scm.com/ |
|
100 | 101 | .. _celery: http://celeryproject.org/ |
|
101 | 102 | .. _Sphinx: http://sphinx.pocoo.org/ |
|
102 | 103 | .. _GPL: http://www.gnu.org/licenses/gpl.html |
|
103 | 104 | .. _vcs: http://pypi.python.org/pypi/vcs No newline at end of file |
@@ -1,118 +1,119 b'' | |||
|
1 | 1 | .. _index: |
|
2 | 2 | |
|
3 | 3 | Welcome to RhodeCode (RhodiumCode) documentation! |
|
4 | 4 | ================================================= |
|
5 | 5 | |
|
6 | 6 | ``RhodeCode`` (formerly hg-app) is Pylons based repository management and |
|
7 | 7 | serving for mercurial_. It's similar to github or bitbucket, but it's suppose to run |
|
8 | 8 | as standalone app, it's open source and focuses more on restricted access to repositories |
|
9 | 9 | There's no default free access to RhodeCode You have to create an account in order |
|
10 | 10 | to use the application. It's powered by vcs_ library that we created to handle |
|
11 | 11 | many various version control systems. |
|
12 | 12 | |
|
13 | 13 | RhodeCode uses `Semantic Versioning <http://semver.org/>`_ |
|
14 | 14 | |
|
15 | 15 | |
|
16 | 16 | RhodeCode demo |
|
17 | 17 | -------------- |
|
18 | 18 | |
|
19 | 19 | http://hg.python-works.com |
|
20 | 20 | |
|
21 | 21 | The default access is |
|
22 | 22 | |
|
23 | 23 | - username: demo |
|
24 | 24 | - password: demo |
|
25 | 25 | |
|
26 | 26 | Source code |
|
27 | 27 | ----------- |
|
28 | 28 | |
|
29 | 29 | Source code is along with issue tracker is available at |
|
30 | 30 | http://bitbucket.org/marcinkuzminski/rhodecode |
|
31 | 31 | |
|
32 | 32 | Also a source codes can be obtained from demo rhodecode instance |
|
33 | 33 | http://hg.python-works.com/rhodecode/summary |
|
34 | 34 | |
|
35 | 35 | Features |
|
36 | 36 | -------- |
|
37 | 37 | |
|
38 |
- Has it's own middleware to handle mercurial_ protocol request. Each request |
|
|
39 |
be logged and authenticated. Runs on threads unlikely to hgweb You can |
|
|
40 | multiple pulls/pushes simultaneous | |
|
38 | - Has it's own middleware to handle mercurial_ protocol request. Each request | |
|
39 | can be logged and authenticated. Runs on threads unlikely to hgweb You can | |
|
40 | make multiple pulls/pushes simultaneous. Supports http/https | |
|
41 | 41 | - Full permissions and authentication per project private/read/write/admin. |
|
42 | 42 | One account for web interface and mercurial_ push/pull/clone. |
|
43 | 43 | - Mako templates let's you customize look and feel of application. |
|
44 | 44 | - Beautiful diffs, annotations and source codes all colored by pygments. |
|
45 | 45 | - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics |
|
46 | 46 | - Admin interface with user/permission management. User activity journal logs |
|
47 | 47 | pulls, pushes, forks,registrations. Possible to disable built in hooks |
|
48 | 48 | - Server side forks, it's possible to fork a project and hack it free without |
|
49 | 49 | breaking the main. |
|
50 | 50 | - Full text search on source codes, search on file names. All powered by whoosh |
|
51 | 51 | and build in indexing daemons |
|
52 | 52 | (no external search servers required all in one application) |
|
53 | 53 | - Rss / atom feeds, gravatar support, download sources as zip/tarballs |
|
54 | 54 | - Async tasks for speed and performance using celery_ (works without them too) |
|
55 | 55 | - Backup scripts can do backup of whole app and send it over scp to desired |
|
56 | 56 | location |
|
57 | 57 | - Setup project descriptions and info inside built in db for easy, non |
|
58 | 58 | file-system operations |
|
59 | 59 | - Added cache with invalidation on push/repo management for high performance and |
|
60 | 60 | always up to date data. |
|
61 | 61 | - Based on pylons 1.0 / sqlalchemy 0.6 / sqlite |
|
62 | 62 | |
|
63 | 63 | |
|
64 | 64 | .. figure:: images/screenshot1_main_page.png |
|
65 | 65 | :align: left |
|
66 | 66 | |
|
67 | 67 | Main page of RhodeCode |
|
68 | 68 | |
|
69 | 69 | .. figure:: images/screenshot2_summary_page.png |
|
70 | 70 | :align: left |
|
71 | 71 | |
|
72 | 72 | Summary page |
|
73 | 73 | |
|
74 | 74 | |
|
75 | 75 | Incoming |
|
76 | 76 | -------- |
|
77 | 77 | |
|
78 | 78 | - code review (probably based on hg-review) |
|
79 | - git_ support (when vcs_ can handle it - it's almost there !) | |
|
79 | - full git_ support, with push/pull server | |
|
80 | 80 | - commit based build in wiki system |
|
81 |
- clone points and cloning from remote repositories into rhodecode |
|
|
81 | - clone points and cloning from remote repositories into rhodecode | |
|
82 | (git_ and mercurial_) | |
|
82 | 83 | - some cache optimizations |
|
83 | 84 | - other cools stuff that i can figure out (or You can help me figure out) |
|
84 | 85 | |
|
85 | 86 | License |
|
86 | 87 | ------- |
|
87 | 88 | |
|
88 | 89 | ``rhodecode`` is released under GPL_ license. |
|
89 | 90 | |
|
90 | 91 | |
|
91 | 92 | Documentation |
|
92 | 93 | ------------- |
|
93 | 94 | |
|
94 | 95 | **Installation:** |
|
95 | 96 | |
|
96 | 97 | .. toctree:: |
|
97 | 98 | :maxdepth: 1 |
|
98 | 99 | |
|
99 | 100 | installation |
|
100 | 101 | setup |
|
101 | 102 | changelog |
|
102 | 103 | |
|
103 | 104 | Other topics |
|
104 | 105 | ------------ |
|
105 | 106 | |
|
106 | 107 | * :ref:`genindex` |
|
107 | 108 | * :ref:`search` |
|
108 | 109 | |
|
109 | 110 | .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
|
110 | 111 | .. _python: http://www.python.org/ |
|
111 | 112 | .. _django: http://www.djangoproject.com/ |
|
112 | 113 | .. _mercurial: http://mercurial.selenic.com/ |
|
113 | 114 | .. _subversion: http://subversion.tigris.org/ |
|
114 | 115 | .. _git: http://git-scm.com/ |
|
115 | 116 | .. _celery: http://celeryproject.org/ |
|
116 | 117 | .. _Sphinx: http://sphinx.pocoo.org/ |
|
117 | 118 | .. _GPL: http://www.gnu.org/licenses/gpl.html |
|
118 | 119 | .. _vcs: http://pypi.python.org/pypi/vcs |
General Comments 0
You need to be logged in to leave comments.
Login now