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