##// END OF EJS Templates
added info about minimum client version for rhodecode. Fixes #224
marcink -
r1439:82863981 beta
parent child Browse files
Show More
@@ -1,121 +1,123
1 .. _installation:
1 .. _installation:
2
2
3 Installation
3 Installation
4 ============
4 ============
5
5
6 ``RhodeCode`` is written entirely in Python. Before posting any issues make
6 ``RhodeCode`` is written entirely in Python. Before posting any issues make
7 sure, your not missing any system libraries and using right version of
7 sure, your not missing any system libraries and using right version of
8 libraries required by RhodeCode.
8 libraries required by RhodeCode. There's also restriction in terms of mercurial
9 clients. Minimal version of hg client known working fine with RhodeCode is
10 **1.6**. If you're using older client, please upgrade.
9
11
10
12
11 Installing RhodeCode from Cheese Shop
13 Installing RhodeCode from Cheese Shop
12 -------------------------------------
14 -------------------------------------
13
15
14 Rhodecode requires python version 2.5 or higher.
16 Rhodecode requires python version 2.5 or higher.
15
17
16 The easiest way to install ``rhodecode`` is to run::
18 The easiest way to install ``rhodecode`` is to run::
17
19
18 easy_install rhodecode
20 easy_install rhodecode
19
21
20 Or::
22 Or::
21
23
22 pip install rhodecode
24 pip install rhodecode
23
25
24 If you prefer to install RhodeCode manually simply grab latest release from
26 If you prefer to install RhodeCode manually simply grab latest release from
25 http://pypi.python.org/pypi/rhodecode, decompress the archive and run::
27 http://pypi.python.org/pypi/rhodecode, decompress the archive and run::
26
28
27 python setup.py install
29 python setup.py install
28
30
29
31
30 Step by step installation example
32 Step by step installation example
31 ---------------------------------
33 ---------------------------------
32
34
33
35
34 For installing RhodeCode i highly recommend using separate virtualenv_. This
36 For installing RhodeCode i highly recommend using separate virtualenv_. This
35 way many required by RhodeCode libraries will remain sandboxed from your main
37 way many required by RhodeCode libraries will remain sandboxed from your main
36 python and making things less problematic when doing system python updates.
38 python and making things less problematic when doing system python updates.
37
39
38 - Assuming you have installed virtualenv_ create a new virtual environment
40 - Assuming you have installed virtualenv_ create a new virtual environment
39 using virtualenv command::
41 using virtualenv command::
40
42
41 virtualenv --no-site-packages /var/www/rhodecode-venv
43 virtualenv --no-site-packages /var/www/rhodecode-venv
42
44
43
45
44 .. note:: Using ``--no-site-packages`` when generating your
46 .. note:: Using ``--no-site-packages`` when generating your
45 virtualenv is **very important**. This flag provides the necessary
47 virtualenv is **very important**. This flag provides the necessary
46 isolation for running the set of packages required by
48 isolation for running the set of packages required by
47 RhodeCode. If you do not specify ``--no-site-packages``,
49 RhodeCode. If you do not specify ``--no-site-packages``,
48 it's possible that RhodeCode will not install properly into
50 it's possible that RhodeCode will not install properly into
49 the virtualenv, or, even if it does, may not run properly,
51 the virtualenv, or, even if it does, may not run properly,
50 depending on the packages you've already got installed into your
52 depending on the packages you've already got installed into your
51 Python's "main" site-packages dir.
53 Python's "main" site-packages dir.
52
54
53
55
54 - this will install new virtualenv_ into `/var/www/rhodecode-venv`.
56 - this will install new virtualenv_ into `/var/www/rhodecode-venv`.
55 - Activate the virtualenv_ by running::
57 - Activate the virtualenv_ by running::
56
58
57 source /var/www/rhodecode-venv/bin/activate
59 source /var/www/rhodecode-venv/bin/activate
58
60
59 .. note:: If you're using UNIX, *do not* use ``sudo`` to run the
61 .. note:: If you're using UNIX, *do not* use ``sudo`` to run the
60 ``virtualenv`` script. It's perfectly acceptable (and desirable)
62 ``virtualenv`` script. It's perfectly acceptable (and desirable)
61 to create a virtualenv as a normal user.
63 to create a virtualenv as a normal user.
62
64
63 - Make a folder for rhodecode data files, and configuration somewhere on the
65 - Make a folder for rhodecode data files, and configuration somewhere on the
64 filesystem. For example::
66 filesystem. For example::
65
67
66 mkdir /var/www/rhodecode
68 mkdir /var/www/rhodecode
67
69
68
70
69 - Go into the created directory run this command to install rhodecode::
71 - Go into the created directory run this command to install rhodecode::
70
72
71 easy_install rhodecode
73 easy_install rhodecode
72
74
73 or::
75 or::
74
76
75 pip install rhodecode
77 pip install rhodecode
76
78
77 - This will install rhodecode together with pylons and all other required
79 - This will install rhodecode together with pylons and all other required
78 python libraries into activated virtualenv
80 python libraries into activated virtualenv
79
81
80 Requirements for Celery (optional)
82 Requirements for Celery (optional)
81 ----------------------------------
83 ----------------------------------
82
84
83 In order to gain maximum performance
85 In order to gain maximum performance
84 there are some third-party you must install. When RhodeCode is used
86 there are some third-party you must install. When RhodeCode is used
85 together with celery you have to install some kind of message broker,
87 together with celery you have to install some kind of message broker,
86 recommended one is rabbitmq_ to make the async tasks work.
88 recommended one is rabbitmq_ to make the async tasks work.
87
89
88 Of course RhodeCode works in sync mode also and then you do not have to install
90 Of course RhodeCode works in sync mode also and then you do not have to install
89 any third party applications. However, using Celery_ will give you a large
91 any third party applications. However, using Celery_ will give you a large
90 speed improvement when using many big repositories. If you plan to use
92 speed improvement when using many big repositories. If you plan to use
91 RhodeCode for say 7 to 10 repositories, RhodeCode will perform perfectly well
93 RhodeCode for say 7 to 10 repositories, RhodeCode will perform perfectly well
92 without celery running.
94 without celery running.
93
95
94 If you make the decision to run RhodeCode with celery make sure you run
96 If you make the decision to run RhodeCode with celery make sure you run
95 celeryd using paster and message broker together with the application.
97 celeryd using paster and message broker together with the application.
96
98
97 .. note::
99 .. note::
98 Installing message broker and using celery is optional, RhodeCode will
100 Installing message broker and using celery is optional, RhodeCode will
99 work perfectly fine without them.
101 work perfectly fine without them.
100
102
101
103
102 **Message Broker**
104 **Message Broker**
103
105
104 - preferred is `RabbitMq <http://www.rabbitmq.com/>`_
106 - preferred is `RabbitMq <http://www.rabbitmq.com/>`_
105 - A possible alternative is `Redis <http://code.google.com/p/redis/>`_
107 - A possible alternative is `Redis <http://code.google.com/p/redis/>`_
106
108
107 For installation instructions you can visit:
109 For installation instructions you can visit:
108 http://ask.github.com/celery/getting-started/index.html.
110 http://ask.github.com/celery/getting-started/index.html.
109 This is a very nice tutorial on how to start using celery_ with rabbitmq_
111 This is a very nice tutorial on how to start using celery_ with rabbitmq_
110
112
111
113
112 You can now proceed to :ref:`setup`
114 You can now proceed to :ref:`setup`
113 -----------------------------------
115 -----------------------------------
114
116
115
117
116
118
117 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
119 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
118 .. _python: http://www.python.org/
120 .. _python: http://www.python.org/
119 .. _mercurial: http://mercurial.selenic.com/
121 .. _mercurial: http://mercurial.selenic.com/
120 .. _celery: http://celeryproject.org/
122 .. _celery: http://celeryproject.org/
121 .. _rabbitmq: http://www.rabbitmq.com/ No newline at end of file
123 .. _rabbitmq: http://www.rabbitmq.com/
General Comments 0
You need to be logged in to leave comments. Login now