.. -*- coding: utf-8 -*-

.. _SetUpEnv:

Installation of a *CubicWeb* environment

========================================

and advanced features of |cubicweb|.

.. _`Installation on Debian/Ubuntu`: DebianInstallation_

.. _`Installation on Windows`: WindowsInstallation_

.. _`Installation with pip`: PipInstallation_

.. _`Installation with easy_install`: EasyInstallInstallation_

.. _`Installation from tarball`: TarballInstallation_

.. _DebianInstallation:

Debian/Ubuntu install

---------------------

|cubicweb| is packaged for Debian/Ubuntu (and derived

Depending on the distribution you are using, add the appropriate line to your

`list of sources` (for example by editing ``/etc/apt/sources.list``).

For Debian Squeeze (stable)::

  deb http://download.logilab.org/production/ squeeze/

For Debian Sid (unstable)::

  deb http://download.logilab.org/production/ sid/

For Ubuntu Lucid (Long Term Support) and newer::

  deb http://download.logilab.org/production/ lucid/

  Note that for Ubuntu Maverick and newer, you shall use the `lucid`

  repository and install the ``libgecode19`` package from `lucid

  universe <http://packages.ubuntu.com/lucid/libgecode19>`_.

The repositories are signed with the `Logilab's gnupg key`_. You can download

and register the key to avoid warnings::

  wget -q http://download.logilab.org/logilab-dists-key.asc -O- | sudo apt-key add -

Update your list of packages and perform the installation::

  apt-get update

  apt-get install cubicweb cubicweb-dev

``cubicweb`` installs the framework itself, allowing you to create new

instances. ``cubicweb-dev`` installs the development environment

allowing you to develop new cubes.

.. note::

  `cubicweb-dev` will install basic sqlite support. You can easily setup

    using :ref:`cubicweb with postgresql datatabase <PostgresqlConfiguration>`

    :ref:`cubicweb with mysql database <MySqlConfiguration>`.

.. _`list of sources`: http://wiki.debian.org/SourcesList

.. _`Logilab's gnupg key`: http://download.logilab.org/logilab-dists-key.asc

.. _`CubicWeb.org Forge`: http://www.cubicweb.org/project/

.. _WindowsInstallation:

Windows Install

---------------

You need to have `python`_ version >= 2.5 and < 3 installed.

.. _python:  http://www.python.org/

.. _`The Python Package Index`: http://pypi.python.org

.. _VirtualenvInstallation:

`Virtualenv` install

--------------------

Since version 3.9, |cubicweb| can be safely installed, used and contained inside

:ref:`easy_install <EasyInstallInstallation>` to install |cubicweb| inside an

activated virtual environment.

.. _PipInstallation:

`pip` install

-------------

`libgecode <http://www.gecode.org/>`_ will help.

  pip install cubicweb

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

  pip install cubicweb-blog

.. _EasyInstallInstallation:

`easy_install` install

----------------------

  easy_install cubicweb

<http://pypi.python.org/pypi?%3Aaction=search&term=cubicweb&submit=search>`_

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

  easy_install cubicweb-blog

.. note::

  If you encounter problem with :ref:`cubes <AvailableCubes>` installation,

.. _SourceInstallation:

Install from source

-------------------

.. _TarballInstallation:

`http://download.logilab.org/pub/cubicweb/ <http://download.logilab.org/pub/cubicweb/>`_.

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

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.

list of availble cubes at the `CubicWeb.org Forge`_.

.. _MercurialInstallation:

Install from version control system

-----------------------------------

  hg clone -u stable http://hg.logilab.org/cubicweb # stable branch

  python cubicweb/bin/clone_deps.py

(Windows users should replace slashes with antislashes).

This script will clone a set of mercurial repositories into the

directory containing the ``cubicweb`` repository, and update them to the

latest published version tag (if any).

.. note::

  In every cloned repositories, a `hg tags` will display a list of

  tags in reverse chronological order. One reasonnable option is to go to a

  the `clone_deps` script)::

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