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