Mercurial > kallithea
annotate README.rst @ 1510:90062009bb1e beta
added default ldap option into migration
author | Marcin Kuzminski <marcin@python-works.com> |
---|---|
date | Tue, 04 Oct 2011 22:43:26 +0200 |
parents | dc16211e7292 |
children | bf263968da47 f40c94ace436 |
rev | line source |
---|---|
796 | 1 ================================================= |
2 Welcome to RhodeCode (RhodiumCode) documentation! | |
3 ================================================= | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
4 |
1093 | 5 ``RhodeCode`` (formerly hg-app) is a Pylons framework based Mercurial repository |
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 | |
8 the ability to authenticate via LDAP. | |
9 | |
1123 | 10 RhodeCode is similar in some respects to github or bitbucket_, |
1093 | 11 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 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 handle multiple different version control systems. | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
16 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
17 RhodeCode uses `Semantic Versioning <http://semver.org/>`_ |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
18 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
19 RhodeCode demo |
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 |
1127 | 22 http://demo.rhodecode.org |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
23 |
1093 | 24 The default access is anonymous but you can login to an administrative account |
25 using the following credentials: | |
254 | 26 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
27 - username: demo |
1488
dc16211e7292
Updated docs and contributors
Marcin Kuzminski <marcin@python-works.com>
parents:
1405
diff
changeset
|
28 - password: demo12 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
29 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
30 Source code |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
31 ----------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
32 |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
33 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
|
34 https://secure.rhodecode.org |
254 | 35 |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
36 |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
37 MIRRORS: |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
38 |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
39 Issue tracker and sources at bitbucket_ |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
40 |
847 | 41 http://bitbucket.org/marcinkuzminski/rhodecode |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
42 |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
43 Sources at github_ |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
44 |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
45 https://github.com/marcinkuzminski/rhodecode |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
46 |
796 | 47 Installation |
48 ------------ | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
49 |
1093 | 50 Please visit http://packages.python.org/RhodeCode/installation.html |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
51 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
52 |
1093 | 53 RhodeCode Features |
54 ------------------ | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
55 |
1093 | 56 - Has it's own middleware to handle mercurial_ protocol requests. |
57 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
|
58 - 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
|
59 Supports http/https and LDAP |
847 | 60 - Full permissions (private/read/write/admin) and authentication per project. |
61 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
|
62 - Have built in users groups for easier permission management |
1405 | 63 - 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
|
64 - 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
|
65 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
|
66 - 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
|
67 interface using simple editor or upload form for binaries. |
1093 | 68 - 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
|
69 - 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
|
70 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
|
71 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics |
847 | 72 - Admin interface with user/permission management. Admin activity journal, logs |
73 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
|
74 - 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
|
75 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
|
76 and install them |
1093 | 77 - Full text search powered by Whoosh on the source files, and file names. |
847 | 78 Build in indexing daemons, with optional incremental index build |
1093 | 79 (no external search servers required all in one application) |
847 | 80 - Setup project descriptions and info inside built in db for easy, non |
81 file-system operations | |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
82 - 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
|
83 high performance and always up to date data. |
847 | 84 - 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
|
85 - 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
|
86 - Backup scripts can do backup of whole app and send it over scp to desired |
847 | 87 location |
88 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs | |
0 | 89 |
253
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
90 |
796 | 91 .. include:: ./docs/screenshots.rst |
92 | |
93 | |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
94 Incoming / Plans |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
95 ---------------- |
241
48727add84c9
Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents:
224
diff
changeset
|
96 |
1488
dc16211e7292
Updated docs and contributors
Marcin Kuzminski <marcin@python-works.com>
parents:
1405
diff
changeset
|
97 - Finer granular permissions per branch, repo group or subrepo |
dc16211e7292
Updated docs and contributors
Marcin Kuzminski <marcin@python-works.com>
parents:
1405
diff
changeset
|
98 - pull requests and web based merges |
dc16211e7292
Updated docs and contributors
Marcin Kuzminski <marcin@python-works.com>
parents:
1405
diff
changeset
|
99 - notification and message system |
1093 | 100 - SSH based authentication with server side key management |
101 - Code review (probably based on hg-review) | |
102 - Full git_ support, with push/pull server (currently in beta tests) | |
1405 | 103 - Redmine and other bugtrackers integration |
1093 | 104 - Commit based built in wiki system |
105 - 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
|
106 - 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
|
107 additions and or requests) |
552
2642f128ad46
removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents:
549
diff
changeset
|
108 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
109 License |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
110 ------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
111 |
1206
a671db5bdd58
fixed license issue #149
Marcin Kuzminski <marcin@python-works.com>
parents:
1167
diff
changeset
|
112 ``RhodeCode`` is released under the GPLv3 license. |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
113 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
114 |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
115 Mailing group Q&A |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
116 ----------------- |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
117 |
1093 | 118 Join the `Google group <http://groups.google.com/group/rhodecode>`_ |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
119 |
1093 | 120 Open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_ |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
121 |
1093 | 122 Join #rhodecode on FreeNode (irc.freenode.net) |
796 | 123 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc. |
124 | |
125 Online documentation | |
126 -------------------- | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
127 |
1093 | 128 Online documentation for the current version of RhodeCode is available at |
129 http://packages.python.org/RhodeCode/. | |
130 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
|
131 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
132 make html |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
133 |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
134 (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
|
135 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
|
136 ``easy_install sphinx``) |
1093 | 137 |
869
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
138 .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
139 .. _python: http://www.python.org/ |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
140 .. _sphinx: http://sphinx.pocoo.org/ |
869
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
141 .. _mercurial: http://mercurial.selenic.com/ |
1123 | 142 .. _bitbucket: http://bitbucket.org/ |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
143 .. _github: http://github.com/ |
869
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
144 .. _subversion: http://subversion.tigris.org/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
145 .. _git: http://git-scm.com/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
146 .. _celery: http://celeryproject.org/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
147 .. _Sphinx: http://sphinx.pocoo.org/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
148 .. _vcs: http://pypi.python.org/pypi/vcs |