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