Mercurial > kallithea
annotate README.rst @ 364:37235cd09703
Update readme
| author | Marcin Kuzminski <marcin@python-works.com> |
|---|---|
| date | Tue, 27 Jul 2010 14:37:40 +0200 |
| parents | ab5d91709af9 |
| children | b27d32cb3157 |
| 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 |
|
224
fdcef6ea3b55
Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents:
0
diff
changeset
|
12 - mako templates let's you cusmotize look and feel of appplication. |
|
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. |
| 364 | 14 - mercurial branch graph and yui-flot powered graphs |
|
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 |
|
344
ab5d91709af9
updated requirements and readme
Marcin Kuzminski <marcin@python-works.com>
parents:
327
diff
changeset
|
16 managment. Additionall settings for mercurial web, (hooks editable from admin |
|
ab5d91709af9
updated requirements and readme
Marcin Kuzminski <marcin@python-works.com>
parents:
327
diff
changeset
|
17 panel !) |
| 325 | 18 - 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
|
19 - 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
|
20 file-system operations |
|
224
fdcef6ea3b55
Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents:
0
diff
changeset
|
21 - added cache with invalidation on push/repo managment for high performance and |
|
fdcef6ea3b55
Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents:
0
diff
changeset
|
22 always upto date data. |
|
fdcef6ea3b55
Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents:
0
diff
changeset
|
23 - rss /atom feed customizable |
|
fdcef6ea3b55
Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents:
0
diff
changeset
|
24 - based on pylons 1.0 / sqlalchemy 0.6 |
| 0 | 25 |
| 254 | 26 **Incoming** |
|
253
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
27 |
| 325 | 28 - code review based on hg-review (when it's stable) |
|
253
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
29 - git support (when vcs can handle it) |
| 325 | 30 - other cools stuff that i can figure out |
|
344
ab5d91709af9
updated requirements and readme
Marcin Kuzminski <marcin@python-works.com>
parents:
327
diff
changeset
|
31 - manage hg ui() per repo, add hooks settings, per repo, and not globally |
|
241
48727add84c9
Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents:
224
diff
changeset
|
32 |
|
253
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
33 .. note:: |
|
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
34 This software is still in beta mode. I don't guarantee that it'll work. |
|
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
35 |
|
241
48727add84c9
Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents:
224
diff
changeset
|
36 |
|
253
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
37 ------------- |
|
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
38 Installation |
|
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
39 ------------- |
| 325 | 40 .. note:: |
| 41 I recomend to install tip version of vcs while the app is in beta mode. | |
| 42 | |
| 43 | |
|
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
|
44 - 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
|
45 virtual-env for whole application |
| 325 | 46 - download hg app from default (not demo) branch from bitbucket and run |
| 47 '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
|
48 - run paster setup-app production.ini it should create all needed tables |
|
344
ab5d91709af9
updated requirements and readme
Marcin Kuzminski <marcin@python-works.com>
parents:
327
diff
changeset
|
49 and an admin account. |
|
ab5d91709af9
updated requirements and readme
Marcin Kuzminski <marcin@python-works.com>
parents:
327
diff
changeset
|
50 - 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
|
51 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
|
52 - run paster serve development.ini - or you can use manage-hg_app script. |
| 254 | 53 the app should be available at the 127.0.0.1:5000 |
| 325 | 54 - use admin account you created to login. |
| 55 - default permissions on each repository is read, and owner is admin. So remember | |
| 56 to update those. | |
| 57 |