[MKDoc-commit] [1.6] update INSTALL,
rearrange and remove irrelevant cruft
bruno at mkdoc.demon.co.uk
bruno at mkdoc.demon.co.uk
Fri Sep 2 16:46:11 BST 2005
Log Message:
-----------
[1.6] update INSTALL, rearrange and remove irrelevant cruft
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.34
retrieving revision 1.3.2.35
diff -LINSTALL.TXT -LINSTALL.TXT -u -r1.3.2.34 -r1.3.2.35
--- INSTALL.TXT
+++ INSTALL.TXT
@@ -11,6 +11,7 @@
These instructions are suitable for the installation of a test version
of MKDoc, production servers may involve different configurations.
+
Upgrading to MKDoc-1.6.30
-------------------------
@@ -30,7 +31,7 @@
Install perl, apache, mod_perl and mysql if they are not already
installed.
-MKDoc has been tested with mysql-3.23, apache-1.3.31 and mod_perl-1.29,
+MKDoc has been tested with mysql-3 or 4, apache-1.3.33 and mod_perl-1.29,
though any recent version of these packages should work.
MKDoc hasn't yet been tested with apache-2 and probably will not run
@@ -40,108 +41,22 @@
support.
-Getting the code
-----------------
-
-You can download a version of MKDoc from:
-
- http://download.mkdoc.com/
-
-Extract your MKDoc tarball somewhere useful like:
-
- /var/www/mkdoc/mkdoc-1.6
-
-Note that if you choose a different installation directory, the
-paths and commands in the following instructions will need to be
-altered accordingly.
-
-
-Creating the database
----------------------
-
-Your mysql server needs to be running before you can create an MKDoc
-database; for redhat linux, you may need to issue the following commands
-as root to start the server and ensure that it restarts when the server
-is rebooted:
-
- /sbin/service mysqld start
- /sbin/chkconfig mysqld on
-
-Consult your operating system documentation for other configurations.
-If this is a production server, you will need to ensure that mysql is
-secure.
-
-If you don't require network access to your mysql server, you may want
-to bind it to the loopback interface only; do this by adding a line to
-the [mysqld] section of your /etc/my.cnf file:
-
- bind-address=127.0.0.1
-
-Create the mysql database that you are going to use (important, you will
-have to use real values for User, Password and Db):
-
- mysql -uroot mysql
-
- INSERT INTO user (Host, User, Password) VALUES ('localhost',
- 'mkdoc1', password ('mkdoc1'));
-
- CREATE database mkdoc1;
-
- INSERT INTO db (Host, Db, User, Select_priv, Insert_priv,
- Update_priv, Delete_priv, Create_priv,Drop_priv, Grant_priv,
- References_priv, Index_priv, Alter_priv) VALUES ('localhost', 'mkdoc1',
- 'mkdoc1', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y');
-
- flush privileges;
-
-If you need to use a non-local mysql server, then your configuration
-will be different - Consult your mysql documentation.
-
-
-Setting up the DNS
-------------------
-
-Create three hostnames that will be used for the two different MKDoc
-interfaces, we suggest that they are given names like:
-
- www.example.com
- users.example.com
-
-If you only want to try-out MKDoc locally and have no access to a dns
-server to create new hostnames, you can simply add them to your local
-/etc/hosts file (change 10.0.0.1 to your actual ip-address):
-
- 10.0.0.1 www.example.com
- 10.0.0.1 users.example.com
-
-
Packages required
-----------------
Install htmltidy:
- http://tidy.sourceforge.net/
-
-If you intend to use the discussion component, you will need access to
-an imap account to store messages. This can be a separate server on the
-same network or can be installed on the same machine as MKDoc.
-
-We recommend Courier-IMAP as a suitable imap server:
-
- http://www.courier-mta.org/download.php#imap
+http://tidy.sourceforge.net/
MKDoc sends email to contact users and editors and will expect that
the host server is capable of routing email through the standard
-/usr/sbin/sendmail interface (Note that this doesn't have to be the
-Sendmail MTA, other MTAs such as Postfix or Exim also provide
-/usr/sbin/sendmail).
+/usr/sbin/sendmail interface.
If you do not have a sendmail tool in /usr/sbin, you may have to
-create a link to another location:
+create a link to the actual location:
ln -s /usr/lib/sendmail /usr/sbin/
-
Install all the perl modules in MODULES.TXT, currently these modules are
required:
@@ -161,7 +76,7 @@
Text::CSV_XS
Unicode::String
Mail::IMAPClient
- Time::ParseDate
+ Time::ParseDate (part of the Time-modules package)
XML::RSS
Cache::Cache
Crypt::PassGen
@@ -177,6 +92,22 @@
DateTime::TimeZone
+Getting the MKDoc code
+----------------------
+
+You can download a version of MKDoc from:
+
+http://download.mkdoc.com/
+
+Extract your MKDoc tarball somewhere useful like:
+
+ /var/www/mkdoc/mkdoc-1.6
+
+Note that if you choose a different installation directory, the
+paths and commands in the following instructions will need to be
+altered accordingly.
+
+
Configuring your MKDoc system
=============================
@@ -190,11 +121,13 @@
From now onwards, you will need to source this shell
configuration file to preset MKDoc environmental variables before
- you can run any MKDoc commands-line tools:
+ you can run any MKDoc commands-line tools or start/restart
+ apache:
source /var/www/mkdoc/mkdoc-1.6/mksetenv.sh
- (You may want to add this line to your profile)
+ (You will want to add this line to whichever script you use to
+ start apache)
Note that 'source' is a bash built-in command. If you use a
different shell, then you will either need to create appropriate
@@ -221,10 +154,7 @@
/sbin/service httpd restart
- You can ensure that the web server is restarted if the machine is ever
- rebooted by issuing this command:
-
- /sbin/chkconfig httpd on
+ (This command will be different if you have built your own apache)
Setup the indexing cron job
@@ -267,6 +197,59 @@
Now you can start creating MKDoc sites.
+
+Creating the database
+---------------------
+
+Create the mysql database that you are going to use (important, you will
+have to use real values for User, Password and Db):
+
+ mysql -uroot mysql
+
+ INSERT INTO user (Host, User, Password) VALUES ('localhost',
+ 'mkdoc1', password ('mkdoc1'));
+
+ CREATE database mkdoc1;
+
+ INSERT INTO db (Host, Db, User, Select_priv, Insert_priv,
+ Update_priv, Delete_priv, Create_priv,Drop_priv, Grant_priv,
+ References_priv, Index_priv, Alter_priv) VALUES ('localhost', 'mkdoc1',
+ 'mkdoc1', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y');
+
+ flush privileges;
+
+For mysql-4.x the db line needs to have two extra entries:
+
+ INSERT INTO db (Host, Db, User, Select_priv, Insert_priv,
+ Update_priv, Delete_priv, Create_priv,Drop_priv, Grant_priv,
+ References_priv, Index_priv, Alter_priv, Create_tmp_table_priv,
+ Lock_tables_priv) VALUES ('localhost', 'mkdoc1', 'mkdoc1', 'Y', 'Y',
+ 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y');
+
+If you need to use a non-local mysql server, then your configuration
+will be different - Consult your mysql documentation.
+
+
+Setting up the DNS
+------------------
+
+Create two hostnames that will be used for the two different MKDoc
+interfaces, we suggest that they are given names like:
+
+ www.example.com
+ users.example.com
+
+If you only want to try-out MKDoc locally and have no access to a dns
+server to create new hostnames, you can simply add them to your local
+/etc/hosts file (change 10.0.0.1 to your actual ip-address):
+
+ 10.0.0.1 www.example.com
+ 10.0.0.1 users.example.com
+
+
+Install the MKDoc site
+----------------------
+
By default, files for a site live in a folder named after the domain
name of the site. So if your domain is called example.com, the
public and user domains would be called www.example.com and
@@ -359,30 +342,21 @@
20 8 1 * * source /var/www/mkdoc/example.com/mksetenv.sh && 020..newsletter.pl month
-Setup MKDoc::Apache_Cache
--------------------------
-
-MKDoc-1.6 ships with an internal cacheing system that means that
-documents don't need to be constantly regenerated for every request.
-
-For anything more than a small site, you should investigate
-setting-up the superior MKDoc::Apache_Cache:
-
- http://www.mkdoc.org/docs/howto/apache-cache/
-
-
Final notes
------------
+===========
Online documentation is available here:
- http://www.mkdoc.org/docs/
+http://www.mkdoc.org/docs/
Any further questions regarding MKDoc setup and administration can be
-posted to the mkdoc-admin mailing list, you can subscribe here:
+posted to the mkdoc-dev mailing list, you can subscribe here:
+
+http://www.mkdoc.org/lists/mkdoc-dev/
+
- http://www.mkdoc.org/lists/mkdoc-dev/
+Document Author
+---------------
---
-2004-09-30 Bruno Postle <bruno at mkdoc.com>
+2005-09-01 Bruno Postle <bruno at mkdoc.com>
More information about the MKDoc-commit
mailing list