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