comparison README.rst @ 549:f99075170eb4

more renames for rhode code !!
author Marcin Kuzminski <marcin@python-works.com>
date Wed, 06 Oct 2010 03:34:18 +0200
parents 1e757ac98988
children 2642f128ad46
comparison
equal deleted inserted replaced
548:b75b77ef649d 549:f99075170eb4
1 ------------------------------------- 1 --------------------------------------------------------------
2 Pylons based replacement for hgwebdir 2 Pylons based repository management for mercurial (and soon git)
3 ------------------------------------- 3 --------------------------------------------------------------
4 4
5 Fully customizable, with authentication, permissions. Based on vcs library. 5 Fully customizable, with authentication, permissions. Based on vcs library.
6 6
7 **Overview** 7 **Overview**
8 8
11 - full permissions per project read/write/admin access even on mercurial request 11 - full permissions per project read/write/admin access even on mercurial request
12 - mako templates let's you customize look and feel of application. 12 - mako templates let's you customize look and feel of application.
13 - diffs annotations and source code all colored by pygments. 13 - diffs annotations and source code all colored by pygments.
14 - mercurial branch graph and yui-flot powered graphs with zooming and statistics 14 - mercurial branch graph and yui-flot powered graphs with zooming and statistics
15 - admin interface for performing user/permission managements as well as repository 15 - admin interface for performing user/permission managements as well as repository
16 management. 16 management.
17 - server side forks, it's possible to fork a project and hack it free without
18 breaking the main.
17 - full text search of source codes with indexing daemons using whoosh 19 - full text search of source codes with indexing daemons using whoosh
18 (no external search servers required all in one application) 20 (no external search servers required all in one application)
19 - async tasks for speed and performance using celery (works without them too) 21 - async tasks for speed and performance using celery (works without them too)
20 - Additional settings for mercurial web, (hooks editable from admin 22 - Additional settings for mercurial web, (hooks editable from admin
21 panel !) also manage paths, archive, remote messages 23 panel !) also manage paths, archive, remote messages
30 **Incoming** 32 **Incoming**
31 33
32 - code review based on hg-review (when it's stable) 34 - code review based on hg-review (when it's stable)
33 - git support (when vcs can handle it - almost there !) 35 - git support (when vcs can handle it - almost there !)
34 - commit based wikis 36 - commit based wikis
35 - in server forks 37 - clonning from remote repositories into rhodecode (git/mercurial)
36 - clonning from remote repositories into hg-app
37 - other cools stuff that i can figure out (or You can help me figure out) 38 - other cools stuff that i can figure out (or You can help me figure out)
38 39
39 .. note:: 40 .. note::
40 This software is still in beta mode. 41 This software is still in beta mode.
41 I don't guarantee that it'll work correctly. 42 I don't guarantee that it'll work correctly.
43 44
44 ------------- 45 -------------
45 Installation 46 Installation
46 ------------- 47 -------------
47 48
48 - I highly recommend to install new virtualenv for hg-app see 49 - I highly recommend to install new virtualenv for rhodecode see
49 http://pypi.python.org/pypi/virtualenv 50 http://pypi.python.org/pypi/virtualenv
50 - Create new virtualenv using `virtualenv --no-site-packages /var/www/hgapp-venv` 51 - Create new virtualenv using `virtualenv --no-site-packages /var/www/rhodecode-venv`
51 this will install new virtual env into /var/www/hgapp-venv. 52 this will install new virtual env into /var/www/rhodecode-venv.
52 Activate the virtualenv by running 53 Activate the virtualenv by running
53 `source activate /var/www/hgapp-venv/bin/activate` 54 `source activate /var/www/rhodecode-venv/bin/activate`
54 - Make a folder for hg-app somewhere on the filesystem for example /var/www/hgapp 55 - Make a folder for rhodecode somewhere on the filesystem for example /var/www/rhodecode
55 - Download and extract http://bitbucket.org/marcinkuzminski/hg-app/get/tip.zip 56 - Download and extract http://bitbucket.org/marcinkuzminski/rhodecode/get/tip.zip
56 into created directory. 57 into created directory.
57 - Run `python setup.py install` in order to install the application and all 58 - Run `python setup.py install` in order to install the application and all
58 needed dependencies. Make sure that You're using activated virutalenv 59 needed dependencies. Make sure that You're using activated virutalenv
59 - Run `paster setup-app production.ini` it should create all needed tables 60 - Run `paster setup-app production.ini` it should create all needed tables
60 and an admin account make sure You specify correct path to repositories. 61 and an admin account make sure You specify correct path to repositories.
64 the app should be available at the 127.0.0.1:5000 65 the app should be available at the 127.0.0.1:5000
65 - Use admin account you created to login. 66 - Use admin account you created to login.
66 - Default permissions on each repository is read, and owner is admin. So remember 67 - Default permissions on each repository is read, and owner is admin. So remember
67 to update these. 68 to update these.
68 - In order to use full power of async tasks, You must install message broker 69 - In order to use full power of async tasks, You must install message broker
69 preferably rabbitmq and start celeryd daemon together with hg-app. 70 preferably rabbitmq and start celeryd daemon together with rhodecode.
70 The app should gain a lot of speed and become much more responsible. 71 The app should gain a lot of speed and become much more responsible.
71 For installation instructions You can visit: 72 For installation instructions You can visit:
72 http://ask.github.com/celery/getting-started/index.html. 73 http://ask.github.com/celery/getting-started/index.html.
73 - All needed configs are inside hg-app ie. celeryconfig.py , production.ini 74 - All needed configs are inside rhodecode ie. celeryconfig.py , production.ini
74 You can configure the email, ports, loggers, workers from there. 75 You can configure the email, ports, loggers, workers from there.
75 - For full text search You can either put crontab entry for 76 - For full text search You can either put crontab entry for
76 `python /var/www/hgapp/rhodecode/lib/indexers/daemon.py incremental <path_to_repos>` 77 `python /var/www/rhodecode/rhodecode/lib/indexers/daemon.py incremental <path_to_repos>`
77 or run indexer from admin panel. This will scann the repos given in the 78 or run indexer from admin panel. This will scann the repos given in the
78 application setup or given path for daemon.py and each scann in incremental 79 application setup or given path for daemon.py and each scann in incremental
79 mode will scann only changed files, 80 mode will scann only changed files,
80 Hg Update hook must be activated to index the content it's enabled by default 81 Hg Update hook must be activated to index the content it's enabled by default
81 after setup 82 after setup