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

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

5
6
Installation of a *CubicWeb* environment
========================================
Adrien Di Mascio's avatar
Adrien Di Mascio committed
7

Nicolas Chauvat's avatar
Nicolas Chauvat committed
8
9
10
11
12
13
Official releases are available from the `CubicWeb.org forge`_ and from
`PyPI`_. Since CubicWeb is developed using `Agile software development
<http://en.wikipedia.org/wiki/Agile_software_development>`_ techniques, releases
happen frequently. In a version numbered X.Y.Z, X changes after a few years when
the API breaks, Y changes after a few weeks when features are added and Z
changes after a few days when bugs are fixed.
14

Nicolas Chauvat's avatar
Nicolas Chauvat committed
15
16
Depending on your needs, you will chose a different way to install CubicWeb on
your system:
17

18
- `Installation using docker`_
Nicolas Chauvat's avatar
Nicolas Chauvat committed
19
20
21
22
23
- `Installation on Debian/Ubuntu`_
- `Installation in a virtualenv`_
- `Installation with pip`_
- `Installation with easy_install`_
- `Installation from tarball`_
24

Nicolas Chauvat's avatar
Nicolas Chauvat committed
25
If you are a power-user and need the very latest features, you will
26

Nicolas Chauvat's avatar
Nicolas Chauvat committed
27
- `Install from version control`_
28

Nicolas Chauvat's avatar
Nicolas Chauvat committed
29
Once the software is installed, move on to :ref:`ConfigEnv` for better control
30
31
32
and advanced features of |cubicweb|.

.. _`Installation on Debian/Ubuntu`: DebianInstallation_
Nicolas Chauvat's avatar
Nicolas Chauvat committed
33
.. _`Installation in a virtualenv`: VirtualenvInstallation_
34
35
36
.. _`Installation with pip`: PipInstallation_
.. _`Installation with easy_install`: EasyInstallInstallation_
.. _`Installation from tarball`: TarballInstallation_
Nicolas Chauvat's avatar
Nicolas Chauvat committed
37
.. _`Install from version control`: MercurialInstallation_
38

39

40
41
42
43
44
45
46
47
48
49
50
51
.. _DockerInstallation:

Docker install
--------------

Detailed instructions on how to deploy CubicWeb using docker can be found
on the `docker hub <https://hub.docker.com/r/logilab/cubicweb>`_.

The images there are built using the following source code :
`docker-cubicweb <https://hg.logilab.org/master/docker-cubicweb/>`_,
see it's `README <https://hg.logilab.org/master/docker-cubicweb/file/tip/README.rst>`_

52
53
.. _DebianInstallation:

54
55
56
57
Debian/Ubuntu install
---------------------

|cubicweb| is packaged for Debian/Ubuntu (and derived
Nicolas Chauvat's avatar
Nicolas Chauvat committed
58
59
60
distributions). Their integrated package-management system make
installation and upgrade much easier for users since
dependencies (like databases) are automatically installed.
61

62
Depending on the distribution you are using, add the appropriate line to your
63
64
`list of sources` (for example by editing ``/etc/apt/sources.list``), replacing
``<release>`` with e.g. ``wheezy`` or ``trusty``::
65

66
  deb http://download.logilab.org/production/ <release>/
67

68
The repositories are signed with `Logilab's gnupg key`_. You can download
69
and register the key to avoid warnings::
70

71
  wget -O/etc/apt/trusted.gpg.d/logilab.gpg https://www.logilab.fr/logilab-debian-keyring.gpg
72
73

Update your list of packages and perform the installation::
74

Nicolas Chauvat's avatar
Nicolas Chauvat committed
75
  apt-get update
76
  apt-get install python3-cubicweb --install-recommends
77

78
79
80
``python3-cubicweb`` installs the framework itself, allowing you to create new
instances. Installing recommended packages will install the development
environment allowing you to develop new cubes.
81

Nicolas Chauvat's avatar
Nicolas Chauvat committed
82
83
84
There is also a wide variety of :ref:`cubes <AvailableCubes>`. You can access a
list of available cubes using ``apt-cache search cubicweb`` or at the
`CubicWeb.org forge`_.
85

86
87
.. note::

88
  `python3-cubicweb` will install basic sqlite support. You can easily setup
Nicolas Chauvat's avatar
Nicolas Chauvat committed
89
90
  :ref:`cubicweb with other database <DatabaseInstallation>` using the following
  virtual packages :
91

92
  * `python3-cubicweb-postgresql-support` contains the necessary dependencies for
93
    using :ref:`cubicweb with postgresql datatabase <PostgresqlConfiguration>`
94

95
.. _`list of sources`: http://wiki.debian.org/SourcesList
96
.. _`Logilab's gnupg key`: https://www.logilab.fr/logilab-debian-keyring.gpg
97
98
.. _`CubicWeb.org Forge`: http://www.cubicweb.org/project/

99
.. _VirtualenvInstallation:
100

101
102
`Virtualenv` install
--------------------
103

104
105
106
107
|cubicweb| can be safely installed, used and contained inside a
`virtualenv`_. You can use either :ref:`pip <PipInstallation>` or
:ref:`easy_install <EasyInstallInstallation>` to install |cubicweb|
inside an activated virtual environment.
108

109
.. _PipInstallation:
110

111
112
`pip` install
-------------
113

114
115
116
117
`pip <http://pip.openplans.org/>`_ is a python tool that helps downloading,
building, installing, and managing Python packages and their dependencies. It
is fully compatible with `virtualenv`_ and installs the packages from sources
published on the `The Python Package Index`_.
Nicolas Chauvat's avatar
Nicolas Chauvat committed
118
119
120
121

.. _`virtualenv`: http://virtualenv.openplans.org/

A working compilation chain is needed to build the modules that include C
122
extensions. If you really do not want to compile anything, installing `lxml <http://lxml.de/>`_,
Denis Laxalde's avatar
Denis Laxalde committed
123
and `libgecode <http://www.gecode.org/>`_ will help.
124

125
126
127
128
129
130
131
132
133
For Debian, these minimal dependencies can be obtained by doing::

  apt-get install gcc python-pip python-dev python-lxml

or, if you prefer to get as much as possible from pip::

  apt-get install gcc python-pip python-dev libxslt1-dev libxml2-dev

For Windows, you can install pre-built packages (possible `source
134
135
136
137
138
139
140
141
<http://www.lfd.uci.edu/~gohlke/pythonlibs/>`_). For a minimal setup, install:

- pip http://www.lfd.uci.edu/~gohlke/pythonlibs/#pip
- setuptools http://www.lfd.uci.edu/~gohlke/pythonlibs/#setuptools
- libxml-python http://www.lfd.uci.edu/~gohlke/pythonlibs/#libxml-python>
- lxml http://www.lfd.uci.edu/~gohlke/pythonlibs/#lxml and

Make sure to choose the correct architecture and version of Python.
142
143

Finally, install |cubicweb| and its dependencies, by running::
144

145
146
  pip install cubicweb[pyramid]

Paul Tonelli's avatar
Paul Tonelli committed
147
Many other :ref:`cubes <AvailableCubes>` are available. A list is available at
Nicolas Chauvat's avatar
Nicolas Chauvat committed
148
149
`PyPI <http://pypi.python.org/pypi?%3Aaction=search&term=cubicweb&submit=search>`_
or at the `CubicWeb.org forge`_.
150

151
152
153
For example, installing the *blog cube* is achieved by::

  pip install cubicweb-blog
154
155
156

.. _EasyInstallInstallation:

157
158
`easy_install` install
----------------------
159

Nicolas Chauvat's avatar
Nicolas Chauvat committed
160
161
162
163
.. note::

   If you are not a Windows user and you have a compilation environment, we
   recommend you to use the PipInstallation_.
164

Nicolas Chauvat's avatar
Nicolas Chauvat committed
165
166
167
168
`easy_install`_ is a python utility that helps downloading, installing, and
managing python packages and their dependencies.

Install |cubicweb| and its dependencies, run::
169

170
  easy_install cubicweb
171

Nicolas Chauvat's avatar
Nicolas Chauvat committed
172
173
There is also a wide variety of :ref:`cubes <AvailableCubes>`. You can access a
list of available cubes on `PyPI
174
<http://pypi.python.org/pypi?%3Aaction=search&term=cubicweb&submit=search>`_
Nicolas Chauvat's avatar
Nicolas Chauvat committed
175
or at the `CubicWeb.org Forge`_.
176

177
For example, installing the *blog cube* is achieved by::
178

179
  easy_install cubicweb-blog
180

181
.. note::
182

183
  If you encounter problem with :ref:`cubes <AvailableCubes>` installation,
Nicolas Chauvat's avatar
Nicolas Chauvat committed
184
185
  consider using :ref:`PipInstallation` which is more stable
  but can not installed pre-compiled binaries.
186

Nicolas Chauvat's avatar
Nicolas Chauvat committed
187
.. _`easy_install`: http://packages.python.org/distribute/easy_install.html
188
189
190


.. _SourceInstallation:
191

192
Install from source
193
-------------------
194

195
196
.. _TarballInstallation:

Nicolas Chauvat's avatar
Nicolas Chauvat committed
197
You can download the archive containing the sources from
198
`http://download.logilab.org/pub/cubicweb/ <http://download.logilab.org/pub/cubicweb/>`_.
199

200
Make sure you also have all the :ref:`InstallDependencies`.
201

202
203
204
205
206
207
208
209
210
Once uncompressed, you can install the framework from inside the uncompressed
folder with::

  python setup.py install

Or you can run |cubicweb| directly from the source directory by
setting the :ref:`resource mode <RessourcesConfiguration>` to `user`. This will
ease the development with the framework.

Nicolas Chauvat's avatar
Nicolas Chauvat committed
211
There is also a wide variety of :ref:`cubes <AvailableCubes>`. You can access a
212
list of availble cubes at the `CubicWeb.org Forge`_.
213

214

215
.. _MercurialInstallation:
216

217
Install from version control system
218
-----------------------------------
219

Nicolas Chauvat's avatar
Nicolas Chauvat committed
220
221
To keep-up with on-going development, clone the :ref:`Mercurial
<MercurialPresentation>` repository::
222

223
  hg clone -u 'last(tag())' http://hg.logilab.org/cubicweb # stable version
Nicolas Chauvat's avatar
Nicolas Chauvat committed
224
  hg clone http://hg.logilab.org/cubicweb # development branch
225

Nicolas Chauvat's avatar
Nicolas Chauvat committed
226
Make sure you also have all the :ref:`InstallDependencies`.