changeset 219:2a9af8163c46

Update README. Extend upgrade instructions.
author Daniele Nicolodi <daniele@grinta.net>
date Mon, 21 Nov 2011 16:10:18 +0100
parents 54cde8e2da5b
children a5f5caf65dd5
files README.rst
diffstat 1 files changed, 36 insertions(+), 18 deletions(-) [+]
line wrap: on
line diff
--- a/README.rst	Mon Nov 21 16:10:16 2011 +0100
+++ b/README.rst	Mon Nov 21 16:10:18 2011 +0100
@@ -84,16 +84,6 @@
    # ./bin/admin useradd <username> --admin true
    # ./bin/admin passwd <username> <password>
 
-Upgrading from the PHP base Web interface is also possible. For doing
-so configure the application to connect to the old administrative
-database (the default administrative database name in the PHP
-application is `ltpda_admin`) and run the upgrade procedure::
-
-   # ./bin/admin upgrade
-
-It is strongly recommended to perform a complete backup of the
-database content before attempting the upgrade.
-
 Help on the usage of the command line tool can be obtained with::
 
    # ./bin/admin help
@@ -106,9 +96,10 @@
 and connect to it at the address http://localhost:5000/
 
 
-[1] An user with the the minimum set of privileges required for
-running the application may be obtained with the following SQL
-commands::
+[1] It is also possible to run the application with an user having
+reduced privileges. An user with the the minimum set of privileges
+required for running the application may be obtained with the
+following SQL commands::
 
     CREATE USER <username>@'localhost' IDENTIFIED BY <password>;
 
@@ -132,14 +123,39 @@
 
     # ./bin/admin install --user root --password <password>
 
-An user account with username and password specified in the
-configuration file, and with minimum privileges suitable for running
-the application, may be created during the database initialization
+An user with the username and password specified in the configuration
+file, and with the minimum set of privileges required for running the
+application, may be created during the database initialization
 procedure with the `--create-user` option of the `install` command::
 
     # ./bin/admin install --create-user --user root --password <password>
 
 
+Upgrade
+-------
+
+Upgrading from old versions of the application may require chenges to
+the databases schema. To permorm the upgrade install and configure the
+application and then run the upgrade procedure:: 
+
+   # ./bin/admin upgrade
+
+If the application is configured to run with an user with limited
+privileges, as detailed in the previous section, it is necessary to
+use the `--user` and `--password` parameters of the `upgrade` commnand
+to connect to the database with a user having administration
+capabilities::
+
+    # ./bin/admin upgrade --user root --password <password>
+
+Upgrading from the PHP base Web interface is also possible. For doing
+that install and configure the application to connect to the old
+administrative database (the default administrative database name for
+the PHP application is `ltpda_admin`) and run the upgrade procedure.
+It is recommended to backup the database content before attempting the
+upgrade.
+
+
 Deployment
 ----------
 
@@ -174,8 +190,10 @@
    </Directory>
 
 In this example the application was installed in the `/srv/ltpdarepo/`
-directory. Modify the configuration accordingly for your installation
-folder.
+directory and has been configureted to be reached at the `/ltpdarepo`
+path of the webserver. Modify the configuration to adjust for your
+installation folder and for the path where the application should be
+reached.
 
 Then restart the Apache server::