Mercurial > kallithea

annotate README.rst @ 402:757c7eef0dcd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
implemented gravatars into main bar. Readme update
author Marcin Kuzminski <marcin@python-works.com>
date Sun, 08 Aug 2010 13:05:56 +0200
parents b27d32cb3157
children 6aa7db1c083a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
254
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
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
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
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
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
6
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
7 **Overview**
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
8
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
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
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
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.
364
37235cd09703 Update readme
Marcin Kuzminski <marcin@python-works.com>
parents: 344
diff changeset
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
392
b27d32cb3157 Implemented hooks system,
Marcin Kuzminski <marcin@python-works.com>
parents: 364
diff changeset
16 managment.
402
757c7eef0dcd implemented gravatars into main bar.
Marcin Kuzminski <marcin@python-works.com>
parents: 392
diff changeset
17 - 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
18 panel !) also manage paths, archive, remote messages
325
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
19 - 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
20 - 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
21 file-system operations
224
fdcef6ea3b55 Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents: 0
diff changeset
22 - 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
23 always upto date data.
402
757c7eef0dcd implemented gravatars into main bar.
Marcin Kuzminski <marcin@python-works.com>
parents: 392
diff changeset
24 - rss / atom feeds, gravatar support
224
fdcef6ea3b55 Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents: 0
diff changeset
25 - based on pylons 1.0 / sqlalchemy 0.6
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
26
254
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
27 **Incoming**
253
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
28
325
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
29 - 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
30 - git support (when vcs can handle it)
402
757c7eef0dcd implemented gravatars into main bar.
Marcin Kuzminski <marcin@python-works.com>
parents: 392
diff changeset
31 - full text search of source codes with indexing daemons using whoosh
757c7eef0dcd implemented gravatars into main bar.
Marcin Kuzminski <marcin@python-works.com>
parents: 392
diff changeset
32 (no external search servers required all in one application)
757c7eef0dcd implemented gravatars into main bar.
Marcin Kuzminski <marcin@python-works.com>
parents: 392
diff changeset
33 - manage hg ui() per repo, add hooks settings, per repo, and not globally
325
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
34 - other cools stuff that i can 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
35
253
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
36 .. note::
392
b27d32cb3157 Implemented hooks system,
Marcin Kuzminski <marcin@python-works.com>
parents: 364
diff changeset
37 This software is still in beta mode.
b27d32cb3157 Implemented hooks system,
Marcin Kuzminski <marcin@python-works.com>
parents: 364
diff changeset
38 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
39
241
48727add84c9 Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents: 224
diff changeset
40
253
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
41 -------------
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
42 Installation
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
43 -------------
325
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
44 .. note::
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
45 I recomend to install tip version of vcs while the app is in beta mode.
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
46
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
47
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 - 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
49 virtual-env for whole application
325
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
50 - download hg app from default (not demo) branch from bitbucket and run
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
51 '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
52 - 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
53 and an admin account.
ab5d91709af9 updated requirements and readme
Marcin Kuzminski <marcin@python-works.com>
parents: 327
diff changeset
54 - 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
55 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
56 - run paster serve development.ini - or you can use manage-hg_app script.
254
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
57 the app should be available at the 127.0.0.1:5000
325
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
58 - use admin account you created to login.
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
59 - 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
60 to update these.
325
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
61