setup.rst 11 KB
Newer Older
1
.. -*- coding: utf-8 -*-
Adrien Di Mascio's avatar
Adrien Di Mascio committed
2

Sandrine Ribeau's avatar
Sandrine Ribeau committed
3
.. _SetUpEnv:
Adrien Di Mascio's avatar
Adrien Di Mascio committed
4

5
===================================================
Nicolas Chauvat's avatar
Nicolas Chauvat committed
6
Installation and set-up of a *CubicWeb* environment
7
===================================================
Adrien Di Mascio's avatar
Adrien Di Mascio committed
8

9
10
11
Installation of `Cubicweb` and its dependencies
-----------------------------------------------

Nicolas Chauvat's avatar
Nicolas Chauvat committed
12
*CubicWeb* is packaged for Debian and Ubuntu, but can be installed from source
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
using a tarball or the Mercurial version control system.

.. _DebianInstallation:

Debian and Ubuntu packages
```````````````````````````

Depending on the distribution you are using, add the appropriate line to your list
of sources (for example by editing ``/etc/apt/sources.list``).

For Debian Lenny::

  deb http://ftp.logilab.org/dists/ lenny/

For Debian Sid::

  deb http://ftp.logilab.org/dists/ sid/

For Ubuntu Hardy::

  deb http://ftp.logilab.org/dists/ hardy/


You can now install the required packages with the following command::

Nicolas Chauvat's avatar
Nicolas Chauvat committed
38
  apt-get update
39
40
41
  apt-get install cubicweb cubicweb-dev

`cubicweb` installs the framework itself, allowing you to create
42
new instances.
43
44
45
46
47
48

`cubicweb-dev` installs the development environment allowing you to
develop new cubes.

There is also a wide variety of cubes listed on http://www.cubicweb.org/Project available as debian packages and tarball.

49
The repositories are signed with `Logilab's gnupg key`_. To avoid warning on "apt-get update":
Aurelien Campeas's avatar
Aurelien Campeas committed
50
1. become root using sudo
51
52
53
54
2. download http://ftp.logilab.org/dists/logilab-dists-key.asc using e.g. wget
3. run "apt-key add logilab-dists-key.asc"
4. re-run apt-get update (manually or through the package manager, whichever you prefer)

55
.. _`Logilab's gnupg key`: http://ftp.logilab.org/dists/logilab-dists-key.asc
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

Install from source
```````````````````

You can download the archive containing the sources from our `ftp site`_ at::

  http://ftp.logilab.org/pub/cubicweb/

.. _`ftp site`: http://ftp.logilab.org/pub/cubicweb/

or keep up to date with on-going development by using Mercurial and its forest
extension::

  hg fclone http://www.logilab.org/hg/forests/cubicweb

See :ref:`MercurialPresentation` for more details about Mercurial.
Aurelien Campeas's avatar
Aurelien Campeas committed
72
73
74
75
When cloning a repository, you might be set in a development branch
(the 'default' branch). You should check that the branches of the
repositories are set to 'stable' (using `hg up stable` for each one)
if you do not intend to develop the framework itself.
76

77
78
79
In both cases, make sure you have installed the dependencies (see appendixes for
the list).

80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
Windows installation
````````````````````

Base elements
_____________

Setting up a windows development environment is not too complicated
but requires a series of small steps. What is proposed there is only
an example of what can be done. We assume everything goes into C:\ in
this document. Adjusting the installation drive should be
straightforward.

You should start by downloading and installing the Python(x,y)
distribution. It contains python 2.5 plus numerous useful third-party
modules and applications::

  http://www.pythonxy.com/download_fr.php

At the time of this writting, one gets version 2.1.15. Among the many
things provided, one finds Eclipse + pydev (an arguably good IDE for
python under windows).

Then you must grab Twisted. There is a windows installer directly
available from this page::

  http://twistedmatrix.com/trac/

A windows installer for lxml will be found there::

  http://pypi.python.org/pypi/lxml/2.2.1

Check out the lxml-2.2.1-win32-py2.5.exe file. More recent bugfix
releases should probably work, too.

You should find postgresql 8.4 there::

  http://www.enterprisedb.com/products/pgdownload.do#windows

The python drivers for posgtresql are to be found there::

  http://www.stickpeople.com/projects/python/win-psycopg/#Version2

Please be careful to select the right python (2.5) and postgres (8.4)
versions.

Aurelien Campeas's avatar
Aurelien Campeas committed
125
126
127
128
129
Pyro enable remote access to cubicweb repository instances. Get it
there::

  http://sourceforge.net/projects/pyro/files/

130
131
132
133
134
135
136
To access LDAP/Active directory directories, we need the python-ldap
package. Windows binaries are available from::

  http://www.osuch.org/python-ldap

Check out the latest release.

137
138
139
140
141
Having graphviz will allow schema drawings, which is quite recommended
(albeit not mandatory). You should get an msi installer there::

  http://www.graphviz.org/Download_windows.php

142
143
144
145
146
Simplejson will be provided within the forest, but a win32 compiled
version will run much faster::

  http://www.osuch.org/python-simplejson%3Awin32

147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
Tools
_____

Get mercurial + its standard windows GUI (TortoiseHG) there (the
latest is the greatest)::

  http://bitbucket.org/tortoisehg/stable/wiki/download

If you need to peruse mercurial over ssh, it can be helpful to get an
ssh client like Putty::

  http://www.putty.org/

Integration of mercurial and Eclipse is convenient enough that we want
it. Instructions are set there, in the `Download & Install` section::

  http://www.vectrace.com/mercurialeclipse/

Setting up the sources
______________________

You need to enable the mercurial forest extension. To do this, edit
the file::

  C:\Program Files\TortoiseHg\Mercurial.ini

In the [extensions] section, add the following line::

  forest=C:\Program Files\TortoiseHg\ext\forest\forest.py

Now, you need to clone the cubicweb repository. We assume that you use
Eclipse. From the IDE, choose File -> Import. In the box, select
`Mercurial/Clone repository using MercurialEclipse`.

In the import main panel you just have to:

* fill the URL field with http://www.logilab.org/hg/forests/cubicwin32

* check the 'Repository is a forest' box.

Then, click on 'Finish'. It might take some time to get it all. Note
that the `cubicwin32` forest contains additional python packages such
as yapps, vobject, simplejson and twisted-web2 which are not provided
with Python(x,y). This is provided for convenience, as we do not
ensure the up-to-dateness of these packages, especially with respect
to security fixes.

Environment variables
_____________________

You will need some convenience environment variables once all is set
up. These variables are settable through the GUI by getting at the
'System properties' window (by righ-clicking on 'My Computer' ->
properties).

In the 'advanced' tab, there is an 'Environment variables'
button. Click on it. That opens a small window allowing edition of
user-related and system-wide variables.

We will consider only user variables. First, the PATH variable. You
should ensure it contains, separated by semi-colons, and assuming you
are logged in as user Jane::

  C:\Documents and Settings\Jane\My Documents\Python\cubicweb\cubicweb\bin
  C:\Program Files\Graphviz2.24\bin

The PYTHONPATH variable should also contain::

  C:\Documents and Settings\Jane\My Documents\Python\cubicweb\

From now, on a fresh `cmd` shell, you should be able to type::

  cubicweb-ctl list

... and get a meaningful output.


Nicolas Chauvat's avatar
Nicolas Chauvat committed
224
225
PostgreSQL installation
```````````````````````
226

Nicolas Chauvat's avatar
Nicolas Chauvat committed
227
Please refer to the `PostgreSQL project online documentation`_.
228

Nicolas Chauvat's avatar
Nicolas Chauvat committed
229
.. _`PostgreSQL project online documentation`: http://www.postgresql.org/
230

Nicolas Chauvat's avatar
Nicolas Chauvat committed
231
232
You need to install the three following packages: `postgresql-8.3`,
`postgresql-contrib-8.3` and `postgresql-plpython-8.3`.
233
234


Nicolas Chauvat's avatar
Nicolas Chauvat committed
235
236
237
238
Other dependencies
``````````````````

You can also install:
239
240
241
242
243
244
245
246
247
248
249
250
251

* `pyro` if you wish the repository to be accessible through Pyro
  or if the client and the server are not running on the same machine
  (in which case the packages will have to be installed on both
  machines)

* `python-ldap` if you plan to use a LDAP source on the server

.. _ConfigurationEnv:

Environment configuration
-------------------------

Nicolas Chauvat's avatar
Nicolas Chauvat committed
252
If you installed *CubicWeb* by cloning the Mercurial forest, then you
Nicolas Chauvat's avatar
Nicolas Chauvat committed
253
will need to update the environment variable PYTHONPATH by adding
254
255
256
257
the path to the forest ``cubicweb``:

Add the following lines to either `.bashrc` or `.bash_profile` to configure
your development environment ::
Nicolas Chauvat's avatar
Nicolas Chauvat committed
258

Nicolas Chauvat's avatar
Nicolas Chauvat committed
259
    export PYTHONPATH=/full/path/to/cubicweb-forest
260

Nicolas Chauvat's avatar
Nicolas Chauvat committed
261
If you installed *CubicWeb* with packages, no configuration is required and your
262
new cubes will be placed in `/usr/share/cubicweb/cubes` and your instances
Nicolas Chauvat's avatar
Nicolas Chauvat committed
263
will be placed in `/etc/cubicweb.d`.
264

Nicolas Chauvat's avatar
Nicolas Chauvat committed
265
266
You may run a system-wide install of *CubicWeb* in "user mode" and use it for
development by setting the following environment variable::
267

Nicolas Chauvat's avatar
Nicolas Chauvat committed
268
    export CW_MODE=user
269
    export CW_CUBES_PATH=~/lib/cubes
Nicolas Chauvat's avatar
Nicolas Chauvat committed
270
271
272
    export CW_INSTANCES_DIR=~/etc/cubicweb.d/
    export CW_INSTANCES_DATA_DIR=$CW_INSTANCES_DIR
    export CW_RUNTIME_DIR=/tmp
273
274
275
276
277
278
279

.. note::
    The values given above are our suggestions but of course
    can be different.


Databases configuration
Sandrine Ribeau's avatar
Sandrine Ribeau committed
280
281
-----------------------

Nicolas Chauvat's avatar
Nicolas Chauvat committed
282
.. _ConfigurationPostgresql:
283

Nicolas Chauvat's avatar
Nicolas Chauvat committed
284
285
PostgreSQL configuration
````````````````````````
286
287

.. note::
Nicolas Chauvat's avatar
Nicolas Chauvat committed
288
    If you already have an existing cluster and PostgreSQL server
289
    running, you do not need to execute the initilization step
Nicolas Chauvat's avatar
Nicolas Chauvat committed
290
    of your PostgreSQL database.
291

Nicolas Chauvat's avatar
Nicolas Chauvat committed
292
* First, initialize the database PostgreSQL with the command ``initdb``.
293
294
295
296
  ::

    $ initdb -D /path/to/pgsql

Nicolas Chauvat's avatar
Nicolas Chauvat committed
297
  Once initialized, start the database server PostgreSQL
298
  with the command::
Nicolas Chauvat's avatar
Nicolas Chauvat committed
299

300
301
302
303
304
    $ postgres -D /path/to/psql

  If you cannot execute this command due to permission issues, please
  make sure that your username has write access on the database.
  ::
Nicolas Chauvat's avatar
Nicolas Chauvat committed
305

306
307
308
    $ chown username /path/to/pgsql

* The database authentication can be either set to `ident sameuser`
Nicolas Chauvat's avatar
Nicolas Chauvat committed
309
  or `md5`.
310
311
312
313
314
  If set to `md5`, make sure to use an existing user
  of your database.
  If set to `ident sameuser`, make sure that your
  client's operating system user name has a matching user in
  the database. If not, please do as follow to create a user::
Nicolas Chauvat's avatar
Nicolas Chauvat committed
315

316
317
318
319
320
    $ su
    $ su - postgres
    $ createuser -s -P username

  The option `-P` (for password prompt), will encrypt the password with
Nicolas Chauvat's avatar
Nicolas Chauvat committed
321
  the method set in the configuration file ``pg_hba.conf``.
322
323
  If you do not use this option `-P`, then the default value will be null
  and you will need to set it with::
Nicolas Chauvat's avatar
Nicolas Chauvat committed
324

325
326
327
328
    $ su postgres -c "echo ALTER USER username WITH PASSWORD 'userpasswd' | psql"

  This login/password will be requested when you will create an
  instance with `cubicweb-ctl create` to initialize the database of
329
  your instance.
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345

.. note::
    The authentication method can be configured in ``pg_hba.conf``.


.. FIXME Are these steps really necessary? It seemed to work without.

* Installation of plain-text index extension ::

    cat /usr/share/postgresql/8.3/contrib/tsearch2.sql | psql -U username template1

* Installation of plpythonu language by default ::

    createlang -U pgadmin plpythonu template1

MySql configuration
Sandrine Ribeau's avatar
Sandrine Ribeau committed
346
```````````````````
347
Yout must add the following lines in ``/etc/mysql/my.cnf`` file::
348
349
350
351
352
353

    transaction-isolation = READ-COMMITTED
    default-storage-engine=INNODB
    default-character-set=utf8
    max_allowed_packet = 128M

354
355
356
357
.. note::
    It is unclear whether mysql supports indexed string of arbitrary lenght or
    not.

358
359
360
361
362
363
364
365
366
367
368
369
370
Pyro configuration
------------------

If you use Pyro, it is required to have a name server Pyro running on your
network (by default it is detected by a broadcast request).

To do so, you need to :

* launch the server manually before starting cubicweb as a server with
  `pyro-nsd start`

* edit the file ``/etc/default/pyro-nsd`` so that the name server pyro
  will be launched automatically when the machine fire up
Adrien Di Mascio's avatar
Adrien Di Mascio committed
371