Mercurial > kallithea

annotate README.rst @ 325:d8d471cfa093

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated readme
author Marcin Kuzminski <marcin@python-works.com>
date Wed, 30 Jun 2010 22:47:19 +0200
parents 702c7e565c56
children 0e87466a117e
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
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.
290
702c7e565c56 docs update, version bump
Marcin Kuzminski <marcin@python-works.com>
parents: 254
diff changeset
14 - mercurial branch graph
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
fdcef6ea3b55 Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents: 0
diff changeset
16 managment
325
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
17 - 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
18 - 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
19 file-system operations
224
fdcef6ea3b55 Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents: 0
diff changeset
20 - 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
21 always upto date data.
fdcef6ea3b55 Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents: 0
diff changeset
22 - rss /atom feed customizable
fdcef6ea3b55 Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents: 0
diff changeset
23 - future support for git
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
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
25
254
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
26 **Incoming**
253
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
27
325
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
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
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
30 - 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
31
253
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
32 .. note::
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
33 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
34
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 -------------
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
37 Installation
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
38 -------------
325
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
39 .. note::
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
40 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
41
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
42
254
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
43 - create new virtualenv and activate it
325
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
44 - 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
45 'python setup.py install' this will install all required dependencies needed
254
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
46 - goto pylons_app/lib and run python db_manage.py it should create all
325
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
47 needed tables and an admin account. You can play with this file if you wish to
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
48 use different db than sqlite
254
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
49 - edit file repositories.config and change the [paths] where you keep your
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
50 mercurial repositories, remember about permissions for accessing this dir by
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
51 hg app.
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
52 - run paster serve development.ini
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
53 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
54 - use admin account you created to login.
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
55 - default permissions on each repository is read, and owner is admin. So remember
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
56 to update those.
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
57