Mercurial > kallithea

comparison docs/installation.rst @ 3224:8b8edfc25856 beta

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
whitespace cleanup
author Marcin Kuzminski <marcin@python-works.com>
date Fri, 25 Jan 2013 02:31:17 +0100
parents a649599ad8b7
children 3563bb7b4b82
comparison
equal deleted inserted replaced
3223:74e455c06881 3224:8b8edfc25856
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
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 46 Alternative very detailed installation instructions for Ubuntu Server with
47 celery, indexer and daemon scripts: https://gist.github.com/4546398 47 celery, indexer and daemon scripts: https://gist.github.com/4546398
48 48
49 49
50 - Assuming you have installed virtualenv_ create a new virtual environment 50 - Assuming you have installed virtualenv_ create a new virtual environment
51 using virtualenv command:: 51 using virtualenv command::
52 52
53 virtualenv --no-site-packages /opt/rhodecode-venv 53 virtualenv --no-site-packages /opt/rhodecode-venv
54 54
55 55
56 .. note:: Using ``--no-site-packages`` when generating your 56 .. note:: Using ``--no-site-packages`` when generating your
61 the virtualenv, or, even if it does, may not run properly, 61 the virtualenv, or, even if it does, may not run properly,
62 depending on the packages you've already got installed into your 62 depending on the packages you've already got installed into your
63 Python's "main" site-packages dir. 63 Python's "main" site-packages dir.
64 64
65 65
66 - this will install new virtualenv_ into `/opt/rhodecode-venv`. 66 - this will install new virtualenv_ into `/opt/rhodecode-venv`.
67 - Activate the virtualenv_ by running:: 67 - Activate the virtualenv_ by running::
68 68
69 source /opt/rhodecode-venv/bin/activate 69 source /opt/rhodecode-venv/bin/activate
70 70
71 .. 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
72 ``virtualenv`` script. It's perfectly acceptable (and desirable) 72 ``virtualenv`` script. It's perfectly acceptable (and desirable)
73 to create a virtualenv as a normal user. 73 to create a virtualenv as a normal user.
74 74
75 - 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
76 filesystem. For example:: 76 filesystem. For example::
77 77
78 mkdir /opt/rhodecode 78 mkdir /opt/rhodecode
79 79
80 80
81 - Go into the created directory run this command to install rhodecode:: 81 - Go into the created directory run this command to install rhodecode::
82 82
83 easy_install rhodecode 83 easy_install rhodecode
84 84
85 or:: 85 or::
86
87 pip install rhodecode
88 86
89 - This will install rhodecode together with pylons and all other required 87 pip install rhodecode
88
89 - This will install rhodecode together with pylons and all other required
90 python libraries into activated virtualenv 90 python libraries into activated virtualenv
91 91
92 Requirements for Celery (optional) 92 Requirements for Celery (optional)
93 ---------------------------------- 93 ----------------------------------
94 94
95 In order to gain maximum performance 95 In order to gain maximum performance
96 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
97 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,
98 recommended one is rabbitmq_ to make the async tasks work. 98 recommended one is rabbitmq_ to make the async tasks work.
99 99
100 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
101 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
102 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
103 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
104 without celery running. 104 without celery running.
105 105
106 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
107 celeryd using paster and message broker together with the application. 107 celeryd using paster and message broker together with the application.
108 108
109 .. note:: 109 .. note::
110 Installing message broker and using celery is optional, RhodeCode will 110 Installing message broker and using celery is optional, RhodeCode will
111 work perfectly fine without them. 111 work perfectly fine without them.
112 112
113 113
114 **Message Broker** 114 **Message Broker**
115 115
116 - preferred is `RabbitMq <http://www.rabbitmq.com/>`_ 116 - preferred is `RabbitMq <http://www.rabbitmq.com/>`_
117 - A possible alternative is `Redis <http://code.google.com/p/redis/>`_ 117 - A possible alternative is `Redis <http://code.google.com/p/redis/>`_
118 118
119 For installation instructions you can visit: 119 For installation instructions you can visit:
120 http://ask.github.com/celery/getting-started/index.html. 120 http://ask.github.com/celery/getting-started/index.html.
121 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_
122 122
123 123
124 You can now proceed to :ref:`setup` 124 You can now proceed to :ref:`setup`
125 ----------------------------------- 125 -----------------------------------
126 126
127 127
128 128
129 .. _virtualenv: http://pypi.python.org/pypi/virtualenv 129 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
130 .. _python: http://www.python.org/ 130 .. _python: http://www.python.org/
131 .. _mercurial: http://mercurial.selenic.com/ 131 .. _mercurial: http://mercurial.selenic.com/
132 .. _celery: http://celeryproject.org/ 132 .. _celery: http://celeryproject.org/
133 .. _rabbitmq: http://www.rabbitmq.com/ 133 .. _rabbitmq: http://www.rabbitmq.com/