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