Mercurial > kallithea
annotate README.rst @ 2065:9ab21c5ddb84 rhodecode-0.0.1.3.2
merge with beta
author | Marcin Kuzminski <marcin@python-works.com> |
---|---|
date | Tue, 28 Feb 2012 20:21:35 +0200 |
parents | 65e2ecfc433d |
children | dc2584ba5fbc |
rev | line source |
---|---|
2020 | 1 ========= |
2 RhodeCode | |
3 ========= | |
4 | |
5 About | |
6 ----- | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
7 |
1750 | 8 ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_ |
1982
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
1839
diff
changeset
|
9 with a built in push/pull server and full text search and code-review. |
1093 | 10 It works on http/https and has a built in permission/authentication system with |
1982
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
1839
diff
changeset
|
11 the ability to authenticate via LDAP or ActiveDirectory. RhodeCode also provides |
1750 | 12 simple API so it's easy integrable with existing external systems. |
1093 | 13 |
2034 | 14 RhodeCode is similar in some respects to github_ or bitbucket_, |
1750 | 15 however RhodeCode can be run as standalone hosted application on your own server. |
1093 | 16 It is open source and donation ware and focuses more on providing a customized, |
2034 | 17 self administered interface for Mercurial_ and GIT_ repositories. |
1093 | 18 RhodeCode is powered by a vcs_ library that Lukasz Balcerzak and I created to |
19 handle multiple different version control systems. | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
20 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
21 RhodeCode uses `Semantic Versioning <http://semver.org/>`_ |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
22 |
2020 | 23 Installation |
24 ------------ | |
25 Stable releases of RhodeCode are best installed via:: | |
26 | |
27 easy_install rhodecode | |
28 | |
29 Or:: | |
30 | |
31 pip install rhodecode | |
32 | |
33 Detailed instructions and links may be found on the Installation page. | |
34 | |
35 Please visit http://packages.python.org/RhodeCode/installation.html for | |
36 more details | |
37 | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
38 RhodeCode demo |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
39 -------------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
40 |
1127 | 41 http://demo.rhodecode.org |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
42 |
1093 | 43 The default access is anonymous but you can login to an administrative account |
44 using the following credentials: | |
254 | 45 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
46 - username: demo |
1488
dc16211e7292
Updated docs and contributors
Marcin Kuzminski <marcin@python-works.com>
parents:
1405
diff
changeset
|
47 - password: demo12 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
48 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
49 Source code |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
50 ----------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
51 |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
52 The latest sources can be obtained from official RhodeCode instance |
1488
dc16211e7292
Updated docs and contributors
Marcin Kuzminski <marcin@python-works.com>
parents:
1405
diff
changeset
|
53 https://secure.rhodecode.org |
254 | 54 |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
55 |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
56 MIRRORS: |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
57 |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
58 Issue tracker and sources at bitbucket_ |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
59 |
847 | 60 http://bitbucket.org/marcinkuzminski/rhodecode |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
61 |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
62 Sources at github_ |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
63 |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
64 https://github.com/marcinkuzminski/rhodecode |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
65 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
66 |
1093 | 67 RhodeCode Features |
68 ------------------ | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
69 |
1663 | 70 - Has its own middleware to handle mercurial_ protocol requests. |
1093 | 71 Each request can be logged and authenticated. |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
72 - Runs on threads unlike hgweb. You can make multiple pulls/pushes simultaneous. |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
73 Supports http/https and LDAP |
847 | 74 - Full permissions (private/read/write/admin) and authentication per project. |
75 One account for web interface and mercurial_ push/pull/clone operations. | |
1062
053983a464e4
docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
869
diff
changeset
|
76 - Have built in users groups for easier permission management |
1405 | 77 - Repository groups let you group repos and manage them easier. |
1062
053983a464e4
docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
869
diff
changeset
|
78 - Users can fork other users repo. RhodeCode have also compare view to see |
053983a464e4
docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
869
diff
changeset
|
79 combined changeset for all changeset made within single push. |
1488
dc16211e7292
Updated docs and contributors
Marcin Kuzminski <marcin@python-works.com>
parents:
1405
diff
changeset
|
80 - Build in commit-api let's you add, edit and commit files right from RhodeCode |
dc16211e7292
Updated docs and contributors
Marcin Kuzminski <marcin@python-works.com>
parents:
1405
diff
changeset
|
81 interface using simple editor or upload form for binaries. |
1093 | 82 - Mako templates let's you customize the look and feel of the application. |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
83 - Beautiful diffs, annotations and source code browsing all colored by pygments. |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
84 Raw diffs are made in git-diff format, including git_ binary-patches |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
85 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics |
847 | 86 - Admin interface with user/permission management. Admin activity journal, logs |
87 pulls, pushes, forks, registrations and other actions made by all users. | |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
88 - Server side forks. It is possible to fork a project and modify it freely |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
89 without breaking the main repository. You can even write Your own hooks |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
90 and install them |
1750 | 91 - code review with notification system, inline commenting, all parsed using |
92 rst syntax | |
93 - rst and markdown README support for repositories | |
1093 | 94 - Full text search powered by Whoosh on the source files, and file names. |
847 | 95 Build in indexing daemons, with optional incremental index build |
1093 | 96 (no external search servers required all in one application) |
847 | 97 - Setup project descriptions and info inside built in db for easy, non |
98 file-system operations | |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
99 - Intelligent cache with invalidation after push or project change, provides |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
100 high performance and always up to date data. |
847 | 101 - Rss / atom feeds, gravatar support, download sources as zip/tar/gz |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
102 - Async tasks for speed and performance using celery_ (works without them too) |
564
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
103 - Backup scripts can do backup of whole app and send it over scp to desired |
847 | 104 location |
105 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs | |
0 | 106 |
796 | 107 |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
108 Incoming / Plans |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
109 ---------------- |
241
48727add84c9
Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents:
224
diff
changeset
|
110 |
1488
dc16211e7292
Updated docs and contributors
Marcin Kuzminski <marcin@python-works.com>
parents:
1405
diff
changeset
|
111 - Finer granular permissions per branch, repo group or subrepo |
dc16211e7292
Updated docs and contributors
Marcin Kuzminski <marcin@python-works.com>
parents:
1405
diff
changeset
|
112 - pull requests and web based merges |
1750 | 113 - per line file history |
1093 | 114 - SSH based authentication with server side key management |
115 - Commit based built in wiki system | |
116 - More statistics and graph (global annotation + some more statistics) | |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
117 - Other advancements as development continues (or you can of course make |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
118 additions and or requests) |
552
2642f128ad46
removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents:
549
diff
changeset
|
119 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
120 License |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
121 ------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
122 |
1206
a671db5bdd58
fixed license issue #149
Marcin Kuzminski <marcin@python-works.com>
parents:
1167
diff
changeset
|
123 ``RhodeCode`` is released under the GPLv3 license. |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
124 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
125 |
2020 | 126 Getting help |
127 ------------ | |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
128 |
2020 | 129 Listed bellow are various support resources that should help. |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
130 |
2020 | 131 .. note:: |
132 | |
133 Please try to read the documentation before posting any issues | |
134 | |
135 - Join the `Google group <http://groups.google.com/group/rhodecode>`_ and ask | |
136 any questions. | |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
137 |
2020 | 138 - Open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_ |
139 | |
140 | |
141 - Join #rhodecode on FreeNode (irc.freenode.net) | |
142 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc. | |
143 | |
2034 | 144 - You can also follow me on twitter **@marcinkuzminski** where i often post some |
2020 | 145 news about RhodeCode |
146 | |
796 | 147 |
148 Online documentation | |
149 -------------------- | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
150 |
1093 | 151 Online documentation for the current version of RhodeCode is available at |
2020 | 152 - http://packages.python.org/RhodeCode/ |
153 - http://rhodecode.readthedocs.org/en/latest/index.html | |
154 | |
1093 | 155 You may also build the documentation for yourself - go into ``docs/`` and run:: |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
156 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
157 make html |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
158 |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
159 (You need to have sphinx_ installed to build the documentation. If you don't |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
160 have sphinx_ installed you can install it via the command: |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
161 ``easy_install sphinx``) |
1093 | 162 |
869
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
163 .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
164 .. _python: http://www.python.org/ |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
165 .. _sphinx: http://sphinx.pocoo.org/ |
869
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
166 .. _mercurial: http://mercurial.selenic.com/ |
1123 | 167 .. _bitbucket: http://bitbucket.org/ |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
168 .. _github: http://github.com/ |
869
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
169 .. _subversion: http://subversion.tigris.org/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
170 .. _git: http://git-scm.com/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
171 .. _celery: http://celeryproject.org/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
172 .. _Sphinx: http://sphinx.pocoo.org/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
173 .. _vcs: http://pypi.python.org/pypi/vcs |