[MKDoc-commit] [1.6] INSTALL now uses /usr/local/lib/mkdoc-1.6 and

[bruno at mkdoc.demon.co.uk]

Log Message:
-----------
[1.6] INSTALL now uses /usr/local/lib/mkdoc-1.6 and /var/mkdoc/example.com

Tags:
----
mkdoc-1-6

Modified Files:
--------------
    mkd:
        INSTALL.TXT

-------------- next part --------------
Index: INSTALL.TXT
===================================================================
RCS file: /var/spool/cvs/mkd/INSTALL.TXT,v
retrieving revision 1.3.2.35
retrieving revision 1.3.2.36
diff -LINSTALL.TXT -LINSTALL.TXT -u -r1.3.2.35 -r1.3.2.36
--- INSTALL.TXT
+++ INSTALL.TXT
@@ -20,8 +20,8 @@
 your sites beforehand.  You can do this by running the
 'timerange_update_db.pl' script for each site like so:
 
-   source /var/www/mkdoc/example.com/mksetenv.sh
-   perl /var/www/mkdoc/mkdoc-1.6/timerange_update_db.pl
+   source /var/mkdoc/example.com/mksetenv.sh
+   perl /usr/local/lib/mkdoc-1.6/timerange_update_db.pl
    etc..
 
 
@@ -101,7 +101,7 @@
 
 Extract your MKDoc tarball somewhere useful like:
 
-    /var/www/mkdoc/mkdoc-1.6
+    /usr/local/lib/mkdoc-1.6
 
 Note that if you choose a different installation directory, the
 paths and commands in the following instructions will need to be
@@ -113,7 +113,7 @@
 
 1. Change to your mkdoc directory:
 
-      cd /var/www/mkdoc/mkdoc-1.6
+      cd /usr/local/lib/mkdoc-1.6
 
 2. Initialise the server-wide MKDoc configuration file:
 
@@ -124,7 +124,7 @@
    you can run any MKDoc commands-line tools or start/restart
    apache:
 
-      source /var/www/mkdoc/mkdoc-1.6/mksetenv.sh
+      source /usr/local/lib/mkdoc-1.6/mksetenv.sh
 
    (You will want to add this line to whichever script you use to
    start apache)
@@ -146,7 +146,7 @@
    ..and add this line after it (you will have to do this as user
    'root'):
 
-      Include /var/www/mkdoc/mkdoc-1.6/conf/httpd.conf
+      Include /usr/local/lib/mkdoc-1.6/conf/httpd.conf
 
 4. Restart apache.  Apache doesn't pick-up changes to configuration
    files automatically, so you need to restart the apache server after
@@ -165,7 +165,7 @@
 be run as cron job at a suitable interval, such as once an hour:
 
     # index all MKDoc sites every hour on the hour, threshold 90 minutes
-    0 * * * * source /var/www/mkdoc/mkdoc-1.6/mksetenv.sh && 010..indexer.pl 5400
+    0 * * * * source /usr/local/lib/mkdoc-1.6/mksetenv.sh && 010..indexer.pl 5400
 
 (This can be run as either a normal user or as the same user as the
 webserver itself)
@@ -186,10 +186,10 @@
 
     # run the RSS troubleshooter three times an hour, thirty-six
     # failures and the feed is permanently abandoned
-    0,20,40 * * * * source /var/www/mkdoc/mkdoc-1.6/mksetenv.sh && 030..rss_troubleshooter.pl 36
+    0,20,40 * * * * source /usr/local/lib/mkdoc-1.6/mksetenv.sh && 030..rss_troubleshooter.pl 36
 
     # run the routine RSS updater at eleven every morning
-    0 11 * * * source /var/www/mkdoc/mkdoc-1.6/mksetenv.sh && 031..rss_routine.pl
+    0 11 * * * source /usr/local/lib/mkdoc-1.6/mksetenv.sh && 031..rss_routine.pl
 
 
 Creating an MKDoc web-site
@@ -254,18 +254,21 @@
 name of the site.  So if your domain is called example.com, the
 public and user domains would be called www.example.com and
 users.example.com - The folder on the server would be called
-something like /var/www/mkdoc/example.com.
+something like /var/mkdoc/example.com.
 
 (from now on this document will refer to this as "$SITE_DIR")
 
+Note that /var/mkdoc needs to be writable by whichever user account
+is doing the installation.
+
 1. Initialise the MKDoc environmental variables:
 
-      source /var/www/mkdoc/mkdoc-1.6/mksetenv.sh
+      source /usr/local/lib/mkdoc-1.6/mksetenv.sh
 
 2. Create an MKDoc site by running the install script and telling it
    where to install the site-specific files:
 
-      install-site.pl /var/www/mkdoc/example.com
+      install-site.pl /var/mkdoc/example.com
 
 3. Now use the menu system to configure your site; you will be asked
    to input your database details and some general information about
@@ -333,13 +336,13 @@
 webserver itself)
 
     # daily newsletter at 8am every morning
-    0 8 * * * source /var/www/mkdoc/example.com/mksetenv.sh && 020..newsletter.pl day
+    0 8 * * * source /var/mkdoc/example.com/mksetenv.sh && 020..newsletter.pl day
 
     # weekly newsletter at ten past eight every monday morning
-    10 8 * * mon source /var/www/mkdoc/example.com/mksetenv.sh && 020..newsletter.pl week
+    10 8 * * mon source /var/mkdoc/example.com/mksetenv.sh && 020..newsletter.pl week
 
     # monthly newsletter at twenty past eight on the first day of every month
-    20 8 1 * * source /var/www/mkdoc/example.com/mksetenv.sh && 020..newsletter.pl month
+    20 8 1 * * source /var/mkdoc/example.com/mksetenv.sh && 020..newsletter.pl month
 
 
 Final notes