Mercurial > kallithea
annotate README.rst @ 833:9753e0907827 beta
added dbmigrate package, added model changes
moved out upgrade db command to that package
author | Marcin Kuzminski <marcin@python-works.com> |
---|---|
date | Sat, 11 Dec 2010 01:54:12 +0100 |
parents | 47d5781bfe8a |
children | 75c425d0afeb |
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 |
796 | 6 ``RhodeCode`` (formerly hg-app) is Pylons framework based Mercurial repository |
7 browser/management with build in push/pull server and full text search. | |
8 It works on http/https, has build in permission/authentication(+ldap) features | |
9 It's similar to github or bitbucket, but it's suppose to run as standalone hosted | |
727
0ab5deeedbdf
readme update and fixed whoosh version 1.3.3 has error
Marcin Kuzminski <marcin@python-works.com>
parents:
676
diff
changeset
|
10 application, it's open source and focuses more on restricted access to |
0ab5deeedbdf
readme update and fixed whoosh version 1.3.3 has error
Marcin Kuzminski <marcin@python-works.com>
parents:
676
diff
changeset
|
11 repositories. It's powered by vcs_ library that we created to handle many |
0ab5deeedbdf
readme update and fixed whoosh version 1.3.3 has error
Marcin Kuzminski <marcin@python-works.com>
parents:
676
diff
changeset
|
12 various version control systems. |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
13 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
14 RhodeCode uses `Semantic Versioning <http://semver.org/>`_ |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
15 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
16 RhodeCode demo |
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 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
19 http://hg.python-works.com |
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 The default access is |
254 | 22 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
23 - username: demo |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
24 - password: demo |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
25 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
26 Source code |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
27 ----------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
28 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
29 Source code is along with issue tracker is available at |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
30 http://bitbucket.org/marcinkuzminski/rhodecode |
254 | 31 |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
32 Also a source codes can be obtained from demo RhodeCode instance |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
33 http://hg.python-works.com/rhodecode/summary |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
34 |
796 | 35 Installation |
36 ------------ | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
37 |
576
5c734b99c4db
fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
572
diff
changeset
|
38 Please visit http://packages.python.org/RhodeCode/installation.html |
572
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 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
41 Features |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
42 -------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
43 |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
44 - Has it's own middleware to handle mercurial_ and git_ protocol request. |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
45 Each request can be logged and authenticated. Runs on threads unlikely to |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
46 hgweb You can make multiple pulls/pushes simultaneous. Supports http/https |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
47 both on git_ and mercurial_ |
564
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
48 - Full permissions and authentication per project private/read/write/admin. |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
49 One account for web interface and mercurial_ push/pull/clone. |
564
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
50 - Mako templates let's you customize look and feel of application. |
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
51 - Beautiful diffs, annotations and source codes all colored by pygments. |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
52 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics |
564
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
53 - Admin interface with user/permission management. User activity journal logs |
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
54 pulls, pushes, forks,registrations. Possible to disable built in hooks |
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
55 - Server side forks, it's possible to fork a project and hack it free without |
549
f99075170eb4
more renames for rhode code !!
Marcin Kuzminski <marcin@python-works.com>
parents:
547
diff
changeset
|
56 breaking the main. |
564
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
57 - Full text search on source codes, search on file names. All powered by whoosh |
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
58 and build in indexing daemons |
498
6aa7db1c083a
version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
402
diff
changeset
|
59 (no external search servers required all in one application) |
564
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
60 - Rss / atom feeds, gravatar support, download sources as zip/tarballs |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
61 - 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
|
62 - Backup scripts can do backup of whole app and send it over scp to desired |
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
63 location |
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
64 - Setup project descriptions and info inside built in db for easy, non |
290
702c7e565c56
docs update, version bump
Marcin Kuzminski <marcin@python-works.com>
parents:
254
diff
changeset
|
65 file-system operations |
564
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
66 - Added cache with invalidation on push/repo management for high performance and |
540
efbab97c3aca
fixed some spelling mistakes
Marcin Kuzminski <marcin@python-works.com>
parents:
523
diff
changeset
|
67 always up to date data. |
564
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
68 - Based on pylons 1.0 / sqlalchemy 0.6 / sqlite |
0 | 69 |
253
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
70 |
796 | 71 .. include:: ./docs/screenshots.rst |
72 | |
73 | |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
74 Incoming / Plans |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
75 ---------------- |
241
48727add84c9
Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents:
224
diff
changeset
|
76 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
77 - code review (probably based on hg-review) |
796 | 78 - full git_ support, with push/pull server (currently in beta tests) |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
79 - project grouping |
727
0ab5deeedbdf
readme update and fixed whoosh version 1.3.3 has error
Marcin Kuzminski <marcin@python-works.com>
parents:
676
diff
changeset
|
80 - redmine integration |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
81 - commit based build in wiki system |
624
60a4aabf6aa6
small docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
576
diff
changeset
|
82 - clone points and cloning from remote repositories into rhodecode |
60a4aabf6aa6
small docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
576
diff
changeset
|
83 (git_ and mercurial_) |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
84 - more statistics and graph (global annotation + some more statistics) |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
85 - other cools stuff that i can figure out (or You can help me figure out) |
552
2642f128ad46
removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents:
549
diff
changeset
|
86 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
87 License |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
88 ------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
89 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
90 ``rhodecode`` is released under GPL_ license. |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
91 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
92 |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
93 Mailing group Q&A |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
94 ----------------- |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
95 |
796 | 96 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
|
97 |
796 | 98 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
|
99 |
796 | 100 join #rhodecode on FreeNode (irc.freenode.net) |
101 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc. | |
102 | |
103 Online documentation | |
104 -------------------- | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
105 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
106 Online documentation for current version is available at |
576
5c734b99c4db
fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
572
diff
changeset
|
107 http://packages.python.org/RhodeCode/. |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
108 You may also build documentation for yourself - go into ``docs/`` and run:: |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
109 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
110 make html |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
111 |