Mercurial > kallithea

annotate docs/installation.rst @ 1286:0e0fb228867b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fixes #182
author Marcin Kuzminski <marcin@python-works.com>
date Tue, 26 Apr 2011 19:21:11 +0200
parents 93b980ebee55
children bf263968da47
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
1 .. _installation:
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
2
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
3 Installation
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
4 ============
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
5
1091
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
6 ``RhodeCode`` is written entirely in Python. In order to gain maximum performance
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
7 there are some third-party you must install. When RhodeCode is used
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
8 together with celery you have to install some kind of message broker,
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
9 recommended one is rabbitmq_ to make the async tasks work.
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
10
1091
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
11 Of course RhodeCode works in sync mode also and then you do not have to install
1136
93b980ebee55 changes for release 1.1.5
Marcin Kuzminski <marcin@python-works.com>
parents: 1095
diff changeset
12 any third party applications. However, using Celery_ will give you a large
93b980ebee55 changes for release 1.1.5
Marcin Kuzminski <marcin@python-works.com>
parents: 1095
diff changeset
13 speed improvement when using many big repositories. If you plan to use
93b980ebee55 changes for release 1.1.5
Marcin Kuzminski <marcin@python-works.com>
parents: 1095
diff changeset
14 RhodeCode for say 7 to 10 small repositories, RhodeCode will perform perfectly
93b980ebee55 changes for release 1.1.5
Marcin Kuzminski <marcin@python-works.com>
parents: 1095
diff changeset
15 well without celery running.
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
16
1136
93b980ebee55 changes for release 1.1.5
Marcin Kuzminski <marcin@python-works.com>
parents: 1095
diff changeset
17 If you make the decision to run RhodeCode with celery make sure you run
93b980ebee55 changes for release 1.1.5
Marcin Kuzminski <marcin@python-works.com>
parents: 1095
diff changeset
18 celeryd using paster and message broker together with the application.
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
19
1091
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
20 Installing RhodeCode from Cheese Shop
1095
3cdacd152b24 fixed sphinx build errors
Marcin Kuzminski <marcin@python-works.com>
parents: 1091
diff changeset
21 -------------------------------------
3cdacd152b24 fixed sphinx build errors
Marcin Kuzminski <marcin@python-works.com>
parents: 1091
diff changeset
22
1091
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
23 Rhodecode requires python version 2.5 or higher.
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
24
1091
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
25 The easiest way to install ``rhodecode`` is to run::
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
26
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
27 easy_install rhodecode
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
28
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
29 Or::
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
30
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
31 pip install rhodecode
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
32
1091
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
33 If you prefer to install RhodeCode manually simply grab latest release from
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
34 http://pypi.python.org/pypi/rhodecode, decompress the archive and run::
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
35
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
36 python setup.py install
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
37
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
38
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
39 Step by step installation example
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
40 ---------------------------------
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
41
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
42
1091
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
43 - Assuming you have installed virtualenv_ create a new virtual environment using virtualenv::
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
44
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
45 virtualenv --no-site-packages /var/www/rhodecode-venv
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
46
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
47
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
48 .. note:: Using ``--no-site-packages`` when generating your
1091
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
49 virtualenv is **very important**. This flag provides the necessary
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
50 isolation for running the set of packages required by
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
51 RhodeCode. If you do not specify ``--no-site-packages``,
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
52 it's possible that RhodeCode will not install properly into
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
53 the virtualenv, or, even if it does, may not run properly,
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
54 depending on the packages you've already got installed into your
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
55 Python's "main" site-packages dir.
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
56
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
57
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
58 - this will install new virtualenv_ into `/var/www/rhodecode-venv`.
1091
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
59 - Activate the virtualenv_ by running::
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
60
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
61 source /var/www/rhodecode-venv/bin/activate
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
62
1091
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
63 .. note:: If you're using UNIX, *do not* use ``sudo`` to run the
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
64 ``virtualenv`` script. It's perfectly acceptable (and desirable)
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
65 to create a virtualenv as a normal user.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
66
1091
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
67 - Make a folder for rhodecode somewhere on the filesystem for example::
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
68
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
69 mkdir /var/www/rhodecode
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
70
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
71
1091
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
72 - Run this command to install rhodecode::
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
73
1071
bdc438fb4fe4 Fixes for release 1.1.4
Marcin Kuzminski <marcin@python-works.com>
parents: 939
diff changeset
74 easy_install rhodecode
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
75
1091
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
76 - This will install rhodecode together with pylons and all other required python
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
77 libraries
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
78
855
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 845
diff changeset
79 Requirements for Celery (optional)
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 845
diff changeset
80 ----------------------------------
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 845
diff changeset
81
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 845
diff changeset
82 .. note::
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 845
diff changeset
83 Installing message broker and using celery is optional, RhodeCode will
1091
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
84 work perfectly fine without them.
855
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 845
diff changeset
85
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 845
diff changeset
86
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 845
diff changeset
87 **Message Broker**
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 845
diff changeset
88
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 845
diff changeset
89 - preferred is `RabbitMq <http://www.rabbitmq.com/>`_
1091
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
90 - A possible alternative is `Redis <http://code.google.com/p/redis/>`_
855
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 845
diff changeset
91
1091
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
92 For installation instructions you can visit:
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
93 http://ask.github.com/celery/getting-started/index.html.
e67786cb2afa - Further corrections.
jfh <jason@jasonfharris.com>
parents: 1071
diff changeset
94 This is a very nice tutorial on how to start using celery_ with rabbitmq_
855
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 845
diff changeset
95
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
96
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
97 You can now proceed to :ref:`setup`
855
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 845
diff changeset
98 -----------------------------------
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 845
diff changeset
99
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 845
diff changeset
100
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
101
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
102 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
103 .. _python: http://www.python.org/
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
104 .. _mercurial: http://mercurial.selenic.com/
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
105 .. _celery: http://celeryproject.org/
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
106 .. _rabbitmq: http://www.rabbitmq.com/