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