Added reindex command to roundup-admin.

[roundup.git] / doc / installation.txt

diff --git a/doc/installation.txt b/doc/installation.txt
index e2de5e0ec08bbb768b937a4b6abc8c2aa48ad845..b55378fdbe419d6c83d64f09923b98a53e5e60bf 100644 (file)
--- a/doc/installation.txt
+++ b/doc/installation.txt
@@ -2,7 +2,7 @@
 Installing Roundup
 ==================
 
-:Version: $Revision: 1.4 $
+:Version: $Revision: 1.13 $
 
 .. contents::
 
@@ -54,17 +54,25 @@ class as soon as the instance is created.
 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
 ===============
@@ -75,7 +83,8 @@ Download the latest version from http://roundup.sf.net/.
 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::
@@ -102,7 +111,7 @@ Set aside 15-30 minutes.
       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_::
@@ -112,9 +121,21 @@ Set aside 15-30 minutes.
           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
@@ -165,7 +186,14 @@ Set aside 15-30 minutes.
 
      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
 ========
@@ -226,4 +254,5 @@ Next: `Getting Started`_
 .. _`getting started`: getting_started.html
 .. _`roundup specification`: spec.html
 .. _`customising roundup`: customizing.html
+.. _`upgrading`: upgrading.html