Mercurial > public > src > rhodecode

annotate docs/installation.rst @ 2819:dd240b2b7a12 beta tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added optional flag to make_ui to not clean sqlalchemy Session. Don't clear sqlalchemy session when using make_ui in admin repo form
author Marcin Kuzminski <marcin@python-works.com>
date Wed, 15 Aug 2012 18:25:38 +0200
parents 33252b42d9eb
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
617
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
1 .. _installation:
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
2
2191
Marcin Kuzminski <marcin@python-works.com>
parents: 1519
diff changeset
3 ============
617
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
4 Installation
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
5 ============
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
6
1387
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
7 ``RhodeCode`` is written entirely in Python. Before posting any issues make
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
8 sure, your not missing any system libraries and using right version of
1519
828639811cdc added info about minimum client version for rhodecode. Fixes #224
Marcin Kuzminski <marcin@python-works.com>
parents: 1387
diff changeset
9 libraries required by RhodeCode. There's also restriction in terms of mercurial
828639811cdc added info about minimum client version for rhodecode. Fixes #224
Marcin Kuzminski <marcin@python-works.com>
parents: 1387
diff changeset
10 clients. Minimal version of hg client known working fine with RhodeCode is
828639811cdc added info about minimum client version for rhodecode. Fixes #224
Marcin Kuzminski <marcin@python-works.com>
parents: 1387
diff changeset
11 **1.6**. If you're using older client, please upgrade.
617
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
12
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
13
1161
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
14 Installing RhodeCode from Cheese Shop
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
15 -------------------------------------
617
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
16
1161
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
17 Rhodecode requires python version 2.5 or higher.
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
18
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
19 The easiest way to install ``rhodecode`` is to run::
617
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
20
1126
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 995
diff changeset
21 easy_install rhodecode
617
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
22
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
23 Or::
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
24
1126
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 995
diff changeset
25 pip install rhodecode
617
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
26
1161
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
27 If you prefer to install RhodeCode manually simply grab latest release from
2453
f55b8142bf6c fix doc typo
Marcin Kuzminski <marcin@python-works.com>
parents: 2191
diff changeset
28 http://pypi.python.org/pypi/RhodeCode, decompress the archive and run::
617
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
29
1126
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 995
diff changeset
30 python setup.py install
617
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
31
2460
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents: 2453
diff changeset
32 Step by step installation example for Windows
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents: 2453
diff changeset
33 ---------------------------------------------
617
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
34
2460
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents: 2453
diff changeset
35 :ref:`installation_win`
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents: 2453
diff changeset
36
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents: 2453
diff changeset
37
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents: 2453
diff changeset
38 Step by step installation example for Linux
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents: 2453
diff changeset
39 -------------------------------------------
617
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
40
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
41
1387
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
42 For installing RhodeCode i highly recommend using separate virtualenv_. This
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
43 way many required by RhodeCode libraries will remain sandboxed from your main
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
44 python and making things less problematic when doing system python updates.
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
45
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
46 - Assuming you have installed virtualenv_ create a new virtual environment
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
47 using virtualenv command::
622
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 617
diff changeset
48
2752
33252b42d9eb changed /var/www to /opt as example in installation, it's just a better example.
Marcin Kuzminski <marcin@python-works.com>
parents: 2460
diff changeset
49 virtualenv --no-site-packages /opt/rhodecode-venv
622
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 617
diff changeset
50
1161
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
51
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
52 .. note:: Using ``--no-site-packages`` when generating your
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
53 virtualenv is **very important**. This flag provides the necessary
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
54 isolation for running the set of packages required by
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
55 RhodeCode. If you do not specify ``--no-site-packages``,
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
56 it's possible that RhodeCode will not install properly into
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
57 the virtualenv, or, even if it does, may not run properly,
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
58 depending on the packages you've already got installed into your
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
59 Python's "main" site-packages dir.
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
60
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
61
2752
33252b42d9eb changed /var/www to /opt as example in installation, it's just a better example.
Marcin Kuzminski <marcin@python-works.com>
parents: 2460
diff changeset
62 - this will install new virtualenv_ into `/opt/rhodecode-venv`.
1161
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
63 - Activate the virtualenv_ by running::
622
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 617
diff changeset
64
2752
33252b42d9eb changed /var/www to /opt as example in installation, it's just a better example.
Marcin Kuzminski <marcin@python-works.com>
parents: 2460
diff changeset
65 source /opt/rhodecode-venv/bin/activate
1161
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
66
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
67 .. note:: If you're using UNIX, *do not* use ``sudo`` to run the
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
68 ``virtualenv`` script. It's perfectly acceptable (and desirable)
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
69 to create a virtualenv as a normal user.
622
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 617
diff changeset
70
1387
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
71 - Make a folder for rhodecode data files, and configuration somewhere on the
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
72 filesystem. For example::
622
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 617
diff changeset
73
2752
33252b42d9eb changed /var/www to /opt as example in installation, it's just a better example.
Marcin Kuzminski <marcin@python-works.com>
parents: 2460
diff changeset
74 mkdir /opt/rhodecode
622
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 617
diff changeset
75
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 617
diff changeset
76
1387
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
77 - Go into the created directory run this command to install rhodecode::
622
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 617
diff changeset
78
1387
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
79 easy_install rhodecode
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
80
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
81 or::
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
82
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
83 pip install rhodecode
622
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 617
diff changeset
84
1387
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
85 - This will install rhodecode together with pylons and all other required
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
86 python libraries into activated virtualenv
622
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 617
diff changeset
87
912
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 902
diff changeset
88 Requirements for Celery (optional)
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 902
diff changeset
89 ----------------------------------
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 902
diff changeset
90
1387
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
91 In order to gain maximum performance
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
92 there are some third-party you must install. When RhodeCode is used
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
93 together with celery you have to install some kind of message broker,
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
94 recommended one is rabbitmq_ to make the async tasks work.
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
95
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
96 Of course RhodeCode works in sync mode also and then you do not have to install
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
97 any third party applications. However, using Celery_ will give you a large
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
98 speed improvement when using many big repositories. If you plan to use
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
99 RhodeCode for say 7 to 10 repositories, RhodeCode will perform perfectly well
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
100 without celery running.
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
101
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
102 If you make the decision to run RhodeCode with celery make sure you run
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
103 celeryd using paster and message broker together with the application.
61a6a7bf2cbd small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1192
diff changeset
104
912
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 902
diff changeset
105 .. note::
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 902
diff changeset
106 Installing message broker and using celery is optional, RhodeCode will
1161
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
107 work perfectly fine without them.
912
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 902
diff changeset
108
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 902
diff changeset
109
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 902
diff changeset
110 **Message Broker**
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 902
diff changeset
111
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 902
diff changeset
112 - preferred is `RabbitMq <http://www.rabbitmq.com/>`_
1161
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
113 - A possible alternative is `Redis <http://code.google.com/p/redis/>`_
912
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 902
diff changeset
114
1161
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
115 For installation instructions you can visit:
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
116 http://ask.github.com/celery/getting-started/index.html.
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1126
diff changeset
117 This is a very nice tutorial on how to start using celery_ with rabbitmq_
912
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 902
diff changeset
118
622
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 617
diff changeset
119
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 617
diff changeset
120 You can now proceed to :ref:`setup`
912
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 902
diff changeset
121 -----------------------------------
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 902
diff changeset
122
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 902
diff changeset
123
617
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
124
622
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 617
diff changeset
125 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 617
diff changeset
126 .. _python: http://www.python.org/
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 617
diff changeset
127 .. _mercurial: http://mercurial.selenic.com/
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 617
diff changeset
128 .. _celery: http://celeryproject.org/
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 617
diff changeset
129 .. _rabbitmq: http://www.rabbitmq.com/