Mercurial > kallithea
annotate README.rst @ 1286:0e0fb228867b
fixes #182
author | Marcin Kuzminski <marcin@python-works.com> |
---|---|
date | Tue, 26 Apr 2011 19:21:11 +0200 |
parents | 8363b0d20c41 |
children | bf263968da47 |
rev | line source |
---|---|
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
1 |
796 | 2 ================================================= |
3 Welcome to RhodeCode (RhodiumCode) documentation! | |
4 ================================================= | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
5 |
1091 | 6 ``RhodeCode`` (formerly hg-app) is a Pylons framework based Mercurial repository |
7 browser/management tool with a built in push/pull server and full text search. | |
8 It works on http/https and has a built in permission/authentication system with | |
9 the ability to authenticate via LDAP. | |
10 | |
1136
93b980ebee55
changes for release 1.1.5
Marcin Kuzminski <marcin@python-works.com>
parents:
1091
diff
changeset
|
11 RhodeCode is similar in some respects to github or bitbucket_, |
93b980ebee55
changes for release 1.1.5
Marcin Kuzminski <marcin@python-works.com>
parents:
1091
diff
changeset
|
12 however RhodeCode can be run as standalone hosted application on your own server. |
93b980ebee55
changes for release 1.1.5
Marcin Kuzminski <marcin@python-works.com>
parents:
1091
diff
changeset
|
13 It is open source and donation ware and focuses more on providing a customized, |
93b980ebee55
changes for release 1.1.5
Marcin Kuzminski <marcin@python-works.com>
parents:
1091
diff
changeset
|
14 self administered interface for Mercurial(and soon GIT) repositories. |
93b980ebee55
changes for release 1.1.5
Marcin Kuzminski <marcin@python-works.com>
parents:
1091
diff
changeset
|
15 RhodeCode is powered by a vcs_ library that Lukasz Balcerzak and I created to |
93b980ebee55
changes for release 1.1.5
Marcin Kuzminski <marcin@python-works.com>
parents:
1091
diff
changeset
|
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 |
1136
93b980ebee55
changes for release 1.1.5
Marcin Kuzminski <marcin@python-works.com>
parents:
1091
diff
changeset
|
23 http://demo.rhodecode.org |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
24 |
1091 | 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 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
29 - password: demo |
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 |
1216
8363b0d20c41
fixes for stable
Marcin Kuzminski <marcin@python-works.com>
parents:
1165
diff
changeset
|
34 The latest sources can be obtained from official RhodeCode instance |
1136
93b980ebee55
changes for release 1.1.5
Marcin Kuzminski <marcin@python-works.com>
parents:
1091
diff
changeset
|
35 https://hg.rhodecode.org |
254 | 36 |
1216
8363b0d20c41
fixes for stable
Marcin Kuzminski <marcin@python-works.com>
parents:
1165
diff
changeset
|
37 |
8363b0d20c41
fixes for stable
Marcin Kuzminski <marcin@python-works.com>
parents:
1165
diff
changeset
|
38 MIRRORS: |
8363b0d20c41
fixes for stable
Marcin Kuzminski <marcin@python-works.com>
parents:
1165
diff
changeset
|
39 |
8363b0d20c41
fixes for stable
Marcin Kuzminski <marcin@python-works.com>
parents:
1165
diff
changeset
|
40 Issue tracker and sources at bitbucket_ |
8363b0d20c41
fixes for stable
Marcin Kuzminski <marcin@python-works.com>
parents:
1165
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 |
1216
8363b0d20c41
fixes for stable
Marcin Kuzminski <marcin@python-works.com>
parents:
1165
diff
changeset
|
44 Sources at github_ |
8363b0d20c41
fixes for stable
Marcin Kuzminski <marcin@python-works.com>
parents:
1165
diff
changeset
|
45 |
8363b0d20c41
fixes for stable
Marcin Kuzminski <marcin@python-works.com>
parents:
1165
diff
changeset
|
46 https://github.com/marcinkuzminski/rhodecode |
8363b0d20c41
fixes for stable
Marcin Kuzminski <marcin@python-works.com>
parents:
1165
diff
changeset
|
47 |
796 | 48 Installation |
49 ------------ | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
50 |
1091 | 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 |
1091 | 54 RhodeCode Features |
55 ------------------ | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
56 |
1091 | 57 - Has it's own middleware to handle mercurial_ protocol requests. |
58 Each request can be logged and authenticated. | |
1216
8363b0d20c41
fixes for stable
Marcin Kuzminski <marcin@python-works.com>
parents:
1165
diff
changeset
|
59 - Runs on threads unlike hgweb. You can make multiple pulls/pushes simultaneous. |
1165
c5af1d3c861f
changes for rhodecode release 1.1.6
Marcin Kuzminski <marcin@python-works.com>
parents:
1136
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. | |
1091 | 63 - Mako templates let's you customize the look and feel of the application. |
64 - Beautiful diffs, annotations and source code browsing all colored by pygments. | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
65 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics |
847 | 66 - Admin interface with user/permission management. Admin activity journal, logs |
67 pulls, pushes, forks, registrations and other actions made by all users. | |
1091 | 68 - Server side forks. It is possible to fork a project and modify it freely without |
847 | 69 breaking the main repository. |
1091 | 70 - Full text search powered by Whoosh on the source files, and file names. |
847 | 71 Build in indexing daemons, with optional incremental index build |
498
6aa7db1c083a
version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
402
diff
changeset
|
72 (no external search servers required all in one application) |
847 | 73 - Setup project descriptions and info inside built in db for easy, non |
74 file-system operations | |
1071
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
856
diff
changeset
|
75 - Intelligent cache with invalidation after push or project change, provides high |
1091 | 76 performance and always up to date data. |
847 | 77 - 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
|
78 - 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
|
79 - Backup scripts can do backup of whole app and send it over scp to desired |
847 | 80 location |
81 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs | |
0 | 82 |
253
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
83 |
796 | 84 .. include:: ./docs/screenshots.rst |
85 | |
86 | |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
87 Incoming / Plans |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
88 ---------------- |
241
48727add84c9
Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents:
224
diff
changeset
|
89 |
1091 | 90 - Project grouping |
847 | 91 - User groups/teams |
1091 | 92 - SSH based authentication with server side key management |
93 - Code review (probably based on hg-review) | |
94 - Full git_ support, with push/pull server (currently in beta tests) | |
95 - Redmine integration | |
96 - Public accessible activity feeds | |
97 - Commit based built in wiki system | |
98 - Clone points and cloning from remote repositories into RhodeCode | |
99 - More statistics and graph (global annotation + some more statistics) | |
100 - Other advancements as development continues (or you can of course make additions and or requests) | |
552
2642f128ad46
removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents:
549
diff
changeset
|
101 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
102 License |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
103 ------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
104 |
1216
8363b0d20c41
fixes for stable
Marcin Kuzminski <marcin@python-works.com>
parents:
1165
diff
changeset
|
105 ``RhodeCode`` is released under the GPLv3 license. |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
106 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
107 |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
108 Mailing group Q&A |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
109 ----------------- |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
110 |
1091 | 111 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
|
112 |
1091 | 113 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
|
114 |
1091 | 115 Join #rhodecode on FreeNode (irc.freenode.net) |
796 | 116 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc. |
117 | |
118 Online documentation | |
119 -------------------- | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
120 |
1091 | 121 Online documentation for the current version of RhodeCode is available at |
122 http://packages.python.org/RhodeCode/. | |
123 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
|
124 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
125 make html |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
126 |
1165
c5af1d3c861f
changes for rhodecode release 1.1.6
Marcin Kuzminski <marcin@python-works.com>
parents:
1136
diff
changeset
|
127 (You need to have sphinx_ installed to build the documentation. If you don't |
1216
8363b0d20c41
fixes for stable
Marcin Kuzminski <marcin@python-works.com>
parents:
1165
diff
changeset
|
128 have sphinx_ installed you can install it via the command: |
8363b0d20c41
fixes for stable
Marcin Kuzminski <marcin@python-works.com>
parents:
1165
diff
changeset
|
129 ``easy_install sphinx``) |
1091 | 130 |
1071
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
856
diff
changeset
|
131 .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
856
diff
changeset
|
132 .. _python: http://www.python.org/ |
1165
c5af1d3c861f
changes for rhodecode release 1.1.6
Marcin Kuzminski <marcin@python-works.com>
parents:
1136
diff
changeset
|
133 .. _sphinx: http://sphinx.pocoo.org/ |
1071
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
856
diff
changeset
|
134 .. _mercurial: http://mercurial.selenic.com/ |
1136
93b980ebee55
changes for release 1.1.5
Marcin Kuzminski <marcin@python-works.com>
parents:
1091
diff
changeset
|
135 .. _bitbucket: http://bitbucket.org/ |
1216
8363b0d20c41
fixes for stable
Marcin Kuzminski <marcin@python-works.com>
parents:
1165
diff
changeset
|
136 .. _github: http://github.com/ |
1071
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
856
diff
changeset
|
137 .. _subversion: http://subversion.tigris.org/ |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
856
diff
changeset
|
138 .. _git: http://git-scm.com/ |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
856
diff
changeset
|
139 .. _celery: http://celeryproject.org/ |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
856
diff
changeset
|
140 .. _Sphinx: http://sphinx.pocoo.org/ |
bdc438fb4fe4
Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents:
856
diff
changeset
|
141 .. _vcs: http://pypi.python.org/pypi/vcs |