##// END OF EJS Templates
fixed doc typo
marcink -
r933:4f930dc0 beta
parent child Browse files
Show More
@@ -1,99 +1,99
1 .. _installation:
1 .. _installation:
2
2
3 Installation
3 Installation
4 ============
4 ============
5
5
6 ``RhodeCode`` is written entirely in Python, but in order to use it's full
6 ``RhodeCode`` is written entirely in Python, but in order to use it's full
7 potential there are some third-party requirements. When RhodeCode is used
7 potential there are some third-party requirements. When RhodeCode is used
8 together with celery You have to install some kind of message broker,
8 together with celery You have to install some kind of message broker,
9 recommended one is rabbitmq_ to make the async tasks work.
9 recommended one is rabbitmq_ to make the async tasks work.
10
10
11 Of course RhodeCode works in sync mode also, then You don't have to install
11 Of course RhodeCode works in sync mode also, then You don't have to install
12 any third party apps. Celery_ will give You large speed improvement when using
12 any third party apps. Celery_ will give You large speed improvement when using
13 many big repositories. If You plan to use it for 7 or 10 small repositories, it
13 many big repositories. If You plan to use it for 7 or 10 small repositories, it
14 will work just fine without celery running.
14 will work just fine without celery running.
15
15
16 After You decide to Run it with celery make sure You run celeryd using paster
16 After You decide to Run it with celery make sure You run celeryd using paster
17 and message broker together with the application.
17 and message broker together with the application.
18
18
19 Install from Cheese Shop
19 Install from Cheese Shop
20 ------------------------
20 ------------------------
21 Rhodecode requires python 2.x greater than version 2.5
21 Rhodecode requires python 2.x greater than version 2.5
22
22
23 Easiest way to install ``rhodecode`` is to run::
23 Easiest way to install ``rhodecode`` is to run::
24
24
25 easy_install rhodecode
25 easy_install rhodecode
26
26
27 Or::
27 Or::
28
28
29 pip install rhodecode
29 pip install rhodecode
30
30
31 If you prefer to install manually simply grab latest release from
31 If you prefer to install manually simply grab latest release from
32 http://pypi.python.org/pypi/rhodecode, decompres archive and run::
32 http://pypi.python.org/pypi/rhodecode, decompres archive and run::
33
33
34 python setup.py install
34 python setup.py install
35
35
36
36
37 Step by step installation example
37 Step by step installation example
38 ---------------------------------
38 ---------------------------------
39
39
40
40
41 - Assuming You have installed virtualenv_ create one using.
41 - Assuming You have installed virtualenv_ create one using.
42 The `--no-site-packages` will make sure non of Your system libs are linked
42 The `--no-site-packages` will make sure non of Your system libs are linked
43 with this virtualenv_
43 with this virtualenv_
44
44
45 ::
45 ::
46
46
47 virtualenv --no-site-packages /var/www/rhodecode-venv
47 virtualenv --no-site-packages /var/www/rhodecode-venv
48
48
49 - this will install new virtualenv_ into `/var/www/rhodecode-venv`.
49 - this will install new virtualenv_ into `/var/www/rhodecode-venv`.
50 - Activate the virtualenv_ by running
50 - Activate the virtualenv_ by running
51
51
52 ::
52 ::
53
53
54 source activate /var/www/rhodecode-venv/bin/activate
54 source /var/www/rhodecode-venv/bin/activate
55
55
56 - Make a folder for rhodecode somewhere on the filesystem for example
56 - Make a folder for rhodecode somewhere on the filesystem for example
57
57
58 ::
58 ::
59
59
60 mkdir /var/www/rhodecode
60 mkdir /var/www/rhodecode
61
61
62
62
63 - Run this command to install rhodecode
63 - Run this command to install rhodecode
64
64
65 ::
65 ::
66
66
67 easy_install rhodecode
67 easy_install rhodecode
68
68
69 - this will install rhodecode together with pylons
69 - this will install rhodecode together with pylons
70 and all other required python libraries
70 and all other required python libraries
71
71
72 Requirements for Celery (optional)
72 Requirements for Celery (optional)
73 ----------------------------------
73 ----------------------------------
74
74
75 .. note::
75 .. note::
76 Installing message broker and using celery is optional, RhodeCode will
76 Installing message broker and using celery is optional, RhodeCode will
77 work without them perfectly fine.
77 work without them perfectly fine.
78
78
79
79
80 **Message Broker**
80 **Message Broker**
81
81
82 - preferred is `RabbitMq <http://www.rabbitmq.com/>`_
82 - preferred is `RabbitMq <http://www.rabbitmq.com/>`_
83 - possible other is `Redis <http://code.google.com/p/redis/>`_
83 - possible other is `Redis <http://code.google.com/p/redis/>`_
84
84
85 For installation instructions You can visit:
85 For installation instructions You can visit:
86 http://ask.github.com/celery/getting-started/index.html
86 http://ask.github.com/celery/getting-started/index.html
87 It's very nice tutorial how to start celery_ with rabbitmq_
87 It's very nice tutorial how to start celery_ with rabbitmq_
88
88
89
89
90 You can now proceed to :ref:`setup`
90 You can now proceed to :ref:`setup`
91 -----------------------------------
91 -----------------------------------
92
92
93
93
94
94
95 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
95 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
96 .. _python: http://www.python.org/
96 .. _python: http://www.python.org/
97 .. _mercurial: http://mercurial.selenic.com/
97 .. _mercurial: http://mercurial.selenic.com/
98 .. _celery: http://celeryproject.org/
98 .. _celery: http://celeryproject.org/
99 .. _rabbitmq: http://www.rabbitmq.com/ No newline at end of file
99 .. _rabbitmq: http://www.rabbitmq.com/
General Comments 0
You need to be logged in to leave comments. Login now