doc/book/en/admin/setup.rst
author Sylvain Thénault <sylvain.thenault@logilab.fr>
Fri, 18 Feb 2011 09:33:32 +0100
branchstable
changeset 7014 7e3e80f4179a
parent 6880 4be32427b2b9
child 7099 ee9f1e1890e0
permissions -rw-r--r--
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
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
6880
4be32427b2b9 [book] fixes some references and other doc construction pbs
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6719
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
6718
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    11
|cubicweb| is packaged for `Debian and Ubuntu`_, is `pip installable`_ and
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    12
`easy_install installable`_. It can be installed from source using a tarball_
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    13
or the `Mercurial version control system`_ . Windows user may want to check the
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    14
`Windows Installation`_ section.
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    15
6719
3d2b6e6af721 [doc] minor fixes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6718
diff changeset
    16
Also, since version 3.9, can be safely installed, used and contained inside a
3d2b6e6af721 [doc] minor fixes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6718
diff changeset
    17
`virtualenv`_.
6718
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    18
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    19
6718
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    20
.. _`Debian and Ubuntu` : DebianInstallation_
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    21
.. _`pip installable`: PipInstallation_
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    22
.. _`easy_install installable`: EasyInstallInstallation_
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    23
.. _tarball: TarballInstallation_
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    24
.. _`Mercurial version control system`: MercurialInstallation_
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    25
.. _`Windows Installation`: WindowsInstallation_
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    26
.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    27
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    28
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    29
.. file:///home/pyves/tmp/cwdoc/html/admin/setup.html#pipinstallation
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
    30
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    31
.. _DebianInstallation:
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    32
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    33
Debian and Ubuntu packages
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
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
    36
Depending on the distribution you are using, add the appropriate line to your
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
    37
list of sources (for example by editing ``/etc/apt/sources.list``).
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    38
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    39
For Debian Lenny::
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    40
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    41
  deb http://ftp.logilab.org/dists/ lenny/
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
For Debian Sid::
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    44
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    45
  deb http://ftp.logilab.org/dists/ sid/
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    46
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    47
For Ubuntu Hardy::
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    48
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    49
  deb http://ftp.logilab.org/dists/ hardy/
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    50
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    51
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    52
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
    53
2172
cf8f9180e63e delete-trailing-whitespace
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1714
diff changeset
    54
  apt-get update
6719
3d2b6e6af721 [doc] minor fixes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6718
diff changeset
    55
  apt-get install cubicweb cubicweb-dev
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    56
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
    57
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
    58
`cubicweb` installs the framework itself, allowing you to create new instances.
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
    59
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
    60
`cubicweb-dev` installs the development environment allowing you to develop new
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
    61
cubes.
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    62
6716
494d4465f032 [doc/book] Add a note about <database>-support virtual package.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6310
diff changeset
    63
.. note::
494d4465f032 [doc/book] Add a note about <database>-support virtual package.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6310
diff changeset
    64
494d4465f032 [doc/book] Add a note about <database>-support virtual package.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6310
diff changeset
    65
   `cubicweb-dev` will install basic sqlite support. You can easily setup
6718
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    66
   `cubicweb with other database`_ using the following virtual packages :
6716
494d4465f032 [doc/book] Add a note about <database>-support virtual package.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6310
diff changeset
    67
   `cubicweb-postgresql-support` contains necessary dependency for using
494d4465f032 [doc/book] Add a note about <database>-support virtual package.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6310
diff changeset
    68
   `cubicweb with postgresql datatabase`_ and `cubicweb-mysql-support` contains
494d4465f032 [doc/book] Add a note about <database>-support virtual package.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6310
diff changeset
    69
   necessary dependency for using `cubicweb with mysql database`_ .
494d4465f032 [doc/book] Add a note about <database>-support virtual package.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6310
diff changeset
    70
6880
4be32427b2b9 [book] fixes some references and other doc construction pbs
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6719
diff changeset
    71
There is also a wide variety of :ref:`cubes <AvailableCubes>` listed on the
4be32427b2b9 [book] fixes some references and other doc construction pbs
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6719
diff changeset
    72
`CubicWeb.org Forge`_ available as debian packages and tarball.
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    73
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
    74
The repositories are signed with `Logilab's gnupg key`_. To avoid warning on
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
    75
"apt-get update":
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    76
2393
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2239
diff changeset
    77
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
    78
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
    79
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
    80
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
    81
2393
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2239
diff changeset
    82
.. _`Logilab's gnupg key`: http://ftp.logilab.org/dists/logilab-dists-key.asc
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
    83
.. _`CubicWeb.org Forge`: http://www.cubicweb.org/project/
6716
494d4465f032 [doc/book] Add a note about <database>-support virtual package.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6310
diff changeset
    84
.. _`cubicweb with other database`: DatabaseInstallation_
494d4465f032 [doc/book] Add a note about <database>-support virtual package.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6310
diff changeset
    85
.. _`cubicweb with postgresql datatabase` : PostgresqlConfiguration_
494d4465f032 [doc/book] Add a note about <database>-support virtual package.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6310
diff changeset
    86
.. _`cubicweb with mysql database` : MySqlConfiguration_
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
    87
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
    88
6192
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
    89
.. _PipInstallation:
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
    90
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
    91
Installation with pip
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
    92
`````````````````````
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
    93
6718
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    94
pip_ is a smart python utility that lets you automatically download, build,
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    95
install, and manage python packages and their dependencies.
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    96
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
    97
|cubicweb| and its cubes have been pip_ installable since version 3.9. Search
6192
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
    98
for them on pypi_::
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
    99
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   100
  pip install cubicweb
6718
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   101
  pip install cubicweb-blog
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   102
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   103
.. note::
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   104
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   105
    Pip is the recommended way to install |cubicweb| if there is no binary
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   106
    package available on your system or you want to install it inside a
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   107
    `virtualenv`_. However pip doesn't install binary package and may require
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   108
    several compilation steps while installing |cubicweb| dependencies. If you
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   109
    don't have a compilation environment you should use  `easy_install
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   110
    installation`_ to install |cubicweb|.
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   111
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   112
    Once, |cubicweb| is installed, this limitation doesn't apply when installing
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   113
    cubes.
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   114
6192
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   115
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   116
.. _pip: http://pypi.python.org/pypi/pip
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   117
.. _pypi: http://pypi.python.org/pypi?%3Aaction=search&term=cubicweb
6718
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   118
.. _`easy_install installation`: EasyInstallInstallation_
6192
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   119
4431
e597e0ca67cd Updated CW tutorial.
Adrien Chauve <adrien.chauve@logilab.fr>
parents: 4065
diff changeset
   120
6310
554da7585fba [doc/book] more notes on setup
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6305
diff changeset
   121
.. warning::
554da7585fba [doc/book] more notes on setup
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6305
diff changeset
   122
6718
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   123
  |cubicweb| depends upon the `lxml` python module. This module contains ``C``
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   124
  code that must be compiled.  To successfully install |cubicweb| with pip, you
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   125
  must either have an environment ables to compile Python ``C`` extensions or
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   126
  preinstall lxml from a binary package.
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   127
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   128
.. note::
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   129
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   130
  For better performance the setup processor will compile a ``C`` extension for
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   131
  the :ref:`RQL <RQL>` language if you have an environment ables to compile
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   132
  Python ``C`` extensions and the `gecode library`_.  Otherwise, a pure python
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   133
  alternative will be used for degraded performance.
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   134
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   135
.. _`gecode library`: http://www.gecode.org/
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   136
.. _`easy_install`:   http://packages.python.org/distribute/easy_install.html
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   137
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   138
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   139
.. _EasyInstallInstallation:
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   140
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   141
Installation with EasyInstall
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   142
``````````````````````````````
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   143
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   144
.. note::
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   145
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   146
    We don't recommend the use of `easy_install` and setuptools in the generic
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   147
    case. However as easy_install is currently the sole pure python package
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   148
    system that support binary installation. Using `easy_install` is currently
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   149
    the easiest way to install |cubicweb| when you don't have a compilation
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   150
    environment set-up or Debian based distribution.
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   151
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   152
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   153
|cubicweb| is easy_install_ installable for version 3.9::
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   154
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   155
  easy_install cubicweb
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   156
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   157
.. warning::
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   158
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   159
    Cubes are **not** is easy_install_ installable. But they are
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   160
    `pip installable`_
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   161
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   162
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   163
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   164
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   165
.. _SourceInstallation:
6310
554da7585fba [doc/book] more notes on setup
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6305
diff changeset
   166
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   167
Install from source
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   168
```````````````````
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   169
6718
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   170
.. _TarballInstallation:
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   171
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   172
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
   173
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   174
  http://ftp.logilab.org/pub/cubicweb/
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   175
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   176
.. _`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
   177
6212
73565b770559 [doc] fix link to appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 6192
diff changeset
   178
Make sure you also have all the :ref:`InstallDependencies`.
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   179
6192
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   180
.. _MercurialInstallation:
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   181
3488
ab9e7bcfc764 [doc] add missing dependencies in annexes. explain more precisely source install.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 3138
diff changeset
   182
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
   183
```````````````````````````````````
ab9e7bcfc764 [doc] add missing dependencies in annexes. explain more precisely source install.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 3138
diff changeset
   184
6304
228921b064c3 [doc,bin] add script to fetch & update most cw dependencies + some cubes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6300
diff changeset
   185
You can keep up to date with on-going development by using Mercurial::
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   186
6717
a81cf7e7ffa2 [doc/book] Update cubicweb repository url
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6716
diff changeset
   187
  hg clone http://hg.logilab.org/cubicweb
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   188
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   189
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
   190
6304
228921b064c3 [doc,bin] add script to fetch & update most cw dependencies + some cubes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6300
diff changeset
   191
A practical way to get many of CubicWeb's dependencies and a nice set
228921b064c3 [doc,bin] add script to fetch & update most cw dependencies + some cubes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6300
diff changeset
   192
of base cubes is to run the `clone_deps.py` script located in
228921b064c3 [doc,bin] add script to fetch & update most cw dependencies + some cubes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6300
diff changeset
   193
`cubicweb/bin/`::
228921b064c3 [doc,bin] add script to fetch & update most cw dependencies + some cubes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6300
diff changeset
   194
228921b064c3 [doc,bin] add script to fetch & update most cw dependencies + some cubes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6300
diff changeset
   195
  python cubicweb/bin/clone_deps.py
228921b064c3 [doc,bin] add script to fetch & update most cw dependencies + some cubes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6300
diff changeset
   196
228921b064c3 [doc,bin] add script to fetch & update most cw dependencies + some cubes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6300
diff changeset
   197
(Windows users should replace slashes with antislashes).
228921b064c3 [doc,bin] add script to fetch & update most cw dependencies + some cubes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6300
diff changeset
   198
228921b064c3 [doc,bin] add script to fetch & update most cw dependencies + some cubes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6300
diff changeset
   199
This script will clone a set of mercurial repositories into in the
228921b064c3 [doc,bin] add script to fetch & update most cw dependencies + some cubes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6300
diff changeset
   200
directory containing the CubicWeb repository, and update them to the
228921b064c3 [doc,bin] add script to fetch & update most cw dependencies + some cubes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6300
diff changeset
   201
latest published version tag (if any).
228921b064c3 [doc,bin] add script to fetch & update most cw dependencies + some cubes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6300
diff changeset
   202
2420
46c83be959b7 a note about branches
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2239
diff changeset
   203
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
   204
(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
   205
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
   206
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
   207
6310
554da7585fba [doc/book] more notes on setup
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6305
diff changeset
   208
Even better, `hg tags` will display a list of tags in reverse
554da7585fba [doc/book] more notes on setup
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6305
diff changeset
   209
chronological order. One reasonnable way to get to a working version
554da7585fba [doc/book] more notes on setup
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6305
diff changeset
   210
is to pick the latest published version (as done by the `clone_deps`
554da7585fba [doc/book] more notes on setup
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6305
diff changeset
   211
script). These look like `cubicweb-debian-version-3.9.7-1`. Typing::
554da7585fba [doc/book] more notes on setup
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6305
diff changeset
   212
554da7585fba [doc/book] more notes on setup
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6305
diff changeset
   213
 hg update cubicweb-debian-version-3.9.7-1
554da7585fba [doc/book] more notes on setup
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6305
diff changeset
   214
554da7585fba [doc/book] more notes on setup
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6305
diff changeset
   215
will update the repository files to this version.
554da7585fba [doc/book] more notes on setup
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6305
diff changeset
   216
6212
73565b770559 [doc] fix link to appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 6192
diff changeset
   217
Make sure you also have all the :ref:`InstallDependencies`.
2393
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2239
diff changeset
   218
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   219
4431
e597e0ca67cd Updated CW tutorial.
Adrien Chauve <adrien.chauve@logilab.fr>
parents: 4065
diff changeset
   220
.. _WindowsInstallation:
e597e0ca67cd Updated CW tutorial.
Adrien Chauve <adrien.chauve@logilab.fr>
parents: 4065
diff changeset
   221
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   222
Windows installation
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   223
````````````````````
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   224
6192
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   225
Your best option is probably the :ref:`PipInstallation`. If it does not work or
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   226
if you want more control over the process, continue with the following
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   227
instructions.
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   228
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   229
Base elements
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   230
~~~~~~~~~~~~~
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   231
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   232
Setting up a windows development environment is not too complicated but requires
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   233
a series of small steps. What is proposed there is only an example of what can be
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   234
done. We assume everything goes into `C:\\` in this document. Adjusting the
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   235
installation drive should be straightforward.
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   236
6192
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   237
You should start by downloading and installing Python version >= 2.5 and < 3.
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   238
6192
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   239
An alternative option would be installing the Python(x,y)
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   240
distribution. Python(x,y) is not a requirement, but it makes things easier for
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   241
Windows user by wrapping in a single installer python 2.5 plus numerous useful
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   242
third-party modules and applications (including Eclipse + pydev, which is an
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   243
arguably good IDE for Python under Windows). Download it from this page::
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   244
6192
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   245
  http://code.google.com/p/pythonxy/wiki/Downloads
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   246
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   247
Then you must grab Twisted. There is a windows installer directly available from
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   248
this page::
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   249
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   250
  http://twistedmatrix.com/trac/
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   251
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   252
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
   253
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   254
  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
   255
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   256
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
   257
releases should probably work, too.
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   258
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   259
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
   260
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   261
  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
   262
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   263
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
   264
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   265
  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
   266
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   267
Please be careful to select the right python (2.5) and postgres (8.4) versions.
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   268
5256
3f95d10fef94 [doc/book] reorg. a bit the top-level toc, complete the windows setup part
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5135
diff changeset
   269
A windows compiled recent version of gettext::
3f95d10fef94 [doc/book] reorg. a bit the top-level toc, complete the windows setup part
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5135
diff changeset
   270
3f95d10fef94 [doc/book] reorg. a bit the top-level toc, complete the windows setup part
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5135
diff changeset
   271
  http://ftp.logilab.org/pub/gettext/gettext-0.17-win32-setup.exe
3f95d10fef94 [doc/book] reorg. a bit the top-level toc, complete the windows setup part
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5135
diff changeset
   272
3f95d10fef94 [doc/book] reorg. a bit the top-level toc, complete the windows setup part
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5135
diff changeset
   273
A pre-compiled version of rql for windows (take care of retrieving the
3f95d10fef94 [doc/book] reorg. a bit the top-level toc, complete the windows setup part
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5135
diff changeset
   274
most recent version available there)::
3f95d10fef94 [doc/book] reorg. a bit the top-level toc, complete the windows setup part
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5135
diff changeset
   275
3f95d10fef94 [doc/book] reorg. a bit the top-level toc, complete the windows setup part
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5135
diff changeset
   276
  http://ftp.logilab.org/pub/rql/rql-0.23.0.win32-py2.5.exe
3f95d10fef94 [doc/book] reorg. a bit the top-level toc, complete the windows setup part
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 5135
diff changeset
   277
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   278
Pyro enables remote access to cubicweb repository instances. Get it there::
3138
b33eb9e91262 add pyro
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3132
diff changeset
   279
b33eb9e91262 add pyro
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3132
diff changeset
   280
  http://sourceforge.net/projects/pyro/files/
b33eb9e91262 add pyro
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3132
diff changeset
   281
3132
cb310b97424e python-ldap, also win32 binary version of simplejson
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3121
diff changeset
   282
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
   283
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
   284
cb310b97424e python-ldap, also win32 binary version of simplejson
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3121
diff changeset
   285
  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
   286
cb310b97424e python-ldap, also win32 binary version of simplejson
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3121
diff changeset
   287
Check out the latest release.
cb310b97424e python-ldap, also win32 binary version of simplejson
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3121
diff changeset
   288
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   289
Having graphviz will allow schema drawings, which is quite recommended (albeit
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   290
not mandatory). You should get an msi installer there::
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   291
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   292
  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
   293
6192
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   294
Simplejson is needed when installing with Python 2.5, but included in the
6304
228921b064c3 [doc,bin] add script to fetch & update most cw dependencies + some cubes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6300
diff changeset
   295
standard library for Python >= 2.6. Get it from there::
3132
cb310b97424e python-ldap, also win32 binary version of simplejson
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3121
diff changeset
   296
cb310b97424e python-ldap, also win32 binary version of simplejson
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3121
diff changeset
   297
  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
   298
6212
73565b770559 [doc] fix link to appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 6192
diff changeset
   299
Make sure you also have all the :ref:`InstallDependencies` that are not specific
73565b770559 [doc] fix link to appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 6192
diff changeset
   300
to Windows.
73565b770559 [doc] fix link to appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 6192
diff changeset
   301
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   302
Tools
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   303
~~~~~
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   304
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   305
Get mercurial + its standard windows GUI (TortoiseHG) there (the latest is the
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   306
greatest)::
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   307
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   308
  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
   309
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   310
If you need to peruse mercurial over ssh, it can be helpful to get an ssh client
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   311
like Putty::
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   312
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   313
  http://www.putty.org/
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   314
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   315
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
   316
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
   317
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   318
  http://www.vectrace.com/mercurialeclipse/
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   319
6192
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   320
Getting the sources
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   321
~~~~~~~~~~~~~~~~~~~
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   322
6304
228921b064c3 [doc,bin] add script to fetch & update most cw dependencies + some cubes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6300
diff changeset
   323
You can either download the latest release (see
228921b064c3 [doc,bin] add script to fetch & update most cw dependencies + some cubes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6300
diff changeset
   324
:ref:`SourceInstallation`) or get the development version using
228921b064c3 [doc,bin] add script to fetch & update most cw dependencies + some cubes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6300
diff changeset
   325
Mercurial (see :ref:`MercurialInstallation` and below), which is more
228921b064c3 [doc,bin] add script to fetch & update most cw dependencies + some cubes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6300
diff changeset
   326
convenient.
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   327
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   328
Environment variables
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   329
~~~~~~~~~~~~~~~~~~~~~
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   330
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   331
You will need some convenience environment variables once all is set up. These
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   332
variables are settable through the GUI by getting at the 'System properties'
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   333
window (by righ-clicking on 'My Computer' -> properties).
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   334
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   335
In the 'advanced' tab, there is an 'Environment variables' button. Click on
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   336
it. That opens a small window allowing edition of user-related and system-wide
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   337
variables.
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   338
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   339
We will consider only user variables. First, the PATH variable. You should ensure
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   340
it contains, separated by semi-colons, and assuming you are logged in as user
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   341
Jane::
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   342
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   343
  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
   344
  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
   345
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   346
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
   347
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   348
  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
   349
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   350
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
   351
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   352
  cubicweb-ctl list
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   353
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   354
... and get a meaningful output.
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   355
4065
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   356
Running an instance as a service
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   357
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4065
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   358
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   359
This currently assumes that the instances configurations is located at
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   360
C:\\etc\\cubicweb.d.
4065
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   361
6192
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   362
For a cube 'my_instance', you will then find
6305
3a87eaf226f6 [doc] fixing install doc (reapply cset that was erroneously overriden)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 6304
diff changeset
   363
C:\\etc\\cubicweb.d\\my_instance\\win32svc.py that has to be used as follows::
4065
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   364
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   365
  win32svc install
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   366
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   367
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
   368
6192
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   369
  net start cubicweb-my_instance
4065
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   370
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   371
should start the service.
6e8da644d996 explain how to run as a windows service
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 3740
diff changeset
   372
3121
dbc02844d412 sections to help building a window dev environment
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2539
diff changeset
   373
2539
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   374
Other dependencies
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   375
``````````````````
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   376
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   377
You can also install:
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   378
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   379
* `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
   380
  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
   381
  (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
   382
  machines)
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
* `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
   385
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   386
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   387
.. _DatabaseInstallation:
1460
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
Databases configuration
1464
09afa1f808c4 [doc] Fix ReST pb.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1460
diff changeset
   390
-----------------------
09afa1f808c4 [doc] Fix ReST pb.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1460
diff changeset
   391
6305
3a87eaf226f6 [doc] fixing install doc (reapply cset that was erroneously overriden)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 6304
diff changeset
   392
Each instance can be configured with its own database connection information,
3a87eaf226f6 [doc] fixing install doc (reapply cset that was erroneously overriden)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 6304
diff changeset
   393
that will be stored in the instance's :file:`sources` file. The database to use
3a87eaf226f6 [doc] fixing install doc (reapply cset that was erroneously overriden)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 6304
diff changeset
   394
will be chosen when creating the instance. Currently cubicweb has been tested
3a87eaf226f6 [doc] fixing install doc (reapply cset that was erroneously overriden)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 6304
diff changeset
   395
using Postgresql (recommended), MySQL, SQLServer and SQLite.
6192
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   396
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   397
Other possible sources of data include CubicWeb, Subversion, LDAP and Mercurial,
6305
3a87eaf226f6 [doc] fixing install doc (reapply cset that was erroneously overriden)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 6304
diff changeset
   398
but at least one relational database is required for CubicWeb to work. You do
3a87eaf226f6 [doc] fixing install doc (reapply cset that was erroneously overriden)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 6304
diff changeset
   399
not need to install a backend that you do not intend to use for one of your
3a87eaf226f6 [doc] fixing install doc (reapply cset that was erroneously overriden)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 6304
diff changeset
   400
instances. SQLite is not fit for production use, but it works well for testing
3a87eaf226f6 [doc] fixing install doc (reapply cset that was erroneously overriden)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 6304
diff changeset
   401
and ships with Python, which saves installation time when you want to get
3a87eaf226f6 [doc] fixing install doc (reapply cset that was erroneously overriden)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 6304
diff changeset
   402
started quickly.
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   403
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   404
.. _PostgresqlConfiguration:
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   405
2539
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   406
PostgreSQL configuration
0f26a76b0348 [doc] some more rewriting
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2536
diff changeset
   407
````````````````````````
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   408
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   409
For installation, please refer to the `PostgreSQL project online documentation`_.
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   410
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   411
.. _`PostgreSQL project online documentation`: http://www.postgresql.org/
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   412
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   413
You need to install the three following packages: `postgresql-8.X`,
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   414
`postgresql-client-8.X`, and `postgresql-plpython-8.X`. If you run postgres
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   415
version prior to 8.3, you'll also need the `postgresql-contrib-8.X` package for
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   416
full-text search extension.
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   417
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   418
If you run postgres on another host than the |cubicweb| repository, you should
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   419
install the `postgresql-client` package on the |cubicweb| host, and others on the
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   420
database host.
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   421
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   422
.. Note::
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   423
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   424
    If you already have an existing cluster and PostgreSQL server running, you do
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   425
    not need to execute the initilization step of your PostgreSQL database unless
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   426
    you want a specific cluster for |cubicweb| databases or if your existing
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   427
    cluster doesn't use the UTF8 encoding (see note below).
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   428
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   429
* First, initialize a PostgreSQL cluster with the command ``initdb``.
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   430
  ::
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   431
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   432
    $ initdb -E UTF8 -D /path/to/pgsql
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   433
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   434
  Notice the encoding specification. This is necessary since |cubicweb| usually
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   435
  want UTF8 encoded database. If you use a cluster with the wrong encoding, you'll
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   436
  get error like::
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   437
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   438
    new encoding (UTF8) is incompatible with the encoding of the template database (SQL_ASCII)
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   439
    HINT:  Use the same encoding as in the template database, or use template0 as template.
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   440
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   441
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   442
  Once initialized, start the database server PostgreSQL with the command::
2172
cf8f9180e63e delete-trailing-whitespace
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1714
diff changeset
   443
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   444
    $ postgres -D /path/to/psql
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   445
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   446
  If you cannot execute this command due to permission issues, please make sure
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   447
  that your username has write access on the database.  ::
2172
cf8f9180e63e delete-trailing-whitespace
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1714
diff changeset
   448
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   449
    $ chown username /path/to/pgsql
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   450
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   451
* The database authentication can be either set to `ident sameuser` or `md5`.  If
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   452
  set to `md5`, make sure to use an existing user of your database.  If set to
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   453
  `ident sameuser`, make sure that your client's operating system user name has a
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   454
  matching user in 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
   455
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   456
    $ su
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   457
    $ su - postgres
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   458
    $ createuser -s -P username
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   459
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   460
  The option `-P` (for password prompt), will encrypt the password with the
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   461
  method set in the configuration file :file:`pg_hba.conf`.  If you do not use this
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   462
  option `-P`, then the default value will be null and you will need to set it
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   463
  with::
2172
cf8f9180e63e delete-trailing-whitespace
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1714
diff changeset
   464
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   465
    $ 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
   466
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   467
.. Note::
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   468
    The authentication method can be configured in file:`pg_hba.conf`.
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   469
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   470
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   471
The above login/password will be requested when you will create an instance with
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   472
`cubicweb-ctl create` to initialize the database of your instance.
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   473
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   474
Notice that the `cubicweb-ctl db-create` does database initialization that
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   475
may requires a postgres superuser. That's why a login/password is explicitly asked
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   476
at this step, so you can use there a superuser without using this user when running
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   477
the instance. Things that require special privileges at this step:
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   478
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   479
* database creation, require the 'create database' permission
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   480
* install the plpython extension language (require superuser)
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   481
* install the tsearch extension for postgres version prior to 8.3 (require superuser)
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   482
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   483
To avoid using a super user each time you create an install, a nice trick is to
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   484
install plpython (and tsearch when needed) on the special `template1` database,
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   485
so they will be installed automatically when cubicweb databases are created
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   486
without even with needs for special access rights. To do so, run ::
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   487
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   488
  # Installation of plpythonu language by default ::
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   489
  $ createlang -U pgadmin plpythonu template1
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   490
  $ psql -U pgadmin template1
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   491
  template1=# update pg_language set lanpltrusted=TRUE where lanname='plpythonu';
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   492
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   493
Where `pgadmin` is a postgres superuser. The last command is necessary since by
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   494
default plpython is an 'untrusted' language and as such can't be used by non
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   495
superuser. This update fix that problem by making it trusted.
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   496
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   497
To install the tsearch plain-text index extension on postgres prior to 8.3, run::
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   498
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   499
    cat /usr/share/postgresql/8.X/contrib/tsearch2.sql | psql -U username template1
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   500
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   501
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   502
.. _MySqlConfiguration:
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   503
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   504
MySql configuration
1464
09afa1f808c4 [doc] Fix ReST pb.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1460
diff changeset
   505
```````````````````
6718
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   506
You 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
   507
4747
516e971f10ea [book/admin/setup] notes about configuration of sql server
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4746
diff changeset
   508
    transaction-isolation=READ-COMMITTED
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   509
    default-storage-engine=INNODB
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   510
    default-character-set=utf8
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   511
    max_allowed_packet = 128M
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   512
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   513
.. Note::
6192
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   514
    It is unclear whether mysql supports indexed string of arbitrary length or
2536
88595be9087d [doc] #306434: say a word about optimization
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2476
diff changeset
   515
    not.
88595be9087d [doc] #306434: say a word about optimization
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2476
diff changeset
   516
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   517
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   518
.. _SQLServerConfiguration:
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   519
4747
516e971f10ea [book/admin/setup] notes about configuration of sql server
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4746
diff changeset
   520
SQLServer configuration
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   521
```````````````````````
4747
516e971f10ea [book/admin/setup] notes about configuration of sql server
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4746
diff changeset
   522
6192
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   523
As of this writing, support for SQLServer 2005 is functional but incomplete. You
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   524
should be able to connect, create a database and go quite far, but some of the
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   525
SQL generated from RQL queries is still currently not accepted by the
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   526
backend. Porting to SQLServer 2008 is also an item on the backlog.
4747
516e971f10ea [book/admin/setup] notes about configuration of sql server
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4746
diff changeset
   527
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   528
The `source` configuration file may look like this (specific parts only are
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   529
shown)::
4747
516e971f10ea [book/admin/setup] notes about configuration of sql server
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4746
diff changeset
   530
516e971f10ea [book/admin/setup] notes about configuration of sql server
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4746
diff changeset
   531
  [system]
516e971f10ea [book/admin/setup] notes about configuration of sql server
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4746
diff changeset
   532
  db-driver=sqlserver2005
516e971f10ea [book/admin/setup] notes about configuration of sql server
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4746
diff changeset
   533
  db-user=someuser
516e971f10ea [book/admin/setup] notes about configuration of sql server
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4746
diff changeset
   534
  # database password not needed
516e971f10ea [book/admin/setup] notes about configuration of sql server
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4746
diff changeset
   535
  #db-password=toto123
516e971f10ea [book/admin/setup] notes about configuration of sql server
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4746
diff changeset
   536
  #db-create/init may ask for a pwd: just say anything
516e971f10ea [book/admin/setup] notes about configuration of sql server
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4746
diff changeset
   537
  db-extra-arguments=Trusted_Connection
516e971f10ea [book/admin/setup] notes about configuration of sql server
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4746
diff changeset
   538
  db-encoding=utf8
516e971f10ea [book/admin/setup] notes about configuration of sql server
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4746
diff changeset
   539
516e971f10ea [book/admin/setup] notes about configuration of sql server
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 4746
diff changeset
   540
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   541
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   542
.. _SQLiteConfiguration:
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   543
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   544
SQLite configuration
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   545
````````````````````
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   546
SQLite has the great advantage of requiring almost no configuration. Simply
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   547
use 'sqlite' as db-driver, and set path to the dabase as db-name. Don't specify
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   548
anything for db-user and db-password, they will be ignore anyway.
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   549
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   550
.. Note::
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   551
  SQLite is great for testing and to play with cubicweb but is not suited for
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   552
  production environments.
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   553
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   554
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   555
.. _PyroConfiguration:
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   556
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   557
Pyro configuration
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   558
------------------
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   559
6718
b741578ce7c9 [doc/book] Improve installation doc mostly about pip ans easy_install
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 6717
diff changeset
   560
If you want to use Pyro to access your instance remotely, or to have multi-source
6192
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   561
or distributed configuration, it is required to have a Pyro name server running
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   562
on your network. By default it is detected by a broadcast request, but you can
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   563
specify a location in the instance's configuration file.
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   564
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   565
To do so, you need to :
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   566
6192
80388edf4e88 [doc] improve doc thanks to user feedback
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5314
diff changeset
   567
* launch the pyro name server with `pyro-nsd start` before starting cubicweb
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   568
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   569
* under debian, edit the file :file:`/etc/default/pyro-nsd` so that the name
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   570
  server pyro will be launched automatically when the machine fire up
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   571
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   572
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   573
Cubicweb resources configuration
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   574
--------------------------------
1460
6520efef1824 [doc] C011 content moved to C010
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents: 1444
diff changeset
   575
5135
f15286235aef [doc] enhanced setup section: fix sections'level, more postgres tips, merge environment doc with cwconfig.py module docstring using custom autodocstring directive
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4747
diff changeset
   576
.. autodocstring:: cubicweb.cwconfig