Mercurial > kallithea

annotate README.rst @ 552:2642f128ad46

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
removed egg info, update files for distutils build updated READMES some config files
author Marcin Kuzminski <marcin@python-works.com>
date Wed, 06 Oct 2010 15:37:23 +0200
parents f99075170eb4
children ba7e24cd4786
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
549
f99075170eb4 more renames for rhode code !!
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
1 --------------------------------------------------------------
f99075170eb4 more renames for rhode code !!
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
2 Pylons based repository management for mercurial (and soon git)
f99075170eb4 more renames for rhode code !!
Marcin Kuzminski <marcin@python-works.com>
parents: 547
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
540
efbab97c3aca fixed some spelling mistakes
Marcin Kuzminski <marcin@python-works.com>
parents: 523
diff changeset
12 - mako templates let's you customize 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.
523
d64a3ab18845 Readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 498
diff changeset
14 - mercurial branch graph and yui-flot powered graphs with zooming and statistics
540
efbab97c3aca fixed some spelling mistakes
Marcin Kuzminski <marcin@python-works.com>
parents: 523
diff changeset
15 - admin interface for performing user/permission managements as well as repository
549
f99075170eb4 more renames for rhode code !!
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
16 management.
f99075170eb4 more renames for rhode code !!
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
17 - server side forks, it's possible to fork a project and hack it free without
f99075170eb4 more renames for rhode code !!
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
18 breaking the main.
498
6aa7db1c083a version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 402
diff changeset
19 - 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
20 (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
21 - 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
22 - 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
23 panel !) also manage paths, archive, remote messages
325
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
24 - 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
25 - 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
26 file-system operations
540
efbab97c3aca fixed some spelling mistakes
Marcin Kuzminski <marcin@python-works.com>
parents: 523
diff changeset
27 - added cache with invalidation on push/repo management for high performance and
efbab97c3aca fixed some spelling mistakes
Marcin Kuzminski <marcin@python-works.com>
parents: 523
diff changeset
28 always up to date data.
402
757c7eef0dcd implemented gravatars into main bar.
Marcin Kuzminski <marcin@python-works.com>
parents: 392
diff changeset
29 - rss / atom feeds, gravatar support
224
fdcef6ea3b55 Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents: 0
diff changeset
30 - based on pylons 1.0 / sqlalchemy 0.6
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
31
254
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
32 **Incoming**
253
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
33
325
d8d471cfa093 Updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 290
diff changeset
34 - 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
35 - 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
36 - commit based wikis
549
f99075170eb4 more renames for rhode code !!
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
37 - clonning from remote repositories into rhodecode (git/mercurial)
498
6aa7db1c083a version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 402
diff changeset
38 - 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
39
253
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
40 .. note::
392
b27d32cb3157 Implemented hooks system,
Marcin Kuzminski <marcin@python-works.com>
parents: 364
diff changeset
41 This software is still in beta mode.
b27d32cb3157 Implemented hooks system,
Marcin Kuzminski <marcin@python-works.com>
parents: 364
diff changeset
42 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
43
241
48727add84c9 Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents: 224
diff changeset
44
253
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
45 -------------
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
46 Installation
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
47 -------------
523
d64a3ab18845 Readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 498
diff changeset
48
552
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
49 quick setup
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
50
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
51 - pip install -E rhodecode-venv http://bitbucket.org/marcinkuzminski/rhodecode/get/tip.zip
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
52 - activate virtualenv
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
53 - run `paster make-config RhodeCode production.ini`
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
54 - run `paster setup-app production.ini`
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
55 - run `paster runserver production.ini`
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
56
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
57 You're ready to go.
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
58
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
59
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
60 MORE DETAILED INSTRUCTIONS
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
61
549
f99075170eb4 more renames for rhode code !!
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
62 - I highly recommend to install new virtualenv for rhodecode see
552
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
63 http://pypi.python.org/pypi/virtualenv for more details.
549
f99075170eb4 more renames for rhode code !!
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
64 - Create new virtualenv using `virtualenv --no-site-packages /var/www/rhodecode-venv`
f99075170eb4 more renames for rhode code !!
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
65 this will install new virtual env into /var/www/rhodecode-venv.
523
d64a3ab18845 Readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 498
diff changeset
66 Activate the virtualenv by running
549
f99075170eb4 more renames for rhode code !!
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
67 `source activate /var/www/rhodecode-venv/bin/activate`
f99075170eb4 more renames for rhode code !!
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
68 - Make a folder for rhodecode somewhere on the filesystem for example /var/www/rhodecode
552
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
69 - Run easy_install http://bitbucket.org/marcinkuzminski/rhodecode/get/tip.zip.
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
70 - Run `paster make-config RhodeCode production.inii` in order to install
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
71 the application config. You can play with the app settings later
523
d64a3ab18845 Readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 498
diff changeset
72 - 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
73 and an admin account make sure You specify correct path to repositories.
523
d64a3ab18845 Readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 498
diff changeset
74 - 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
75 accessible for the application
552
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
76 - Run paster serve production.ini - or you can use sample init.d scripts.
254
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
77 the app should be available at the 127.0.0.1:5000
523
d64a3ab18845 Readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 498
diff changeset
78 - Use admin account you created to login.
d64a3ab18845 Readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 498
diff changeset
79 - 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
80 to update these.
523
d64a3ab18845 Readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 498
diff changeset
81 - In order to use full power of async tasks, You must install message broker
549
f99075170eb4 more renames for rhode code !!
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
82 preferably rabbitmq and start celeryd daemon together with rhodecode.
523
d64a3ab18845 Readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 498
diff changeset
83 The app should gain a lot of speed and become much more responsible.
d64a3ab18845 Readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 498
diff changeset
84 For installation instructions You can visit:
d64a3ab18845 Readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 498
diff changeset
85 http://ask.github.com/celery/getting-started/index.html.
549
f99075170eb4 more renames for rhode code !!
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
86 - All needed configs are inside rhodecode ie. celeryconfig.py , production.ini
523
d64a3ab18845 Readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 498
diff changeset
87 You can configure the email, ports, loggers, workers from there.
d64a3ab18845 Readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 498
diff changeset
88 - For full text search You can either put crontab entry for
549
f99075170eb4 more renames for rhode code !!
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
89 `python /var/www/rhodecode/rhodecode/lib/indexers/daemon.py incremental <path_to_repos>`
523
d64a3ab18845 Readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 498
diff changeset
90 or run indexer from admin panel. This will scann the repos given in the
d64a3ab18845 Readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 498
diff changeset
91 application setup or given path for daemon.py and each scann in incremental
d64a3ab18845 Readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 498
diff changeset
92 mode will scann only changed files,
d64a3ab18845 Readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 498
diff changeset
93 Hg Update hook must be activated to index the content it's enabled by default
d64a3ab18845 Readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 498
diff changeset
94 after setup