diff --git a/doc/installation.txt b/doc/installation.txt
index 9a13cb8cabfaad73671773095287870017d4b69c..b55378fdbe419d6c83d64f09923b98a53e5e60bf 100644 (file)
--- a/doc/installation.txt
+++ b/doc/installation.txt
Installing Roundup
==================
-:Version: $Revision: 1.3 $
+:Version: $Revision: 1.13 $
.. contents::
Prerequisites
=============
-Python 2.1.1 or newer with a functioning anydbm or bsddb module.
+Python 2.1.1 or newer with a functioning anydbm or bsddb module. Download the
+latest version from http://www.python.org/. It is highly recommended that
+users install the latest patch version of python - 2.1.3 or 2.2.1 - as these
+contain many fixes to serious bugs.
-Download the latest version from http://www.python.org/.
+If you want to use Berkeley DB bsddb3 with Roundup, use version 3.3.0 or
+later. Download the latest version from http://pybsddb.sourceforge.net/.
Testing your Python
-------------------
-Run ``"python -c 'import test;test.go()'"`` and make sure there
+Run ``python ./run_tests`` and make sure there
are no errors. If there are errors, please let us know!
+If the above fails, you may be using the wrong version of python. Try
+``python2 ./run_tests``. If that works, you will need to substitute
+``python2`` for ``python`` in all further commands you use in relation to
+Roundup -- from installation and scripts.
Getting Roundup
===============
Installation
============
-Set aside 15-30 minutes.
+Set aside 15-30 minutes. Please make sure you're using a supported version of
+Python -- see `testing your python`_.
1. To install the Roundup support code into your Python tree and
Roundup scripts into /usr/local/bin::
environment variable or specify the full path to
the command in the next step.
- c. ``roundup-admin init``
+ c. ``roundup-admin install``
You will be asked a series of questions. A description of
the Roundup-provided templates can be found under the Overview_::
Select template [classic]: classic
Back ends: anydbm, bsddb
Select backend [anydbm]: anydbm
+
+ You will now be directed to edit the instance configuration and
+ initial schema. See `Customising Roundup`_ for details on configuration
+ and schema changes.
+
+ d. ``roundup-admin initialise``
+
+ This step initialises the instance database. You will need to supply
+ an admin password at this step. You will be prompted:
+
Admin Password:
Confirm:
+ Once this is done, the instance has been created.
+
3. Each instance ideally should have its own UNIX group, so create
a UNIX group (edit ``/etc/group`` or your appropriate NIS map if
you're using NIS). To continue with my examples so far, I would
echo test | mail -s '[issue] test' support@YOUR_DOMAIN_HERE
-TODO (finish)
+
+Upgrading
+=========
+
+Read the separate upgrading_ document, which describes the steps needed to
+upgrade existing tracker instances for each version of Roundup that is
+released.
+
+
+ZRoundup
+========
+
+Install roundup as usual (see installation_).
+
+ZRoundup installs as a regular Zope product. Copy the ZRoundup directory to
+your Products directory either in an INSTANCE_HOME/Products or the Zope
+code tree lib/python/Products.
+
+You will need to create the instance using the roundup-admin tool (step 2 in
+installation_).
+
+When you next (re)start up Zope, you will be able to add a ZRoundup object
+that interfaces to your new instance.
Further Reading
.. _`getting started`: getting_started.html
.. _`roundup specification`: spec.html
.. _`customising roundup`: customizing.html
+.. _`upgrading`: upgrading.html