# HG changeset patch # User Nicolas Chauvat # Date 1283934473 -7200 # Node ID 80388edf4e88f4e406b5b833b2240014e0499395 # Parent ece6996e6ac8209ab5bb9e1670949897705e160a [doc] improve doc thanks to user feedback diff -r ece6996e6ac8 -r 80388edf4e88 cwconfig.py --- a/cwconfig.py Wed Sep 08 10:03:30 2010 +0200 +++ b/cwconfig.py Wed Sep 08 10:27:53 2010 +0200 @@ -51,7 +51,7 @@ CW_INSTANCES_DATA_DIR = /var/lib/cubicweb/instances/ CW_RUNTIME_DIR = /var/run/cubicweb/ - * 'user': :: +* 'user': :: CW_INSTANCES_DIR = ~/etc/cubicweb.d/ CW_INSTANCES_DATA_DIR = ~/etc/cubicweb.d/ diff -r ece6996e6ac8 -r 80388edf4e88 doc/book/en/admin/setup.rst --- a/doc/book/en/admin/setup.rst Wed Sep 08 10:03:30 2010 +0200 +++ b/doc/book/en/admin/setup.rst Wed Sep 08 10:27:53 2010 +0200 @@ -59,6 +59,19 @@ .. _`CubicWeb.org Forge`: http://www.cubicweb.org/project/ +.. _PipInstallation: + +Installation with pip +````````````````````` + +|cubicweb| and its cubes have been pip_ installable since version 3.8. Search +for them on pypi_:: + + pip install cubicweb + +.. _pip: http://pypi.python.org/pypi/pip +.. _pypi: http://pypi.python.org/pypi?%3Aaction=search&term=cubicweb + .. _SourceInstallation: Install from source @@ -72,10 +85,8 @@ Make sure you have installed the dependencies (see appendixes for the list). -|cubicweb| should soon be pip_ installable, stay tuned (expected in 3.8). -.. _pip: http://pypi.python.org/pypi/pip - +.. _MercurialInstallation: Install from version control system ``````````````````````````````````` @@ -102,6 +113,10 @@ Windows installation ```````````````````` +Your best option is probably the :ref:`PipInstallation`. If it does not work or +if you want more control over the process, continue with the following +instructions. + Base elements ~~~~~~~~~~~~~ @@ -110,14 +125,15 @@ done. We assume everything goes into `C:\\` in this document. Adjusting the installation drive should be straightforward. -You should start by downloading and installing the Python(x,y) distribution. It -contains python 2.5 plus numerous useful third-party modules and applications:: +You should start by downloading and installing Python version >= 2.5 and < 3. - http://www.pythonxy.com/download_fr.php +An alternative option would be installing the Python(x,y) +distribution. Python(x,y) is not a requirement, but it makes things easier for +Windows user by wrapping in a single installer python 2.5 plus numerous useful +third-party modules and applications (including Eclipse + pydev, which is an +arguably good IDE for Python under Windows). Download it from this page:: -At the time of this writting, one gets version 2.1.15. Among the many things -provided, one finds Eclipse + pydev (an arguably good IDE for python under -windows). + http://code.google.com/p/pythonxy/wiki/Downloads Then you must grab Twisted. There is a windows installer directly available from this page:: @@ -166,8 +182,9 @@ http://www.graphviz.org/Download_windows.php -Simplejson will be provided within the forest, but a win32 compiled version will -run much faster:: +Simplejson is needed when installing with Python 2.5, but included in the +standard library for Python >= 2.6. It will be provided within the forest, but a +win32 compiled version will run much faster:: http://www.osuch.org/python-simplejson%3Awin32 @@ -189,10 +206,14 @@ http://www.vectrace.com/mercurialeclipse/ -Setting up the sources -~~~~~~~~~~~~~~~~~~~~~~ +Getting the sources +~~~~~~~~~~~~~~~~~~~ -You need to enable the mercurial forest extension. To do this, edit the file:: +You can either download the latest release (see :ref:`SourceInstallation`) or +get the development version using Mercurial (see +:ref:`MercurialInstallation` and below). + +To enable the Mercurial forest extension on Windows, edit the file:: C:\Program Files\TortoiseHg\Mercurial.ini @@ -250,14 +271,14 @@ This currently assumes that the instances configurations is located at C:\\etc\\cubicweb.d. -For a cube 'my_cube', you will then find -C:\\etc\\cubicweb.d\\my_cube\\win32svc.py that has to be used thusly:: +For a cube 'my_instance', you will then find +C:\\etc\\cubicweb.d\\my_instance\\win32svc.py that has to be used thusly:: win32svc install This should just register your instance as a windows service. A simple:: - net start cubicweb-my_cube + net start cubicweb-my_instance should start the service. @@ -282,7 +303,12 @@ Whatever the backend used, database connection information are stored in the instance's :file:`sources` file. Currently cubicweb has been tested using -Postgresql (recommanded), MySQL, SQLServer and SQLite. +Postgresql (recommended), MySQL, SQLServer and SQLite. + +Other possible sources of data include CubicWeb, Subversion, LDAP and Mercurial, +but at least one relational database is required for CubicWeb to work. SQLite is +not fit for production use, but it works for testing and ships with Python, +which saves installation time when you want to get started quickly. .. _PostgresqlConfiguration: @@ -394,7 +420,7 @@ max_allowed_packet = 128M .. Note:: - It is unclear whether mysql supports indexed string of arbitrary lenght or + It is unclear whether mysql supports indexed string of arbitrary length or not. @@ -403,9 +429,10 @@ SQLServer configuration ``````````````````````` -As of this writing, sqlserver support is in progress. You should be able to -connect, create a database and go quite far, but some of the generated SQL is -still currently not accepted by the backend. +As of this writing, support for SQLServer 2005 is functional but incomplete. You +should be able to connect, create a database and go quite far, but some of the +SQL generated from RQL queries is still currently not accepted by the +backend. Porting to SQLServer 2008 is also an item on the backlog. The `source` configuration file may look like this (specific parts only are shown):: @@ -440,14 +467,13 @@ ------------------ If you want to use Pyro to access your instance remotly, or to have multi-source -or distributed configuration, it is required to have a name server Pyro running -on your network. By by default it is detected by a broadcast request, but you can +or distributed configuration, it is required to have a Pyro name server running +on your network. By default it is detected by a broadcast request, but you can specify a location in the instance's configuration file. To do so, you need to : -* launch the server manually before starting cubicweb as a server with `pyro-nsd - start` +* launch the pyro name server with `pyro-nsd start` before starting cubicweb * under debian, edit the file :file:`/etc/default/pyro-nsd` so that the name server pyro will be launched automatically when the machine fire up