##// END OF EJS Templates
cleaned installation docs a little
marcink -
r855:8bbe9ab7 beta
parent child Browse files
Show More
@@ -1,96 +1,99 b''
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 Requirements for Celery
20 -----------------------
21
22 .. note::
23 Installing message broker and using celery is optional, RhodeCode will
24 work without them perfectly fine.
25
26
27 **Message Broker**
28
29 - preferred is `RabbitMq <http://www.rabbitmq.com/>`_
30 - possible other is `Redis <http://code.google.com/p/redis/>`_
31
32 For installation instructions You can visit:
33 http://ask.github.com/celery/getting-started/index.html
34 It's very nice tutorial how to start celery_ with rabbitmq_
35
36 Install from Cheese Shop
19 Install from Cheese Shop
37 ------------------------
20 ------------------------
38 Rhodecode requires python 2.x greater than version 2.5
21 Rhodecode requires python 2.x greater than version 2.5
39
22
40 Easiest way to install ``rhodecode`` is to run::
23 Easiest way to install ``rhodecode`` is to run::
41
24
42 easy_install rhodecode
25 easy_install rhodecode
43
26
44 Or::
27 Or::
45
28
46 pip install rhodecode
29 pip install rhodecode
47
30
48 If you prefer to install manually simply grab latest release from
31 If you prefer to install manually simply grab latest release from
49 http://pypi.python.org/pypi/rhodecode, decompres archive and run::
32 http://pypi.python.org/pypi/rhodecode, decompres archive and run::
50
33
51 python setup.py install
34 python setup.py install
52
35
53
36
54 Step by step installation example
37 Step by step installation example
55 ---------------------------------
38 ---------------------------------
56
39
57
40
58 - Assuming You have installed virtualenv_ create one using.
41 - Assuming You have installed virtualenv_ create one using.
59 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
60 with this virtualenv_
43 with this virtualenv_
61
44
62 ::
45 ::
63
46
64 virtualenv --no-site-packages /var/www/rhodecode-venv
47 virtualenv --no-site-packages /var/www/rhodecode-venv
65
48
66 - this will install new virtualenv_ into `/var/www/rhodecode-venv`.
49 - this will install new virtualenv_ into `/var/www/rhodecode-venv`.
67 - Activate the virtualenv_ by running
50 - Activate the virtualenv_ by running
68
51
69 ::
52 ::
70
53
71 source activate /var/www/rhodecode-venv/bin/activate
54 source activate /var/www/rhodecode-venv/bin/activate
72
55
73 - Make a folder for rhodecode somewhere on the filesystem for example
56 - Make a folder for rhodecode somewhere on the filesystem for example
74
57
75 ::
58 ::
76
59
77 mkdir /var/www/rhodecode
60 mkdir /var/www/rhodecode
78
61
79
62
80 - Run this command to install rhodecode
63 - Run this command to install rhodecode
81
64
82 ::
65 ::
83
66
84 easy_install rhodecode
67 easy_install rhodecode
85
68
86 - this will install rhodecode together with pylons
69 - this will install rhodecode together with pylons
87 and all other required python libraries
70 and all other required python libraries
88
71
72 Requirements for Celery (optional)
73 ----------------------------------
74
75 .. note::
76 Installing message broker and using celery is optional, RhodeCode will
77 work without them perfectly fine.
78
79
80 **Message Broker**
81
82 - preferred is `RabbitMq <http://www.rabbitmq.com/>`_
83 - possible other is `Redis <http://code.google.com/p/redis/>`_
84
85 For installation instructions You can visit:
86 http://ask.github.com/celery/getting-started/index.html
87 It's very nice tutorial how to start celery_ with rabbitmq_
88
89
89
90 You can now proceed to :ref:`setup`
90 You can now proceed to :ref:`setup`
91 -----------------------------------
92
93
91
94
92 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
95 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
93 .. _python: http://www.python.org/
96 .. _python: http://www.python.org/
94 .. _mercurial: http://mercurial.selenic.com/
97 .. _mercurial: http://mercurial.selenic.com/
95 .. _celery: http://celeryproject.org/
98 .. _celery: http://celeryproject.org/
96 .. _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