Mercurial > kallithea
annotate README.rst @ 499:ca41d544dbdf rhodecode-0.0.0.8.3
Merge with 6aa7db1c083a1384ebff5c2bb3c943a035bb310d - celery branch
author | Marcin Kuzminski <marcin@python-works.com> |
---|---|
date | Thu, 23 Sep 2010 01:23:13 +0200 |
parents | 6aa7db1c083a |
children | d64a3ab18845 |
rev | line source |
---|---|
254 | 1 ------------------------------------- |
253
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
2 Pylons based replacement for hgwebdir |
254 | 3 ------------------------------------- |
253
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
4 |
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
5 Fully customizable, with authentication, permissions. Based on vcs library. |
254 | 6 |
7 **Overview** | |
8 | |
9 - has it's own middleware to handle mercurial protocol request each request can | |
253
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
10 be logged and authenticated + threaded performance unlikely to hgweb |
325 | 11 - full permissions per project read/write/admin access even on mercurial request |
392
b27d32cb3157
Implemented hooks system,
Marcin Kuzminski <marcin@python-works.com>
parents:
364
diff
changeset
|
12 - mako templates let's you cusmotize look and feel of application. |
224
fdcef6ea3b55
Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents:
0
diff
changeset
|
13 - diffs annotations and source code all colored by pygments. |
498
6aa7db1c083a
version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
402
diff
changeset
|
14 - mercurial branch graph and yui-flot powered graphs with zooming |
224
fdcef6ea3b55
Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents:
0
diff
changeset
|
15 - admin interface for performing user/permission managments as well as repository |
392
b27d32cb3157
Implemented hooks system,
Marcin Kuzminski <marcin@python-works.com>
parents:
364
diff
changeset
|
16 managment. |
498
6aa7db1c083a
version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
402
diff
changeset
|
17 - full text search of source codes with indexing daemons using whoosh |
6aa7db1c083a
version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
402
diff
changeset
|
18 (no external search servers required all in one application) |
6aa7db1c083a
version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
402
diff
changeset
|
19 - async tasks for speed and performance using celery (works without them too) |
402
757c7eef0dcd
implemented gravatars into main bar.
Marcin Kuzminski <marcin@python-works.com>
parents:
392
diff
changeset
|
20 - Additional settings for mercurial web, (hooks editable from admin |
757c7eef0dcd
implemented gravatars into main bar.
Marcin Kuzminski <marcin@python-works.com>
parents:
392
diff
changeset
|
21 panel !) also manage paths, archive, remote messages |
325 | 22 - backup scripts can do backup of whole app and send it over scp to desired location |
290
702c7e565c56
docs update, version bump
Marcin Kuzminski <marcin@python-works.com>
parents:
254
diff
changeset
|
23 - setup project descriptions and info inside built in db for easy, non |
702c7e565c56
docs update, version bump
Marcin Kuzminski <marcin@python-works.com>
parents:
254
diff
changeset
|
24 file-system operations |
224
fdcef6ea3b55
Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents:
0
diff
changeset
|
25 - added cache with invalidation on push/repo managment for high performance and |
392
b27d32cb3157
Implemented hooks system,
Marcin Kuzminski <marcin@python-works.com>
parents:
364
diff
changeset
|
26 always upto date data. |
402
757c7eef0dcd
implemented gravatars into main bar.
Marcin Kuzminski <marcin@python-works.com>
parents:
392
diff
changeset
|
27 - rss / atom feeds, gravatar support |
224
fdcef6ea3b55
Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents:
0
diff
changeset
|
28 - based on pylons 1.0 / sqlalchemy 0.6 |
0 | 29 |
254 | 30 **Incoming** |
253
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
31 |
325 | 32 - code review based on hg-review (when it's stable) |
498
6aa7db1c083a
version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
402
diff
changeset
|
33 - git support (when vcs can handle it - almost there !) |
6aa7db1c083a
version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
402
diff
changeset
|
34 - commit based wikis |
6aa7db1c083a
version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
402
diff
changeset
|
35 - in server forks |
6aa7db1c083a
version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
402
diff
changeset
|
36 - clonning from remote repositories into hg-app |
6aa7db1c083a
version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
402
diff
changeset
|
37 - other cools stuff that i can figure out (or You can help me figure out) |
241
48727add84c9
Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents:
224
diff
changeset
|
38 |
253
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
39 .. note:: |
392
b27d32cb3157
Implemented hooks system,
Marcin Kuzminski <marcin@python-works.com>
parents:
364
diff
changeset
|
40 This software is still in beta mode. |
b27d32cb3157
Implemented hooks system,
Marcin Kuzminski <marcin@python-works.com>
parents:
364
diff
changeset
|
41 I don't guarantee that it'll work correctly. |
253
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
42 |
241
48727add84c9
Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents:
224
diff
changeset
|
43 |
253
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
44 ------------- |
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
45 Installation |
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
46 ------------- |
325 | 47 .. note:: |
48 I recomend to install tip version of vcs while the app is in beta mode. | |
49 | |
50 | |
327
0e87466a117e
updated installation instruction, made more user friendly way of creating all needed configs. All is done now from paster setup-app
Marcin Kuzminski <marcin@python-works.com>
parents:
325
diff
changeset
|
51 - create new virtualenv and activate it - highly recommend that you use separate |
0e87466a117e
updated installation instruction, made more user friendly way of creating all needed configs. All is done now from paster setup-app
Marcin Kuzminski <marcin@python-works.com>
parents:
325
diff
changeset
|
52 virtual-env for whole application |
498
6aa7db1c083a
version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
402
diff
changeset
|
53 - download hg app from default branch from bitbucket and run |
325 | 54 'python setup.py install' this will install all required dependencies needed |
327
0e87466a117e
updated installation instruction, made more user friendly way of creating all needed configs. All is done now from paster setup-app
Marcin Kuzminski <marcin@python-works.com>
parents:
325
diff
changeset
|
55 - run paster setup-app production.ini it should create all needed tables |
498
6aa7db1c083a
version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
402
diff
changeset
|
56 and an admin account make sure You specify correct path to repositories. |
344
ab5d91709af9
updated requirements and readme
Marcin Kuzminski <marcin@python-works.com>
parents:
327
diff
changeset
|
57 - remember that the given path for mercurial repositories must be write |
327
0e87466a117e
updated installation instruction, made more user friendly way of creating all needed configs. All is done now from paster setup-app
Marcin Kuzminski <marcin@python-works.com>
parents:
325
diff
changeset
|
58 accessible for the application |
0e87466a117e
updated installation instruction, made more user friendly way of creating all needed configs. All is done now from paster setup-app
Marcin Kuzminski <marcin@python-works.com>
parents:
325
diff
changeset
|
59 - run paster serve development.ini - or you can use manage-hg_app script. |
254 | 60 the app should be available at the 127.0.0.1:5000 |
325 | 61 - use admin account you created to login. |
62 - default permissions on each repository is read, and owner is admin. So remember | |
402
757c7eef0dcd
implemented gravatars into main bar.
Marcin Kuzminski <marcin@python-works.com>
parents:
392
diff
changeset
|
63 to update these. |
498
6aa7db1c083a
version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
402
diff
changeset
|
64 - in order to use full power of async tasks, You must install message broker |
6aa7db1c083a
version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
402
diff
changeset
|
65 preferrably rabbitmq and start celeryd daemon. The app should gain some speed |
6aa7db1c083a
version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
402
diff
changeset
|
66 than. For installation instructions |
6aa7db1c083a
version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
402
diff
changeset
|
67 You can visit: http://ask.github.com/celery/getting-started/index.html. All |
6aa7db1c083a
version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
402
diff
changeset
|
68 needed configs are inside hg-app ie. celeryconfig.py |
325 | 69 |