Configure a CubicWeb environment
2. Configure a CubicWeb environment#
You can configure the database system of your choice:
For advanced features, have a look to:
2.1. Databases configuration#
Each instance can be configured with its own database connection information,
that will be stored in the instance’s
sources file. The database to use
will be chosen when creating the instance. CubicWeb is known to run with
Postgresql (recommended) and SQLite.
Other possible sources of data include CubicWeb, LDAP and Mercurial, but at least one relational database is required for CubicWeb to work. You do not need to install a backend that you do not intend to use for one of your instances. SQLite is not fit for production use, but it works well for testing and ships with Python, which saves installation time when you want to get started quickly.
Many Linux distributions ship with the appropriate PostgreSQL packages. Basically, you need to install the following packages:
postgresql and postgresql-client, which will pull the respective versioned packages (e.g. postgresql-9.1 and postgresql-client-9.1) and, optionally,
a postgresql-plpython-X.Y package with a version corresponding to that of the aforementioned packages (e.g. postgresql-plpython-9.1). (Not needed now by default)
If you run postgres on another host than the CubicWeb repository, you should install the postgresql-client package on the CubicWeb host, and others on the database host.
For extra details concerning installation, please refer to the PostgreSQL project online documentation.
22.214.171.124. Database cluster#
If you already have an existing cluster and PostgreSQL server running, you do not need to execute the initilization step of your PostgreSQL database unless you want a specific cluster for CubicWeb databases or if your existing cluster doesn’t use the UTF8 encoding (see note below).
To initialize a PostgreSQL cluster, use the command
$ initdb -E UTF8 -D /path/to/pgsql
initdb might not be in the PATH, so you may have to use its
absolute path instead (usually something like
Notice the encoding specification. This is necessary since CubicWeb usually want UTF8 encoded database. If you use a cluster with the wrong encoding, you’ll get error like:
new encoding (UTF8) is incompatible with the encoding of the template database (SQL_ASCII) HINT: Use the same encoding as in the template database, or use template0 as template.
Once initialized, start the database server PostgreSQL with the command:
$ postgres -D /path/to/psql
If you cannot execute this command due to permission issues, please make sure that your username has write access on the database.
$ chown username /path/to/pgsql
126.96.36.199. Database authentication#
The database authentication is configured in pg_hba.conf. It can be either set to ident sameuser or md5. If set to md5, make sure to use an existing user of your database. If set to ident sameuser, make sure that your client’s operating system user name has a matching user in the database. If not, please do as follow to create a user:
$ su $ su - postgres $ createuser -s -P <dbuser>
The option -P (for password prompt), will encrypt the password with the
method set in the configuration file
pg_hba.conf. If you do not use this
option -P, then the default value will be null and you will need to set it
$ su postgres -c "echo ALTER USER <dbuser> WITH PASSWORD '<dbpassword>' | psql"
The above login/password will be requested when you will create an instance with cubicweb-ctl create to initialize the database of your instance.
188.8.131.52. Database creation#
If you create the database by hand (instead of using the cubicweb-ctl db-create tool), you may want to make sure that the local settings are properly set. For example, if you need to handle french accents properly for indexing and sorting, you may need to create the database with something like:
$ createdb --encoding=UTF-8 --locale=fr_FR.UTF-8 -t template0 -O <owner> <dbname>
Notice that the cubicweb-ctl db-create does database initialization that may requires a postgres superuser. That’s why a login/password is explicitly asked at this step, so you can use there a superuser without using this user when running the instance. Things that require special privileges at this step:
database creation, require the ‘create database’ permission
Where pgadmin is a postgres superuser.
SQLite has the great advantage of requiring almost no configuration. Simply use ‘sqlite’ as db-driver, and set path to the dabase as db-name. Don’t specify anything for db-user and db-password, they will be ignore anyway.
SQLite is great for testing and to play with cubicweb but is not suited for production environments.
2.2. Cubicweb resources configuration#
2.2.1. Resource mode#
184.108.40.206. Standard resource mode#
A resource mode is a predefined set of settings for various resources directories, such as cubes, instances, etc. to ease development with the framework. There are two running modes with CubicWeb:
system: resources are searched / created in the system directories (eg usually requiring root access):
instances are stored in
temporary files (such as pid file) in
where <INSTALL_PREFIX> is the detected installation prefix (‘/usr/local’ for instance).
user: resources are searched / created in the user home directory:
instances are stored in
temporary files (such as pid file) in
220.127.116.11. Within virtual environment#
When installed within a virtualenv, CubicWeb will look for instances data as in user mode by default, that is in $HOME/etc/cubicweb.d. However the CW_INSTANCES_DIR environment variable should be preferably used.
18.104.22.168. Custom resource location#
Notice that each resource path may be explicitly set using an environment variable if the default doesn’t suit your needs. Here are the default resource directories that are affected according to mode:
CW_INSTANCES_DIR = <INSTALL_PREFIX>/etc/cubicweb.d/ CW_INSTANCES_DATA_DIR = <INSTALL_PREFIX>/var/lib/cubicweb/instances/ CW_RUNTIME_DIR = <INSTALL_PREFIX>/var/run/cubicweb/
CW_INSTANCES_DIR = ~/etc/cubicweb.d/ CW_INSTANCES_DATA_DIR = ~/etc/cubicweb.d/ CW_RUNTIME_DIR = /tmp
Cubes search path is also affected, see the Cubes section.
22.214.171.124. Setting Cubicweb Mode#
By default, the mode is set to ‘system’ for standard installation. The mode is
set to ‘user’ if cubicweb is used from a mercurial repository. You can force
this by setting the
CW_MODE environment variable to either ‘user’ or
‘system’ so you can easily:
use system wide installation but user specific instances and all, without root privileges on the system (export CW_MODE=user)
use local checkout of cubicweb on system wide instances (requires root privileges on the system (export CW_MODE=system)
If you’ve a doubt about the mode you’re currently running, check the first line outputed by the cubicweb-ctl list command.
126.96.36.199. Development Mode (source)#
.hg directory is found into the cubicweb package, there are
specific resource rules.
<CW_SOFTWARE_ROOT> is the source checkout’s
cubicweb migration files are searched in <CW_SOFTWARE_ROOT>/misc/migration instead of <INSTALL_PREFIX>/share/cubicweb/migration/.
188.8.131.52. Development Mode (virtualenv)#
If a virtualenv is found to be activated (i.e. a VIRTUAL_ENV variable is found
in environment), the virtualenv root is used as <INSTALL_PREFIX>. This, in
particular, makes it possible to work in setuptools development mode
python setup.py develop) without any further configuration.
2.2.2. Environment configuration#
If you installed CubicWeb by cloning the Mercurial shell repository or from source distribution, then you will need to update the environment variable PYTHONPATH by adding the path to cubicweb:
Add the following lines to either
configure your development environment
If you installed CubicWeb with packages, no configuration is required and your new cubes will be placed in /usr/share/cubicweb/cubes and your instances will be placed in /etc/cubicweb.d.
Here are all environment variables that may be used to configure CubicWeb:
Resource mode: user or system, as explained in Resource mode.
Directory where cubicweb instances will be found.
Directory where cubicweb instances data will be written (backup file…)
Directory where pid files will be written