doc/book/en/admin/setup.rst
author Aurelien Campeas <aurelien.campeas@logilab.fr>
Wed, 09 Dec 2009 19:29:21 +0100
branchstable
changeset 4065 6e8da644d996
parent 3740 e9ce140c9065
child 4414 4a680adda04c
child 4431 e597e0ca67cd
permissions -rw-r--r--
explain how to run as a windows service
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     1
.. -*- coding: utf-8 -*-
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     2
1224
a9da8a8f0b19 [doc] Change id to english.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 221
diff changeset
     3
.. _SetUpEnv:
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     4
2175
16d3c37c5d28 [doc] improvements
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2172
diff changeset
     5
Installation and set-up of a *CubicWeb* environment
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
     6
===================================================
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     7
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
     8
Installation of `Cubicweb` and its dependencies
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
     9
-----------------------------------------------
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    10
2175
16d3c37c5d28 [doc] improvements
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2172
diff changeset
    11
*CubicWeb* is packaged for Debian and Ubuntu, but can be installed from source
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    12
using a tarball or the Mercurial version control system.
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    13
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    14
.. _DebianInstallation:
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    15
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    16
Debian and Ubuntu packages
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    17
```````````````````````````
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    18
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    19
Depending on the distribution you are using, add the appropriate line to your list
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    20
of sources (for example by editing ``/etc/apt/sources.list``).
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    21
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    22
For Debian Lenny::
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    23
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    24
  deb http://ftp.logilab.org/dists/ lenny/
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    25
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    26
For Debian Sid::
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    27
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    28
  deb http://ftp.logilab.org/dists/ sid/
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    29
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    30
For Ubuntu Hardy::
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    31
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    32
  deb http://ftp.logilab.org/dists/ hardy/
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    33
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    34
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    35
You can now install the required packages with the following command::
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    36
2172
cf8f9180e63e delete-trailing-whitespace
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1714
diff changeset
    37
  apt-get update
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    38
  apt-get install cubicweb cubicweb-dev
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    39
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    40
`cubicweb` installs the framework itself, allowing you to create
2476
1294a6bdf3bf application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2458
diff changeset
    41
new instances.
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    42
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    43
`cubicweb-dev` installs the development environment allowing you to
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    44
develop new cubes.
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    45
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    46
There is also a wide variety of cubes listed on http://www.cubicweb.org/Project available as debian packages and tarball.
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    47
2239
0f12f1ebf27c add note about logilab key file / apt-get
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2175
diff changeset
    48
The repositories are signed with `Logilab's gnupg key`_. To avoid warning on "apt-get update":
2393
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2239
diff changeset
    49
1. become root using sudo
2239
0f12f1ebf27c add note about logilab key file / apt-get
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2175
diff changeset
    50
2. download http://ftp.logilab.org/dists/logilab-dists-key.asc using e.g. wget
0f12f1ebf27c add note about logilab key file / apt-get
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2175
diff changeset
    51
3. run "apt-key add logilab-dists-key.asc"
0f12f1ebf27c add note about logilab key file / apt-get
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2175
diff changeset
    52
4. re-run apt-get update (manually or through the package manager, whichever you prefer)
0f12f1ebf27c add note about logilab key file / apt-get
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2175
diff changeset
    53
2393
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2239
diff changeset
    54
.. _`Logilab's gnupg key`: http://ftp.logilab.org/dists/logilab-dists-key.asc
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    55
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    56
Install from source
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    57
```````````````````
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    58
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    59
You can download the archive containing the sources from our `ftp site`_ at::
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    60
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    61
  http://ftp.logilab.org/pub/cubicweb/
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    62
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    63
.. _`ftp site`: http://ftp.logilab.org/pub/cubicweb/
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    64
3488
ab9e7bcfc764 [doc] add missing dependencies in annexes. explain more precisely source install.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 3138
diff changeset
    65
Make sure you have installed the dependencies (see appendixes for the list).
ab9e7bcfc764 [doc] add missing dependencies in annexes. explain more precisely source install.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 3138
diff changeset
    66
ab9e7bcfc764 [doc] add missing dependencies in annexes. explain more precisely source install.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 3138
diff changeset
    67
Install from version control system
ab9e7bcfc764 [doc] add missing dependencies in annexes. explain more precisely source install.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 3138
diff changeset
    68
```````````````````````````````````
ab9e7bcfc764 [doc] add missing dependencies in annexes. explain more precisely source install.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 3138
diff changeset
    69
ab9e7bcfc764 [doc] add missing dependencies in annexes. explain more precisely source install.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 3138
diff changeset
    70
You can keep up to date with on-going development by using Mercurial and its
ab9e7bcfc764 [doc] add missing dependencies in annexes. explain more precisely source install.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 3138
diff changeset
    71
forest extension::
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    72
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    73
  hg fclone http://www.logilab.org/hg/forests/cubicweb
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    74
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    75
See :ref:`MercurialPresentation` for more details about Mercurial.
3488
ab9e7bcfc764 [doc] add missing dependencies in annexes. explain more precisely source install.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 3138
diff changeset
    76
2420
46c83be959b7 a note about branches
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2239
diff changeset
    77
When cloning a repository, you might be set in a development branch
46c83be959b7 a note about branches
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2239
diff changeset
    78
(the 'default' branch). You should check that the branches of the
46c83be959b7 a note about branches
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2239
diff changeset
    79
repositories are set to 'stable' (using `hg up stable` for each one)
46c83be959b7 a note about branches
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2239
diff changeset
    80
if you do not intend to develop the framework itself.
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    81
3488
ab9e7bcfc764 [doc] add missing dependencies in annexes. explain more precisely source install.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 3138
diff changeset
    82
Do not forget to update the forest itself (using `cd path/to/forest ; hg up`).
ab9e7bcfc764 [doc] add missing dependencies in annexes. explain more precisely source install.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 3138
diff changeset
    83
ab9e7bcfc764 [doc] add missing dependencies in annexes. explain more precisely source install.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 3138
diff changeset
    84
Make sure you have installed the dependencies (see appendixes for the list).
2393
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2239
diff changeset
    85
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
    86
Windows installation
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
    87
````````````````````
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
    88
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
    89
Base elements
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
    90
_____________
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
    91
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
    92
Setting up a windows development environment is not too complicated
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
    93
but requires a series of small steps. What is proposed there is only
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
    94
an example of what can be done. We assume everything goes into C:\ in
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
    95
this document. Adjusting the installation drive should be
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
    96
straightforward.
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
    97
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
    98
You should start by downloading and installing the Python(x,y)
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
    99
distribution. It contains python 2.5 plus numerous useful third-party
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   100
modules and applications::
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   101
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   102
  http://www.pythonxy.com/download_fr.php
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   103
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   104
At the time of this writting, one gets version 2.1.15. Among the many
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   105
things provided, one finds Eclipse + pydev (an arguably good IDE for
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   106
python under windows).
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   107
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   108
Then you must grab Twisted. There is a windows installer directly
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   109
available from this page::
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   110
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   111
  http://twistedmatrix.com/trac/
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   112
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   113
A windows installer for lxml will be found there::
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   114
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   115
  http://pypi.python.org/pypi/lxml/2.2.1
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   116
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   117
Check out the lxml-2.2.1-win32-py2.5.exe file. More recent bugfix
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   118
releases should probably work, too.
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   119
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   120
You should find postgresql 8.4 there::
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   122
  http://www.enterprisedb.com/products/pgdownload.do#windows
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   123
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   124
The python drivers for posgtresql are to be found there::
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   125
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   126
  http://www.stickpeople.com/projects/python/win-psycopg/#Version2
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   127
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   128
Please be careful to select the right python (2.5) and postgres (8.4)
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   129
versions.
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   130
3138
b33eb9e91262 add pyro
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3132
diff changeset
   131
Pyro enable remote access to cubicweb repository instances. Get it
b33eb9e91262 add pyro
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3132
diff changeset
   132
there::
b33eb9e91262 add pyro
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3132
diff changeset
   133
b33eb9e91262 add pyro
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3132
diff changeset
   134
  http://sourceforge.net/projects/pyro/files/
b33eb9e91262 add pyro
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3132
diff changeset
   135
3132
cb310b97424e python-ldap, also win32 binary version of simplejson
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3121
diff changeset
   136
To access LDAP/Active directory directories, we need the python-ldap
cb310b97424e python-ldap, also win32 binary version of simplejson
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3121
diff changeset
   137
package. Windows binaries are available from::
cb310b97424e python-ldap, also win32 binary version of simplejson
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3121
diff changeset
   138
cb310b97424e python-ldap, also win32 binary version of simplejson
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3121
diff changeset
   139
  http://www.osuch.org/python-ldap
cb310b97424e python-ldap, also win32 binary version of simplejson
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3121
diff changeset
   140
cb310b97424e python-ldap, also win32 binary version of simplejson
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3121
diff changeset
   141
Check out the latest release.
cb310b97424e python-ldap, also win32 binary version of simplejson
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3121
diff changeset
   142
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   143
Having graphviz will allow schema drawings, which is quite recommended
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   144
(albeit not mandatory). You should get an msi installer there::
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   145
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   146
  http://www.graphviz.org/Download_windows.php
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   147
3132
cb310b97424e python-ldap, also win32 binary version of simplejson
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3121
diff changeset
   148
Simplejson will be provided within the forest, but a win32 compiled
cb310b97424e python-ldap, also win32 binary version of simplejson
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3121
diff changeset
   149
version will run much faster::
cb310b97424e python-ldap, also win32 binary version of simplejson
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3121
diff changeset
   150
cb310b97424e python-ldap, also win32 binary version of simplejson
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3121
diff changeset
   151
  http://www.osuch.org/python-simplejson%3Awin32
cb310b97424e python-ldap, also win32 binary version of simplejson
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3121
diff changeset
   152
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   153
Tools
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   154
_____
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   155
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   156
Get mercurial + its standard windows GUI (TortoiseHG) there (the
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   157
latest is the greatest)::
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   158
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   159
  http://bitbucket.org/tortoisehg/stable/wiki/download
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   160
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   161
If you need to peruse mercurial over ssh, it can be helpful to get an
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   162
ssh client like Putty::
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   163
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   164
  http://www.putty.org/
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   165
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   166
Integration of mercurial and Eclipse is convenient enough that we want
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   167
it. Instructions are set there, in the `Download & Install` section::
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   168
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   169
  http://www.vectrace.com/mercurialeclipse/
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   170
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   171
Setting up the sources
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   172
______________________
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   173
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   174
You need to enable the mercurial forest extension. To do this, edit
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   175
the file::
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   176
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   177
  C:\Program Files\TortoiseHg\Mercurial.ini
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   178
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   179
In the [extensions] section, add the following line::
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   180
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   181
  forest=C:\Program Files\TortoiseHg\ext\forest\forest.py
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   182
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   183
Now, you need to clone the cubicweb repository. We assume that you use
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   184
Eclipse. From the IDE, choose File -> Import. In the box, select
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   185
`Mercurial/Clone repository using MercurialEclipse`.
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   186
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   187
In the import main panel you just have to:
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   188
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   189
* fill the URL field with http://www.logilab.org/hg/forests/cubicwin32
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   190
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   191
* check the 'Repository is a forest' box.
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   192
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   193
Then, click on 'Finish'. It might take some time to get it all. Note
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   194
that the `cubicwin32` forest contains additional python packages such
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   195
as yapps, vobject, simplejson and twisted-web2 which are not provided
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   196
with Python(x,y). This is provided for convenience, as we do not
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   197
ensure the up-to-dateness of these packages, especially with respect
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   198
to security fixes.
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   199
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   200
Environment variables
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   201
_____________________
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   202
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   203
You will need some convenience environment variables once all is set
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   204
up. These variables are settable through the GUI by getting at the
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   205
'System properties' window (by righ-clicking on 'My Computer' ->
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   206
properties).
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   207
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   208
In the 'advanced' tab, there is an 'Environment variables'
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   209
button. Click on it. That opens a small window allowing edition of
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   210
user-related and system-wide variables.
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   211
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   212
We will consider only user variables. First, the PATH variable. You
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   213
should ensure it contains, separated by semi-colons, and assuming you
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   214
are logged in as user Jane::
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   215
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   216
  C:\Documents and Settings\Jane\My Documents\Python\cubicweb\cubicweb\bin
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   217
  C:\Program Files\Graphviz2.24\bin
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   218
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   219
The PYTHONPATH variable should also contain::
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   220
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   221
  C:\Documents and Settings\Jane\My Documents\Python\cubicweb\
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   222
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   223
From now, on a fresh `cmd` shell, you should be able to type::
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   224
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   225
  cubicweb-ctl list
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   226
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   227
... and get a meaningful output.
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   228
4065
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   229
Running an instance as a service
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   230
--------------------------------
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   231
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   232
This currently assumes that the instances configurations is located
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   233
at C:\etc\cubicweb.d.
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   234
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   235
For a cube 'my_cube', you will then find C:\etc\cubicweb.d\my_cube\win32svc.py
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   236
that has to be used thusly::
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   237
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   238
  win32svc install
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   239
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   240
This should just register your instance as a windows service. A simple::
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   241
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   242
  net start cubicweb-my_cube
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   243
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   244
should start the service.
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   245
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   246
2539
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   247
PostgreSQL installation
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   248
```````````````````````
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   249
2539
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   250
Please refer to the `PostgreSQL project online documentation`_.
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   251
2539
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   252
.. _`PostgreSQL project online documentation`: http://www.postgresql.org/
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   253
2539
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   254
You need to install the three following packages: `postgresql-8.3`,
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   255
`postgresql-contrib-8.3` and `postgresql-plpython-8.3`.
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   256
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   257
2539
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   258
Other dependencies
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   259
``````````````````
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   260
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   261
You can also install:
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   262
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   263
* `pyro` if you wish the repository to be accessible through Pyro
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   264
  or if the client and the server are not running on the same machine
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   265
  (in which case the packages will have to be installed on both
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   266
  machines)
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   267
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   268
* `python-ldap` if you plan to use a LDAP source on the server
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   269
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   270
.. _ConfigurationEnv:
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   271
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   272
Environment configuration
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   273
-------------------------
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   274
2175
16d3c37c5d28 [doc] improvements
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2172
diff changeset
   275
If you installed *CubicWeb* by cloning the Mercurial forest, then you
2172
cf8f9180e63e delete-trailing-whitespace
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1714
diff changeset
   276
will need to update the environment variable PYTHONPATH by adding
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   277
the path to the forest ``cubicweb``:
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   278
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   279
Add the following lines to either `.bashrc` or `.bash_profile` to configure
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   280
your development environment ::
2172
cf8f9180e63e delete-trailing-whitespace
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1714
diff changeset
   281
2449
888d698af3f9 #344747: add env var CW_MODE
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2445
diff changeset
   282
    export PYTHONPATH=/full/path/to/cubicweb-forest
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   283
2449
888d698af3f9 #344747: add env var CW_MODE
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2445
diff changeset
   284
If you installed *CubicWeb* with packages, no configuration is required and your
2476
1294a6bdf3bf application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2458
diff changeset
   285
new cubes will be placed in `/usr/share/cubicweb/cubes` and your instances
2449
888d698af3f9 #344747: add env var CW_MODE
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2445
diff changeset
   286
will be placed in `/etc/cubicweb.d`.
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   287
2449
888d698af3f9 #344747: add env var CW_MODE
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2445
diff changeset
   288
You may run a system-wide install of *CubicWeb* in "user mode" and use it for
888d698af3f9 #344747: add env var CW_MODE
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2445
diff changeset
   289
development by setting the following environment variable::
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   290
2449
888d698af3f9 #344747: add env var CW_MODE
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2445
diff changeset
   291
    export CW_MODE=user
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   292
    export CW_CUBES_PATH=~/lib/cubes
2445
6f065b366d14 rename environment variables
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2420
diff changeset
   293
    export CW_INSTANCES_DIR=~/etc/cubicweb.d/
6f065b366d14 rename environment variables
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2420
diff changeset
   294
    export CW_INSTANCES_DATA_DIR=$CW_INSTANCES_DIR
6f065b366d14 rename environment variables
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2420
diff changeset
   295
    export CW_RUNTIME_DIR=/tmp
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   296
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   297
.. note::
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   298
    The values given above are our suggestions but of course
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   299
    can be different.
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   300
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   301
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   302
Databases configuration
1464
09afa1f808c4 [doc] Fix ReST pb.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1460
diff changeset
   303
-----------------------
09afa1f808c4 [doc] Fix ReST pb.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1460
diff changeset
   304
2539
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   305
.. _ConfigurationPostgresql:
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   306
2539
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   307
PostgreSQL configuration
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   308
````````````````````````
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   309
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   310
.. note::
2539
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   311
    If you already have an existing cluster and PostgreSQL server
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   312
    running, you do not need to execute the initilization step
2539
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   313
    of your PostgreSQL database.
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   314
2539
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   315
* First, initialize the database PostgreSQL with the command ``initdb``.
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   316
  ::
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   317
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   318
    $ initdb -D /path/to/pgsql
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   319
2539
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   320
  Once initialized, start the database server PostgreSQL
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   321
  with the command::
2172
cf8f9180e63e delete-trailing-whitespace
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1714
diff changeset
   322
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   323
    $ postgres -D /path/to/psql
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   324
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   325
  If you cannot execute this command due to permission issues, please
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   326
  make sure that your username has write access on the database.
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   327
  ::
2172
cf8f9180e63e delete-trailing-whitespace
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1714
diff changeset
   328
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   329
    $ chown username /path/to/pgsql
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   330
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   331
* The database authentication can be either set to `ident sameuser`
2172
cf8f9180e63e delete-trailing-whitespace
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1714
diff changeset
   332
  or `md5`.
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   333
  If set to `md5`, make sure to use an existing user
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   334
  of your database.
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   335
  If set to `ident sameuser`, make sure that your
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   336
  client's operating system user name has a matching user in
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   337
  the database. If not, please do as follow to create a user::
2172
cf8f9180e63e delete-trailing-whitespace
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1714
diff changeset
   338
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   339
    $ su
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   340
    $ su - postgres
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   341
    $ createuser -s -P username
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   342
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   343
  The option `-P` (for password prompt), will encrypt the password with
2172
cf8f9180e63e delete-trailing-whitespace
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1714
diff changeset
   344
  the method set in the configuration file ``pg_hba.conf``.
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   345
  If you do not use this option `-P`, then the default value will be null
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   346
  and you will need to set it with::
2172
cf8f9180e63e delete-trailing-whitespace
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1714
diff changeset
   347
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   348
    $ su postgres -c "echo ALTER USER username WITH PASSWORD 'userpasswd' | psql"
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   349
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   350
  This login/password will be requested when you will create an
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   351
  instance with `cubicweb-ctl create` to initialize the database of
2476
1294a6bdf3bf application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2458
diff changeset
   352
  your instance.
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   353
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   354
.. note::
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   355
    The authentication method can be configured in ``pg_hba.conf``.
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   356
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   357
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   358
.. FIXME Are these steps really necessary? It seemed to work without.
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   359
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   360
* Installation of plain-text index extension ::
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   361
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   362
    cat /usr/share/postgresql/8.3/contrib/tsearch2.sql | psql -U username template1
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   363
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   364
* Installation of plpythonu language by default ::
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   365
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   366
    createlang -U pgadmin plpythonu template1
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   367
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   368
MySql configuration
1464
09afa1f808c4 [doc] Fix ReST pb.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1460
diff changeset
   369
```````````````````
2536
88595be9087d [doc] #306434: say a word about optimization
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2476
diff changeset
   370
Yout must add the following lines in ``/etc/mysql/my.cnf`` file::
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   371
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   372
    transaction-isolation = READ-COMMITTED
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   373
    default-storage-engine=INNODB
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   374
    default-character-set=utf8
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   375
    max_allowed_packet = 128M
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   376
2536
88595be9087d [doc] #306434: say a word about optimization
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2476
diff changeset
   377
.. note::
88595be9087d [doc] #306434: say a word about optimization
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2476
diff changeset
   378
    It is unclear whether mysql supports indexed string of arbitrary lenght or
88595be9087d [doc] #306434: say a word about optimization
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2476
diff changeset
   379
    not.
88595be9087d [doc] #306434: say a word about optimization
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2476
diff changeset
   380
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   381
Pyro configuration
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   382
------------------
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   383
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   384
If you use Pyro, it is required to have a name server Pyro running on your
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   385
network (by default it is detected by a broadcast request).
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   386
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   387
To do so, you need to :
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   388
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   389
* launch the server manually before starting cubicweb as a server with
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   390
  `pyro-nsd start`
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   391
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   392
* edit the file ``/etc/default/pyro-nsd`` so that the name server pyro
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   393
  will be launched automatically when the machine fire up
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   394