##// END OF EJS Templates
updated readme
marcink -
r3848:832907f4 beta
parent child Browse files
Show More
@@ -1,179 +1,180 b''
1 =========
1 =========
2 RhodeCode
2 RhodeCode
3 =========
3 =========
4
4
5 About
5 About
6 -----
6 -----
7
7
8 ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_
8 ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_
9 with a built in push/pull server, full text search and code-review.
9 with a built in push/pull server, full text search and code-review.
10 It works on http/https and has a built in permission/authentication system with
10 It works on http/https and has a built in permission/authentication system with
11 the ability to authenticate via LDAP or ActiveDirectory. RhodeCode also provides
11 the ability to authenticate via LDAP or ActiveDirectory. RhodeCode also provides
12 simple API so it's easy integrable with existing external systems.
12 simple API so it's easy integrable with existing external systems.
13
13
14 RhodeCode is similar in some respects to github_ or bitbucket_,
14 RhodeCode is similar in some respects to github_ or bitbucket_,
15 however RhodeCode can be run as standalone hosted application on your own server.
15 however RhodeCode can be run as standalone hosted application on your own server.
16 It is open source and donation ware and focuses more on providing a customized,
16 It is open source and donation ware and focuses more on providing a customized,
17 self administered interface for Mercurial_ and GIT_ repositories.
17 self administered interface for Mercurial_ and GIT_ repositories.
18 RhodeCode works on \*nix systems and Windows it is powered by a vcs_ library
18 RhodeCode works on \*nix systems and Windows it is powered by a vcs_ library
19 that Lukasz Balcerzak and Marcin Kuzminski created to handle multiple
19 that Lukasz Balcerzak and Marcin Kuzminski created to handle multiple
20 different version control systems.
20 different version control systems.
21
21
22 RhodeCode uses `PEP386 versioning <http://www.python.org/dev/peps/pep-0386/>`_
22 RhodeCode uses `PEP386 versioning <http://www.python.org/dev/peps/pep-0386/>`_
23
23
24 Installation
24 Installation
25 ------------
25 ------------
26 Stable releases of RhodeCode are best installed via::
26 Stable releases of RhodeCode are best installed via::
27
27
28 easy_install rhodecode
28 easy_install rhodecode
29
29
30 Or::
30 Or::
31
31
32 pip install rhodecode
32 pip install rhodecode
33
33
34 Detailed instructions and links may be found on the Installation page.
34 Detailed instructions and links may be found on the Installation page.
35
35
36 Please visit http://packages.python.org/RhodeCode/installation.html for
36 Please visit http://packages.python.org/RhodeCode/installation.html for
37 more details
37 more details
38
38
39 RhodeCode demo
39 RhodeCode demo
40 --------------
40 --------------
41
41
42 http://demo.rhodecode.org
42 http://demo.rhodecode.org
43
43
44 The default access is anonymous but you can login to an administrative account
44 The default access is anonymous but you can login to an administrative account
45 using the following credentials:
45 using the following credentials:
46
46
47 - username: demo
47 - username: demo
48 - password: demo12
48 - password: demo12
49
49
50 Source code
50 Source code
51 -----------
51 -----------
52
52
53 The latest sources can be obtained from official RhodeCode instance
53 The latest sources can be obtained from official RhodeCode instance
54 https://secure.rhodecode.org
54 https://secure.rhodecode.org
55
55
56
56
57 MIRRORS:
57 MIRRORS:
58
58
59 Issue tracker and sources at bitbucket_
59 Issue tracker and sources at bitbucket_
60
60
61 http://bitbucket.org/marcinkuzminski/rhodecode
61 http://bitbucket.org/marcinkuzminski/rhodecode
62
62
63 Sources at github_
63 Sources at github_
64
64
65 https://github.com/marcinkuzminski/rhodecode
65 https://github.com/marcinkuzminski/rhodecode
66
66
67
67
68 RhodeCode Features
68 RhodeCode Features
69 ------------------
69 ------------------
70
70
71 - Has its own middleware to handle mercurial_ and git_ protocol requests.
71 - Has its own middleware to handle mercurial_ and git_ protocol requests.
72 Each request is authenticated and logged together with IP address.
72 Each request is authenticated and logged together with IP address.
73 - Build for speed and performance. You can make multiple pulls/pushes simultaneous.
73 - Build for speed and performance. You can make multiple pulls/pushes simultaneous.
74 Proven to work with 1000s of repositories and users
74 Proven to work with 1000s of repositories and users
75 - Supports http/https, LDAP, AD, proxy-pass authentication.
75 - Supports http/https, LDAP, AD, proxy-pass authentication.
76 - Full permissions (private/read/write/admin) together with IP restrictions for each repository,
76 - Full permissions (private/read/write/admin) together with IP restrictions for each repository,
77 additional explicit forking and repository creation permissions.
77 additional explicit forking, repositories group and repository creation permissions.
78 - User groups for easier permission management
78 - User groups for easier permission management.
79 - Repository groups let you group repos and manage them easier.
79 - Repository groups let you group repos and manage them easier. They come with
80 permission delegation features, so you can delegate groups management.
80 - Users can fork other users repos, and compare them at any time.
81 - Users can fork other users repos, and compare them at any time.
82 - Built in Gist functionality for sharing code snippets.
81 - Integrates easily with other systems, with custom created mappers you can connect it to almost
83 - Integrates easily with other systems, with custom created mappers you can connect it to almost
82 any issue tracker, and with an JSON-RPC API you can make much more
84 any issue tracker, and with an JSON-RPC API you can make much more
83 - Build in commit-api let's you add, edit and commit files right from RhodeCode
85 - Build in commit-api let's you add, edit and commit files right from RhodeCode
84 web interface using simple editor or upload binary files using simple form.
86 web interface using simple editor or upload binary files using simple form.
85 - Powerfull pull-request driven review system with inline commenting,
87 - Powerfull pull-request driven review system with inline commenting,
86 changeset statuses, and notification system.
88 changeset statuses, and notification system.
87 - Importing and syncing repositories from remote locations for GIT_, Mercurial_ and SVN.
89 - Importing and syncing repositories from remote locations for GIT_, Mercurial_ and SVN.
88 - Mako templates let's you customize the look and feel of the application.
90 - Mako templates let's you customize the look and feel of the application.
89 - Beautiful diffs, annotations and source code browsing all colored by pygments.
91 - Beautiful diffs, annotations and source code browsing all colored by pygments.
90 Raw diffs are made in git-diff format for both VCS systems, including GIT_ binary-patches
92 Raw diffs are made in git-diff format for both VCS systems, including GIT_ binary-patches
91 - Mercurial_ and Git_ DAG graphs and yui-flot powered graphs with zooming and statistics
93 - Mercurial_ and Git_ DAG graphs and yui-flot powered graphs with zooming and statistics
92 to track activity for repositories
94 to track activity for repositories
93 - Admin interface with user/permission management. Admin activity journal, logs
95 - Admin interface with user/permission management. Admin activity journal, logs
94 pulls, pushes, forks, registrations and other actions made by all users.
96 pulls, pushes, forks, registrations and other actions made by all users.
95 - Server side forks. It is possible to fork a project and modify it freely
97 - Server side forks. It is possible to fork a project and modify it freely
96 without breaking the main repository.
98 without breaking the main repository.
97 - rst and markdown README support for repositories.
99 - rst and markdown README support for repositories.
98 - Full text search powered by Whoosh on the source files, commit messages, and file names.
100 - Full text search powered by Whoosh on the source files, commit messages, and file names.
99 Build in indexing daemons, with optional incremental index build
101 Build in indexing daemons, with optional incremental index build
100 (no external search servers required all in one application)
102 (no external search servers required all in one application)
101 - Setup project descriptions/tags and info inside built in db for easy, non
103 - Setup project descriptions/tags and info inside built in db for easy, non
102 file-system operations.
104 file-system operations.
103 - Intelligent cache with invalidation after push or project change, provides
105 - Intelligent cache with invalidation after push or project change, provides
104 high performance and always up to date data.
106 high performance and always up to date data.
105 - RSS / Atom feeds, gravatar support, downloadable sources as zip/tar/gz
107 - RSS / Atom feeds, gravatar support, downloadable sources as zip/tar/gz
106 - Optional async tasks for speed and performance using celery_
108 - Optional async tasks for speed and performance using celery_
107 - Backup scripts can do backup of whole app and send it over scp to desired
109 - Backup scripts can do backup of whole app and send it over scp to desired
108 location
110 location
109 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs
111 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs
110
112
111
113
112 Incoming / Plans
114 Incoming / Plans
113 ----------------
115 ----------------
114
116
115 - Finer granular permissions per branch, or subrepo
117 - Finer granular permissions per branch, or subrepo
116 - Web based merges for pull requests
118 - Web based merges for pull requests
117 - Tracking history for each lines in files
119 - Tracking history for each lines in files
118 - Simple issue tracker
120 - Simple issue tracker
119 - SSH based authentication with server side key management
121 - SSH based authentication with server side key management
120 - Commit based built in wiki system
122 - Commit based built in wiki system
121 - Gist server
122 - More statistics and graph (global annotation + some more statistics)
123 - More statistics and graph (global annotation + some more statistics)
123 - Other advancements as development continues (or you can of course make
124 - Other advancements as development continues (or you can of course make
124 additions and or requests)
125 additions and or requests)
125
126
126 License
127 License
127 -------
128 -------
128
129
129 ``RhodeCode`` is released under the GPLv3 license.
130 ``RhodeCode`` is released under the GPLv3 license.
130
131
131
132
132 Getting help
133 Getting help
133 ------------
134 ------------
134
135
135 Listed bellow are various support resources that should help.
136 Listed bellow are various support resources that should help.
136
137
137 .. note::
138 .. note::
138
139
139 Please try to read the documentation before posting any issues, especially
140 Please try to read the documentation before posting any issues, especially
140 the **troubleshooting section**
141 the **troubleshooting section**
141
142
142 - Join the `Google group <http://groups.google.com/group/rhodecode>`_ and ask
143 - Join the `Google group <http://groups.google.com/group/rhodecode>`_ and ask
143 any questions.
144 any questions.
144
145
145 - Open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_
146 - Open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_
146
147
147 - Join #rhodecode on FreeNode (irc.freenode.net)
148 - Join #rhodecode on FreeNode (irc.freenode.net)
148 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc.
149 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc.
149
150
150 - You can also follow me on twitter **@marcinkuzminski** where i often post some
151 - You can also follow me on twitter **@marcinkuzminski** where i often post some
151 news about RhodeCode
152 news about RhodeCode
152
153
153
154
154 Online documentation
155 Online documentation
155 --------------------
156 --------------------
156
157
157 Online documentation for the current version of RhodeCode is available at
158 Online documentation for the current version of RhodeCode is available at
158 - http://packages.python.org/RhodeCode/
159 - http://packages.python.org/RhodeCode/
159 - http://rhodecode.readthedocs.org/en/latest/index.html
160 - http://rhodecode.readthedocs.org/en/latest/index.html
160
161
161 You may also build the documentation for yourself - go into ``docs/`` and run::
162 You may also build the documentation for yourself - go into ``docs/`` and run::
162
163
163 make html
164 make html
164
165
165 (You need to have sphinx_ installed to build the documentation. If you don't
166 (You need to have sphinx_ installed to build the documentation. If you don't
166 have sphinx_ installed you can install it via the command:
167 have sphinx_ installed you can install it via the command:
167 ``easy_install sphinx``)
168 ``easy_install sphinx``)
168
169
169 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
170 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
170 .. _python: http://www.python.org/
171 .. _python: http://www.python.org/
171 .. _sphinx: http://sphinx.pocoo.org/
172 .. _sphinx: http://sphinx.pocoo.org/
172 .. _mercurial: http://mercurial.selenic.com/
173 .. _mercurial: http://mercurial.selenic.com/
173 .. _bitbucket: http://bitbucket.org/
174 .. _bitbucket: http://bitbucket.org/
174 .. _github: http://github.com/
175 .. _github: http://github.com/
175 .. _subversion: http://subversion.tigris.org/
176 .. _subversion: http://subversion.tigris.org/
176 .. _git: http://git-scm.com/
177 .. _git: http://git-scm.com/
177 .. _celery: http://celeryproject.org/
178 .. _celery: http://celeryproject.org/
178 .. _Sphinx: http://sphinx.pocoo.org/
179 .. _Sphinx: http://sphinx.pocoo.org/
179 .. _vcs: http://pypi.python.org/pypi/vcs
180 .. _vcs: http://pypi.python.org/pypi/vcs
General Comments 0
You need to be logged in to leave comments. Login now