##// END OF EJS Templates
merge beta fixes into stable
marcink -
r1522:c252049a merge rhodecode-0.0.1.2.0 default
parent child Browse files
Show More
@@ -1,148 +1,149 b''
1 =================================================
1 =================================================
2 Welcome to RhodeCode (RhodiumCode) documentation!
2 Welcome to RhodeCode (RhodiumCode) documentation!
3 =================================================
3 =================================================
4
4
5 ``RhodeCode`` (formerly hg-app) is a Pylons framework based Mercurial repository
5 ``RhodeCode`` is a Pylons framework based Mercurial repository
6 browser/management tool with a built in push/pull server and full text search.
6 browser/management tool with a built in push/pull server and full text search.
7 It works on http/https and has a built in permission/authentication system with
7 It works on http/https and has a built in permission/authentication system with
8 the ability to authenticate via LDAP.
8 the ability to authenticate via LDAP or ActiveDirectory. RhodeCode also supports
9 simple API so it's easy integrable with existing systems.
9
10
10 RhodeCode is similar in some respects to github or bitbucket_,
11 RhodeCode is similar in some respects to github or bitbucket_,
11 however RhodeCode can be run as standalone hosted application on your own server.
12 however RhodeCode can be run as standalone hosted application on your own server.
12 It is open source and donation ware and focuses more on providing a customized,
13 It is open source and donation ware and focuses more on providing a customized,
13 self administered interface for Mercurial(and soon GIT) repositories.
14 self administered interface for Mercurial(and soon GIT) repositories.
14 RhodeCode is powered by a vcs_ library that Lukasz Balcerzak and I created to
15 RhodeCode is powered by a vcs_ library that Lukasz Balcerzak and I created to
15 handle multiple different version control systems.
16 handle multiple different version control systems.
16
17
17 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
18 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
18
19
19 RhodeCode demo
20 RhodeCode demo
20 --------------
21 --------------
21
22
22 http://demo.rhodecode.org
23 http://demo.rhodecode.org
23
24
24 The default access is anonymous but you can login to an administrative account
25 The default access is anonymous but you can login to an administrative account
25 using the following credentials:
26 using the following credentials:
26
27
27 - username: demo
28 - username: demo
28 - password: demo12
29 - password: demo12
29
30
30 Source code
31 Source code
31 -----------
32 -----------
32
33
33 The latest sources can be obtained from official RhodeCode instance
34 The latest sources can be obtained from official RhodeCode instance
34 https://secure.rhodecode.org
35 https://secure.rhodecode.org
35
36
36
37
37 MIRRORS:
38 MIRRORS:
38
39
39 Issue tracker and sources at bitbucket_
40 Issue tracker and sources at bitbucket_
40
41
41 http://bitbucket.org/marcinkuzminski/rhodecode
42 http://bitbucket.org/marcinkuzminski/rhodecode
42
43
43 Sources at github_
44 Sources at github_
44
45
45 https://github.com/marcinkuzminski/rhodecode
46 https://github.com/marcinkuzminski/rhodecode
46
47
47 Installation
48 Installation
48 ------------
49 ------------
49
50
50 Please visit http://packages.python.org/RhodeCode/installation.html
51 Please visit http://packages.python.org/RhodeCode/installation.html
51
52
52
53
53 RhodeCode Features
54 RhodeCode Features
54 ------------------
55 ------------------
55
56
56 - Has it's own middleware to handle mercurial_ protocol requests.
57 - Has it's own middleware to handle mercurial_ protocol requests.
57 Each request can be logged and authenticated.
58 Each request can be logged and authenticated.
58 - Runs on threads unlike hgweb. You can make multiple pulls/pushes simultaneous.
59 - Runs on threads unlike hgweb. You can make multiple pulls/pushes simultaneous.
59 Supports http/https and LDAP
60 Supports http/https and LDAP
60 - Full permissions (private/read/write/admin) and authentication per project.
61 - Full permissions (private/read/write/admin) and authentication per project.
61 One account for web interface and mercurial_ push/pull/clone operations.
62 One account for web interface and mercurial_ push/pull/clone operations.
62 - Have built in users groups for easier permission management
63 - Have built in users groups for easier permission management
63 - Repository groups let you group repos and manage them easier.
64 - Repository groups let you group repos and manage them easier.
64 - Users can fork other users repo. RhodeCode have also compare view to see
65 - Users can fork other users repo. RhodeCode have also compare view to see
65 combined changeset for all changeset made within single push.
66 combined changeset for all changeset made within single push.
66 - Build in commit-api let's you add, edit and commit files right from RhodeCode
67 - Build in commit-api let's you add, edit and commit files right from RhodeCode
67 interface using simple editor or upload form for binaries.
68 interface using simple editor or upload form for binaries.
68 - Mako templates let's you customize the look and feel of the application.
69 - Mako templates let's you customize the look and feel of the application.
69 - Beautiful diffs, annotations and source code browsing all colored by pygments.
70 - Beautiful diffs, annotations and source code browsing all colored by pygments.
70 Raw diffs are made in git-diff format, including git_ binary-patches
71 Raw diffs are made in git-diff format, including git_ binary-patches
71 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics
72 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics
72 - Admin interface with user/permission management. Admin activity journal, logs
73 - Admin interface with user/permission management. Admin activity journal, logs
73 pulls, pushes, forks, registrations and other actions made by all users.
74 pulls, pushes, forks, registrations and other actions made by all users.
74 - Server side forks. It is possible to fork a project and modify it freely
75 - Server side forks. It is possible to fork a project and modify it freely
75 without breaking the main repository. You can even write Your own hooks
76 without breaking the main repository. You can even write Your own hooks
76 and install them
77 and install them
77 - Full text search powered by Whoosh on the source files, and file names.
78 - Full text search powered by Whoosh on the source files, and file names.
78 Build in indexing daemons, with optional incremental index build
79 Build in indexing daemons, with optional incremental index build
79 (no external search servers required all in one application)
80 (no external search servers required all in one application)
80 - Setup project descriptions and info inside built in db for easy, non
81 - Setup project descriptions and info inside built in db for easy, non
81 file-system operations
82 file-system operations
82 - Intelligent cache with invalidation after push or project change, provides
83 - Intelligent cache with invalidation after push or project change, provides
83 high performance and always up to date data.
84 high performance and always up to date data.
84 - Rss / atom feeds, gravatar support, download sources as zip/tar/gz
85 - Rss / atom feeds, gravatar support, download sources as zip/tar/gz
85 - Async tasks for speed and performance using celery_ (works without them too)
86 - Async tasks for speed and performance using celery_ (works without them too)
86 - Backup scripts can do backup of whole app and send it over scp to desired
87 - Backup scripts can do backup of whole app and send it over scp to desired
87 location
88 location
88 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs
89 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs
89
90
90
91
91 .. include:: ./docs/screenshots.rst
92 .. include:: ./docs/screenshots.rst
92
93
93
94
94 Incoming / Plans
95 Incoming / Plans
95 ----------------
96 ----------------
96
97
97 - Finer granular permissions per branch, repo group or subrepo
98 - Finer granular permissions per branch, repo group or subrepo
98 - pull requests and web based merges
99 - pull requests and web based merges
99 - notification and message system
100 - notification and message system
100 - SSH based authentication with server side key management
101 - SSH based authentication with server side key management
101 - Code review (probably based on hg-review)
102 - Code review (probably based on hg-review)
102 - Full git_ support, with push/pull server (currently in beta tests)
103 - Full git_ support, with push/pull server (currently in beta tests)
103 - Redmine and other bugtrackers integration
104 - Redmine and other bugtrackers integration
104 - Commit based built in wiki system
105 - Commit based built in wiki system
105 - More statistics and graph (global annotation + some more statistics)
106 - More statistics and graph (global annotation + some more statistics)
106 - Other advancements as development continues (or you can of course make
107 - Other advancements as development continues (or you can of course make
107 additions and or requests)
108 additions and or requests)
108
109
109 License
110 License
110 -------
111 -------
111
112
112 ``RhodeCode`` is released under the GPLv3 license.
113 ``RhodeCode`` is released under the GPLv3 license.
113
114
114
115
115 Mailing group Q&A
116 Mailing group Q&A
116 -----------------
117 -----------------
117
118
118 Join the `Google group <http://groups.google.com/group/rhodecode>`_
119 Join the `Google group <http://groups.google.com/group/rhodecode>`_
119
120
120 Open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_
121 Open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_
121
122
122 Join #rhodecode on FreeNode (irc.freenode.net)
123 Join #rhodecode on FreeNode (irc.freenode.net)
123 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc.
124 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc.
124
125
125 Online documentation
126 Online documentation
126 --------------------
127 --------------------
127
128
128 Online documentation for the current version of RhodeCode is available at
129 Online documentation for the current version of RhodeCode is available at
129 http://packages.python.org/RhodeCode/.
130 http://packages.python.org/RhodeCode/.
130 You may also build the documentation for yourself - go into ``docs/`` and run::
131 You may also build the documentation for yourself - go into ``docs/`` and run::
131
132
132 make html
133 make html
133
134
134 (You need to have sphinx_ installed to build the documentation. If you don't
135 (You need to have sphinx_ installed to build the documentation. If you don't
135 have sphinx_ installed you can install it via the command:
136 have sphinx_ installed you can install it via the command:
136 ``easy_install sphinx``)
137 ``easy_install sphinx``)
137
138
138 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
139 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
139 .. _python: http://www.python.org/
140 .. _python: http://www.python.org/
140 .. _sphinx: http://sphinx.pocoo.org/
141 .. _sphinx: http://sphinx.pocoo.org/
141 .. _mercurial: http://mercurial.selenic.com/
142 .. _mercurial: http://mercurial.selenic.com/
142 .. _bitbucket: http://bitbucket.org/
143 .. _bitbucket: http://bitbucket.org/
143 .. _github: http://github.com/
144 .. _github: http://github.com/
144 .. _subversion: http://subversion.tigris.org/
145 .. _subversion: http://subversion.tigris.org/
145 .. _git: http://git-scm.com/
146 .. _git: http://git-scm.com/
146 .. _celery: http://celeryproject.org/
147 .. _celery: http://celeryproject.org/
147 .. _Sphinx: http://sphinx.pocoo.org/
148 .. _Sphinx: http://sphinx.pocoo.org/
148 .. _vcs: http://pypi.python.org/pypi/vcs No newline at end of file
149 .. _vcs: http://pypi.python.org/pypi/vcs
General Comments 0
You need to be logged in to leave comments. Login now