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