doc/book/en/C011-installation.en.txt
author Stephanie Marcu <stephanie.marcu@logilab.fr>
Mon, 20 Apr 2009 10:50:36 +0200
changeset 1405 4233089f7fb2
parent 1209 4ec80ee57b19
child 1440 4fc48f2a1748
permissions -rw-r--r--
add mysql configuration section in cubicweb documentation
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
221
19125141f6eb [doc] Add internal link. Suppress content display which creates duplicated toc.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 152
diff changeset
     3
.. _CubicWebInstallation:
19125141f6eb [doc] Add internal link. Suppress content display which creates duplicated toc.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 152
diff changeset
     4
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     5
Installation
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     6
============
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     7
267
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
     8
Installation of `Cubicweb` and its dependencies
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
     9
-----------------------------------------------
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    10
267
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    11
`CubicWeb` is packaged for Debian and Ubuntu, but can be installed from source
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    12
using a tarball or the Mercurial version control system.
105
300166b41ea9 [doc] Moved installation from mercurial forest in appendix. Cleaned installation section but needs improvements.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 98
diff changeset
    13
152
b435d80d0c9e [doc] rewrite paragraph about installing debian and ubuntu packages
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 127
diff changeset
    14
Debian and Ubuntu packages
b435d80d0c9e [doc] rewrite paragraph about installing debian and ubuntu packages
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 127
diff changeset
    15
```````````````````````````
b435d80d0c9e [doc] rewrite paragraph about installing debian and ubuntu packages
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 127
diff changeset
    16
Depending on the distribution you are using, add the appropriate line to your list
267
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    17
of sources (for example by editing ``/etc/apt/sources.list``).
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    18
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    19
For Debian Lenny::
105
300166b41ea9 [doc] Moved installation from mercurial forest in appendix. Cleaned installation section but needs improvements.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 98
diff changeset
    20
300166b41ea9 [doc] Moved installation from mercurial forest in appendix. Cleaned installation section but needs improvements.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 98
diff changeset
    21
  deb http://ftp.logilab.org/dists/ lenny/
267
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    22
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    23
For Debian Sid::
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    24
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    25
  deb http://ftp.logilab.org/dists/ sid/
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    26
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    27
For Ubuntu Hardy::
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    28
105
300166b41ea9 [doc] Moved installation from mercurial forest in appendix. Cleaned installation section but needs improvements.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 98
diff changeset
    29
  deb http://ftp.logilab.org/dists/ hardy/
267
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    30
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    31
1209
4ec80ee57b19 [doc] Simplify punctation for blocks.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1203
diff changeset
    32
You can now install the required packages with the following command::
105
300166b41ea9 [doc] Moved installation from mercurial forest in appendix. Cleaned installation section but needs improvements.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 98
diff changeset
    33
269
6751132d3648 [doc] Add cubicweb-dev package to install.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 267
diff changeset
    34
  apt-get update 
6751132d3648 [doc] Add cubicweb-dev package to install.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 267
diff changeset
    35
  apt-get install cubicweb
6751132d3648 [doc] Add cubicweb-dev package to install.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 267
diff changeset
    36
  apt-get install cubicweb-dev
6751132d3648 [doc] Add cubicweb-dev package to install.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 267
diff changeset
    37
1209
4ec80ee57b19 [doc] Simplify punctation for blocks.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1203
diff changeset
    38
`cubicweb` installs the framework itself, allowing you to create
4ec80ee57b19 [doc] Simplify punctation for blocks.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1203
diff changeset
    39
new applications.
105
300166b41ea9 [doc] Moved installation from mercurial forest in appendix. Cleaned installation section but needs improvements.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 98
diff changeset
    40
1209
4ec80ee57b19 [doc] Simplify punctation for blocks.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1203
diff changeset
    41
`cubicweb-dev` installs the development environment allowing you to
4ec80ee57b19 [doc] Simplify punctation for blocks.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1203
diff changeset
    42
develop new cubes.
4ec80ee57b19 [doc] Simplify punctation for blocks.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1203
diff changeset
    43
4ec80ee57b19 [doc] Simplify punctation for blocks.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1203
diff changeset
    44
There is also a wide variety of cubes listed on http://www.cubicweb.org/Project available as debian packages and tarball.
4ec80ee57b19 [doc] Simplify punctation for blocks.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1203
diff changeset
    45
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    46
267
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    47
Install from source
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    48
```````````````````
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    49
1209
4ec80ee57b19 [doc] Simplify punctation for blocks.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1203
diff changeset
    50
You can download the archive containing the sources from our `ftp site`_ at::
105
300166b41ea9 [doc] Moved installation from mercurial forest in appendix. Cleaned installation section but needs improvements.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 98
diff changeset
    51
300166b41ea9 [doc] Moved installation from mercurial forest in appendix. Cleaned installation section but needs improvements.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 98
diff changeset
    52
  http://ftp.logilab.org/pub/cubicweb/
300166b41ea9 [doc] Moved installation from mercurial forest in appendix. Cleaned installation section but needs improvements.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 98
diff changeset
    53
267
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    54
.. _`ftp site`: http://ftp.logilab.org/pub/cubicweb/
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    55
267
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    56
or keep up to date with on-going development by using Mercurial and its forest
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    57
extension::
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    58
267
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    59
  hg fclone http://www.logilab.org/hg/forests/cubicweb
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    60
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    61
See :ref:`MercurialPresentation` for more details about Mercurial.
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    62
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    63
Postgres installation
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    64
`````````````````````
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    65
267
843e0b1bf991 [doc] simpler install and mercurial instructions
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 221
diff changeset
    66
Please refer to the `Postgresql project online documentation`_.
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    67
271
e150b92237d9 [doc] Add link to cubicweb's forge for cubes available.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 269
diff changeset
    68
.. _`Postgresql project online documentation`: http://www.postgresql.org/
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    69
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    70
You need to install the three following packages: `postgres-8.3`,
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    71
`postgres-contrib-8.3` and `postgresql-plpython-8.3`.
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    72
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    73
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    74
Then you can install:
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    75
564
8b48724d4c2b some doc typos
Emile Anclin <emile.anclin@logilab.fr>
parents: 271
diff changeset
    76
* `pyro` if you wish the repository to be accessible through Pyro
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    77
  or if the client and the server are not running on the same machine
564
8b48724d4c2b some doc typos
Emile Anclin <emile.anclin@logilab.fr>
parents: 271
diff changeset
    78
  (in which case the packages will have to be installed on both
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    79
  machines)
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    80
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    81
* `python-ldap` if you plan to use a LDAP source on the server
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    82
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    83
.. _ConfigurationEnv:
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    84
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    85
Environment configuration
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    86
-------------------------
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    87
271
e150b92237d9 [doc] Add link to cubicweb's forge for cubes available.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 269
diff changeset
    88
If you installed `CubicWeb` by cloning the Mercurial forest, then you
564
8b48724d4c2b some doc typos
Emile Anclin <emile.anclin@logilab.fr>
parents: 271
diff changeset
    89
will need to update the environment variable PYTHONPATH by adding  
8b48724d4c2b some doc typos
Emile Anclin <emile.anclin@logilab.fr>
parents: 271
diff changeset
    90
the path to the forest ``cubicweb``:
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    91
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    92
Add the following lines to either `.bashrc` or `.bash_profile` to configure
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
    93
your development environment ::
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    94
  
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    95
  export PYTHONPATH=/full/path/to/cubicweb-forest
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    96
271
e150b92237d9 [doc] Add link to cubicweb's forge for cubes available.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 269
diff changeset
    97
If you installed the debian packages, no configuration is required.
e150b92237d9 [doc] Add link to cubicweb's forge for cubes available.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 269
diff changeset
    98
Your new cubes will be placed in `/usr/share/cubicweb/cubes` and
e150b92237d9 [doc] Add link to cubicweb's forge for cubes available.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 269
diff changeset
    99
your applications will be placed in `/etc/cubicweb.d`.
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   100
1192
82375c14eb26 [doc] Add set-up of environment variables.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 564
diff changeset
   101
To use others directories then you will have to configure the
1209
4ec80ee57b19 [doc] Simplify punctation for blocks.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1203
diff changeset
   102
following environment variables as follows::
1192
82375c14eb26 [doc] Add set-up of environment variables.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 564
diff changeset
   103
82375c14eb26 [doc] Add set-up of environment variables.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 564
diff changeset
   104
    export CW_CUBES_PATH=~/lib/cubes
82375c14eb26 [doc] Add set-up of environment variables.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 564
diff changeset
   105
    export CW_REGISTRY=~/etc/cubicweb.d/
82375c14eb26 [doc] Add set-up of environment variables.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 564
diff changeset
   106
    export CW_INSTANCE_DATA=$CW_REGISTRY
82375c14eb26 [doc] Add set-up of environment variables.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 564
diff changeset
   107
    export CW_RUNTIME=/tmp
82375c14eb26 [doc] Add set-up of environment variables.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 564
diff changeset
   108
82375c14eb26 [doc] Add set-up of environment variables.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 564
diff changeset
   109
.. note::
82375c14eb26 [doc] Add set-up of environment variables.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 564
diff changeset
   110
    The values given above are our suggestions but of course
82375c14eb26 [doc] Add set-up of environment variables.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 564
diff changeset
   111
    can be different.
82375c14eb26 [doc] Add set-up of environment variables.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 564
diff changeset
   112
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   113
.. _ConfigurationPostgres:
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   114
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
   115
Postgres configuration
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   116
----------------------
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
   117
1193
24486ce4dea1 [doc] Improve a little bit postgres configuration and environment variables set-up. Needs to be finalized.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1192
diff changeset
   118
.. note::
24486ce4dea1 [doc] Improve a little bit postgres configuration and environment variables set-up. Needs to be finalized.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1192
diff changeset
   119
    If you already have an existing cluster and postgres server
1201
ef2715330b92 [doc] Adds information about database authentication.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1193
diff changeset
   120
    running, you do not require to execute the initilization step
1193
24486ce4dea1 [doc] Improve a little bit postgres configuration and environment variables set-up. Needs to be finalized.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1192
diff changeset
   121
    of your Postgres database.
24486ce4dea1 [doc] Improve a little bit postgres configuration and environment variables set-up. Needs to be finalized.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1192
diff changeset
   122
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
   123
* First you have to initialize the database Postgres with the command ``initdb``.
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   124
  ::
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   125
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   126
    $ initdb -D /path/to/pgsql
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   127
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
   128
  Once initialized, you can launch the database server Postgres 
1209
4ec80ee57b19 [doc] Simplify punctation for blocks.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1203
diff changeset
   129
  with the command::
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   130
  
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   131
    $ postgres -D /path/to/psql
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   132
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
   133
  If you cannot execute this command due to permission issues, please
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
   134
  make sure that your username has write access on the database.
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   135
  ::
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   136
 
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   137
    $ chown username /path/to/pgsql
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   138
1201
ef2715330b92 [doc] Adds information about database authentication.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1193
diff changeset
   139
* The database authentication can be either set to `ident sameuser`
ef2715330b92 [doc] Adds information about database authentication.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1193
diff changeset
   140
  or `md5`. 
ef2715330b92 [doc] Adds information about database authentication.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1193
diff changeset
   141
  If set to `md5`, make sure to use an existing user
ef2715330b92 [doc] Adds information about database authentication.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1193
diff changeset
   142
  of your database.
ef2715330b92 [doc] Adds information about database authentication.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1193
diff changeset
   143
  If set to `ident sameuser`, make sure that your
ef2715330b92 [doc] Adds information about database authentication.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1193
diff changeset
   144
  client's operating system user name has a matching user in
1209
4ec80ee57b19 [doc] Simplify punctation for blocks.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1203
diff changeset
   145
  the database. If not, please do as follow to create a user::
1193
24486ce4dea1 [doc] Improve a little bit postgres configuration and environment variables set-up. Needs to be finalized.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1192
diff changeset
   146
    
24486ce4dea1 [doc] Improve a little bit postgres configuration and environment variables set-up. Needs to be finalized.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1192
diff changeset
   147
    $ su
24486ce4dea1 [doc] Improve a little bit postgres configuration and environment variables set-up. Needs to be finalized.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1192
diff changeset
   148
    $ su - postgres
24486ce4dea1 [doc] Improve a little bit postgres configuration and environment variables set-up. Needs to be finalized.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1192
diff changeset
   149
    $ createuser -s username
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   150
1201
ef2715330b92 [doc] Adds information about database authentication.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1193
diff changeset
   151
  If created with the options -P (for password prompt, 
ef2715330b92 [doc] Adds information about database authentication.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1193
diff changeset
   152
  ``createuser -s -P username``), the password will be encrypted with
ef2715330b92 [doc] Adds information about database authentication.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1193
diff changeset
   153
  the method set in the configuration file ``pg_hba.conf``. 
ef2715330b92 [doc] Adds information about database authentication.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1193
diff changeset
   154
  If you do not use this option, then the default value will be null
ef2715330b92 [doc] Adds information about database authentication.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1193
diff changeset
   155
  and this require to set the password in the database itself.
ef2715330b92 [doc] Adds information about database authentication.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1193
diff changeset
   156
  To do so: ::
1193
24486ce4dea1 [doc] Improve a little bit postgres configuration and environment variables set-up. Needs to be finalized.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1192
diff changeset
   157
    
24486ce4dea1 [doc] Improve a little bit postgres configuration and environment variables set-up. Needs to be finalized.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1192
diff changeset
   158
    $ su 
24486ce4dea1 [doc] Improve a little bit postgres configuration and environment variables set-up. Needs to be finalized.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1192
diff changeset
   159
    $ su - postgres
24486ce4dea1 [doc] Improve a little bit postgres configuration and environment variables set-up. Needs to be finalized.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1192
diff changeset
   160
    $ psql
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   161
1209
4ec80ee57b19 [doc] Simplify punctation for blocks.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1203
diff changeset
   162
  And then execute de following query::
1193
24486ce4dea1 [doc] Improve a little bit postgres configuration and environment variables set-up. Needs to be finalized.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1192
diff changeset
   163
    
24486ce4dea1 [doc] Improve a little bit postgres configuration and environment variables set-up. Needs to be finalized.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1192
diff changeset
   164
    ALTER USER username WITH PASSWORD `password`
24486ce4dea1 [doc] Improve a little bit postgres configuration and environment variables set-up. Needs to be finalized.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1192
diff changeset
   165
24486ce4dea1 [doc] Improve a little bit postgres configuration and environment variables set-up. Needs to be finalized.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1192
diff changeset
   166
  This login/password will be requested when you will create an
24486ce4dea1 [doc] Improve a little bit postgres configuration and environment variables set-up. Needs to be finalized.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1192
diff changeset
   167
  instance with `cubicweb-ctl create` to initialize the database of
24486ce4dea1 [doc] Improve a little bit postgres configuration and environment variables set-up. Needs to be finalized.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1192
diff changeset
   168
  your application.
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   169
1201
ef2715330b92 [doc] Adds information about database authentication.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1193
diff changeset
   170
.. note::
ef2715330b92 [doc] Adds information about database authentication.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1193
diff changeset
   171
    The authentication method can be configured in ``pg_hba.conf``.
ef2715330b92 [doc] Adds information about database authentication.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1193
diff changeset
   172
1203
746b83d492bb [doc] merge trouble fixed
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1202
diff changeset
   173
746b83d492bb [doc] merge trouble fixed
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1202
diff changeset
   174
.. FIXME Are these steps really necessary? It seemed to work without.
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   175
1209
4ec80ee57b19 [doc] Simplify punctation for blocks.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1203
diff changeset
   176
* Installation of plain-text index extension ::
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   177
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
   178
    cat /usr/share/postgresql/8.3/contrib/tsearch2.sql | psql -U username template1
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   179
1209
4ec80ee57b19 [doc] Simplify punctation for blocks.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1203
diff changeset
   180
* Installation of plpythonu language by default ::
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   181
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   182
    createlang -U pgadmin plpythonu template1
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   183
1405
4233089f7fb2 add mysql configuration section in cubicweb documentation
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents: 1209
diff changeset
   184
MySql configuration
4233089f7fb2 add mysql configuration section in cubicweb documentation
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents: 1209
diff changeset
   185
-------------------
4233089f7fb2 add mysql configuration section in cubicweb documentation
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents: 1209
diff changeset
   186
Yout must add the following lines in /etc/mysql/my.cnf file::
4233089f7fb2 add mysql configuration section in cubicweb documentation
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents: 1209
diff changeset
   187
4233089f7fb2 add mysql configuration section in cubicweb documentation
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents: 1209
diff changeset
   188
    transaction-isolation = READ-COMMITTED
4233089f7fb2 add mysql configuration section in cubicweb documentation
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents: 1209
diff changeset
   189
    default-storage-engine=INNODB
4233089f7fb2 add mysql configuration section in cubicweb documentation
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents: 1209
diff changeset
   190
    default-character-set=utf8
4233089f7fb2 add mysql configuration section in cubicweb documentation
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents: 1209
diff changeset
   191
    max_allowed_packet = 128M
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   192
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
   193
Pyro configuration
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   194
------------------
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
   195
564
8b48724d4c2b some doc typos
Emile Anclin <emile.anclin@logilab.fr>
parents: 271
diff changeset
   196
If you use Pyro, it is required to have a name server Pyro running on your
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
   197
network (by default it is identified by a broadcast request).
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
   198
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
   199
To do so, you need to :
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   200
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
   201
* launch the server manually before starting cubicweb with `pyro-ns`
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   202
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
   203
* launch the server manually before starting cubicweb as a server with
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
   204
  `pyro-nsd start`
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   205
98
f756ead5746a [doc] Initial translation of first two section in installation chapter.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 93
diff changeset
   206
* edit the file ``/etc/default/pyro-nsd`` so that the name server pyro
564
8b48724d4c2b some doc typos
Emile Anclin <emile.anclin@logilab.fr>
parents: 271
diff changeset
   207
  will be launched automatically when the machine fire up
93
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   208
9c919a47e140 [doc] total file reorganisation - phase 1 complete
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
   209