--- /dev/null
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
+ [
+ <!ENTITY MIR_VERSION "1.1">
+ ]
+>
+<book>
+ <title>Mir CMS 1.1 Installation manual</title>
+ <bookinfo>
+ <revhistory>
+ <revision>
+ <revnumber>0.0.0</revnumber>
+
+ <date>July 2004</date>
+
+ <revremark>First steps</revremark>
+ </revision>
+ <revision>
+ <revnumber>0.0.1</revnumber>
+
+ <date>October/November 2004</date>
+
+ <revremark>First usable version</revremark>
+ </revision>
+ </revhistory>
+
+ <authorgroup>
+ <author>
+ <firstname>Zapata</firstname>
+ <affiliation>Mir coders</affiliation>
+ </author>
+ </authorgroup>
+ </bookinfo>
+
+ <preface>
+ <abstract>
+ This document helps system administrators install Mir,
+ a Java-based Content Management System distributed under
+ the Gnu Public License.
+ </abstract>
+ </preface>
+
+ <chapter id="introduction">
+
+ <title>Introduction</title>
+
+ <section>
+ <title>Mir</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section>
+ <title>Version</title>
+
+ <para>
+ This documentation applies to mir version &MIR_VERSION;.
+ </para>
+ </section>
+
+ <section>
+ <title>Overview</title>
+ <para>
+ In order to make use of Mir, one has to install configure
+ several required pieces of third party software.
+
+ </para>
+ </section>
+
+ </chapter>
+
+ <chapter>
+ <title>Overview</title>
+
+ <section>
+ <title></title>
+
+ <para>
+ <itemizedlist>
+ <listitem>
+ Third party software required by mir, such as Postgresql, the Relational
+ Database Management System Mir requires.
+ </listitem>
+ <listitem>
+ The Mir code itself, normally in the form of a binary
+ distribution.
+ </listitem>
+ <listitem>
+ Configuration with details like database access parameters.
+ </listitem>
+ <listitem>
+ A custom mir setup, incorporating the look and feel the mir-driven
+ site should have
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ </section>
+
+ </chapter>
+
+ <chapter>
+ <title>Installing Mir itself</title>
+
+ <section>
+ <title>Introduction</title>
+
+ <para>
+ <itemizedlist>
+ <listitem>
+ Mir versions: x.y.z
+ </listitem>
+ <listitem>
+ Binary distribution, Source distribution,CVS distribution
+ </listitem>
+ <listitem>
+ Mir customization
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+
+ <section>
+ <title>Obtaining a distribution</title>
+
+ <para>
+ </para>
+ </section>
+
+ <section>
+ <title>Configuring mir</title>
+
+ <para>
+ <itemizedlist>
+ </itemizedlist>
+ </para>
+
+ </section>
+
+ <section>
+ <title>Notes for multiple mir installation on a single system</title>
+
+ <para>
+ </para>
+ </section>
+
+ <section>
+ <title>The most commonly used configuration entries</title>
+
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><literal>Mir.Name</literal></term>
+ <term><literal>Mir.Shortname</literal></term>
+ <term><literal>Mir.Contact-email.address</literal></term>
+ <term><literal>Mir.Contact-email.name</literal></term>
+ <term><literal>Mir.Tech-email.address</literal></term>
+ <term><literal>Mir.Tech-email.name</literal></term>
+ <term><literal>Mir.Public-email.address</literal></term>
+ <term><literal>Mir.Public-email.name</literal></term>
+
+ <listitem>
+ These entries constitute various names and email addresses used in error forms and
+ within mir's admin interface.
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Mir.DefaultTimezone</term>
+ <listitem>
+ The default timezone to be used for showing dates and times.
+ Values like <literal>Europe/Amsterdam</literal> are highly
+ reccommended, since these take daylight savings time into
+ account where applicable.
+
+ For a full list of possible values, see:
+ <ulink url="http://www.fnal.gov/docs/products/crl/misc/Time_Zone_Listing.txt">here</ulink>.
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Mir.DefaultDateTimeFormat</term>
+ <listitem>
+ The format to use for dates and times in admin, e.g. <literal>yyyy-MM-dd HH:mm</literal>.
+
+ For the allowed codes and their meanings, see
+ <ulink url="http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html">here</ulink>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Mir.Admin.FallbackLanguage</term>
+ <listitem>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Mir.Login.DefaultLanguage</term>
+ <listitem>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Mir.Login.Languages</term>
+ <listitem>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Mir.Admin.ShowLoggedinUsers</term>
+ <listitem>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Mir.Localizer.Admin.ListOperationsFlavor</term>
+ <listitem>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Mir.Login.Languages</term>
+ <listitem>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Mir.Login.Languages</term>
+ <listitem>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Mir.Login.Languages</term>
+ <listitem>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Mir.Login.Languages</term>
+ <listitem>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Mir.Login.Languages</term>
+ <listitem>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Mir.Login.Languages</term>
+ <listitem>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Mir.Login.Languages</term>
+ <listitem>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Mir.Login.Languages</term>
+ <listitem>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term></term>
+ <listitem>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </section>
+ </chapter>
+
+ <chapter>
+ <title>Third party software required by Mir</title>
+
+ <section>
+ <title>A Java Virtual Machine (version 1.3 and up)</title>
+
+ <para>
+ Since Mir is a Java application, a Java virtual machine is
+ needed to run it.
+ </para>
+
+ <para>
+ version 1.3+
+
+ For linux systems, both IBM and Sun have such a virtual machine
+ available.
+ </para>
+
+ <para>
+ JRE versus JDK
+ </para>
+
+ <para>
+ Neither the IBM nor the SUN Virtual Machine constitute free
+ software as definied by the <ulink url="http://www.fsf.org">Free Software
+ Foundation</ulink>.
+
+ At this moment
+
+ Given Mir's commitment to Free Software
+
+ Alternatives to propietary JVMs are actively sought by the mir coders,
+ especially regarding gnu's gjc and classpath projects and the
+ sable virtual machine.
+
+ This investigation is ongoing.
+
+ Results will be announced on the mir site as well as the mir coders
+ mailing list.
+
+ Until then, one of the aforementioned proprietary virtual machines
+ is required for Mir.
+ </para>
+ </section>
+
+ <section>
+ <title>RDBMS: Postgresql</title>
+
+ <para>
+ The version of Mir described in this document depends on the
+ Postgresql RDBMS system.
+
+ This section will explain the specific side issues applicable
+ to using it in conjunction with mir.
+
+ For general Postgresql information, see <ulink url="http://www.postgresql.org/">The
+ official Postgresql website</ulink>
+
+ Note that databases to be used by mir can be initialized by
+ a script provided in the mir distribution.
+ </para>
+
+ <section>
+ <title>Installation</title>
+
+ <para>
+ A normal postgresql installation will suffice for Mir (details can
+ be found on the postgresql site).
+
+ It would be wise however to install support for unicode encoded
+ databases, since with Mir, these generally work out the best.
+ </para>
+ </section>
+
+ <section>
+ <title>Configuration</title>
+
+ <para>
+ <programlisting>
+ pg_hba.conf
+ </programlisting>
+ </para>
+ </section>
+
+ <section>
+ <title>Maintenance</title>
+
+ <para>
+ The mircoders advise you to make regular backups of your databases,
+ to prevent accidental loss of data.
+
+ Aside from this, there's one important Postgresql-specific maintenance
+ issue:
+
+ <programlisting>
+ vacuum analyze;
+ </programlisting>
+ </para>
+ </section>
+
+ <section>
+ <title>Practical tips</title>
+
+ <para>
+ A postgresql installation comes with a number of handy tools.
+
+ We'll supply you with a brief overview of them.
+
+ Further information is available in the man pages of the tools
+ in question and on the postgresql website.
+ </para>
+
+ <section>
+ <title><application>psql</application></title>
+
+ <para>
+ <application>psql</application> is postgresql's literal-line
+ interface to perform queries on databases.
+ </para>
+ </section>
+
+ <section>
+ <title><application>pg_dump</application> and <application>pg_restore</application></title>
+
+ <para>
+ </para>
+ </section>
+
+ </section>
+ </section>
+
+ <section>
+ <title>Java servlet container: Tomcat</title>
+
+ <para>
+ The reccommended Java Servlet Container is Tomcat.
+
+ Mir will probably work with Tomcat version 3.3 and up.
+
+ For various practical reasons, Tomcat 4 is recommended.
+
+ The next version of Mir will most likely require at least Tomcat 4.
+ </para>
+
+ <section>
+ <title>Installation</title>
+
+ <para>
+ - distributions
+ </para>
+ </section>
+
+ <section>
+ <title>Configuration</title>
+
+ <para>
+ </para>
+
+ <section>
+ <title>Pointing tomcat to the mir installation</title>
+
+ <para>
+ </para>
+ </section>
+
+ <section>
+ <title>Turning off IP logging</title>
+
+ <para>
+
+ </para>
+ </section>
+
+ <section>
+ <title>Disabling security</title>
+
+ <para>
+ Future versions of this documentation will contain a
+ guide to properly configure tomcat's security manager.
+ </para>
+ </section>
+ </section>
+
+ <section>
+ <title>Practical tips</title>
+
+ <para>
+ manager, tomcat restarts, the user running tomcat
+ </para>
+
+ </section>
+ </section>
+
+ <section>
+ <title>HTTP Server: Apache</title>
+
+ <para>
+ <itemizedlist>
+ <listitem>enabling SSI</listitem>
+ <listitem></listitem>
+ </itemizedlist>
+ </para>
+ </section>
+
+ <section>
+ <title>Servlet connector: mod_jk</title>
+ </section>
+
+ <section>
+ <title>Sun's JAI library</title>
+
+ <para>
+ In addition to a virtual machine, Mir depends at this time on another
+ piece of non-free software, namely the JAI image library from Sun.
+
+ As with the virtual machine dependency, the mir coders will also do
+ its best to move towards a free replacement for JAI.
+ </para>
+
+ <section>
+ <title>Installation</title>
+ </section>
+
+ <section>
+ <title>Setting up</title>
+ </section>
+ </section>
+ </chapter>
+
+
+ <chapter>
+ <title>Setting up Mir on Debian</title>
+
+ <section>
+ <title>Introduction</title>
+
+ <para>
+ For users of the Debian GNU/Linux distribution, this chapter offers
+ easy steps to install mir.
+ </para>
+
+ <para>
+ Most of the third part software needed to run Mir, is available as
+ packages in debian distributions from woody on.
+
+ This chapter assumes the distribution, though most should be applicable
+ to newer distributions as well.
+ </para>
+ </section>
+ <section>
+ <title>Postgresql</title>
+
+ <para>
+ <application>Postgresql</application> is available in debian under the
+ package postgresql.
+
+ <informalexample>
+ <programlisting><literal>apt-get install postgresql</literal></programlisting>
+ </informalexample>
+ </para>
+
+ <para>
+ By default, postgresql in Debian is configured to use
+ <quote>ident</quote> authentication and <quote>sameuser</quote>
+ authorization for local users.
+
+ This means a local user can connect as the postgresql user with the
+ same name.
+
+ For Mir, it's required to have <quote>password</quote> authentication.
+
+ Therefore, in <filename>/etc/postgresql/pg_hba.conf</filename> a
+ change needs to be made:
+
+ The line containing the localhost configuration should be changed to look
+ like:
+ <programlisting>
+host all 127.0.0.1 255.0.0.0 password
+ </programlisting>
+
+ This means that any user from localhost can connect as any postgresql
+ user, as long as she can authenticate herself with the password.
+
+ </para>
+ <para>
+ For convenience reasons, it's also recommended to use password
+ authentication for the local domain.
+
+ For this, first a proper password needs to be selected for the postgres
+
+ super user:
+ <informalexample>
+ <programlisting><literal>su postgres</literal>
+<literal>psql template1</literal>
+# alter user postgres with password 'xxxxxxx';
+/q</programlisting>
+ </informalexample>
+
+ Then, the line with local authentication in
+ <filename>/etc/postgresql/pg_hba.conf</filename> should be
+ altered:
+ <programlisting>
+local all password
+ </programlisting>
+ </para>
+ <para>
+
+ </para>
+ </section>
+ <section>
+ <title>Tomcat</title>
+ <para>
+ <application>Tomcat 4</application> can be found in Debian-package tomcat4.
+ <informalexample>
+ <programlisting><literal>apt-get install tomcat4</literal></programlisting>
+ </informalexample>
+ </para>
+ <para>
+ The security manager needs to be disabled by editing
+ <filename>/etc/default/tomcat4</filename>
+ and setting the option <option>TOMCAT4_SECURITY</option>
+ to <literal>"no"</literal>
+ <informalexample>
+ <programlisting><option>TOMCAT4_SECURITY</option> = <literal>"no"</literal></programlisting>
+ </informalexample>
+ </para>
+ <para>
+ It is reccommended to disable ip logging.
+
+ This can be done by editing
+ <filename>/usr/share/tomcat4/conf/server.xml</filename>
+ and deleting or commenting out the <quote>acces log valve</quote>:
+ <informalexample>
+ <programlisting>
+<!--
+<Valve className="org.apache.catalina.valves.AccessLogValve"
+ directory="logs" prefix="localhost_access_log." suffix=".txt"
+ pattern="common" />
+
+ -->
+ </programlisting>
+ </informalexample>
+ </para>
+ </section>
+ </chapter>
+</book>
+
+
+
+
+
+
projects / mir.git / commitdiff