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