view docs/INSTALL.html @ 421:8eefc299cf06 1.5.2rc1

1.5.2rc1 - bumped version, make install-docs, interwiki, underlay, pagepacks imported from: moin--main--1.5--patch-425
author Thomas Waldmann <>
date Sat, 04 Feb 2006 12:10:42 +0000
parents 4d58b19bd3a7
children 45cd2bbb395b
line wrap: on
line source
<link rel="shortcut icon" href="">
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<meta name="robots" content="noindex,nofollow">

<title>MoinMoin/InstallDocs - MoinMaster</title>
<script type="text/javascript" src="/wiki/common/js/common.js"></script>

<link rel="stylesheet" type="text/css" charset="utf-8" media="all" href="wiki/htdocs/modern/css/common.css">
<link rel="stylesheet" type="text/css" charset="utf-8" media="all" href="wiki/htdocs/modern/css/print.css">
<link rel="stylesheet" type="text/css" charset="utf-8" media="screen" href="">
<link rel="alternate" title="MoinMaster Recent Changes" href=";ddiffs=1&amp;unique=1" type="application/rss+xml">

<link rel="Start" href="">
<link rel="Alternate" title="Wiki Markup" href="">
<link rel="Alternate" media="print" title="Print View" href="">
<link rel="Up" href="">
<link rel="Search" href="">
<link rel="Index" href="">
<link rel="Glossary" href="">
<link rel="Help" href="">

<body  lang="en" dir="ltr">
<div id="page" lang="en" dir="ltr">
<div id="interwiki"><span><a href="">MoinMaster</a></span></div>
<ul id="pagelocation">
<div dir="ltr" id="content" lang="en"><span class="anchor" id="top"></span>
<span class="anchor" id="line-9"></span><span class="anchor" id="line-10"></span><p class="line879">This HTML page contains the basic install docs that can be found on <a class="http" href=""></a>. It contains all necessary information to get your wiki up and running, even without being online. If you have a permanent internet connection, you might want to browse the docs on the Help<tt class="backtick"></tt>On<tt class="backtick"></tt>Installing page, which might contain more up-to-date information. <span class="anchor" id="line-11"></span></p><span class="anchor" id="line-12"></span><p class="line886">After following the procedures on this page, you should have a working wiki and can browse the rest of the online docs there. <span class="anchor" id="line-13"></span></p><span class="anchor" id="line-14"></span>
<h1 id="head-378d73a512870e1afed036c887489ab98ba3c56a">How to install your own MoinMoin Wiki</h1>
<span class="anchor" id="line-15"></span><p class="line879">This page describes the installation procedure of <a href="">MoinMoin</a>. In the next section, there is a list of real-world <a href="#installscenarios">Installation Scenarios</a> that help you to understand how to apply the instructions in different environments. If you already have a wiki running and want to upgrade, see <a class="interwiki" href="" title="MoinMaster">HelpOnUpdating</a>. <span class="anchor" id="line-16"></span></p><span class="anchor" id="line-17"></span><p class="line879">A Moin<tt class="backtick"></tt>Moin installation is done by some elementary steps: <span class="anchor" id="line-18"></span></p><ul><li><p class="line903"><a href="#basic-install">Basic Installation</a> explains the "<tt class="backtick"></tt>" step of the installation in more detail. This is uses to get the Moin<tt class="backtick"></tt>Moin code and wiki template installed onto your system. This applies equally to all scenarios, and you should read it before trying a live installation. <span class="anchor" id="line-19"></span></p></li><li><p class="line903"><a href="#wikiinstance-creation">Wiki Instance Creation</a> explains how you make a new wiki instance (data and configuration), this is also common to all scenarios. <span class="anchor" id="line-20"></span></p></li><li><p class="line879">Getting the web server to serve static stuff under the <tt class="backtick">/wiki</tt> URL (url_prefix) - used for theme CSS and images, etc. - this is slightly different for the various web servers that can be used - see below. <span class="anchor" id="line-21"></span></p></li><li><p class="line886">Getting the web server to execute the moin code when you access wiki pages. This is done either by CGI, FastCGI, mod_python or Twisted or the built-in stand alone server - this is slightly different for the various web servers that can be used - see below. <span class="anchor" id="line-22"></span></p></li><li><p class="line879">After a successful installation, you might want to read more about configuration and other options that you, as the wiki administrator, can set up. <a class="interwiki" href="" title="MoinMaster">HelpOnAdministration</a> contains links to pages that cover these topics. Especially, the <a class="interwiki" href="" title="MoinMaster">HelpOnConfiguration</a> and <a class="interwiki" href="" title="MoinMaster">HelpOnUpdating</a> pages provide additional information regarding wiki setup and maintenance. <span class="anchor" id="line-23"></span></p></li><li><p class="line903"><a href="#trouble-shooting">Trouble-shooting</a> helps with fixing any general problems you might encounter, which apply to any installation platform.  <span class="anchor" id="line-24"></span></p><span class="anchor" id="line-25"></span></li></ul><span class="anchor" id="installscenarios"></span> <span class="anchor" id="line-26"></span>
<h1 id="head-bee4ae5a5ef44b7af47ecd4f29b44226ba935e5b">Installation steps specific for some web servers and operating systems</h1>
<span class="anchor" id="line-27"></span><span class="anchor" id="line-28"></span><p class="line879">The following links will show you concrete examples of installation sessions, showing the commands used and explaining what they do. You <em>must first read the general information on installing above</em> before doing the installation steps described on the pages linked from below: <span class="anchor" id="line-29"></span></p><span class="anchor" id="line-30"></span><p class="line886">Linux: <span class="anchor" id="line-31"></span></p><ul><li><p class="line903"><a href="#linuxapache-install">Linux Installation using Apache</a> <span class="anchor" id="line-32"></span></p></li><li><p class="line903"><a href="#linuxstandalone-install">Linux Installation using standalone server</a> <span class="anchor" id="line-33"></span></p><span class="anchor" id="line-34"></span></li></ul><p class="line886">Long-Running-Process Setup: <span class="anchor" id="line-35"></span></p><ul><li><p class="line903"><a href="#fastcgi-install">FastCGI Setup using Apache</a> <span class="anchor" id="line-36"></span></p></li><li><p class="line903"><a href="#modpy-install">mod_python Setup using Apache</a> <span class="anchor" id="line-37"></span></p></li><li><p class="line903"><a href="#twisted-install">Setup using twisted</a> <span class="anchor" id="line-38"></span></p><span class="anchor" id="line-39"></span></li></ul><p class="line886">Mac OS X: <span class="anchor" id="line-40"></span></p><ul><li><p class="line903"><a href="#macosx-install">Mac OS X Installation</a> <span class="anchor" id="line-41"></span></p><span class="anchor" id="line-42"></span></li></ul><p class="line886">Windows: <span class="anchor" id="line-43"></span></p><ul><li><p class="line903"><a href="#win32apache-install">Windows Installation using Apache</a> <span class="anchor" id="line-44"></span></p></li><li><p class="line903"><a href="#win32iis-install">Windows Installation using IIS</a> <span class="anchor" id="line-45"></span></p><span class="anchor" id="line-46"></span></li></ul><span class="anchor" id="basic-install"></span> <span class="anchor" id="line-47"></span><div dir="ltr" id="Include_HelpOnInstalling/BasicInstallation" lang="en"><span class="anchor" id="top_Include_HelpOnInstalling/BasicInstallation"></span>
<span class="anchor" id="line-8"></span><span class="anchor" id="line-9"></span><p class="line903"><span class="anchor" id="line-10"></span><strong>How to do a basic installation of <a href="">MoinMoin</a> on your system.</strong> <span class="anchor" id="line-11"></span></p><span class="anchor" id="line-12"></span><p class="line903"><strong>Contents</strong> <span class="anchor" id="line-13"></span><ol><li><a href="#head-2fa431ad9c9bff5badd07c5ee676b19852ed28e3">Check if Python is working</a></li><li><a href="#head-119b1acf8110bb618e4f366c3d1f8a35ad625f75">Download MoinMoin</a></li><li><a href="#head-a84e58c8b4256bd645b9c47b5a900219a356259f">Install MoinMoin</a><ol><li><a href="#head-640b21abea127e7ac4b48c938607c233b7119bd5">Installing in the default system location</a></li><li><a href="#head-ae8ab55eb5e8c11d4fd1eb06e12d69f1b33d411b">Installing in the home directory or another specific location</a></li></ol><li><a href="#head-d7d600c8dcfdd9270f4a6642566404ede510f46a">Test installation</a></li><li><a href="#head-87a60f1d02c36fb1804b442815dba49cbc8adfe7">What has been installed</a></li></ol> <span class="anchor" id="line-14"></span></p><span class="anchor" id="line-15"></span><p class="line879">Before you can integrate Moin<tt class="backtick"></tt>Moin into your web environment, you have to install the <a href="">MoinMoin</a> source code and data files using the standard Python <em>distutils</em> mechanism (<tt class="backtick"></tt>). This page explains the steps you usually need to take to do this. For more details on the <em>distutils</em> installation process, consult the <a class="http" href="">Installing Python Modules</a> document in your Python documentation set. <span class="anchor" id="line-16"></span></p><span class="anchor" id="line-17"></span><p class="line886">The installation is similar on Windows and Linux (and other POSIX-type systems; for simplicity, we just say "Linux" in the docs). <span class="anchor" id="line-18"></span></p><span class="anchor" id="line-19"></span><ul><li style="list-style-type:none"><p class="line903"><img alt="(!)" height="15" src="wiki/htdocs/modern/img/idea.png" title="(!)" width="15" /> We use text such as <strong><tt class="backtick">&gt;&nbsp;command&nbsp;arguments</tt></strong> to show what you have to type at the command prompt (also known as shell, terminal, etc.). In our examples "<tt class="backtick">&gt;&nbsp;</tt>" is the prompt, you don't have to type it in, you have to type what comes after it. Lines that do not begin with "<tt class="backtick">&gt;&nbsp;</tt>" are the answers to the commands you have typed. Read them carefully. <span class="anchor" id="line-20"></span></p><span class="anchor" id="line-21"></span></li></ul>
<h1 id="head-2fa431ad9c9bff5badd07c5ee676b19852ed28e3">Check if Python is working</h1>
<span class="anchor" id="line-22"></span><span class="anchor" id="line-23"></span><p class="line879">Moin<tt class="backtick"></tt>Moin needs Python to run, so the first step is to check if an usable version of Python is installed and correctly set-up. If this is not the case, you will have to fix that before you can proceed. <span class="anchor" id="line-24"></span></p><span class="anchor" id="line-25"></span><p class="line879">The <tt class="backtick">CHANGES</tt> file in the Moin<tt class="backtick"></tt>Moin archive mentions what versions are supported. Python 2.3 is the minimum requirement for Moin<tt class="backtick"></tt>Moin 1.5, but we suggest you use the latest Python release version. <span class="anchor" id="line-26"></span></p><span class="anchor" id="line-27"></span><p class="line879">You can download Python at <a class="http" href=""></a>. <span class="anchor" id="line-28"></span></p><span class="anchor" id="line-29"></span><p class="line879">If you are pretty sure an acceptable version of Python is installed but the commands below do not work, this may be because your Python files are not in the <em>search path</em>. Correctly setting the search path is outside the scope of this document; please ask for help on your favorite Python, Linux, or Windows discussion board. <span class="anchor" id="line-30"></span></p><span class="anchor" id="line-31"></span><p class="line886">If you have shell access, checking if Python is working is very simple. Just type the following command, and look at the result: <span class="anchor" id="line-32"></span><span class="anchor" id="line-33"></span></p><pre>&gt; python -V
<span class="anchor" id="line-34"></span>Python 2.3.4
<span class="anchor" id="line-35"></span></pre><span class="anchor" id="line-36"></span><span class="anchor" id="line-37"></span><p class="line879">If you don't have shell access, you can try using this <tt class="backtick">pythontest.cgi</tt> script (it assumes that you are using a Linux kind of webserver). Upload the script to your <tt class="backtick">cgi-bin</tt> directory, use <tt class="backtick">chmod&nbsp;a+rx&nbsp;pythontest.cgi</tt> (or a similar command in your FTP program) to make it executable, and invoke it using your web browser. <span class="anchor" id="line-38"></span><span class="anchor" id="line-39"></span></p><pre>#!/bin/sh
<span class="anchor" id="line-40"></span>echo Content-Type: text/plain
<span class="anchor" id="line-41"></span>echo
<span class="anchor" id="line-42"></span>echo "Your web server is running as:"
<span class="anchor" id="line-43"></span>id
<span class="anchor" id="line-44"></span>echo "CGI scripts work"
<span class="anchor" id="line-45"></span>echo "Now we try to invoke Python interpreters and get their versions:"
<span class="anchor" id="line-46"></span>python -V 2&gt;&amp;1
<span class="anchor" id="line-47"></span>python2.3 -V 2&gt;&amp;1
<span class="anchor" id="line-48"></span>python2.4 -V 2&gt;&amp;1
<span class="anchor" id="line-49"></span>echo "Finished."
<span class="anchor" id="line-50"></span></pre><span class="anchor" id="line-51"></span><span class="anchor" id="line-52"></span><p class="line886">If it doesn't display "CGI scripts work", well, then CGI scripts don't work. If it doesn't show one or more Python version numbers, then Python is not correctly installed. In both cases, before you can proceed, you will have to get in touch with the administrator of the server so that the problems get corrected. <span class="anchor" id="line-53"></span></p><span class="anchor" id="line-54"></span><p class="line879">Also be sure to read <a href="">../ApacheOnLinuxFtp</a> after you've completed the <a href="">../BasicInstallation</a> illustrated here. <span class="anchor" id="line-55"></span></p><span class="anchor" id="line-56"></span>
<h1 id="head-119b1acf8110bb618e4f366c3d1f8a35ad625f75">Download MoinMoin</h1>
<span class="anchor" id="line-57"></span><span class="anchor" id="line-58"></span><p class="line879">To download the distribution archive, go to the <a class="http" href="">download area</a> and fetch the latest archive. <span class="anchor" id="line-59"></span></p><span class="anchor" id="line-60"></span><p class="line879">The next step is to unpack the distribution archive (which you have done already if you are reading this text from your hard drive). If you read this on the web, the distribution comes in a versioned <tt class="backtick">.tar.gz</tt> archive, which you can unpack as shown below. <span class="anchor" id="line-61"></span></p><span class="anchor" id="line-62"></span><ul><li><p class="line886">On Windows <span class="anchor" id="line-63"></span></p><ul><li><p class="line879">You can use recent versions of programs like Win<tt class="backtick"></tt>Zip, Win<tt class="backtick"></tt>Rar, and Win<tt class="backtick"></tt>Ace, which handle .tar.gz kind of archives. <span class="anchor" id="line-64"></span></p></li><li><p class="line879">At the command prompt, you can use <a class="http" href="">GNU gzip</a> and <a class="http" href="">GNU tar</a> for Windows. <span class="anchor" id="line-65"></span></p></li></ul></li><li><p class="line886">On Linux <span class="anchor" id="line-66"></span></p><ul><li><p class="line886">You can use your favorite file manager -- it should be able to unpack them. <span class="anchor" id="line-67"></span></p></li><li><p class="line879">At any shell prompt, you can use the <tt class="backtick">tar</tt> command. <span class="anchor" id="line-68"></span></p><span class="anchor" id="line-69"></span></li></ul></li></ul><p class="line879">The distribution archive will always unpack into a directory named <tt class="backtick">moin-&lt;version&gt;</tt>, for example <tt class="backtick">moin-1.5</tt>. <span class="anchor" id="line-70"></span></p><span class="anchor" id="line-71"></span><p class="line879">Here is how you would unpack the archive (using GNU tar) and enter the directory with the Moin<tt class="backtick"></tt>Moin files: <span class="anchor" id="line-72"></span><span class="anchor" id="line-73"></span></p><pre>&gt; tar xzf moin-1.5.0.tar.gz
<span class="anchor" id="line-74"></span>&gt; cd moin-1.5.0
<span class="anchor" id="line-75"></span></pre><span class="anchor" id="line-76"></span><span class="anchor" id="line-77"></span>
<h1 id="head-a84e58c8b4256bd645b9c47b5a900219a356259f">Install MoinMoin</h1>
<span class="anchor" id="line-78"></span><span class="anchor" id="line-79"></span><p class="line879">You can install Moin<tt class="backtick"></tt>Moin to either: <span class="anchor" id="line-80"></span></p><ul><li><p class="line886">a system location (if you have the necessary rights to do that -- on Linux you need to be root) <span class="anchor" id="line-81"></span></p></li><li><p class="line879">some specific location, like your home directory (Linux) or <tt class="backtick">C:\moin</tt> (Windows). <span class="anchor" id="line-82"></span></p><span class="anchor" id="line-83"></span></li></ul><p class="line886">The installation to a system location is easier, so choose that if possible. <span class="anchor" id="line-84"></span></p><span class="anchor" id="line-85"></span><p class="line903"><img alt="/!\" height="15" src="wiki/htdocs/modern/img/alert.png" title="/!\" width="15" /> If you have several versions of Python installed, please use the same version for setup and for running the wiki. Usually, the latest Python version will get the best results. <span class="anchor" id="line-86"></span></p><span class="anchor" id="line-87"></span><p class="line879">If you have problems with the <tt class="backtick"></tt> install step, try using the command: <span class="anchor" id="line-88"></span><span class="anchor" id="line-89"></span></p><pre>&gt; python -v --quiet install --record=install.log
<span class="anchor" id="line-90"></span></pre><span class="anchor" id="line-91"></span><span class="anchor" id="line-92"></span><p class="line879">The additional <tt class="backtick">-v</tt> flag should provide you detailed verbose messages every step of the way. <span class="anchor" id="line-93"></span></p><span class="anchor" id="line-94"></span><p class="line903"><img alt="/!\" height="15" src="wiki/htdocs/modern/img/alert.png" title="/!\" width="15" /> On Linux, if u get an error like <tt class="backtick">Invalid&nbsp;Python&nbsp;installation:&nbsp;cannot&nbsp;find&nbsp;/usr/lib/Python2.x/config/Makefile</tt>, you may not have the python module <strong><tt class="backtick">distutils</tt></strong> installed, it's usually a part of the <strong>Python development libarary (<tt class="backtick">python-dev</tt>)</strong>. Some Linux distributions may not have installed it by default. For example, on Mandrake you need to install the <strong><tt class="backtick">python-devel</tt></strong> package, on Debian it's called <strong><tt class="backtick">python-dev</tt></strong>. <span class="anchor" id="line-95"></span></p><span class="anchor" id="line-96"></span>
<h2 id="head-640b21abea127e7ac4b48c938607c233b7119bd5">Installing in the default system location</h2>
<span class="anchor" id="line-97"></span><span class="anchor" id="line-98"></span><span class="anchor" id="line-99"></span><pre>&gt; python --quiet install --record=install.log
<span class="anchor" id="line-100"></span></pre><span class="anchor" id="line-101"></span><span class="anchor" id="line-102"></span><p class="line879">This installs Moin<tt class="backtick"></tt>Moin to the default system location (typically the Python directory, for example on Linux, inside <tt class="backtick">/usr/lib</tt> and <tt class="backtick">/usr/share</tt>). Look at the <tt class="backtick">install.log</tt> file to see what was installed, and where. <span class="anchor" id="line-103"></span></p><span class="anchor" id="line-104"></span><ul><li><p class="line886">Mac OS X note: use the command: <span class="anchor" id="line-105"></span><span class="anchor" id="line-106"></span></p><pre>python install --install-data='/usr/local'
<span class="anchor" id="line-107"></span></pre><span class="anchor" id="line-108"></span><p class="line886">This will install the shared files to '/usr/local/share/moin', instead of an inconvenient location in the System folder. <span class="anchor" id="line-109"></span></p><span class="anchor" id="line-110"></span></li></ul>
<h2 id="head-ae8ab55eb5e8c11d4fd1eb06e12d69f1b33d411b">Installing in the home directory or another specific location</h2>
<span class="anchor" id="line-111"></span><span class="anchor" id="line-112"></span><p class="line886">Linux example, installing in the home directory: <span class="anchor" id="line-113"></span><span class="anchor" id="line-114"></span></p><pre>&gt; python --quiet install --prefix=$HOME --record=install.log
<span class="anchor" id="line-115"></span></pre><span class="anchor" id="line-116"></span><span class="anchor" id="line-117"></span><p class="line879">Windows example, installing in the <tt class="backtick">C:\moin</tt> directory: <span class="anchor" id="line-118"></span><span class="anchor" id="line-119"></span></p><pre>&gt; python --quiet install --prefix="C:\moin" --record=install.log
<span class="anchor" id="line-120"></span></pre><span class="anchor" id="line-121"></span><span class="anchor" id="line-122"></span><p class="line879">All Moin<tt class="backtick"></tt>Moin files will then be installed inside those directories, see <tt class="backtick">install.log</tt> to know which files were installed, and where. <span class="anchor" id="line-123"></span></p><span class="anchor" id="line-124"></span><p class="line903"><strong>Note:</strong> You will likely see the following warning: <span class="anchor" id="line-125"></span></p><span class="anchor" id="line-126"></span><ul><li style="list-style-type:none"><p class="line903"><tt class="backtick">warning:&nbsp;install:&nbsp;modules&nbsp;installed&nbsp;to&nbsp;'C:\moin\',&nbsp;which</tt><br />
 <span class="anchor" id="line-127"></span><tt class="backtick">is&nbsp;not&nbsp;in&nbsp;Python's&nbsp;module&nbsp;search&nbsp;path&nbsp;(sys.path)&nbsp;--&nbsp;you'll</tt><br />
 <span class="anchor" id="line-128"></span><tt class="backtick">have&nbsp;to&nbsp;change&nbsp;the&nbsp;search&nbsp;path&nbsp;yourself</tt> <span class="anchor" id="line-129"></span></p><span class="anchor" id="line-130"></span></li></ul><p class="line879">This means exactly what it says, you need to add your install directory to the search path of Python, or it won't find the Moin<tt class="backtick"></tt>Moin code. <span class="anchor" id="line-131"></span></p><span class="anchor" id="line-132"></span><p class="line879">For example, if you are running using a webserver and standard CGI, edit <tt class="backtick">moin.cgi</tt> and add your installation directory to the Python path, like this: <span class="anchor" id="line-133"></span><span class="anchor" id="line-134"></span></p><pre>import sys
<span class="anchor" id="line-135"></span>sys.path.insert(0, 'C:/moin')
<span class="anchor" id="line-136"></span></pre><span class="anchor" id="line-137"></span><span class="anchor" id="line-138"></span>
<h1 id="head-d7d600c8dcfdd9270f4a6642566404ede510f46a">Test installation</h1>
<span class="anchor" id="line-139"></span><span class="anchor" id="line-140"></span><p class="line879">As a final step, if you have access to the shell or the command prompt, you can check that everything is correctly installed and ready to run. Start Python and type <tt class="backtick">import&nbsp;MoinMoin</tt>. Nothing should be displayed in response to this command. Example: <span class="anchor" id="line-141"></span></p><span class="anchor" id="line-142"></span><span class="anchor" id="line-143"></span><pre>&gt; python
<span class="anchor" id="line-144"></span>Python 2.3.4 (#1, May 29 2004, 17:05:23)
<span class="anchor" id="line-145"></span>[GCC 3.3.3] on linux2
<span class="anchor" id="line-146"></span>Type "help", "copyright", "credits" or "license" for more information.
<span class="anchor" id="line-147"></span>&gt;&gt;&gt; import MoinMoin
<span class="anchor" id="line-148"></span>&gt;&gt;&gt;
<span class="anchor" id="line-149"></span></pre><span class="anchor" id="line-150"></span><span class="anchor" id="line-151"></span><p class="line886">If you get this instead: <span class="anchor" id="line-152"></span></p><span class="anchor" id="line-153"></span><span class="anchor" id="line-154"></span><pre>&gt;&gt;&gt; import MoinMoin
<span class="anchor" id="line-155"></span>Traceback (most recent call last):
<span class="anchor" id="line-156"></span>  File "&lt;stdin&gt;", line 1, in ?
<span class="anchor" id="line-157"></span>ImportError: No module named MoinMoin
<span class="anchor" id="line-158"></span>&gt;&gt;&gt;
<span class="anchor" id="line-159"></span></pre><span class="anchor" id="line-160"></span><span class="anchor" id="line-161"></span><p class="line879">then you have to tune your installation. Try modifying <tt class="backtick">sys.path</tt>, as described above. <span class="anchor" id="line-162"></span></p><span class="anchor" id="line-163"></span>
<h1 id="head-87a60f1d02c36fb1804b442815dba49cbc8adfe7">What has been installed</h1>
<span class="anchor" id="line-164"></span><span class="anchor" id="line-165"></span><p class="line879">So, you have a ready-to-work Moin<tt class="backtick"></tt>Moin installation now. Congratulations! Before you go on to configuring it, take a look at the various files and directories that have been installed. <span class="anchor" id="line-166"></span></p><span class="anchor" id="line-167"></span><p class="line903"><img alt="/!\" height="15" src="wiki/htdocs/modern/img/alert.png" title="/!\" width="15" /> It is important that you understand the different locations used in a Moin<tt class="backtick"></tt>Moin setup, so read this carefully. <span class="anchor" id="line-168"></span></p><span class="anchor" id="line-169"></span><p class="line879">In the following descriptions, <tt class="backtick">PREFIX</tt> is what you used with the <tt class="backtick"></tt> command, or a default location if you didn't use the <tt class="backtick">--prefix</tt> option. (Typical default values on Linux are <tt class="backtick">/usr</tt> and <tt class="backtick">/usr/local</tt>.) <tt class="backtick">X.Y</tt> is the version of Python. Typically, this is <tt class="backtick">2.3</tt> or <tt class="backtick">2.4</tt>. <span class="anchor" id="line-170"></span></p><span class="anchor" id="line-171"></span><p class="line879">Look into <tt class="backtick">install.log</tt> to find out about following important locations: <span class="anchor" id="line-172"></span></p><span class="anchor" id="line-173"></span><ul><li><p class="line903"><strong><tt class="backtick">MoinMoin</tt> directory</strong>, usually <tt class="backtick">PREFIX/lib/pythonX.Y/site-packages/MoinMoin</tt> -- this is where the Moin<tt class="backtick"></tt>Moin <strong>source code</strong> is located <span class="anchor" id="line-174"></span></p></li><li><p class="line903"><strong><tt class="backtick">share</tt> directory</strong>, usually <tt class="backtick">PREFIX/share/moin</tt> - this is where the <em>templates</em> are located <span class="anchor" id="line-175"></span></p><ul><li><p class="line903"><strong><tt class="backtick">data</tt></strong> directory (wiki pages, users, etc.) - only Moin<tt class="backtick"></tt>Moin should access this <span class="anchor" id="line-176"></span></p></li><li><p class="line903"><strong><tt class="backtick">underlay</tt></strong> directory (wiki pages) - only Moin<tt class="backtick"></tt>Moin should access this <span class="anchor" id="line-177"></span></p></li><li><p class="line903"><strong><tt class="backtick">htdocs</tt></strong> directory with html support files (images for the various themes, etc.) - the web server will need to access this <span class="anchor" id="line-178"></span></p></li><li><p class="line903"><strong><tt class="backtick">server</tt></strong> - Moin<tt class="backtick"></tt>Moin example startup files (like <tt class="backtick">moin.cgi</tt> for CGI, and other files for other startup methods) <span class="anchor" id="line-179"></span></p></li><li><p class="line903"><strong><tt class="backtick">config</tt></strong> - Moin<tt class="backtick"></tt>Moin example configuration files (like <tt class="backtick"></tt>) <span class="anchor" id="line-180"></span></p></li></ul></li><li><p class="line903"><strong><tt class="backtick">bin</tt></strong> directory with some scripts that help you use the Moin<tt class="backtick"></tt>Moin shell commands <span class="anchor" id="line-181"></span></p><span class="anchor" id="line-182"></span></li></ul><p class="line879">We talk of <em>templates</em> in the <tt class="backtick">share</tt> directory because you usually will not use those files at that location, but copy them elsewhere when you need them. This way, you can set-up several wikis without problems, and easily upgrade to new Moin<tt class="backtick"></tt>Moin versions. <span class="anchor" id="line-183"></span></p><span class="anchor" id="bottom_Include_HelpOnInstalling/BasicInstallation"></span></div> <span class="anchor" id="line-48"></span><hr class="hr2" /><p class="line886"> <span class="anchor" id="line-49"></span><span class="anchor" id="wikiinstance-creation"></span> <span class="anchor" id="line-50"></span><div dir="ltr" id="Include_HelpOnInstalling/WikiInstanceCreation" lang="en"><span class="anchor" id="top_Include_HelpOnInstalling/WikiInstanceCreation"></span>
<span class="anchor" id="line-8"></span><span class="anchor" id="line-9"></span><p class="line879">After you have downloaded and installed Moin<tt class="backtick"></tt>Moin, you will want to "have a wiki". As explained at the bottom of <a href="">../BasicInstallation</a>, you have to copy several directories and files. This way, you can have as many wikis as you want, and you can easily upgrade Moin<tt class="backtick"></tt>Moin: only the original files will be overwritten, not your copies. <span class="anchor" id="line-10"></span></p><span class="anchor" id="line-11"></span><p class="line879">Every time you copy those files (and modify the configuration of your server accordingly), you create what is called a <em>wiki instance</em>. Each wiki instance is independant from the others, with a different configuration, different pages, different users, etc. <span class="anchor" id="line-12"></span></p><span class="anchor" id="line-13"></span><p class="line886">Some of the steps you need to take depend on which web server and which operating system you use. They are described on dedicated pages, which you should read (at least the beginning) before reading this one. Some other steps are common to every webserver and operating system (copying files around, setting permissions), and this is what is described here. <span class="anchor" id="line-14"></span></p><span class="anchor" id="line-15"></span>
<h1 id="head-8c227c275465dec3f8e3b326d53f9566727c5648">Read this first</h1>
<span class="anchor" id="line-16"></span><span class="anchor" id="line-17"></span>
<h2 id="head-6e91ed0b234e903763a945b5249e7de8b726e5d7">Security warnings</h2>
<span class="anchor" id="line-18"></span><span class="anchor" id="line-19"></span><div><table style="color: red"><tbody><tr>  <td><p class="line879"> <img alt="/!\" height="15" src="wiki/htdocs/modern/img/alert.png" title="/!\" width="15" /> <strong>Warning: make sure that your <tt class="backtick">data</tt> directory and your configuration files are not accessible through your web server. Do not put your wiki directory in <tt class="backtick">public_html</tt>, <tt class="backtick">Sites</tt> or any other directory your web server can access. The web server only needs to access the file in the <tt class="backtick">htdocs</tt> directory and the <tt class="backtick">moin.cgi</tt> script! (Or whatever script your server uses to start Moin<tt class="backtick"></tt>Moin.)</strong> </p></td>
<span class="anchor" id="line-20"></span></tbody></table></div><span class="anchor" id="line-21"></span><div><table style="color: red"><tbody><tr>  <td><p class="line879"> <img alt="/!\" height="15" src="wiki/htdocs/modern/img/alert.png" title="/!\" width="15" /> <strong>Warning: make sure that the <tt class="backtick">data</tt> directory and its subdirectories are not readable and not writeable by users other than the web server user. If you need to give worldwide read-write permissions to get it working, be aware that you are doing a very unsecure setup, that can be compromised by any other user or program on your computer.</strong> </p></td>
<span class="anchor" id="line-22"></span></tbody></table></div><span class="anchor" id="line-23"></span>
<h2 id="head-942d29849126a576afcc19bdbfd59c661739eb55">Note to Windows users</h2>
<span class="anchor" id="line-24"></span><span class="anchor" id="line-25"></span><p class="line886">All the commands below are Linux commands. The text descriptions that introduce them should be enough to help you understand what you need to do. Use the Windows Explorer, or the appropriate text-mode commands. <span class="anchor" id="line-26"></span></p><span class="anchor" id="line-27"></span>
<h1 id="head-66ec28f32e6870e96f6062a4a6ac77bbb4606109">Choose a wiki name</h1>
<span class="anchor" id="line-28"></span><span class="anchor" id="line-29"></span><p class="line886">Choose a unique name for the new wiki instance you want to create. It should be a short word, something that reflects what you intend to use the wiki for, like the name of your organization, of your team, of the project you are working on, etc. <span class="anchor" id="line-30"></span></p><span class="anchor" id="line-31"></span><ul><li style="list-style-type:none"><p class="line903"><img alt="&lt;!&gt;" height="15" src="wiki/htdocs/modern/img/attention.png" title="&lt;!&gt;" width="15" /> <strong>Do not use the name "wiki" - it is reserved for internal use. You would need a special setup to use this with CGI, and you can't use it at all with standalone or twisted server.</strong> <span class="anchor" id="line-32"></span></p><span class="anchor" id="line-33"></span></li></ul><p class="line879">The name "<tt class="backtick">mywiki</tt>" is used as an example in the various commands below. <span class="anchor" id="line-34"></span></p><span class="anchor" id="line-35"></span>
<h1 id="head-379ea73c819b2c729ba9c2432b8a4c4b4c524f71">Choose a location</h1>
<span class="anchor" id="line-36"></span><span class="anchor" id="line-37"></span><p class="line886">Choose a directory on your disk, it will contain all the files needed for your wiki instance. At the beginning, your wiki instance will use approximately 10 MB of disk space. Then of course, it will grow depending on the way your wiki is used. A personal wiki, even with many pages, might only use 30 MB or 40 MB of disk space. A popular wiki, or a wiki with many files attached to the pages, might use much more, of course. <span class="anchor" id="line-38"></span></p><span class="anchor" id="line-39"></span><p class="line879">If you are the administrator (or root) of the server, you can use anything you like or that makes sense to you, for example <tt class="backtick">/usr/local/var/moin</tt>, <tt class="backtick">/mnt/wikis</tt>, etc. <span class="anchor" id="line-40"></span></p><span class="anchor" id="line-41"></span><p class="line879">If you are a simple user, you will probably only be allowed to write in your personal, "home" directory. Choose a subdirectory that makes sense to you, for example the <tt class="backtick">share/moin</tt> subdirectory. <span class="anchor" id="line-42"></span></p><span class="anchor" id="line-43"></span>
<h1 id="head-951584cdd82db21218fc2ffd3945de602f8275c0">Collect some important information</h1>
<span class="anchor" id="line-44"></span><span class="anchor" id="line-45"></span><p class="line886">This is where the instructions differ according to the web server and operating system you use, and whether you are the administrator or a simple user. See the appropriate pages for your web server and operating system combination. <span class="anchor" id="line-46"></span></p><span class="anchor" id="line-47"></span><p class="line879">On Linux, the <tt class="backtick">export</tt> command will be used to remember the collected information. Windows users should write it down carefully (maybe cutting-and-pasting in a Notepad window), or store it in environment variables if they use the command prompt. <span class="anchor" id="line-48"></span></p><span class="anchor" id="line-49"></span><ul><li><p class="line903"><tt class="backtick">PREFIX</tt> is the prefix you used during the <a href="">../BasicInstallation</a> <span class="anchor" id="line-50"></span></p></li><li><p class="line903"><tt class="backtick">SHARE</tt> is the name of the <tt class="backtick">share</tt> directory, as discussed at the bottom of <a href="">../BasicInstallation</a> <span class="anchor" id="line-51"></span></p></li><li><p class="line903"><tt class="backtick">WIKILOCATION</tt> is the name of the directory that will contain your wiki instance <span class="anchor" id="line-52"></span></p><span class="anchor" id="line-53"></span></li></ul><p class="line886">If you are an administrator, you also need to collect the following: <span class="anchor" id="line-54"></span></p><span class="anchor" id="line-55"></span><ul><li><p class="line903"><tt class="backtick">USER</tt> is the user name of the web server <span class="anchor" id="line-56"></span></p></li><li><p class="line903"><tt class="backtick">GROUP</tt> is the name of the group to which the web server belongs <span class="anchor" id="line-57"></span></p><span class="anchor" id="line-58"></span></li></ul><p class="line886">Now, Linux folks, let's store these settings in memory: <span class="anchor" id="line-59"></span><span class="anchor" id="line-60"></span></p><pre>&gt; export PREFIX=/usr                # this might be something else
<span class="anchor" id="line-61"></span>&gt; export SHARE=$PREFIX/share/moin   # this should be correct for most people
<span class="anchor" id="line-62"></span>&gt; export WIKILOCATION=$SHARE        # this is just an example
<span class="anchor" id="line-63"></span>&gt; export INSTANCE=mywiki            # this is just an example
<span class="anchor" id="line-64"></span></pre><span class="anchor" id="line-65"></span><span class="anchor" id="line-66"></span><p class="line886">Administrators also need the following two lines: <span class="anchor" id="line-67"></span></p><span class="anchor" id="line-68"></span><span class="anchor" id="line-69"></span><pre>&gt; export USER=www-data              # this is just an example
<span class="anchor" id="line-70"></span>&gt; export GROUP=www-data             # this is just an example
<span class="anchor" id="line-71"></span></pre><span class="anchor" id="line-72"></span><span class="anchor" id="line-73"></span>
<h1 id="head-c3fc33e072973371ea739841440fb52175ddb9f6">Copy the files</h1>
<span class="anchor" id="line-74"></span><span class="anchor" id="line-75"></span><p class="line879">To create your new instance, you first need to create a directory named like your instance, inside the <tt class="backtick">WIKILOCATION</tt>. Then you need to copy the <tt class="backtick">data</tt> and <tt class="backtick">underlay</tt> directories from your <tt class="backtick">SHARE</tt> directory into your instance directory. Finally, you need to copy the <tt class="backtick"></tt> file from the <tt class="backtick">config</tt> directory into the instance directory. <span class="anchor" id="line-76"></span></p><span class="anchor" id="line-77"></span><p class="line886">Linux folks need just type these commands: <span class="anchor" id="line-78"></span><span class="anchor" id="line-79"></span></p><pre>&gt; cd $WIKILOCATION
<span class="anchor" id="line-80"></span>&gt; mkdir $INSTANCE                   # make a directory for this instance
<span class="anchor" id="line-81"></span>&gt; cp -R $SHARE/data $INSTANCE       # copy template data directory
<span class="anchor" id="line-82"></span>&gt; cp -R $SHARE/underlay $INSTANCE   # copy underlay data directory
<span class="anchor" id="line-83"></span>&gt; cp $SHARE/config/ $INSTANCE   # copy wiki configuration sample file
<span class="anchor" id="line-84"></span></pre><span class="anchor" id="line-85"></span><span class="anchor" id="line-86"></span><ul><li style="list-style-type:none"><p class="line903"><img alt="/!\" height="15" src="wiki/htdocs/modern/img/alert.png" title="/!\" width="15" /> Note that you just need to keep one underlay directory on your system if you are running multiple wikis (e.g. in a farm.) <span class="anchor" id="line-87"></span></p><span class="anchor" id="line-88"></span></li></ul>
<h1 id="head-027e3666aea4dc02569ad386901ae9456bad5ae1">Set permissions</h1>
<span class="anchor" id="line-89"></span><span class="anchor" id="line-90"></span>
<h2 id="head-3b8b040007c209e4621b176c8724b3bbcb755957">Administrators</h2>
<span class="anchor" id="line-91"></span><span class="anchor" id="line-92"></span><p class="line886">Administrators need to restrict the permissions of the files, so that only the web server (and the administrator of course) can read and write them. For maximum security, no other user on the machine should be able to read or write anything in the wiki instance directory. Don't forget that this directory contains sensitive information, notably the (encrypted) passwords of the wiki users. <span class="anchor" id="line-93"></span></p><span class="anchor" id="line-94"></span><p class="line886">On Linux, the following commands should be enough: <span class="anchor" id="line-95"></span><span class="anchor" id="line-96"></span></p><pre>&gt; chown -R $USER.$GROUP $INSTANCE   # check that USER and GROUP are correct
<span class="anchor" id="line-97"></span>&gt; chmod -R ug+rwX $INSTANCE         # USER.GROUP may read and write
<span class="anchor" id="line-98"></span>&gt; chmod -R o-rwx $INSTANCE          # everybody else is rejected
<span class="anchor" id="line-99"></span></pre><span class="anchor" id="line-100"></span><span class="anchor" id="line-101"></span>
<h2 id="head-19c5987edf26a8517fbf6cbee5ba5dd5f36ec280">Normal users</h2>
<span class="anchor" id="line-102"></span><span class="anchor" id="line-103"></span><p class="line879">Normal users, on the contrary, need to broaden the permissions of the files, so that the web server can read and write them. On recent Windows versions, and on some versions of Unix, Linux and other systems, <em>access control lists</em> can be used to that effect. They are, however, powerful and complicated, much beyond the scope of this document. Ask a knowledgeable person about them. <span class="anchor" id="line-104"></span></p><span class="anchor" id="line-105"></span><p class="line879">Without them, normal users have to allow <em>everybody</em> to access the instance directory. This is the only way the web server can enter it and do its work. This is, of course, <strong>VERY INSECURE</strong>, since any other user and program on the server can read the directory. You should <strong>not</strong> use such a setup for a wiki open to the public. <span class="anchor" id="line-106"></span></p><span class="anchor" id="line-107"></span><p class="line886">On Linux, the following commands will open the instance directory to the whole world: <span class="anchor" id="line-108"></span><span class="anchor" id="line-109"></span></p><pre>&gt; chmod -R a+rwX $INSTANCE
<span class="anchor" id="line-110"></span></pre><span class="anchor" id="line-111"></span><span class="anchor" id="line-112"></span><p class="line903"><strong>Note:</strong> <span class="anchor" id="line-113"></span></p><ul><li><p class="line879">it is also possible to put the web server and the normal user in the same <em>group</em>, and then only open the instance directory to the members of that group. This is a bit more secure (depending on who else is in the group), but you need the cooperation of the server administrator; he is the one setting up groups. <span class="anchor" id="line-114"></span></p></li><li><p class="line879">the best other possibility is that the server administrator sets up <tt class="backtick">suexec</tt> to execute CGI scripts in user directories under the user id of that user. You don't need to give world permissions that way, so it is a quite secure setup, but you also need cooperation of the administrator. <span class="anchor" id="line-115"></span></p><span class="anchor" id="line-116"></span><span class="anchor" id="line-117"></span></li></ul>
<h1 id="head-442871161f523855f2162b426248f0bb0523c289">Tune configuration</h1>
<span class="anchor" id="line-118"></span><span class="anchor" id="line-119"></span><p class="line886">Now, you need to tune the configuration of your web server and of your wiki instance. Look at the appropriate help page for your web server, then come back here to tune the settings of your wiki instance. <span class="anchor" id="line-120"></span></p><span class="anchor" id="line-121"></span><p class="line879">Edit <tt class="backtick"></tt>. The default settings should work fine in most cases, but there are some things that you will probably want to change, like the name and logo of your wiki! <img alt=":)" height="15" src="wiki/htdocs/modern/img/smile.png" title=":)" width="15" /> Read the comments inside <tt class="backtick"></tt>, they will guide you through this process.  (Start with "Wiki identity", around line 25.) <span class="anchor" id="line-122"></span></p><span class="anchor" id="line-123"></span><p class="line903"><a href="">HelpOnConfiguration</a> contains all the details about all the options, in case the comments in <tt class="backtick"></tt> are not enough. <span class="anchor" id="line-124"></span></p><span class="anchor" id="bottom_Include_HelpOnInstalling/WikiInstanceCreation"></span></div> <span class="anchor" id="line-51"></span></p><hr class="hr1" /><p class="line886"> <span class="anchor" id="line-52"></span><span class="anchor" id="linuxapache-install"></span> <span class="anchor" id="line-53"></span>
<h1>Linux Installation using Apache</h1>
<div dir="ltr" id="Include_HelpOnInstalling/ApacheOnLinux" lang="en"><span class="anchor" id="top_Include_HelpOnInstalling/ApacheOnLinux"></span>
<span class="anchor" id="line-9"></span><p class="line879">This page describes the particular steps that need to be taken to create a wiki instance using <a href="">MoinMoin</a> on Linux with the Apache web server. <strong>You should have already performed the <a href="">../BasicInstallation</a>. </strong>Installations on other Unices like FreeBSD are very similar. <span class="anchor" id="line-10"></span></p><span class="anchor" id="line-11"></span><p class="line886">Two scenarios are possible. You might be the administrator (root) of the server, able to install and modify files almost anywhere on the machine, and notably able to modifiy the Apache configuration. You might also be a simple user, only able to write files into your home directory, and unable to alter the master Apache config file. The two scenarios are discussed below. <span class="anchor" id="line-12"></span></p><span class="anchor" id="line-13"></span><p class="line903"><strong>Table of contents</strong> <ol><li><a href="#head-5a61f5b0107edba120089e4251cd633be60b6e15">Administrator (root)</a><ol><li><a href="#head-c27688fbe7f65d67190a47ce8d32eba244ab0d01">Create a wiki instance</a></li><li><a href="#head-e3e9e08058bb0ae34c33f53367cd58d6c7411998">Install moin.cgi</a></li><li><a href="#head-408a7a283b2406c4e6b24646b25ec7996d5ff459">Configure moin.cgi</a></li><li><a href="#head-b02e2f66403a66cc3b1ff0ce2c7261cf44e4f0d4">Configure Apache</a></li><li><a href="#head-ffa39b171f9d130bb07a8481a5fff1a5a9065e86">Configure MoinMoin</a></li><li><a href="#head-0f7a0fb8dccf6a13b6042fa17e0d7cda751fe3f3">Test the wiki</a></li><li><a href="#head-52920da3312438e6a484347d4dfaa369b86cb521">Apache tricks</a></li></ol><li><a href="#head-e559f024646d8751eee1135ad5423247d72ab7fd">Simple user (home directory installation)</a><ol><li><a href="#head-6a39e2829f37fd34c569c2ffa768c9b3ec2289cc">Make sure /~username works</a></li><li><a href="#head-c27688fbe7f65d67190a47ce8d32eba244ab0d01-2">Create a wiki instance</a></li><li><a href="#head-ec9ce458a3f08281e5906f6d1e2e5cc008d620db">Install the htdocs files</a></li><li><a href="#head-e3e9e08058bb0ae34c33f53367cd58d6c7411998-2">Install moin.cgi</a></li><li><a href="#head-408a7a283b2406c4e6b24646b25ec7996d5ff459-2">Configure moin.cgi</a></li><li><a href="#head-ffa39b171f9d130bb07a8481a5fff1a5a9065e86-2">Configure MoinMoin</a></li><li><a href="#head-0f7a0fb8dccf6a13b6042fa17e0d7cda751fe3f3-2">Test the wiki</a></li></ol><li><a href="#head-3f286acb05ce4ad64240f788c78a8f915f59e34e">Troubleshooting</a><ol><li><a href="#head-b8c0d1c1aba9cd39d0d15f86ea33025f7f25d48d">Adding permission to serve the htdocs directory</a></li></ol></li></ol> <span class="anchor" id="line-14"></span></p><span class="anchor" id="line-15"></span>
<h2 id="head-5a61f5b0107edba120089e4251cd633be60b6e15">Administrator (root)</h2>
<span class="anchor" id="line-16"></span><p class="line886">Most GNU/Linux distributions come with Apache pre-installed. There is, however, some variation as to where exactly the various Apache files are located. You should consult your distribution manual, or ask on the appropriate discussion board. In the following paragraphs, we assume a (quite standard) file system layout with: <span class="anchor" id="line-17"></span></p><span class="anchor" id="line-18"></span><ul><li><p class="line903"><tt class="backtick">/etc/httpd/httpd.conf</tt> - the main Apache configuration file <span class="anchor" id="line-19"></span></p></li><li><p class="line903"><tt class="backtick">/var/log/httpd/error_log</tt> - the log file containing Apache error messages <span class="anchor" id="line-20"></span></p><span class="anchor" id="line-21"></span></li></ul><p class="line879">Some distributions use <tt class="backtick">apache</tt> instead of <tt class="backtick">httpd</tt> for the directory names, others may use weirder settings. <span class="anchor" id="line-22"></span></p><span class="anchor" id="line-23"></span>
<h3 id="head-c27688fbe7f65d67190a47ce8d32eba244ab0d01">Create a wiki instance</h3>
<span class="anchor" id="line-24"></span><p class="line886">Creating a wiki instance involves copying files around and setting appropriate permissions. Before you can proceed, you need to know what user and group your Apache server runs as. The easiest way to know this is to issue this command: <span class="anchor" id="line-25"></span></p><span class="anchor" id="line-26"></span><span class="anchor" id="line-27"></span><pre>&gt; egrep "^User|^Group" /etc/httpd/httpd.conf
<span class="anchor" id="line-28"></span>User wwwrun
<span class="anchor" id="line-29"></span>Group nogroup
<span class="anchor" id="line-30"></span></pre><span class="anchor" id="line-31"></span><span class="anchor" id="line-32"></span><p class="line879">This shows a typical result: "<tt class="backtick">wwwrun.nogroup</tt>". Other common results are "<tt class="backtick">nobody.nogroup</tt>", "<tt class="backtick">apache.apache</tt>" and "<tt class="backtick">www-data.www-data</tt>". You can of course use your own. What matters is that you know which ones are in use, because you will need them to set file permissions. <span class="anchor" id="line-33"></span></p><span class="anchor" id="line-34"></span><p class="line879">Once you have gathered this information, read <a href="">../WikiInstanceCreation</a> and follow the steps described there. <span class="anchor" id="line-35"></span></p><span class="anchor" id="line-36"></span>
<h3 id="head-e3e9e08058bb0ae34c33f53367cd58d6c7411998">Install moin.cgi</h3>
<span class="anchor" id="line-37"></span><p class="line879">There is one last file you need to copy, the bridge between Apache and Moin<tt class="backtick"></tt>Moin: the CGI script that Apache will call every time a wiki page is requested, and that will in turn invoke all the Moin<tt class="backtick"></tt>Moin components to handle the request. You can actually put this script anywhere you like (all the paths to the files Moin<tt class="backtick"></tt>Moin needs can be configured to match your filesystem layout), but for the sake of simplicity and security, we suggest you follow the instructions below, unless you think you know better. <span class="anchor" id="line-38"></span></p><span class="anchor" id="line-39"></span><p class="line879">We will create a <tt class="backtick">cgi-bin</tt> subdirectory in the instance directory. Using the environment variables defined in <a href="">../WikiInstanceCreation</a>, run the following commands: <span class="anchor" id="line-40"></span></p><span class="anchor" id="line-41"></span><span class="anchor" id="line-42"></span><pre>&gt; cd $WIKILOCATION/$INSTANCE
<span class="anchor" id="line-43"></span>&gt; mkdir cgi-bin
<span class="anchor" id="line-44"></span>&gt; cp $SHARE/server/moin.cgi cgi-bin
<span class="anchor" id="line-45"></span>&gt; chown -R $USER.$GROUP cgi-bin
<span class="anchor" id="line-46"></span>&gt; chmod -R ug+rx cgi-bin
<span class="anchor" id="line-47"></span>&gt; chmod -R o-rwx cgi-bin
<span class="anchor" id="line-48"></span></pre><span class="anchor" id="line-49"></span><span class="anchor" id="line-50"></span>
<h3 id="head-408a7a283b2406c4e6b24646b25ec7996d5ff459">Configure moin.cgi</h3>
<span class="anchor" id="line-51"></span><p class="line879">When <tt class="backtick">moin.cgi</tt> is launched, it imports a Moin<tt class="backtick"></tt>Moin module that in turn imports other modules and the configuration file. While the Moin<tt class="backtick"></tt>Moin modules should always be found in a properly configured system (as described in <a href="">../BasicInstallation</a>), it is likely that the configuration file will not be found. Edit the <tt class="backtick">moin.cgi</tt> script to correct that. Add these lines near the top of the file: <span class="anchor" id="line-52"></span></p><span class="anchor" id="line-53"></span><span class="anchor" id="line-54"></span><pre>import sys
<span class="anchor" id="line-55"></span>sys.path.insert(0, '..')
<span class="anchor" id="line-56"></span></pre><span class="anchor" id="line-57"></span><span class="anchor" id="line-58"></span><p class="line879">You can also use the absolute name of the directory that contains the <tt class="backtick"></tt> file instead of <tt class="backtick">'..'</tt>. <span class="anchor" id="line-59"></span></p><span class="anchor" id="line-60"></span>
<h3 id="head-b02e2f66403a66cc3b1ff0ce2c7261cf44e4f0d4">Configure Apache</h3>
<span class="anchor" id="line-61"></span><p class="line886">Now that every file is in place and properly locked down (as far as the filesystem is concerned), we need to configure Apache so that it offers access to the right files, and no others. However, since the default Apache configuration varies a lot according to the distribution you use, and since administrators often make important additions and changes to it, we cannot give exact instructions that cover all cases. Instead, we will first describe roughly what needs to be done, and then give a few specific lines that you should add at the appropriate place in your Apache config. <span class="anchor" id="line-62"></span></p><span class="anchor" id="line-63"></span><p class="line886">Your Apache should be set up so that: <span class="anchor" id="line-64"></span></p><span class="anchor" id="line-65"></span><ul><li><p class="line886">Access to your instance directory is denied (sane Apache installations should actually deny access to the whole server, and then only allow a few specific directories). <span class="anchor" id="line-66"></span></p></li><li><p class="line879">An alias is set up to redirect requests from <tt class="backtick">/wiki/</tt> (in the URL) to the <tt class="backtick">htdocs</tt> directory (in the <tt class="backtick">share</tt> directory, as discussed at the bottom of <a href="">../BasicInstallation</a>) <span class="anchor" id="line-67"></span></p></li><li><p class="line879">A script alias is set up to redirect requests from whatever you want (we suggest you use your instance name, for example <tt class="backtick">/mywiki</tt>) to the CGI script you just copied. <span class="anchor" id="line-68"></span></p><span class="anchor" id="line-69"></span></li></ul><p class="line886">The following commands will add two lines at the bottom of your Apache config file. These lines only cover the last two items listed above. You have to check the first one by yourself (there is too much variation in Linux distributions). Note that you may have to move the two lines to the appropriate place in your config file -- maybe near other similar lines. <span class="anchor" id="line-70"></span></p><span class="anchor" id="line-71"></span><span class="anchor" id="line-72"></span><pre>&gt; echo "" &gt;&gt;/etc/httpd/httpd.conf
<span class="anchor" id="line-73"></span>&gt; echo "Alias /wiki/ \"$SHARE/htdocs/\"" &gt;&gt;/etc/httpd/httpd.conf
<span class="anchor" id="line-74"></span>&gt; echo "ScriptAlias /mywiki \"$WIKILOCATION/$INSTANCE/cgi-bin/moin.cgi\"" &gt;&gt;/etc/httpd/httpd.conf
<span class="anchor" id="line-75"></span></pre><span class="anchor" id="line-76"></span><span class="anchor" id="line-77"></span><p class="line879">You only need to define the alias for <tt class="backtick">htdocs</tt> once. You need to define a different script alias for each wiki instance you intend to run. <span class="anchor" id="line-78"></span></p><span class="anchor" id="line-79"></span>
<h3 id="head-ffa39b171f9d130bb07a8481a5fff1a5a9065e86">Configure MoinMoin</h3>
<span class="anchor" id="line-80"></span><p class="line879">Finally, check that the <tt class="backtick"></tt> file in the instance directory contains correct paths for the htdocs prefix, the instance data directory, and the instance underlay directory. You can use relative paths for the directories, but note that they are relative to the CGI script, not the configuration file! You can also use absolute paths, and save yourself some headaches. <span class="anchor" id="line-81"></span></p><span class="anchor" id="line-82"></span><p class="line886">Here are the settings you should have in the config file if you followed all our suggestions: <span class="anchor" id="line-83"></span></p><span class="anchor" id="line-84"></span><span class="anchor" id="line-85"></span><pre>    data_dir = '../data/'
<span class="anchor" id="line-86"></span>    data_underlay_dir = '../underlay/'
<span class="anchor" id="line-87"></span>    url_prefix = '/wiki'
<span class="anchor" id="line-88"></span></pre><span class="anchor" id="line-89"></span><span class="anchor" id="line-90"></span><p class="line879">There are other settings you will likely want to alter, look at the bottom of <a href="">../WikiInstanceCreation</a> for more details about them. <span class="anchor" id="line-91"></span></p><span class="anchor" id="line-92"></span>
<h3 id="head-0f7a0fb8dccf6a13b6042fa17e0d7cda751fe3f3">Test the wiki</h3>
<span class="anchor" id="line-93"></span><p class="line879">Everything should work fine now. It is time to <strong>restart the Apache server</strong> (usually with "<tt class="backtick">/etc/init.d/apache&nbsp;restart</tt>", sometimes with "<tt class="backtick">apachectl&nbsp;restart</tt>") and perform the following steps: <span class="anchor" id="line-94"></span></p><span class="anchor" id="line-95"></span><ul><li><p class="line879">Run the <em>Moin<tt class="backtick"></tt>Moin CGI Diagnosis</em>: connect to "<tt class="backtick"></tt>" (or the name and port you have defined in the Apache configuration file). Verify that the displayed information is correct. Check that the directories listed under <em>Checking directories...</em> are <em>OK</em>. <span class="anchor" id="line-96"></span></p></li><li><p class="line879">Access your new wiki with the URL "<tt class="backtick"></tt>" (or the name and port you have defined in the Apache configuration file). You should see the Front<tt class="backtick"></tt>Page. <span class="anchor" id="line-97"></span></p></li><li><p class="line886">If this is the case, try to edit it and save your changes. <span class="anchor" id="line-98"></span></p></li><li><p class="line879">If that works, see if your edit is reflected on the Recent<tt class="backtick"></tt>Changes page. <span class="anchor" id="line-99"></span></p></li><li><p class="line879">If you see them, congratulations, your new wiki works! <img alt=":)" height="15" src="wiki/htdocs/modern/img/smile.png" title=":)" width="15" /> <span class="anchor" id="line-100"></span></p><span class="anchor" id="line-101"></span></li></ul><p class="line886">If something goes wrong, have a look at Troubleshooting, at the bottom of this page. <span class="anchor" id="line-102"></span></p><span class="anchor" id="line-103"></span>
<h3 id="head-52920da3312438e6a484347d4dfaa369b86cb521">Apache tricks</h3>
<span class="anchor" id="line-104"></span><p class="line879">For more advanced configuration and some tricks see <a href="">HelpMiscellaneous</a>. <span class="anchor" id="line-105"></span></p><span class="anchor" id="line-106"></span>
<h2 id="head-e559f024646d8751eee1135ad5423247d72ab7fd">Simple user (home directory installation)</h2>
<span class="anchor" id="line-107"></span><p class="line879">On machines shared by many people, simple users typically have no access to the root account, cannot modify the <tt class="backtick">httpd.conf</tt> file, and cannot copy files into the system-wide <tt class="backtick">cgi-bin</tt> and <tt class="backtick">htdocs</tt> directories. In that case, Apache can be set up so that each user can host a web site in the home directory of his or her shell account, using the <tt class="backtick">UserDir</tt> directive. If the machine administrator decides to use it, all URLs that start with "<tt class="backtick">/~username</tt>" will be redirected to a directory in the users' home directories, where they have write permission and can install Moin<tt class="backtick"></tt>Moin. <span class="anchor" id="line-108"></span></p><span class="anchor" id="line-109"></span><p class="line879">As an example, we will consider the case of a user named "<tt class="backtick">mm</tt>". Of course, wherever you see "<tt class="backtick">mm</tt>" below, you will replace it with your own username. <span class="anchor" id="line-110"></span></p><span class="anchor" id="line-111"></span>
<h3 id="head-6a39e2829f37fd34c569c2ffa768c9b3ec2289cc">Make sure /~username works</h3>
<span class="anchor" id="line-112"></span><p class="line879">The home directory installation can only work if the administrator (root) has allowed it. So, the first step is of course to check that it works. Typically, Apache is set up so that the <tt class="backtick">public_html</tt> subdirectory in the home directory is used as the web site root. So, the first first step is to check if that directory exists. <span class="anchor" id="line-113"></span></p><span class="anchor" id="line-114"></span><span class="anchor" id="line-115"></span><pre>&gt; ls -ld ~/public_html
<span class="anchor" id="line-116"></span>drwxr-xr-x   2 mm       users        4096 Nov 30 00:29 public_html
<span class="anchor" id="line-117"></span></pre><span class="anchor" id="line-118"></span><span class="anchor" id="line-119"></span><p class="line886">If the directory does not exist, create it, and be sure it can be read and entered by the web server. <span class="anchor" id="line-120"></span></p><span class="anchor" id="line-121"></span><span class="anchor" id="line-122"></span><pre>&gt; mkdir public_html
<span class="anchor" id="line-123"></span>&gt; chmod a+rx public_html
<span class="anchor" id="line-124"></span>&gt; ls -ld ~/public_html
<span class="anchor" id="line-125"></span>drwxr-xr-x   2 mm       users        4096 Nov 30 00:35 public_html
<span class="anchor" id="line-126"></span></pre><span class="anchor" id="line-127"></span><span class="anchor" id="line-128"></span><p class="line879">Now, check if the "<tt class="backtick">/~mm</tt>" URL works: <span class="anchor" id="line-129"></span></p><span class="anchor" id="line-130"></span><span class="anchor" id="line-131"></span><pre>&gt; lynx -error_file=/dev/stderr -dump http://localhost/~mm/ &gt;/dev/null
<span class="anchor" id="line-132"></span>URL=http://localhost/~mm/ (GET)
<span class="anchor" id="line-133"></span>STATUS=HTTP/1.1 200 OK
<span class="anchor" id="line-134"></span></pre><span class="anchor" id="line-135"></span><span class="anchor" id="line-136"></span><p class="line879">If you get a "<tt class="backtick">200&nbsp;OK</tt>" response code, then it works, and you can go on to the next check. If you get a "<tt class="backtick">403&nbsp;Forbidden</tt>" or a "<tt class="backtick">404&nbsp;Not&nbsp;Found</tt>" response, then maybe something is wrong with your directory, or maybe the whole thing has not been enabled by your administrator. <span class="anchor" id="line-137"></span></p><span class="anchor" id="line-138"></span><ul><li><p class="line879">Check the permissions for your home directory (<tt class="backtick">~</tt>) and your <tt class="backtick">public_html</tt> directory. The first one should at least end with "<tt class="backtick">--x</tt>", and the second one, as we saw above, with "<tt class="backtick">r-x</tt>". <span class="anchor" id="line-139"></span></p></li><li><p class="line879">It also possible that the administrator has set up another name for the personal web site directory. "<tt class="backtick">public_html</tt>" is just the usual default, but anything can actually be used. There is no way to know, you have to ask the administrator (root). <span class="anchor" id="line-140"></span></p></li><li><p class="line886">Finally, if the personal web site feature is disabled, maybe you can ask the administrator to enable it? <span class="anchor" id="line-141"></span></p><span class="anchor" id="line-142"></span></li></ul><p class="line886">Once you have checked you can read the files in the directory, you need to check that you are also able to execute CGI scripts in that directory. Use the following commands to create a simple CGI script in the appropriate location: <span class="anchor" id="line-143"></span></p><span class="anchor" id="line-144"></span><span class="anchor" id="line-145"></span><pre>&gt; mkdir -p ~/public_html/cgi-bin
<span class="anchor" id="line-146"></span>&gt; cat &gt; ~/public_html/cgi-bin/test.cgi
<span class="anchor" id="line-147"></span>#!/bin/sh
<span class="anchor" id="line-148"></span>echo Content-Type: text/plain
<span class="anchor" id="line-149"></span>echo
<span class="anchor" id="line-150"></span>echo "CGI scripts work"
<span class="anchor" id="line-151"></span>&lt;CTRL-D&gt;
<span class="anchor" id="line-152"></span>&gt; chmod a+rx ~/public_html/cgi-bin/test.cgi
<span class="anchor" id="line-153"></span>&gt; lynx -dump http://localhost/~jh/cgi-bin/test.cgi
<span class="anchor" id="line-154"></span>CGI scripts work
<span class="anchor" id="line-155"></span></pre><span class="anchor" id="line-156"></span><span class="anchor" id="line-157"></span><p class="line879">If you get anything else than "<tt class="backtick">CGI&nbsp;scripts&nbsp;work</tt>", then something went wrong. Check the directory permissions as above, try other names (or ask about them). The sad truth might be that you are not allowed to execute CGI scripts. You would then have to ask the administrator (root) for that permission. <span class="anchor" id="line-158"></span></p><span class="anchor" id="line-159"></span><p class="line879">Once you get it, you can set up your wiki instance in the <tt class="backtick">public_html</tt> directory. <img alt=":)" height="15" src="wiki/htdocs/modern/img/smile.png" title=":)" width="15" /> <span class="anchor" id="line-160"></span></p><span class="anchor" id="line-161"></span>
<h3 id="head-c27688fbe7f65d67190a47ce8d32eba244ab0d01-2">Create a wiki instance</h3>
<span class="anchor" id="line-162"></span><p class="line879">Creating a wiki instance involves copying files around and setting appropriate permissions. Read <a href="">../WikiInstanceCreation</a> and follow the steps described there. <span class="anchor" id="line-163"></span></p><span class="anchor" id="line-164"></span>
<h3 id="head-ec9ce458a3f08281e5906f6d1e2e5cc008d620db">Install the htdocs files</h3>
<span class="anchor" id="line-165"></span><p class="line879">The web server needs to access these files, so we need to copy them in the "<tt class="backtick">public_html</tt>" directory. Just use this: <span class="anchor" id="line-166"></span></p><span class="anchor" id="line-167"></span><span class="anchor" id="line-168"></span><pre>&gt; cd ~/public_html
<span class="anchor" id="line-169"></span>&gt; cp -R ~/share/moin/htdocs wiki
<span class="anchor" id="line-170"></span>&gt; chmod -R a+rX wiki
<span class="anchor" id="line-171"></span></pre><span class="anchor" id="line-172"></span><span class="anchor" id="line-173"></span>
<h3 id="head-e3e9e08058bb0ae34c33f53367cd58d6c7411998-2">Install moin.cgi</h3>
<span class="anchor" id="line-174"></span><p class="line879">There is one last file you need to copy, the bridge between Apache and Moin<tt class="backtick"></tt>Moin: the CGI script that Apache will call every time a wiki page is requested, and that will in turn invoke all the Moin<tt class="backtick"></tt>Moin components to handle the request. You need to put this file in a directory for which CGI scripts execution is enabled. By default, this should work: <span class="anchor" id="line-175"></span></p><span class="anchor" id="line-176"></span><span class="anchor" id="line-177"></span><pre>&gt; cd ~/public_html
<span class="anchor" id="line-178"></span>&gt; mkdir cgi-bin
<span class="anchor" id="line-179"></span>&gt; cp $SHARE/server/moin.cgi cgi-bin
<span class="anchor" id="line-180"></span>&gt; chmod -R a+rx cgi-bin
<span class="anchor" id="line-181"></span></pre><span class="anchor" id="line-182"></span><span class="anchor" id="line-183"></span>
<h3 id="head-408a7a283b2406c4e6b24646b25ec7996d5ff459-2">Configure moin.cgi</h3>
<span class="anchor" id="line-184"></span><p class="line879">When <tt class="backtick">moin.cgi</tt> is launched, it imports a Moin<tt class="backtick"></tt>Moin module (that in turn imports other modules and the configuration file). Since everything has been installed in your home directory, it is likely none of these will be found. Edit the <tt class="backtick">moin.cgi</tt> script to correct that. Add these lines near the top of the file: <span class="anchor" id="line-185"></span></p><span class="anchor" id="line-186"></span><span class="anchor" id="line-187"></span><pre>import sys
<span class="anchor" id="line-188"></span>sys.path.insert(0, '/home/mm/lib/python2.3')
<span class="anchor" id="line-189"></span>sys.path.insert(0, '/home/mm/lib/python2.3/site-packages')
<span class="anchor" id="line-190"></span>sys.path.insert(0, '/home/mm/share/moin/mywiki')
<span class="anchor" id="line-191"></span></pre><span class="anchor" id="line-192"></span><span class="anchor" id="line-193"></span><p class="line879">Of course, you need to adapt the paths to your situation. The first two lines should help locate the Moin<tt class="backtick"></tt>Moin modules, the last one should help locate the <tt class="backtick"></tt> file. <span class="anchor" id="line-194"></span></p><span class="anchor" id="line-195"></span><p class="line903"><strong>Note:</strong> You might also need to edit the first line of the file, to point to the correct version of Python. The default should be fine, but a line like "<tt class="backtick">#!&nbsp;/usr/bin/python2.3</tt>" might help you if the default does not work. <span class="anchor" id="line-196"></span></p><span class="anchor" id="line-197"></span><p class="line903"><strong>Note 2:</strong> In this file there is a line reading <tt>request&nbsp;=&nbsp;RequestCGI()</tt>. If you have a complex mod_rewrite case, you might want to add <tt>properties&nbsp;=&nbsp;{'script_name':&nbsp;'/mywiki'}&nbsp;</tt> in the parenthesis. This will let <a href="">MoinMoin</a> generate URLs that start with <tt>/mywiki</tt> and not the path that the webserver passed to <a href="">MoinMoin</a>: <span class="anchor" id="line-198"></span></p><span class="anchor" id="line-199"></span><span class="anchor" id="line-200"></span><pre>def handle_request(req, env, form):
<span class="anchor" id="line-201"></span>    request = RequestCGI(req, env, form, properties = {'script_name': '/mywiki'})
<span class="anchor" id="line-202"></span>
<span class="anchor" id="line-203"></span></pre><span class="anchor" id="line-204"></span><span class="anchor" id="line-205"></span>
<h3 id="head-ffa39b171f9d130bb07a8481a5fff1a5a9065e86-2">Configure MoinMoin</h3>
<span class="anchor" id="line-206"></span><p class="line879">Finally, check that the <tt class="backtick"></tt> file in the instance directory contains correct paths for the htdocs directory, the instance data directory, and the instance underlay directory. You can use relative paths for the directories, but note that they are relative to the CGI script, not the configuration file! You can also use absolute paths, and save yourself some headaches. <span class="anchor" id="line-207"></span></p><span class="anchor" id="line-208"></span><span class="anchor" id="line-209"></span><pre>    data_dir = '/home/mm/share/moin/mywiki/data/'
<span class="anchor" id="line-210"></span>    data_underlay_dir = '/home/mm/share/moin/mywiki/underlay/'
<span class="anchor" id="line-211"></span>    url_prefix = '/~mm/wiki'
<span class="anchor" id="line-212"></span></pre><span class="anchor" id="line-213"></span><span class="anchor" id="line-214"></span>
<h3 id="head-0f7a0fb8dccf6a13b6042fa17e0d7cda751fe3f3-2">Test the wiki</h3>
<span class="anchor" id="line-215"></span><p class="line886">Everything should work fine, now. It is time to perform the following steps: <span class="anchor" id="line-216"></span></p><span class="anchor" id="line-217"></span><ul><li><p class="line879">Run the <em>Moin<tt class="backtick"></tt>Moin CGI Diagnosis</em>: <tt>&gt;&nbsp;lynx&nbsp;-dump&nbsp;http://localhost/~mm/cgi-bin/moin.cgi?action=test</tt> <span class="anchor" id="line-218"></span></p></li><li><p class="line879">If it worked, try to access your new-born wiki with the URL "<tt class="backtick"></tt>". You should see the Front<tt class="backtick"></tt>Page. <span class="anchor" id="line-219"></span></p></li><li><p class="line886">If this is the case, try to edit it and save your changes. <span class="anchor" id="line-220"></span></p></li><li><p class="line879">If that works, see if your edit is reflected on the Recent<tt class="backtick"></tt>Changes page. <span class="anchor" id="line-221"></span></p></li><li><p class="line879">If you see them, congratulations, you have a new wiki! <img alt=":)" height="15" src="wiki/htdocs/modern/img/smile.png" title=":)" width="15" /> <span class="anchor" id="line-222"></span></p><span class="anchor" id="line-223"></span></li></ul><p class="line886">If something goes wrong, have a look at Troubleshooting, below. <span class="anchor" id="line-224"></span></p><span class="anchor" id="line-225"></span>
<h2 id="head-3f286acb05ce4ad64240f788c78a8f915f59e34e">Troubleshooting</h2>
<span class="anchor" id="line-226"></span><p class="line879">See also <a href="">../TroubleShooting</a> for generic stuff. <span class="anchor" id="line-227"></span></p><span class="anchor" id="line-228"></span><p class="line879">The first thing to do when your wiki does not work as expected is to issue the command "<tt class="backtick">tail&nbsp;/var/log/httpd/error_log</tt>" to display the most recent errors. Usually, you will get a hint on what went wrong, like missing file system permissions. <span class="anchor" id="line-229"></span></p><span class="anchor" id="line-230"></span>
<h3 id="head-b8c0d1c1aba9cd39d0d15f86ea33025f7f25d48d">Adding permission to serve the htdocs directory</h3>
<span class="anchor" id="line-231"></span><p class="line879">In some (sane) Linux distributions (like SuSE 9.0) serving directories other than the document-root "<tt class="backtick">/srv/www/htdocs</tt>" with Apache is switched off by default for security reasons in "<tt class="backtick">/etc/httpd/httpd.conf</tt>" (or for Apache2 "<tt class="backtick">/etc/apache2/httpd.conf</tt>"): <span class="anchor" id="line-232"></span></p><span class="anchor" id="line-233"></span><span class="anchor" id="line-234"></span><pre># forbid access to the entire filesystem by default
<span class="anchor" id="line-235"></span>&lt;Directory /&gt;
<span class="anchor" id="line-236"></span>  Options None
<span class="anchor" id="line-237"></span>  AllowOverride None
<span class="anchor" id="line-238"></span>  Order deny,allow
<span class="anchor" id="line-239"></span>  Deny from all
<span class="anchor" id="line-240"></span>&lt;/Directory&gt;
<span class="anchor" id="line-241"></span></pre><span class="anchor" id="line-242"></span><span class="anchor" id="line-243"></span><p class="line879">To allow Apache to serve directories outside of the document root you have to add these lines to "<tt class="backtick">/etc/httpd/httpd.conf</tt>" (in SuSE it is recommended to create a new "<tt class="backtick">http.conf.local</tt>" and include this file in "<tt class="backtick">/etc/sysconfig/apache2</tt>"): <span class="anchor" id="line-244"></span></p><span class="anchor" id="line-245"></span><span class="anchor" id="line-246"></span><pre>Alias /wiki/ "/usr/share/moin/htdocs/"
<span class="anchor" id="line-247"></span>&lt;Directory "/usr/share/moin/htdocs/"&gt;
<span class="anchor" id="line-248"></span>   Order deny,allow
<span class="anchor" id="line-249"></span>   Allow from all
<span class="anchor" id="line-250"></span>&lt;/Directory&gt;
<span class="anchor" id="line-251"></span>
<span class="anchor" id="line-252"></span>ScriptAlias /mywiki "/usr/share/moin/mywiki/cgi-bin/moin.cgi"
<span class="anchor" id="line-253"></span>&lt;Directory "/usr/share/moin/mywiki/cgi-bin"&gt;
<span class="anchor" id="line-254"></span>   Order deny,allow
<span class="anchor" id="line-255"></span>   Allow from all
<span class="anchor" id="line-256"></span>&lt;/Directory&gt;
<span class="anchor" id="line-257"></span></pre><span class="anchor" id="line-258"></span><span class="anchor" id="line-259"></span><p class="line886">Of course, you need to adapt the paths to your particular situation. <span class="anchor" id="line-260"></span></p><span class="anchor" id="bottom_Include_HelpOnInstalling/ApacheOnLinux"></span></div> <span class="anchor" id="line-54"></span></p><hr class="hr2" /><p class="line886"> <span class="anchor" id="line-55"></span><span class="anchor" id="fastcgi-install"></span> <span class="anchor" id="line-56"></span> <span class="anchor" id="line-57"></span></p><hr class="hr2" /><p class="line886"> <span class="anchor" id="line-58"></span><span class="anchor" id="modpy-install"></span> <span class="anchor" id="line-59"></span>
<h1>mod_python Setup using Apache</h1>
<div dir="ltr" id="Include_HelpOnInstalling/ApacheWithModPython" lang="en"><span class="anchor" id="top_Include_HelpOnInstalling/ApacheWithModPython"></span>
<span class="anchor" id="line-8"></span><span class="anchor" id="line-9"></span><ol><li><a href="#head-4e6235e8e3535359b4aa9df9722961dfd62a685a">Why Use mod_python</a></li><li><a href="#head-52f515a2448d32357136b23a188dd227330baeb2">Basic configuring</a><ol><li><a href="#head-8cd6758d1fcc77b433f6584bcc34e24469568d75">Install mod_python</a></li><li><a href="#head-671adcfb8441deb9daa6ba877d59cc69d5e9d25e">Set up a wiki instance</a></li><li><a href="#head-08923628c7a5b449b5f210251334c431791adec9">Edit ``</a></li><li><a href="#head-b628477f88ab294636a22af4ee665656a8897b3a">Changes to Apache `httpd.conf`</a></li></ol><li><a href="#head-2dba68d0d0ad069f1c4a2a46bcdbd07cb21d3887">Solving problems for non-root-mounted wikis</a></li><li><a href="#head-e7e935fbfb5a81ceb0698ef82b5b7a897aa5e157">Configuring root wiki</a></li><li><a href="#head-53a11a51ff1c262df8f1f287084f8700685446d4">Older mod_python versions</a><ol><li><a href="#head-7b2283d5184932488fe551b2cee08e28fb18230c">Use a wrapper script</a></li><li><a href="#head-f2a32b29f0aff0101a91c87d692d063a6e0a4ec2">Fix mod_python</a></li></ol><li><a href="#head-17313e33f7320af70773f484730b290d86b62ee5">Troubleshooting</a></li></ol> <span class="anchor" id="line-10"></span><span class="anchor" id="line-11"></span>
<h1 id="head-4e6235e8e3535359b4aa9df9722961dfd62a685a">Why Use mod_python</h1>
<span class="anchor" id="line-12"></span><span class="anchor" id="line-13"></span><p class="line903"><a class="http" href="">mod_python</a> embeds the python interpreter into <span class="anchor" id="line-14"></span>the apache server. This saves initialization time and the need of <span class="anchor" id="line-15"></span>forking cgi scripts. It doesn't have the ability to run as different <span class="anchor" id="line-16"></span>users. It will always run as the main apache user and group. Be sure <span class="anchor" id="line-17"></span>that your wiki data files are accessible and writable by your apache <span class="anchor" id="line-18"></span>server. <span class="anchor" id="line-19"></span></p><span class="anchor" id="line-20"></span><p class="line903"><img alt="&lt;!&gt;" height="15" src="wiki/htdocs/modern/img/attention.png" title="&lt;!&gt;" width="15" /> The basic configuration is suitable for mod_python 3.1.3 and later. If you use older version, see the section "Older mod_python versions" <span class="anchor" id="line-21"></span></p><span class="anchor" id="line-22"></span><p class="line903"><img alt="&lt;!&gt;" height="15" src="wiki/htdocs/modern/img/attention.png" title="&lt;!&gt;" width="15" /> mod_python will cause your apache processes to increase their <span class="anchor" id="line-23"></span>memory requirements considerably - especially as apache runs many <span class="anchor" id="line-24"></span>separate processes which will each need to have their own copy of the <span class="anchor" id="line-25"></span>python code and data in the process memory space.  You may find that <span class="anchor" id="line-26"></span>FastCGI, as detailed in <a class="nonexistent nonexistent" href="">HelpOnInstalling/ApacheWithFastCgi</a> is rather <span class="anchor" id="line-27"></span>more efficient in this respect. <span class="anchor" id="line-28"></span></p><span class="anchor" id="line-29"></span>
<h1 id="head-52f515a2448d32357136b23a188dd227330baeb2">Basic configuring</h1>
<span class="anchor" id="line-30"></span><span class="anchor" id="line-31"></span><ol type="1"><li><p class="line886">Install mod_python <span class="anchor" id="line-32"></span></p></li><li><p class="line886">Set up a wiki instance <span class="anchor" id="line-33"></span></p></li><li><p class="line879">Edit <tt class="backtick"></tt> <span class="anchor" id="line-34"></span></p></li><li><p class="line879">Changes to Apache <tt class="backtick">httpd.conf</tt> <span class="anchor" id="line-35"></span></p></li><li><p class="line886">Restart Apache <span class="anchor" id="line-36"></span></p><span class="anchor" id="line-37"></span></li></ol><p class="line879">The sample configurations below are for a wiki instance called <tt class="backtick">mywiki</tt> installed in a directory <tt class="backtick">/var/www/moin/mywiki</tt> with the main <a href="">MoinMoin</a> installation installed in python's default site library path. The wiki appears as URL <tt class="backtick">/mywiki</tt> under the server - ie <tt class="backtick">http://my.ser.ver/mywiki</tt>.  You will need to change these to reflect your installation. <span class="anchor" id="line-38"></span></p><span class="anchor" id="line-39"></span>
<h2 id="head-8cd6758d1fcc77b433f6584bcc34e24469568d75">Install mod_python</h2>
<span class="anchor" id="line-40"></span><span class="anchor" id="line-41"></span><p class="line879">Most people will just add a <tt class="backtick">mod_python</tt> package to their current operating system installation.  If you are building from source then you should consult the <a class="http" href="">mod_python documentation</a>. <span class="anchor" id="line-42"></span></p><span class="anchor" id="line-43"></span><p class="line879">The mod_python installation should have added some lines to the Apache configuration file - either in the file itself or in an included configuration file (for example on Red Hat or Fedora linux the mod_python configuration is in <tt class="backtick">/etc/httpd/conf.d/python.conf</tt>). <span class="anchor" id="line-44"></span></p><span class="anchor" id="line-45"></span><p class="line879">Make sure you have this line in <tt class="backtick">httpd.conf</tt> or mod_python will not work: <span class="anchor" id="line-46"></span><span class="anchor" id="line-47"></span></p><pre>LoadModule python_module modules/
<span class="anchor" id="line-48"></span></pre><span class="anchor" id="line-49"></span><span class="anchor" id="line-50"></span><p class="line886">After this restart Apache and make sure that it starts successfully, and that the error log has a line similar to this:- <span class="anchor" id="line-51"></span><span class="anchor" id="line-52"></span></p><pre>[Sat Jan 01 15:40:49 2005] [notice] mod_python: Creating 4 session mutexes based on 150 max processes and 0 max threads.
<span class="anchor" id="line-53"></span></pre><span class="anchor" id="line-54"></span><span class="anchor" id="line-55"></span><p class="line886">You may need to change some environment variables on (eg) FreeBSD - this is detailed in the port installation message. <span class="anchor" id="line-56"></span></p><span class="anchor" id="line-57"></span>
<h2 id="head-671adcfb8441deb9daa6ba877d59cc69d5e9d25e">Set up a wiki instance</h2>
<span class="anchor" id="line-58"></span><span class="anchor" id="line-59"></span><p class="line879">This is done as shown in <a href="">WikiInstanceCreation</a>. Its recommended to first configure the wiki with cgi and check that it works, then change the configuratin to use mod_python. This allows you be sure that any problems are in the mod_python transition rather than the basic <a href="">MoinMoin</a> installation. <span class="anchor" id="line-60"></span></p><span class="anchor" id="line-61"></span><ol type="1"><li><p class="line886">Copy moin.cgi into your wiki directory <span class="anchor" id="line-62"></span></p></li><li><p class="line879">Configure <tt class="backtick">httpd.conf</tt> as cgi first: <span class="anchor" id="line-63"></span></p><ul><li style="list-style-type:none"><span class="anchor" id="line-64"></span><pre>Alias /wiki/ "/usr/share/moin/htdocs/"
<span class="anchor" id="line-65"></span>ScriptAlias /mywiki "/var/www/moin/mywiki/moin.cgi"
<span class="anchor" id="line-66"></span></pre><span class="anchor" id="line-67"></span><span class="anchor" id="line-68"></span></li></ul></li></ol><p class="line886">Restart Apache and make test that your wiki works. <span class="anchor" id="line-69"></span></p><span class="anchor" id="line-70"></span>
<h2 id="head-08923628c7a5b449b5f210251334c431791adec9">Edit ``</h2>
<span class="anchor" id="line-71"></span><span class="anchor" id="line-72"></span><p class="line886">Make sure you use only absolute paths - relative paths will not work! <span class="anchor" id="line-73"></span><span class="anchor" id="line-74"></span></p><pre>data_dir = '/var/www/moin/mywiki/data/'
<span class="anchor" id="line-75"></span>data_underlay_dir = '/var/www/moin/mywiki/underlay/'
<span class="anchor" id="line-76"></span></pre><span class="anchor" id="line-77"></span><span class="anchor" id="line-78"></span><p class="line886">If you do not want to use absolute paths, you can use Python's os module to construct the relative paths: <span class="anchor" id="line-79"></span></p><pre>import os 
<span class="anchor" id="line-80"></span>data_dir = os.path.join(os.path.dirname(__file__), 'data/')
<span class="anchor" id="line-81"></span>data_underlay_dir = os.path.join(os.path.dirname(__file__), 'underlay/')
<span class="anchor" id="line-82"></span></pre><span class="anchor" id="line-83"></span><span class="anchor" id="line-84"></span><p class="line886">Test that the wiki works after this change. <span class="anchor" id="line-85"></span></p><span class="anchor" id="line-86"></span><ul><li style="list-style-type:none"><p class="line903"><img alt="(!)" height="15" src="wiki/htdocs/modern/img/idea.png" title="(!)" width="15" /> In 1.2 and earlyer, the configuration file is called <tt class="backtick"></tt>. <span class="anchor" id="line-87"></span></p><span class="anchor" id="line-88"></span></li></ul>
<h2 id="head-b628477f88ab294636a22af4ee665656a8897b3a">Changes to Apache `httpd.conf`</h2>
<span class="anchor" id="line-89"></span><span class="anchor" id="line-90"></span><p class="line886">After your wiki is running as cgi script, convert it to run with mod_python.  <span class="anchor" id="line-91"></span></p><span class="anchor" id="line-92"></span><p class="line879">If you run your wiki as cgi as we recommended before, remove or comment the <a class="nonexistent nonexistent" href="">ScriptAlias</a> directive: <span class="anchor" id="line-93"></span><span class="anchor" id="line-94"></span></p><pre>#ScriptAlias /mywiki "/var/www/moin/mywiki/moin.cgi"
<span class="anchor" id="line-95"></span></pre><span class="anchor" id="line-96"></span><span class="anchor" id="line-97"></span><p class="line879">Add a <tt class="backtick">Location</tt> directive: <span class="anchor" id="line-98"></span><span class="anchor" id="line-99"></span></p><pre>&lt;Location /mywiki&gt;
<span class="anchor" id="line-100"></span>    SetHandler python-program
<span class="anchor" id="line-101"></span>    # Add the path of your wiki directory
<span class="anchor" id="line-102"></span>    PythonPath "['/var/www/moin/mywiki'] + sys.path"
<span class="anchor" id="line-103"></span>    PythonHandler
<span class="anchor" id="line-104"></span>&lt;/Location&gt;
<span class="anchor" id="line-105"></span></pre><span class="anchor" id="line-106"></span><span class="anchor" id="line-107"></span><p class="line879">If you have multiple <a href="">MoinMoin</a> instances then add one location directive for each one (changing the paths as appropriate) and add a line with the directive <tt class="backtick">PythonInterpreter&nbsp;mywiki</tt> to each Location section. With this directive different subinterpreters with completely separate namespaces will be used for each wiki (see <a class="http" href="">here</a> for details). <span class="anchor" id="line-108"></span></p><span class="anchor" id="line-109"></span><p class="line879">If you did not install <a href="">MoinMoin</a> in the default location, you will have to add the path to <a href="">MoinMoin</a> to the system path: <span class="anchor" id="line-110"></span><span class="anchor" id="line-111"></span></p><pre>    PythonPath "['/var/www/moin/mywiki', '/prefix/lib/python2.x/site-packages'] + sys.path"
<span class="anchor" id="line-112"></span></pre><span class="anchor" id="line-113"></span><span class="anchor" id="line-114"></span><p class="line886">Restart Apache - everything should now work correctly. <span class="anchor" id="line-115"></span></p><span class="anchor" id="line-116"></span>
<h1 id="head-2dba68d0d0ad069f1c4a2a46bcdbd07cb21d3887">Solving problems for non-root-mounted wikis</h1>
<span class="anchor" id="line-117"></span><span class="anchor" id="line-118"></span><ul><li style="list-style-type:none"><p class="line903"><img alt="/!\" height="15" src="wiki/htdocs/modern/img/alert.png" title="/!\" width="15" /> If your wiki does not have a root URL (like <tt class="backtick"></tt>), then you might need to follow the next steps: <span class="anchor" id="line-119"></span></p><span class="anchor" id="line-120"></span></li></ul><p class="line879">On some installations, mod_python hands <a href="">MoinMoin</a> incorrect script_name and path_info. It usually happens when using the Apache Location directive, with a wiki in an arbitary path: <span class="anchor" id="line-121"></span><span class="anchor" id="line-122"></span></p><pre>&lt;Location /farm/mywiki&gt;
<span class="anchor" id="line-123"></span>    ...
<span class="anchor" id="line-124"></span>&lt;/Location&gt;
<span class="anchor" id="line-125"></span></pre><span class="anchor" id="line-126"></span><p class="line886">This will not work, because its not clear what is the script name, since with location setup, there is no real script. <span class="anchor" id="line-127"></span></p><span class="anchor" id="line-128"></span><p class="line879">To solve this problem, use a <tt class="backtick">PythonOption</tt> directive: <span class="anchor" id="line-129"></span><span class="anchor" id="line-130"></span></p><pre>&lt;Location /farm/mywiki&gt;
<span class="anchor" id="line-131"></span>    # Location value must match the Apache Location value!
<span class="anchor" id="line-132"></span>    PythonOption Location /farm/mywiki
<span class="anchor" id="line-133"></span>    ...
<span class="anchor" id="line-134"></span>&lt;/Location&gt;
<span class="anchor" id="line-135"></span></pre><span class="anchor" id="line-136"></span><ul><li style="list-style-type:none"><p class="line903"><img alt="(!)" height="15" src="wiki/htdocs/modern/img/idea.png" title="(!)" width="15" /> New in release 1.3.5 <span class="anchor" id="line-137"></span></p><span class="anchor" id="line-138"></span></li></ul>
<h1 id="head-e7e935fbfb5a81ceb0698ef82b5b7a897aa5e157">Configuring root wiki</h1>
<span class="anchor" id="line-139"></span><span class="anchor" id="line-140"></span><p class="line879">You may wish to have your wiki appearing at the root of your webserver - for example so that <tt class="backtick"></tt> will map to your wiki rather than having to use <tt class="backtick"></tt>.  This requires a slightly different form of configuration using <tt class="backtick">mod_rewrite</tt> - this is a standard module of recent Apache distributions, and is often enabled by default. <span class="anchor" id="line-141"></span></p><span class="anchor" id="line-142"></span><p class="line879">You need to set up your wiki instance as described above, and also copy <tt class="backtick"></tt> from the Moin installation directory to the wiki instance directory (<tt class="backtick">/var/www/moin/mywiki</tt> in these examples). <span class="anchor" id="line-143"></span></p><span class="anchor" id="line-144"></span><p class="line879">The Apache configuration needs <tt class="backtick">mod_rewrite</tt> enabled - so the line <span class="anchor" id="line-145"></span><span class="anchor" id="line-146"></span></p><pre>LoadModule rewrite_module modules/
<span class="anchor" id="line-147"></span></pre><span class="anchor" id="line-148"></span><p class="line879">should appear in the first part of the <tt class="backtick">httpd.conf</tt> configuration file. <span class="anchor" id="line-149"></span></p><span class="anchor" id="line-150"></span><p class="line886">The wiki and virtual host configuration sould look like this:- <span class="anchor" id="line-151"></span><span class="anchor" id="line-152"></span></p><pre>&lt;VirtualHost *:80&gt;
<span class="anchor" id="line-153"></span>  ServerAdmin
<span class="anchor" id="line-154"></span>  DocumentRoot /var/www/html
<span class="anchor" id="line-155"></span>  ServerName
<span class="anchor" id="line-156"></span>  Alias /wiki/ "/usr/share/moin/htdocs/"
<span class="anchor" id="line-157"></span>
<span class="anchor" id="line-158"></span>  # Rewrite urls
<span class="anchor" id="line-159"></span>  RewriteEngine On
<span class="anchor" id="line-160"></span>  RewriteLogLevel 0
<span class="anchor" id="line-161"></span>  # map /wiki static files to Moin htdocs
<span class="anchor" id="line-162"></span>  RewriteRule ^/wiki/(.*)$ /usr/share/moin/htdocs/$1 [last]
<span class="anchor" id="line-163"></span>  RewriteRule ^/robots.txt$ /usr/share/moin/htdocs/robots.txt [last]
<span class="anchor" id="line-164"></span>  RewriteRule ^/favicon.ico$ /usr/share/moin/htdocs/favicon.ico [last]
<span class="anchor" id="line-165"></span>  # map everything else to server script
<span class="anchor" id="line-166"></span>  RewriteRule ^(.*)$ /var/www/moin/mywiki/$1
<span class="anchor" id="line-167"></span>
<span class="anchor" id="line-168"></span>  &lt;Directory "/var/www/moin/testwiki"&gt;
<span class="anchor" id="line-169"></span>    # Modpy stuff
<span class="anchor" id="line-170"></span>    AddHandler python-program .py
<span class="anchor" id="line-171"></span>    # Add the path to the wiki directory, where
<span class="anchor" id="line-172"></span>    # and are located.
<span class="anchor" id="line-173"></span>    PythonPath "['/var/www/moin/mywiki'] + sys.path"
<span class="anchor" id="line-174"></span>    PythonHandler moinmodpy
<span class="anchor" id="line-175"></span>  &lt;/Directory&gt;
<span class="anchor" id="line-176"></span>&lt;/VirtualHost&gt;
<span class="anchor" id="line-177"></span></pre><span class="anchor" id="line-178"></span><span class="anchor" id="line-179"></span><p class="line879">Apache should be restarted, and the FrontPage of <tt class="backtick">mywiki</tt> should now appear at <tt class="backtick"></tt>. <span class="anchor" id="line-180"></span></p><span class="anchor" id="line-181"></span><p class="line879">Other ways of handling root level wikis with Apache are detailed in the appropriately named <a href="">HelpOnConfiguration/ApacheVoodoo</a>. <span class="anchor" id="line-182"></span></p><span class="anchor" id="line-183"></span>
<h1 id="head-53a11a51ff1c262df8f1f287084f8700685446d4">Older mod_python versions</h1>
<span class="anchor" id="line-184"></span><span class="anchor" id="line-185"></span><p class="line879">mod_python versions 2.7.10, 3.0.4 and 3.1.2b have a bug in <tt class="backtick">apache.resolve_object</tt>. This bug was reported to the mod_python <span class="anchor" id="line-186"></span>maintainers and has been fixed in the 3.1.3 release. The best fix for this is to update to the current release. However if you are unable to do this there are 2 possible solutions: <span class="anchor" id="line-187"></span></p><span class="anchor" id="line-188"></span>
<h2 id="head-7b2283d5184932488fe551b2cee08e28fb18230c">Use a wrapper script</h2>
<span class="anchor" id="line-189"></span><span class="anchor" id="line-190"></span><p class="line903"><a href="">MoinMoin</a> come with a <tt class="backtick"></tt> wrapper script, and this could be used by changing the <tt class="backtick">PythonPath</tt> and <tt class="backtick">PythonHandler</tt> directives as shown in the <tt class="backtick">moinmodpy.htaccess</tt> file. The wrapper was named <tt class="backtick"></tt> in <a href="">MoinMoin</a> 1.2. <span class="anchor" id="line-191"></span></p><span class="anchor" id="line-192"></span>
<h2 id="head-f2a32b29f0aff0101a91c87d692d063a6e0a4ec2">Fix mod_python</h2>
<span class="anchor" id="line-193"></span><p class="line886">mod_python has a small resolver bug in versions 2.7.10, 3.0.4 and 3.1.2b. <span class="anchor" id="line-194"></span>The method <tt class="backtick">resolve_object</tt> in <tt class="backtick">mod_python/</tt> checks the wrong <span class="anchor" id="line-195"></span>object, and so the lookup for <tt class="backtick"></tt> fails. <span class="anchor" id="line-196"></span></p><span class="anchor" id="line-197"></span><p class="line879">To fix it you need to change the method <tt class="backtick">resolve_object</tt> (around line 551 for <span class="anchor" id="line-198"></span>mod_python 3.1.2b) from <span class="anchor" id="line-199"></span></p><span class="anchor" id="line-200"></span><span class="anchor" id="line-201"></span><pre>        if silent and not hasattr(module, obj_str):
<span class="anchor" id="line-202"></span>            return None
<span class="anchor" id="line-203"></span></pre><span class="anchor" id="line-204"></span><span class="anchor" id="line-205"></span><p class="line886">to <span class="anchor" id="line-206"></span></p><span class="anchor" id="line-207"></span><span class="anchor" id="line-208"></span><pre>        if silent and not hasattr(obj, obj_str):
<span class="anchor" id="line-209"></span>            return None
<span class="anchor" id="line-210"></span></pre><span class="anchor" id="line-211"></span><span class="anchor" id="line-212"></span><span class="anchor" id="line-213"></span>
<h1 id="head-17313e33f7320af70773f484730b290d86b62ee5">Troubleshooting</h1>
<span class="anchor" id="line-214"></span><span class="anchor" id="line-215"></span><p class="line886">Page access gives apache error:: <span class="anchor" id="line-216"></span></p><ul><li style="list-style-type:none"><p class="line903"><tt>PythonHandler&nbsp;;OSError:&nbsp;[Errno&nbsp;2]&nbsp;No&nbsp;such&nbsp;file&nbsp;or&nbsp;directory:&nbsp;'data/user'</tt> <span class="anchor" id="line-217"></span>This appears to be caused by you not having an absolute path for <tt class="backtick">data_dir</tt> in <tt class="backtick"></tt>.  There are several other lines of error traceback preceding this one in the apache error log.  Fix the path in <tt class="backtick"></tt>. <span class="anchor" id="line-218"></span></p></li></ul><span class="anchor" id="bottom_Include_HelpOnInstalling/ApacheWithModPython"></span></div> <span class="anchor" id="line-60"></span></p><hr class="hr2" /><p class="line886"> <span class="anchor" id="line-61"></span><span class="anchor" id="twisted-install"></span> <span class="anchor" id="line-62"></span>
<h1>Setup using Twisted</h1>
<div dir="ltr" id="Include_HelpOnInstalling/TwistedWeb" lang="en"><span class="anchor" id="top_Include_HelpOnInstalling/TwistedWeb"></span>
<span class="anchor" id="line-8"></span><span class="anchor" id="line-9"></span>
<h1 id="head-aadc9ea90352d5b5ad5745583f12238abc07f6b1">Using MoinMoin with Twisted</h1>
<span class="anchor" id="line-10"></span><span class="anchor" id="line-11"></span><p class="line903"><a class="http" href="">Twisted</a> is a standalone python framework for many kinds of applications. <span class="anchor" id="line-12"></span>For <a href="">MoinMoin</a>, we use Twisted as a python web server that just imports <a href="">MoinMoin</a> persistently. <span class="anchor" id="line-13"></span></p><span class="anchor" id="line-14"></span><p class="line879">This has the advantage that the Python interpreter and all Python scripts (including Twisted itself and also <a href="">MoinMoin</a>) is only loaded and initialized one time, and that data can be cached in memory from request to request, enhancing the performance of <a href="">MoinMoin</a>. <span class="anchor" id="line-15"></span></p><span class="anchor" id="line-16"></span><p class="line879">Another advantage is that this is all based on Python. <img alt=";)" height="15" src="wiki/htdocs/modern/img/smile4.png" title=";)" width="15" /> <span class="anchor" id="line-17"></span></p><span class="anchor" id="line-18"></span><p class="line879">First do <a href="">../BasicInstallation</a> and <a href="">../WikiInstanceCreation</a>. <span class="anchor" id="line-19"></span></p><span class="anchor" id="line-20"></span>
<h2 id="head-781019b7b4433e2b39a07387d381c1ca28eb9134">Install Twisted</h2>
<span class="anchor" id="line-21"></span><span class="anchor" id="line-22"></span><p class="line886">First, install Twisted (see URL above). Many Linux distributions have Twisted packages. Please refer to the documentation of Twisted for installation information. <span class="anchor" id="line-23"></span></p><span class="anchor" id="line-24"></span>
<h2 id="head-f377d8187c2c46a84ee4a6ae292b323853a6ae0c">Configuring the Twisted server</h2>
<span class="anchor" id="line-25"></span><span class="anchor" id="line-26"></span><p class="line879">Copy the file <tt class="backtick">wiki/server/</tt> to your wiki directory. Edit and adapt the settings to your needs. <span class="anchor" id="line-27"></span></p><span class="anchor" id="line-28"></span>
<h3 id="head-6cf160dca6339d0a63474b5e9d1c94115980d292">System path configuration</h3>
<span class="anchor" id="line-29"></span><span class="anchor" id="line-30"></span><p class="line886">If you did a standard install, and you are not a developer, you probably want to skip this section. Otherwise, you might want to add the path to moin and config file, like that: <span class="anchor" id="line-31"></span></p><span class="anchor" id="line-32"></span><span class="anchor" id="line-33"></span><pre>sys.path.insert(0, '/path/to/moin')
<span class="anchor" id="line-34"></span>sys.path.insert(0, '/path/to/wikiconfig')
<span class="anchor" id="line-35"></span></pre><span class="anchor" id="line-36"></span><span class="anchor" id="line-37"></span>
<h3 id="head-a51f43e6a56656fb4ff7b17d487afc09442427b5">Config class options</h3>
<span class="anchor" id="line-38"></span><span class="anchor" id="line-39"></span><p class="line886">If you did a standard install, the default options might be just what you need. Check and change what you like: <span class="anchor" id="line-40"></span></p><span class="anchor" id="line-41"></span><div><table><tbody><tr>  <td><p class="line879"> <strong>Option</strong> </p></td>
  <td><p class="line879"> <strong>Default</strong> </p></td>
  <td><p class="line879"> <strong>Comment</strong> </p></td>
<span class="anchor" id="line-42"></span><tr>  <td><p class="line879"> docs </p></td>
  <td><p class="line879"> '/usr/share/moin/wiki/htdocs' </p></td>
  <td><p class="line879"> Path to moin shared files </p></td>
<span class="anchor" id="line-43"></span><tr>  <td><p class="line879"> user </p></td>
  <td><p class="line879"> 'www-data' </p></td>
  <td><p class="line879"> If you run as root, the server will run as this user </p></td>
<span class="anchor" id="line-44"></span><tr>  <td><p class="line879"> group </p></td>
  <td><p class="line879"> 'www-data' </p></td>
  <td><p class="line879"> If you run as root, the server will run as this group </p></td>
<span class="anchor" id="line-45"></span><tr>  <td><p class="line879"> port </p></td>
  <td><p class="line879"> 8080 </p></td>
  <td><p class="line879"> Port to serve. To serve a privileged port below 1024 you will have to run as root </p></td>
<span class="anchor" id="line-46"></span><tr>  <td><p class="line879"> interfaces </p></td>
  <td><p class="line879"> <tt class="backtick">['']</tt> </p></td>
  <td><p class="line879"> A list of interfaces the server will listen to. If the list contains the entry <tt class="backtick">''</tt> (like for the default configuration), all other entries are ignored and the server will listen to all interfaces. </p></td>
<span class="anchor" id="line-47"></span><tr>  <td><p class="line879"> logPath </p></td>
  <td><p class="line879"> 'mointwisted.log' </p></td>
  <td><p class="line879"> Log file. </p></td>
<span class="anchor" id="line-48"></span><tr>  <td><p class="line879"> profiler </p></td>
  <td><p class="line879"> commented python code </p></td>
  <td><p class="line879"> Useful only if you are a moin developer. </p></td>
<span class="anchor" id="line-49"></span></tbody></table></div><span class="anchor" id="line-50"></span>
<h2 id="head-e4c385b7866dfc82bdf390d00038d1e191cd6870">Configuring</h2>
<span class="anchor" id="line-51"></span><span class="anchor" id="line-52"></span><p class="line886">The sample config file should be just fine. <span class="anchor" id="line-53"></span></p><span class="anchor" id="line-54"></span><div><table><tbody><tr>  <td><p class="line879"> <strong>Option</strong> </p></td>
  <td><p class="line879"> <strong>Default</strong> </p></td>
  <td><p class="line879"> <strong>Comment</strong> </p></td>
<span class="anchor" id="line-55"></span><tr>  <td><p class="line879"> url_prefix </p></td>
  <td><p class="line879"> '/wiki' </p></td>
  <td><p class="line879"> You should not change this, or images and css file will not be available to the wiki! </p></td>
<span class="anchor" id="line-56"></span></tbody></table></div><span class="anchor" id="line-57"></span>
<h2 id="head-828a44c0e867e6f0fb60395a972cb6003658f76f">Starting the server on Unix</h2>
<span class="anchor" id="line-58"></span><span class="anchor" id="line-59"></span><p class="line879">On GNU/Linux, Mac OS X or another POSIX-like OS, copy <tt class="backtick">wiki/server/mointwisted</tt> to your wiki directory. You might want to adapt <tt class="backtick">PYTHONPATH</tt> and the path to <tt class="backtick">twistd</tt>.  <span class="anchor" id="line-60"></span></p><span class="anchor" id="line-61"></span><p class="line879">Start the server with <tt>./mointwisted&nbsp;start</tt> and test your wiki at <a class="http" href="http://localhost:8080/">http://localhost:8080/</a>. Stop the server with <tt>./mointwisted&nbsp;stop</tt>. <span class="anchor" id="line-62"></span></p><span class="anchor" id="line-63"></span><p class="line879">For more options run <tt>./mointwisted</tt> without arguments. <span class="anchor" id="line-64"></span></p><span class="anchor" id="line-65"></span>
<h2 id="head-0457c39c25e65945e29141fa8f207afe318806fe">Starting the server on Windows</h2>
<span class="anchor" id="line-66"></span><span class="anchor" id="line-67"></span><p class="line879">Copy <tt class="backtick">wiki/server/mointwisted.cmd</tt> to your wiki directory. You might have to change the path pointing to the python-scripts directory. <span class="anchor" id="line-68"></span></p><span class="anchor" id="line-69"></span><p class="line879">Double click <tt class="backtick">mointwisted.cmd</tt> to start the server. It will create a new terminal window. To stop the server, close the terminal window. <span class="anchor" id="line-70"></span></p><span class="anchor" id="bottom_Include_HelpOnInstalling/TwistedWeb"></span></div> <span class="anchor" id="line-63"></span></p><hr class="hr2" /><p class="line886"> <span class="anchor" id="line-64"></span><span class="anchor" id="linuxstandalone-install"></span> <span class="anchor" id="line-65"></span>
<h1>Linux Installation using standalone server</h1>
<div dir="ltr" id="Include_HelpOnInstalling/StandaloneServer" lang="en"><span class="anchor" id="top_Include_HelpOnInstalling/StandaloneServer"></span>
<span class="anchor" id="line-9"></span><p class="line903"><strong>Installing and configuring standalone server</strong> <span class="anchor" id="line-10"></span></p><span class="anchor" id="line-11"></span><p class="line879">See also: <a href="">HelpOnConfiguration/IntegratingWithApache</a> <span class="anchor" id="line-12"></span></p><span class="anchor" id="line-13"></span><p class="line886">The standalone server is especially made for local wikis because it does not need a web server installed. Only Python and Moin are necessary! <span class="anchor" id="line-14"></span></p><span class="anchor" id="line-15"></span><p class="line886">To install and run the standalone server: <span class="anchor" id="line-16"></span></p><ol type="1"><li><p class="line879">If <a href="">MoinMoin</a> is not installed yet, preform <a href="">../BasicInstallation</a> <span class="anchor" id="line-17"></span></p></li><li><p class="line879">Create a wiki instance as described in <a href="">../WikiInstanceCreation</a> <span class="anchor" id="line-18"></span></p></li><li><p class="line879">Copy <tt></tt> to your wiki directory, where your <tt></tt> is <span class="anchor" id="line-19"></span></p></li><li><p class="line879">If you installed with <tt class="backtick">--prefix</tt> option, you must edit and set <tt class="backtick">docs</tt> to the correct path. <span class="anchor" id="line-20"></span></p></li><li><p class="line879">Run <tt></tt> <span class="anchor" id="line-21"></span></p></li><li><p class="line879">Access your wiki at <a class="http" href="http://localhost:8000/">http://localhost:8000/</a> <span class="anchor" id="line-22"></span></p><span class="anchor" id="line-23"></span></li></ol><p class="line879">On most cases, the default settings will be just fine. You many want to edit <tt></tt> and change some of the options, as described in the next section. <span class="anchor" id="line-24"></span></p><span class="anchor" id="line-25"></span>
<h1 id="head-b104ff56fc1c89199447f1f2756b65995534e032">Configuring</h1>
<span class="anchor" id="line-26"></span><span class="anchor" id="line-27"></span>
<h2 id="head-5d2a2fc430a567acd72fcaa712af23333abca0df">System path configuration</h2>
<span class="anchor" id="line-28"></span><span class="anchor" id="line-29"></span><p class="line886">If you did a standard install, and you are not a developer, you probably want to skip this section. If not, you might want to add the path to moin and config file, like that: <span class="anchor" id="line-30"></span></p><span class="anchor" id="line-31"></span><span class="anchor" id="line-32"></span><pre>import sys
<span class="anchor" id="line-33"></span>sys.path.insert(0, '/path/to/moin')
<span class="anchor" id="line-34"></span>sys.path.insert(0, '/path/to/wikiconfig')
<span class="anchor" id="line-35"></span></pre><span class="anchor" id="line-36"></span><span class="anchor" id="line-37"></span><span class="anchor" id="options"></span> <span class="anchor" id="line-38"></span>
<h2 id="head-3cb7180f429490b9735cfc083869eaaa128ed64c">Config class options</h2>
<span class="anchor" id="line-39"></span><span class="anchor" id="line-40"></span><div><table><tbody><tr>  <td><p class="line879"> <strong>Option</strong> </p></td>
  <td><p class="line879"> <strong>Default</strong> </p></td>
  <td><p class="line879"> <strong>Comment</strong> </p></td>
<span class="anchor" id="line-41"></span><tr>  <td><p class="line879"> name </p></td>
  <td><p class="line879"> <tt>'moin'</tt> </p></td>
  <td><p class="line879"> Server name, used by default for log and pid files. <img alt="(!)" height="15" src="wiki/htdocs/modern/img/idea.png" title="(!)" width="15" /> New in 1.5 </p></td>
<span class="anchor" id="line-42"></span><tr>  <td><p class="line879"> docs </p></td>
  <td><p class="line879"> <tt>'/usr/share/moin/wiki/htdocs'</tt> </p></td>
  <td><p class="line879"> Path to moin shared files. If you used <tt class="backtick">--prefix</tt> install, the default path will not work, and you must set the path to <tt>'PREFIX/share/moin/wiki/htdocs'</tt>. </p></td>
<span class="anchor" id="line-43"></span><tr>  <td><p class="line879"> user </p></td>
  <td><p class="line879"> <tt>'www-data'</tt> </p></td>
  <td><p class="line879"> If you run as root, the server will run with as this user </p></td>
<span class="anchor" id="line-44"></span><tr>  <td><p class="line879"> group </p></td>
  <td><p class="line879"> <tt>'www-data'</tt> </p></td>
  <td><p class="line879"> If you run as root, the server will run with as this group </p></td>
<span class="anchor" id="line-45"></span><tr>  <td><p class="line879"> port </p></td>
  <td><p class="line879"> <tt>8000</tt> </p></td>
  <td><p class="line879"> Port to serve. To serve privileged port under 1024 you will have to run as root </p></td>
<span class="anchor" id="line-46"></span><tr>  <td><p class="line879"> interface </p></td>
  <td><p class="line879"> <tt>'localhost'</tt> </p></td>
  <td><p class="line879"> The interface the server will listen to. The default will listen only to localhost. Set to <tt>''</tt> to listen to all.</p></td>
<span class="anchor" id="line-47"></span><tr>  <td><p class="line879"> logPath </p></td>
  <td><p class="line879"> <tt>name&nbsp;+&nbsp;'.log'</tt> </p></td>
  <td><p class="line879"> Log file. Default is commented. </p></td>
<span class="anchor" id="line-48"></span><tr>  <td><p class="line879"> serverClass </p></td>
  <td><p class="line879"> <tt>'ThreadPoolServer'</tt>, <tt>'ThreadingServer'</tt>, <tt>'ForkingServer'</tt>, <tt>'SimpleServer'</tt> </p></td>
  <td><p class="line879"> The server type to use, see the comments in the <tt></tt>. The default is <tt>'ThreadPoolServer'</tt>, which create a pool of threads and reuse them for new connections. <img alt="(!)" height="15" src="wiki/htdocs/modern/img/idea.png" title="(!)" width="15" /> New in 1.3.5 </p></td>
<span class="anchor" id="line-49"></span><tr>  <td><p class="line879"> threadLimit </p></td>
  <td><p class="line879"> <tt>10</tt> </p></td>
  <td><p class="line879"> How many threads to create. <img alt="(!)" height="15" src="wiki/htdocs/modern/img/idea.png" title="(!)" width="15" /> New in 1.3.5 </p></td>
<span class="anchor" id="line-50"></span><tr>  <td><p class="line879"> requestQueueSize </p></td>
  <td><p class="line879"> <tt>50</tt> </p></td>
  <td><p class="line879"> The count of socket connection requests that are buffered by the operating system. <img alt="(!)" height="15" src="wiki/htdocs/modern/img/idea.png" title="(!)" width="15" /> New in 1.3.5 </p></td>
<span class="anchor" id="line-51"></span><tr>  <td><p class="line879"> properties </p></td>
  <td><p class="line879"> <tt>&nbsp;{}&nbsp;</tt> </p></td>
  <td><p class="line879"> allow overriding any request property by setting the value in this dict e.g <tt>properties&nbsp;=&nbsp;{'script_name':&nbsp;'/mywiki'</tt>}. <img alt="(!)" height="15" src="wiki/htdocs/modern/img/idea.png" title="(!)" width="15" /> New in 1.5 </p></td>
<span class="anchor" id="line-52"></span></tbody></table></div><span class="anchor" id="line-53"></span><ul><li style="list-style-type:none"><p class="line903"><img alt="(!)" height="15" src="wiki/htdocs/modern/img/idea.png" title="(!)" width="15" /> There may be more options useful to moin developers, see the comments in <tt></tt> <span class="anchor" id="line-54"></span></p><span class="anchor" id="line-55"></span><span class="anchor" id="line-56"></span></li></ul>
<h1 id="head-09dea245aaa1a9c2da2585949e627adb3e22284d">Configuring</h1>
<span class="anchor" id="line-57"></span><span class="anchor" id="line-58"></span><p class="line886">The sample config file should be just fine. <span class="anchor" id="line-59"></span></p><span class="anchor" id="line-60"></span><div><table><tbody><tr>  <td><p class="line879"> <strong>Option</strong> </p></td>
  <td><p class="line879"> <strong>Default</strong> </p></td>
  <td><p class="line879"> <strong>Comment</strong> </p></td>
<span class="anchor" id="line-61"></span><tr>  <td><p class="line879"> url_prefix </p></td>
  <td><p class="line879"> '/wiki' </p></td>
  <td><p class="line879"> You should not change this, or images and css file will not be available to the wiki! </p></td>
<span class="anchor" id="line-62"></span></tbody></table></div><span class="anchor" id="line-63"></span>
<h1 id="head-97336ff12bb113d4f2b55edf2d4c433001e6e54e">Starting the server</h1>
<span class="anchor" id="line-64"></span><span class="anchor" id="line-65"></span><p class="line879">Run <tt></tt> from the command line: <span class="anchor" id="line-66"></span><span class="anchor" id="line-67"></span></p><pre>$ ./
<span class="anchor" id="line-68"></span>Serving on localhost:8000
<span class="anchor" id="line-69"></span></pre><span class="anchor" id="line-70"></span><span class="anchor" id="line-71"></span><p class="line879">Test your wiki at <a class="http" href="http://localhost:8000/">http://localhost:8000/</a> <span class="anchor" id="line-72"></span></p><span class="anchor" id="line-73"></span><p class="line879">On Windows, you can double click <tt></tt> to start the server. A new terminal window will be opened. Close the window or press <tt>Control&nbsp;+&nbsp;Pause</tt> to stop the server. <span class="anchor" id="line-74"></span></p><span class="anchor" id="line-75"></span><p class="line879">On Unix, interrupt the server with <tt>Control&nbsp;+&nbsp;C</tt> in order to shut it down. <span class="anchor" id="line-76"></span></p><span class="anchor" id="line-77"></span>
<h1 id="head-3da0e8e1ef007d5e29a21fda332f1982c4e7140b">Serving port 80 on Unix</h1>
<span class="anchor" id="line-78"></span><span class="anchor" id="line-79"></span><p class="line879">On GNU/Linux, Mac OS X or other Posix like OS, you can serve the standard port 80 used for web serving, but you must run as <tt>root</tt> for this. <span class="anchor" id="line-80"></span></p><span class="anchor" id="line-81"></span><p class="line879">Set <tt>port</tt> to 80, and verify that <tt>user</tt> and <tt>group</tt> exists on your system. If not, set them to an existing user, meant for web serving. If needed, <tt>chown</tt> your wiki dir to this user and group. <span class="anchor" id="line-82"></span></p><span class="anchor" id="line-83"></span><p class="line879">Run <tt></tt> as root: <span class="anchor" id="line-84"></span><span class="anchor" id="line-85"></span></p><pre>$ sudo
<span class="anchor" id="line-86"></span>Password:
<span class="anchor" id="line-87"></span>Serving on localhost:8000
<span class="anchor" id="line-88"></span>Running as uid/gid 70/70
<span class="anchor" id="line-89"></span></pre><span class="anchor" id="line-90"></span><span class="anchor" id="line-91"></span><p class="line879">Test your wiki at <a class="http" href="http://localhost/">http://localhost/</a> <span class="anchor" id="line-92"></span></p><span class="anchor" id="line-93"></span>
<h1 id="head-79336bdc41d8a5136baf30cad5a31b8c49b7c57b">Running as daemon</h1>
<span class="anchor" id="line-94"></span><span class="anchor" id="line-95"></span><p class="line886">If run on Unix, you can run as a background process: <span class="anchor" id="line-96"></span></p><ol type="1"><li><p class="line879">Have a working <tt></tt> as explained above <span class="anchor" id="line-97"></span></p></li><li><p class="line879">Copy the file <tt>prefix/share/moin/server/moin</tt> to your wiki directory. <span class="anchor" id="line-98"></span></p></li><li><p class="line886">Start moin server: <span class="anchor" id="line-99"></span></p></li></ol><span class="anchor" id="line-100"></span><pre>./moin start
<span class="anchor" id="line-101"></span></pre><span class="anchor" id="line-102"></span><span class="anchor" id="line-103"></span><p class="line886">To stop the server: <span class="anchor" id="line-104"></span><span class="anchor" id="line-105"></span></p><pre>./moin stop
<span class="anchor" id="line-106"></span></pre><span class="anchor" id="line-107"></span><span class="anchor" id="line-108"></span><p class="line879">For more info run <tt>moin</tt> with no arguments. <span class="anchor" id="line-109"></span></p><span class="anchor" id="line-110"></span><p class="line879">If you want to start moin from a system startup script, you may need to add the path to <tt></tt> in the top of the script: <span class="anchor" id="line-111"></span><span class="anchor" id="line-112"></span></p><pre># Add the path to directory 
<span class="anchor" id="line-113"></span>import sys
<span class="anchor" id="line-114"></span>sys.path.insert(0, '/path/to/moin')
<span class="anchor" id="line-115"></span></pre><span class="anchor" id="line-116"></span><span class="anchor" id="line-117"></span><ul><li style="list-style-type:none"><p class="line903"><img alt="(!)" height="15" src="wiki/htdocs/modern/img/idea.png" title="(!)" width="15" /> New in release 1.5 <span class="anchor" id="line-118"></span></p></li></ul><span class="anchor" id="bottom_Include_HelpOnInstalling/StandaloneServer"></span></div> <span class="anchor" id="line-66"></span></p><hr class="hr2" /><p class="line886"> <span class="anchor" id="line-67"></span><span class="anchor" id="macosx-install"></span> <span class="anchor" id="line-68"></span>
<h1>Mac OS X Installation using Apache</h1>
<div dir="ltr" id="Include_HelpOnInstalling/ApacheOnMacOsx" lang="en"><span class="anchor" id="top_Include_HelpOnInstalling/ApacheOnMacOsx"></span>
<span class="anchor" id="line-8"></span><span class="anchor" id="line-9"></span><p class="line886">You must not be afraid to use the terminal. It is possible but much harder to install without using the terminal. <span class="anchor" id="line-10"></span></p><span class="anchor" id="line-11"></span><p class="line886">There are 2 step in the installation: <span class="anchor" id="line-12"></span></p><ol type="1"><li><p class="line879">Install the <a href="">MoinMoin</a> engine - once <span class="anchor" id="line-13"></span></p></li><li><p class="line886">Create wiki instance. You can create and serve as many wikis as you like. <span class="anchor" id="line-14"></span></p><span class="anchor" id="line-15"></span><span class="anchor" id="line-16"></span></li></ol>
<h1 id="head-c94edbb5fa226613bc614ed4817a423e49bfab74">Installing MoinMoin</h1>
<span class="anchor" id="line-17"></span>
<h2 id="head-fab7fde843537e1c43e51293df06cf230070066f">Download</h2>
<span class="anchor" id="line-18"></span><span class="anchor" id="line-19"></span><p class="line879">Download the source on the Desktop. You should see a <tt class="backtick">moin-1.3.tar.gz</tt> file. Extract this file on the desktop with Stuffit Expander, or from the terminal (faster and safer): <span class="anchor" id="line-20"></span><span class="anchor" id="line-21"></span></p><pre>cd ~/Desktop
<span class="anchor" id="line-22"></span>tar -xzf moin-1.3.0.tar.gz
<span class="anchor" id="line-23"></span></pre><span class="anchor" id="line-24"></span><span class="anchor" id="line-25"></span>
<h2 id="head-fe44f2863565a3eaecef0a33bc1e9a1f4c96638f">Install procedure</h2>
<span class="anchor" id="line-26"></span><span class="anchor" id="line-27"></span><p class="line879">Use these commands in the terminal to install the MoinMoin wiki engine into the system. <span class="anchor" id="line-28"></span></p><span class="anchor" id="line-29"></span><p class="line879">First, open a shell as root. You will need this to install <a href="">MoinMoin</a> and configure the wiki. When asked, enter your password. <span class="anchor" id="line-30"></span><span class="anchor" id="line-31"></span></p><pre>sudo -s
<span class="anchor" id="line-32"></span>... password:
<span class="anchor" id="line-33"></span></pre><span class="anchor" id="line-34"></span><p class="line886">Now you have root privileges in this shell. <span class="anchor" id="line-35"></span></p><span class="anchor" id="line-36"></span><p class="line886">Install: <span class="anchor" id="line-37"></span><span class="anchor" id="line-38"></span></p><pre>cd moin-1.3.0
<span class="anchor" id="line-39"></span>python install --install-data='/usr/local'
<span class="anchor" id="line-40"></span></pre><span class="anchor" id="line-41"></span><span class="anchor" id="line-42"></span><ul><li style="list-style-type:none"><p class="line903"><img alt="(!)" height="15" src="wiki/htdocs/modern/img/idea.png" title="(!)" width="15" /> The --install-data='/usr/local' will put the shared data in the convenient <tt class="backtick">'/usr/local/share/moin'</tt> folder. If you don't use it, your shared data will be at <tt class="backtick">'/System/Library/Frameworks/Python.framework/Versions/2.3/share/moin'</tt>. On Mac OS X, '/usr' belong to Apple, and it is safer to install in '/usr/local'. <span class="anchor" id="line-43"></span></p><span class="anchor" id="line-44"></span><p class="line903"><img alt="(!)" height="15" src="wiki/htdocs/modern/img/idea.png" title="(!)" width="15" /> The default Python used by Apache is the framework one supplied by Apple.  If you have added another Python version such as through <a class="nonexistent nonexistent" href="">DarwinPorts</a> or Fink, then you should substitute "/usr/bin/python" for "python" above or you should substitute the specific path for the Python that will be used by Apache. <span class="anchor" id="line-45"></span></p><span class="anchor" id="line-46"></span></li></ul><p class="line886">Now the installation is finished. You will not have to repeat this step unless you upgrade moin. <span class="anchor" id="line-47"></span></p><span class="anchor" id="line-48"></span>
<h2 id="head-7cf05b3d73a21fa16eabfdced354c3e079182014">Optional Installs</h2>
<span class="anchor" id="line-49"></span><span class="anchor" id="line-50"></span>
<h3 id="head-223faa3a0e587eb269f79e3faf05d3851d778e8d">RSS</h3>
<span class="anchor" id="line-51"></span><span class="anchor" id="line-52"></span><p class="line879">If you want your wiki to support RSS and Mozilla Firefox Live Bookmarks features, you have to install PyXML. Get PyXML from <a class="http" href=""></a> and install according to the instructions. <span class="anchor" id="line-53"></span></p>
<h1 id="head-0cd30234950a8438af556cb7a93ef4dd346358a3">Creating a wiki</h1>
<span class="anchor" id="line-54"></span><span class="anchor" id="line-55"></span><p class="line886">After you have installed the software, you need to create a wiki. You may create several wikis if you need. <span class="anchor" id="line-56"></span></p><span class="anchor" id="line-57"></span>
<h2 id="head-df71f35b5f6ca32f75dd1e1d9c71a7113906c308">Copying a template wiki</h2>
<span class="anchor" id="line-58"></span><span class="anchor" id="line-59"></span><p class="line879">Copy a template wiki from the <tt>/usr/local/share/moin</tt>. Do not try to run the wiki from <tt>/usr/local/share/moin/data</tt> because your wiki will be overwritten when you install a new version of moin. <span class="anchor" id="line-60"></span></p><span class="anchor" id="line-61"></span><ul><li style="list-style-type:none"><p class="line903"><img alt="&lt;!&gt;" height="15" src="wiki/htdocs/modern/img/attention.png" title="&lt;!&gt;" width="15" /> <strong>Security warning: do not put your wiki folder where the web server can access it! Your wiki should not be at the "Sites" folder in your home folder.</strong> <span class="anchor" id="line-62"></span></p><span class="anchor" id="line-63"></span></li></ul><p class="line886">The following instructions will create a wiki called "mywiki". You can choose any name you like, except the reserved name "wiki". <span class="anchor" id="line-64"></span></p><span class="anchor" id="line-65"></span><p class="line886">Do these commands: <span class="anchor" id="line-66"></span><span class="anchor" id="line-67"></span></p><pre>cd /usr/local/share/moin
<span class="anchor" id="line-68"></span>mkdir mywiki
<span class="anchor" id="line-69"></span>cp -r data mywiki
<span class="anchor" id="line-70"></span>cp -r underlay mywiki
<span class="anchor" id="line-71"></span>cp server/moin.cgi mywiki
<span class="anchor" id="line-72"></span>cp config/ mywiki
<span class="anchor" id="line-73"></span></pre><span class="anchor" id="line-74"></span><span class="anchor" id="line-75"></span>
<h2 id="head-49456651956c5f3bbba97c6917e54be2420fbf14">Setting Permissions</h2>
<span class="anchor" id="line-76"></span><span class="anchor" id="line-77"></span><p class="line886">You have to make the web server the owner of the files in your wiki. Unless you changed the default configuration, both are 'www'. <span class="anchor" id="line-78"></span><span class="anchor" id="line-79"></span></p><pre>chown -R www:www mywiki
<span class="anchor" id="line-80"></span>chmod -R ug+rwX mywiki
<span class="anchor" id="line-81"></span>chmod -R o-rwx mywiki
<span class="anchor" id="line-82"></span></pre><span class="anchor" id="line-83"></span><span class="anchor" id="line-84"></span>
<h2 id="head-31a82db9b85a63663e1b46abf203b3c0abdb5fad">Configure Apache</h2>
<span class="anchor" id="line-85"></span><span class="anchor" id="line-86"></span><p class="line886">We'll use the pico editor: <span class="anchor" id="line-87"></span><span class="anchor" id="line-88"></span></p><pre>pico /etc/httpd/httpd.conf
<span class="anchor" id="line-89"></span></pre><span class="anchor" id="line-90"></span><span class="anchor" id="line-91"></span><p class="line886">Go to the end of the Aliases section and edit like the example below: <span class="anchor" id="line-92"></span><span class="anchor" id="line-93"></span></p><pre>    Alias /wiki/ "/usr/local/share/moin/htdocs/"      
<span class="anchor" id="line-94"></span>    ScriptAlias /mywiki "/usr/local/share/moin/mywiki/moin.cgi"       
<span class="anchor" id="line-95"></span></pre><span class="anchor" id="line-96"></span><p class="line886">Use Control+O to save the file and Control+X to exit pico. <span class="anchor" id="line-97"></span></p><span class="anchor" id="line-98"></span><p class="line886">Restart Apache - open System Preferences, go to the Sharing page, select "Personal Web Sharing" and click "Stop" then "Start". Or just type this instead: <span class="anchor" id="line-99"></span><span class="anchor" id="line-100"></span></p><pre>apachectl graceful
<span class="anchor" id="line-101"></span>... /usr/sbin/apachectl graceful: httpd gracefully restarted
<span class="anchor" id="line-102"></span></pre><span class="anchor" id="line-103"></span><span class="anchor" id="line-104"></span><span class="anchor" id="line-105"></span><p class="line886">Instance creation finished - exit from the shell with the root privileges - working as root is dangerous. <span class="anchor" id="line-106"></span><span class="anchor" id="line-107"></span></p><pre>exit
<span class="anchor" id="line-108"></span></pre><span class="anchor" id="line-109"></span><p class="line886">Now you are running again safely. <span class="anchor" id="line-110"></span></p><span class="anchor" id="line-111"></span><span class="anchor" id="line-112"></span>
<h2 id="head-eb585ff24f9cd4b445a74b848cd1c5ec2b10706a">Testing Your New Wiki</h2>
<span class="anchor" id="line-113"></span><span class="anchor" id="line-114"></span><p class="line879">In a web-browser surf to the site: <a class="http" href="http://localhost/mywiki">http://localhost/mywiki</a> <span class="anchor" id="line-115"></span></p><span class="anchor" id="line-116"></span><p class="line879">You should see the FrontPage of your new wiki. <span class="anchor" id="line-117"></span></p><span class="anchor" id="line-118"></span><p class="line879">Now run the unit tests, to make sure everything is fine. Go to this address: <a class="http" href="http://localhost/mywiki?action=test">http://localhost/mywiki?action=test</a> <span class="anchor" id="line-119"></span></p><span class="anchor" id="line-120"></span><p class="line879">You should see a report on the wiki and tests results for the <a href="">MoinMoin</a> engine. If some of the tests fail, please report the problem on <a class="http" href="">MoinMoinBugs</a>. <span class="anchor" id="line-121"></span></p><span class="anchor" id="line-122"></span>
<h2 id="head-14a0f4b701dc07823ca965841351a2bd3d021b8e">Configuring Your wiki</h2>
<span class="anchor" id="line-123"></span><span class="anchor" id="line-124"></span><p class="line879">The wiki you created is a new "Untitled Wiki", using the default configuration. You want to give a better name and setup some configuration values. Open <tt></tt> and read the comments. You can edit the file with any text editor, like pico, emacs, or BBEdit.  <span class="anchor" id="line-125"></span></p><span class="anchor" id="line-126"></span><ul><li style="list-style-type:none"><p class="line903"><img alt="(!)" height="15" src="wiki/htdocs/modern/img/idea.png" title="(!)" width="15" /> Note that the file belongs to user and group www:www. You can edit the file as root, or change the group of the file to yourself with <tt>chown&nbsp;www:username&nbsp;</tt>. <span class="anchor" id="line-127"></span></p><span class="anchor" id="line-128"></span></li></ul><p class="line879">For more help on configuration, see <a href="">HelpOnConfiguration</a>. <span class="anchor" id="line-129"></span></p><span class="anchor" id="bottom_Include_HelpOnInstalling/ApacheOnMacOsx"></span></div> <span class="anchor" id="line-69"></span></p><hr class="hr1" /><p class="line886"> <span class="anchor" id="line-70"></span><span class="anchor" id="win32apache-install"></span> <span class="anchor" id="line-71"></span>
<h1>Windows Installation using Apache</h1>
<div dir="ltr" id="Include_HelpOnInstalling/ApacheOnWin32" lang="en"><span class="anchor" id="top_Include_HelpOnInstalling/ApacheOnWin32"></span>
<span class="anchor" id="line-8"></span><p class="line903"><strong>Index</strong> <span class="anchor" id="line-9"></span><ol><li><a href="#head-3c727e631e2668b26b0f23f76dfaca64e810648e">Requirements</a></li><li><a href="#head-18c7f9f6c7f20cad8a2598f80aba6a6b36bae585">Preparation</a><ol><li><a href="#head-ce3f1899eb42247cc89c79893ca80eb5da56d2d4">MSI Installer</a></li><li><a href="#head-b1287e95efcad1b36cc2c15f825e1de198ebfcf6">Installing Apache</a></li><li><a href="#head-55b68c00864e2a0be48f87115a45f6a17a76bcc0">Installing Python</a></li></ol><li><a href="#head-c76f9a659995f587c02878baf3877ab5bd08a5bd">Installing MoinMoin</a></li><li><a href="#head-ba9ed0d8dd27b7bc62472aa0d24e8102dd103deb">Creating a Wiki Instance</a></li><li><a href="#head-42c812a9d38d3af1de6c09ed952ac1858c5221b8">Integrating MoinMoin into Apache</a></li><li><a href="#head-82ba5417401e5b5cb78836b4f23ef160fbc80630">Troubleshooting</a><ol><li><a href="#head-01d84d7e6494dcee0bd2abfbb04f43f812c9bdd7">Internal Server Error</a></li><li><a href="#head-7a4c0881ccb7242b9857811b27dc07ad836889d0">Not Found</a></li><li><a href="#head-d9b4f0491158f7280b4bf1693d990336527ebf4d">The Page Cannot be found</a></li><li><a href="#head-d47936fa3c21c07d857b27fdb811e5836635a100">FrontPage Loads Without Icons</a></li></ol></li></ol> <span class="anchor" id="line-10"></span></p><span class="anchor" id="line-11"></span>
<h2 id="head-3c727e631e2668b26b0f23f76dfaca64e810648e">Requirements</h2>
<span class="anchor" id="line-12"></span><span class="anchor" id="line-13"></span><p class="line879">Before you install Moin<tt class="backtick"></tt>Moin, you must have the necessary infrastructure in place. This procedure explains the steps necessary to install the infrastructure and provides detailed instructions for the installation of Moin<tt class="backtick"></tt>Moin.  <span class="anchor" id="line-14"></span></p><span class="anchor" id="line-15"></span><p class="line886">Downloading and installing all of the required components will require almost 100 MB of disk space - shouldn't be a problem nowadays, right? <span class="anchor" id="line-16"></span></p><span class="anchor" id="line-17"></span><p class="line879">Many users prefer to install software products in a folder other than the installation default. Python typically changes the default installation folder name with each point release, and Apache has changed the default installation folder name with the release of version 2.  Instead of enumerating all the possibilities at each step, this procedure will use the <strong>Reference</strong> name in the table below as the installed location for each product. Substitute your real installation location when editing configuration files and entering commands. <span class="anchor" id="line-18"></span></p><span class="anchor" id="line-19"></span><div><table><tbody><tr style="background-color: #EEDDAA;">  <td><p class="line879">Reference</p></td>
  <td><p class="line879">Product</p></td>
  <td><p class="line879">Installation Default or Typical Name</p></td>
<span class="anchor" id="line-20"></span><tr>  <td><p class="line903"><strong>C:\Apache</strong></p></td>
  <td><p class="line879"> Apache</p></td>
  <td><p class="line879">C:\Program Files\Apache Group\Apache2</p></td>
<span class="anchor" id="line-21"></span><tr>  <td><p class="line903"><strong>C:\Python</strong></p></td>
  <td><p class="line879">Python</p></td>
  <td><p class="line879">C:\Python22</p></td>
<span class="anchor" id="line-22"></span><tr>  <td><p class="line903"><strong>C:\Moin</strong></p></td>
  <td><p class="line879">wiki instances</p></td>
  <td><p class="line879">C:\My Documents\Moin</p></td>
<span class="anchor" id="line-23"></span></tbody></table></div><span class="anchor" id="line-24"></span><p class="line886">This installation procedure was tested with Apache 1.3.26 and Apache 2.0.44 for Windows running on Windows ME, and using Python 2.3. <span class="anchor" id="line-25"></span></p><span class="anchor" id="line-26"></span>
<h2 id="head-18c7f9f6c7f20cad8a2598f80aba6a6b36bae585">Preparation</h2>
<span class="anchor" id="line-27"></span><span class="anchor" id="line-28"></span>
<h3 id="head-ce3f1899eb42247cc89c79893ca80eb5da56d2d4">MSI Installer</h3>
<span class="anchor" id="line-29"></span><p class="line879">Installation of Apache and one alternative distribution of Python require the Microsoft <strong>MSI Installer</strong>.  The latest version, 2.0, was released in September of 2001. You will know you don't have the correct version if you receive errors after double-clicking on a file name ending in <strong>.msi</strong>. To get the latest version, go to <a class="http" href=""></a>, search for <strong>msi installer</strong>, and follow the instructions.  There are two versions, one for Windows ME, 98, and 95; and another for Windows 2000 and NT. Windows XP has the 2.0 version and requires no update. <span class="anchor" id="line-30"></span></p><span class="anchor" id="line-31"></span>
<h3 id="head-b1287e95efcad1b36cc2c15f825e1de198ebfcf6">Installing Apache</h3>
<span class="anchor" id="line-32"></span><span class="anchor" id="line-33"></span><p class="line879">To obtain the latest version of Apache, go to <a class="http" href=""></a>, and click on the link to <strong>HTTP Server</strong>. Find the link to download the <strong>Win32 Binary (MSI Installer)</strong> version. Read the Apache documentation to determine the correct installation procedure for your situation.  Questions and problems with the Apache installation process should be resolved through use of the resources provided by the Apache organization. Be sure your webserver runs correctly before proceeding.  <span class="anchor" id="line-34"></span></p><span class="anchor" id="line-35"></span><p class="line903"><strong>Warning:</strong> the procedure described above tends to trivialize the installation of the Apache web server. Apache can be installed and running on your PC in a very few minutes with only a cursory examination of the Apache documentation.  Before you undertake the installation of any web server that can be accessed through the internet, you should exercise a controlled level of paranoia and assess the potential damage that may be caused by hackers accessing or destroying sensitive data. This should include not only the all data which resides on the PC which will host the Apache web server, but all other PCs on the local LAN which participate in any form of file sharing.   <span class="anchor" id="line-36"></span></p><span class="anchor" id="line-37"></span><p class="line886">Windows ME, 98SE, 98, 95, and probably NT should be considered inappropriate hosts for any Apache web server that can be accessed via the internet.  Use either Windows 2000 or XP and install all security patches available for your operating system. <span class="anchor" id="line-38"></span></p><span class="anchor" id="line-39"></span><p class="line879">Do not let the above discourage you from installing Moin<tt class="backtick"></tt>Moin.  Most of the internet activity probing your system for weaknesses will be from virus infected Windows NT systems running IIS whose owners have neglected to apply available security patches. The starting Apache configuration is secure and you will not have a problem provided you: <span class="anchor" id="line-40"></span></p><ul><li><p class="line886">Regularly review and apply security patches for your installed software. <span class="anchor" id="line-41"></span></p></li><li><p class="line886">Understand the ramifications of any changes you make to the Apache config files. <span class="anchor" id="line-42"></span></p></li><li><p class="line886">Regularly review the Apache logs for suspicious activity. <span class="anchor" id="line-43"></span></p></li><li><p class="line886">Regularly take backups of your data. <span class="anchor" id="line-44"></span></p><span class="anchor" id="line-45"></span></li></ul>
<h3 id="head-55b68c00864e2a0be48f87115a45f6a17a76bcc0">Installing Python</h3>
<span class="anchor" id="line-46"></span><span class="anchor" id="line-47"></span><p class="line879">There are currently two different distributions of Python available for Windows. The normal Python distribution is available from <a class="http" href=""></a>. This is distributed as a windows executable (.exe) file. <span class="anchor" id="line-48"></span></p><span class="anchor" id="line-49"></span><p class="line879">An alternative distribution called <strong>Active<tt class="backtick"></tt>Python</strong> is available from <a class="http" href=""></a>. This distribution uses the MSI Installer and contains some tools specific to the Windows operating system and a popular Windows IDE called Pythonwin.  Active<tt class="backtick"></tt>Python is available for free; an email address is requested (but not required) before downloading. <span class="anchor" id="line-50"></span></p><span class="anchor" id="line-51"></span><p class="line879">Moin<tt class="backtick"></tt>Moin will work with either distribution, but requires Python release 2.3 or later.  Download and install the distribution of your choice.  Questions and problems dealing with the Python installation process should be resolved through the use of resources provided by or Active<tt class="backtick"></tt>State.  Be sure your Python installation is correct before proceeding. <span class="anchor" id="line-52"></span></p><span class="anchor" id="line-53"></span>
<h2 id="head-c76f9a659995f587c02878baf3877ab5bd08a5bd">Installing MoinMoin</h2>
<span class="anchor" id="line-54"></span><p class="line879">Download the current version of Moin<tt class="backtick"></tt>Moin from <a class="http" href=""></a> into <tt class="backtick">C:\TEMP</tt> or an alternative location. To extract the <em>.tar.gz</em>-format archive, you may use Win<tt class="backtick"></tt>Zip. <span class="anchor" id="line-55"></span></p><span class="anchor" id="line-56"></span><p class="line879">You should then have a folder such as <tt class="backtick">C:\TEMP\moin-x.x</tt> where "x.x" is the current release number. This folder will contain a <tt class="backtick"></tt> file in addition to several other files and subfolders. <span class="anchor" id="line-57"></span></p><span class="anchor" id="line-58"></span><p class="line886">Open an MS-DOS or console window and enter the commands: <span class="anchor" id="line-59"></span><span class="anchor" id="line-60"></span></p><pre>C:
<span class="anchor" id="line-61"></span>cd \TEMP\moin-x.x
<span class="anchor" id="line-62"></span>C:\Python\python install --record=install.log
<span class="anchor" id="line-63"></span></pre><span class="anchor" id="line-64"></span><span class="anchor" id="line-65"></span><p class="line879">The above commands will add Moin<tt class="backtick"></tt>Moin to your <tt class="backtick">C:\Python</tt> installation and create an <tt class="backtick">install.log</tt> file in <tt>C:\temp\moin-x.x</tt> listing all the copied files. You may use Windows Explorer to examine the newly created folders within <tt class="backtick">C:\Python</tt>. You should find a <tt class="backtick">C:\Python\share\moin</tt> folder. With Python 2.3 and later you will also find a <tt class="backtick">C:\Python\Lib\site-packages\MoinMoin</tt> folder. The <tt class="backtick">MoinMoin</tt> folder contains many Python scripts and several subfolders. <span class="anchor" id="line-66"></span></p><span class="anchor" id="line-67"></span><p class="line886">You are now ready to create a wiki instance. <span class="anchor" id="line-68"></span></p><span class="anchor" id="line-69"></span>
<h2 id="head-ba9ed0d8dd27b7bc62472aa0d24e8102dd103deb">Creating a Wiki Instance</h2>
<span class="anchor" id="line-70"></span><p class="line879">It is a good practice to try to keep all of your personal or site specific data under a few root folders. This way you can easily backup your important data on a regular basis without having to waste time either backing up static files or picking out dozens of important folders scattered throughout your folder structure.  You should avoid placing your wiki data under the <tt class="backtick">C:\Python</tt> folder so that you can later upgrade Python or Moin<tt class="backtick"></tt>Moin without accidentally overwriting or deleting your wiki data.  For the same reason, you probably don't want to place your wiki data within the <tt class="backtick">C:\Apache</tt> folder. The default personal folder under many Windows versions is called <tt class="backtick">C:\My&nbsp;Documents</tt>.   <span class="anchor" id="line-71"></span></p><span class="anchor" id="line-72"></span><p class="line879">Choose a location appropriate for you; the following instructions assume you will be creating one or more wiki instances in <tt class="backtick">C:\Moin\</tt> and the first wiki instance will be named <tt class="backtick">mywiki</tt>. <span class="anchor" id="line-73"></span></p><span class="anchor" id="line-74"></span><p class="line879">You may replace the name <tt class="backtick">mywiki</tt> with almost any name you wish, but do not use <tt class="backtick">wiki</tt> because that is used by Moin<tt class="backtick"></tt>Moin for loading standard images and style sheets. Although this can be changed later, the plan is that the name you choose for <tt class="backtick">mywiki</tt> will become part of the url used to access your site, e.g. <tt class="backtick"></tt>. <span class="anchor" id="line-75"></span></p><span class="anchor" id="line-76"></span><p class="line879">Start an MS-DOS or console window and enter the commands below. This will create a clone of the Moin<tt class="backtick"></tt>Moin wiki in the mywiki folder.  <span class="anchor" id="line-77"></span></p><span class="anchor" id="line-78"></span><span class="anchor" id="line-79"></span><pre>cd C:\ 
<span class="anchor" id="line-80"></span>md Moin
<span class="anchor" id="line-81"></span>md Moin\mywiki
<span class="anchor" id="line-82"></span>md Moin\mywiki\data
<span class="anchor" id="line-83"></span>md Moin\mywiki\underlay
<span class="anchor" id="line-84"></span>cd \Python\share\moin
<span class="anchor" id="line-85"></span>xcopy data        C:\Moin\mywiki\data /E
<span class="anchor" id="line-86"></span>xcopy underlay    C:\Moin\mywiki\underlay /E
<span class="anchor" id="line-87"></span>copy  config\*.* C:\Moin\mywiki\*.*
<span class="anchor" id="line-88"></span>copy  server\*.* C:\Moin\mywiki\*.*
<span class="anchor" id="line-89"></span></pre><span class="anchor" id="line-90"></span><span class="anchor" id="line-91"></span><p class="line886">If your server is going to run multiple wikis, you need to create additional clones. Do the same commands again, but use mywiki2 instead of mywiki. <span class="anchor" id="line-92"></span></p><span class="anchor" id="line-93"></span><p class="line879">Edit <tt class="backtick">C:\Moin\mywiki\</tt> and at least change <tt class="backtick">sitename</tt> to the name of your wiki: <span class="anchor" id="line-94"></span><span class="anchor" id="line-95"></span></p><pre>    sitename = 'My Wiki'
<span class="anchor" id="line-96"></span></pre><span class="anchor" id="line-97"></span><span class="anchor" id="line-98"></span><p class="line879">Additionally, set <tt class="backtick">data_dir</tt> and <tt class="backtick">data_underlay_dir</tt> to the absolute paths of the particular directories. Like here: <span class="anchor" id="line-99"></span><span class="anchor" id="line-100"></span></p><pre>    data_dir = r'C:\Moin\mywiki\data'
<span class="anchor" id="line-101"></span>    data_underlay_dir = r'C:\Moin\mywiki\underlay'
<span class="anchor" id="line-102"></span></pre><span class="anchor" id="line-103"></span><span class="anchor" id="line-104"></span><p class="line879">For a personal or intranet installation, you'll normally also add this line to <tt class="backtick"></tt>: <span class="anchor" id="line-105"></span><span class="anchor" id="line-106"></span></p><pre>    allowed_actions = ['DeletePage', 'AttachFile', 'RenamePage', ]
<span class="anchor" id="line-107"></span></pre><span class="anchor" id="line-108"></span><span class="anchor" id="line-109"></span><p class="line879">If you will <em><strong>not</strong></em> be running a Wiki farm (if you're not sure what this means, then you probably won't be), make sure to delete the <tt class="backtick"></tt> file from the <tt class="backtick">C:\Moin\mywiki</tt> directory, or else <tt class="backtick">moin.cgi</tt> will most likely give off various errors (including one about not being able to find a configuration file) and will ultimately fail to start up properly. <span class="anchor" id="line-110"></span></p><span class="anchor" id="line-111"></span><p class="line879">Additional configuration details can be found in <a href="">HelpOnConfiguration</a>. <span class="anchor" id="line-112"></span></p><span class="anchor" id="line-113"></span>
<h2 id="head-42c812a9d38d3af1de6c09ed952ac1858c5221b8">Integrating MoinMoin into Apache</h2>
<span class="anchor" id="line-114"></span><p class="line879">Use your editor to edit the file <tt class="backtick">C:\Moin\mywiki\moin.cgi</tt>.  Change the first line (the shebang statement) to point to your local Python executable program. Note the forward slashes -- Apache uses the Unix convention for folder separators. This tells Apache the <tt class="backtick">moin.cgi</tt> file is an executable script that will be interpreted by a program to be loaded from <tt class="backtick">C:/Python/python</tt>. <span class="anchor" id="line-115"></span></p><pre>
<span class="anchor" id="line-116"></span>#! C:/Python/python
<span class="anchor" id="line-117"></span></pre><span class="anchor" id="line-118"></span><span class="anchor" id="line-119"></span><p class="line879">After that, you may need to activate the lines which add a folder to the sys.path and enter your path to <a href="">MoinMoin</a> there if you have <strong>not</strong> installed <a href="">MoinMoin</a> to the site-packages dir: <span class="anchor" id="line-120"></span><span class="anchor" id="line-121"></span><span class="anchor" id="line-122"></span><span class="anchor" id="line-123"></span></p><div class="codearea" dir="ltr" lang="en">
<script type="text/javascript">
function isnumbered(obj) {
  return obj.childNodes.length && obj.firstChild.childNodes.length && obj.firstChild.firstChild.className == 'LineNumber';
function nformat(num,chrs,add) {
  var nlen = Math.max(0,chrs-(''+num).length), res = '';
  while (nlen>0) { res += ' '; nlen-- }
  return res+num+add;
function addnumber(did, nstart, nstep) {
  var c = document.getElementById(did), l = c.firstChild, n = 1;
  if (!isnumbered(c))
    if (typeof nstart == 'undefined') nstart = 1;
    if (typeof nstep  == 'undefined') nstep = 1;
    n = nstart;
    while (l != null) {
      if (l.tagName == 'SPAN') {
        var s = document.createElement('SPAN');
        s.className = 'LineNumber'
        s.appendChild(document.createTextNode(nformat(n,4,' ')));
        n += nstep;
        if (l.childNodes.length)
          l.insertBefore(s, l.firstChild)
      l = l.nextSibling;
  return false;
function remnumber(did) {
  var c = document.getElementById(did), l = c.firstChild;
  if (isnumbered(c))
    while (l != null) {
      if (l.tagName == 'SPAN' && l.firstChild.className == 'LineNumber') l.removeChild(l.firstChild);
      l = l.nextSibling;
  return false;
function togglenumber(did, nstart, nstep) {
  var c = document.getElementById(did);
  if (isnumbered(c)) {
  } else {
  return false;

<script type="text/javascript">
document.write('<a href="#" onclick="return togglenumber(\'CA-ae7207ce08c12f42f82f00c644b7aa0c244223a5_000\', 1, 1);" \
                class="codenumbers">Toggle line numbers<\/a>');
<pre dir="ltr" id="CA-ae7207ce08c12f42f82f00c644b7aa0c244223a5_000" lang="en"><span class="line"><span class="LineNumber">   1 </span><span class="ResWord">import</span> <span class="ID">sys</span></span>
<span class="line"><span class="LineNumber">   2 </span><span class="ID">sys</span><span class="Operator">.</span><span class="ID">path</span><span class="Operator">.</span><span class="ID">insert</span><span class="Operator">(</span><span class="Number">0</span><span class="Operator">,</span> <span class="String">r'C:\Moin\...'</span><span class="Operator">)</span><span class="Text"></span></span>
</pre></div><span class="anchor" id="line-124"></span><span class="anchor" id="line-125"></span><p class="line886">The next step is to tell Apache that is has more work to do. <span class="anchor" id="line-126"></span>Use your editor to append the following lines to <tt class="backtick">C:\Apache\conf\httpd.conf</tt>. Note the presence and absence of trailing slashes, it is important to enter the lines exactly as shown below. <span class="anchor" id="line-127"></span><span class="anchor" id="line-128"></span></p><pre>Alias       /wiki/     "C:/Python/share/moin/htdocs/"
<span class="anchor" id="line-129"></span>ScriptAlias /mywiki    "C:/Moin/mywiki/moin.cgi"
<span class="anchor" id="line-130"></span></pre><span class="anchor" id="line-131"></span><span class="anchor" id="line-132"></span><p class="line879">The <strong>Alias</strong> lines for <tt class="backtick">wiki</tt> above instructs Apache to serve images, style sheets, etc. from the specified folders and subfolders. The <strong>Script<tt class="backtick"></tt>Alias</strong> line is needed once for each wiki instance, so if you have multiple wikis, repeat the statement using mywiki2, mywiki3, etc. The Script<tt class="backtick"></tt>Alias statement instructs Apache to execute scripts from the specified folder. See the Apache docs for a complete explanation. <span class="anchor" id="line-133"></span></p><span class="anchor" id="line-134"></span><p class="line879">Test your changes by restarting your Apache server and try to access your newborn wiki with the URL <tt class="backtick"></tt>. You should see the Front<tt class="backtick"></tt>Page, try to edit and save it, and if that works, verify your edit is reflected on the Recent<tt class="backtick"></tt>Changes page. <span class="anchor" id="line-135"></span></p><span class="anchor" id="line-136"></span><p class="line879">And now, it is up to you and your user community to transform your wiki into an informative and useful tool. You will probably want to retain most of the Help<tt class="backtick"></tt>On~ pages dealing with editing, delete those pages with irrelevant information (like this page, don't let your users or boss know how easy it was to install Moin<tt class="backtick"></tt>Moin <img alt=";)" height="15" src="wiki/htdocs/modern/img/smile4.png" title=";)" width="15" /> ), and rewrite the Front<tt class="backtick"></tt>Page to introduce your wiki topic.  <span class="anchor" id="line-137"></span></p><span class="anchor" id="line-138"></span>
<h2 id="head-82ba5417401e5b5cb78836b4f23ef160fbc80630">Troubleshooting</h2>
<span class="anchor" id="line-139"></span><p class="line879">The first place to look for clues when the unexpected happens is to try changing your url to: <tt class="backtick"></tt>. If Apache can find and execute the module <tt class="backtick">C:/Moin/mywiki/moin.cgi</tt>, a page of diagnostics titled <strong>Moin<tt class="backtick"></tt>Moin CGI Diagnosis</strong> will be displayed. Check the output for error messages. <span class="anchor" id="line-140"></span></p><span class="anchor" id="line-141"></span><p class="line879">The second place to look for is <tt class="backtick">C:\Apache\logs\error.log</tt>. The following are common errors grouped by the message displayed by your browser. <span class="anchor" id="line-142"></span></p><span class="anchor" id="line-143"></span>
<h3 id="head-01d84d7e6494dcee0bd2abfbb04f43f812c9bdd7">Internal Server Error</h3>
<span class="anchor" id="line-144"></span><span class="anchor" id="line-145"></span><p class="line879">If the Apache log shows a message "The system cannot find the file specified." then a possibility is the shebang statement in <tt class="backtick">moin.cgi</tt> is incorrect. <span class="anchor" id="line-146"></span></p><span class="anchor" id="line-147"></span><p class="line879">If the Apache log shows a different error message, then the Moin<tt class="backtick"></tt>Moin Python scripts may be abending. To determine the cause, you could try temporarily renaming <tt class="backtick">moin.cgi</tt> to <tt class="backtick"></tt>, loading <tt class="backtick"></tt> with the Python <strong>idle</strong> IDE and executing it to determine if there are any error messages. <span class="anchor" id="line-148"></span></p><span class="anchor" id="line-149"></span>
<h3 id="head-7a4c0881ccb7242b9857811b27dc07ad836889d0">Not Found</h3>
<span class="anchor" id="line-150"></span><p class="line879">If the Apache error log shows the message "File does not exist: C:/Apache/htdocs/mywiki",  the <strong>Script<tt class="backtick"></tt>Alias</strong> statement in <tt class="backtick">httpd.conf</tt> may be incorrect. <span class="anchor" id="line-151"></span></p><span class="anchor" id="line-152"></span>
<h3 id="head-d9b4f0491158f7280b4bf1693d990336527ebf4d">The Page Cannot be found</h3>
<span class="anchor" id="line-153"></span><p class="line879">If the Apache error log shows the message "File does not exist: C:/Apache/htdocs/????", you may have mistyped the url "<a class="http" href=""></a>" into your browser. <span class="anchor" id="line-154"></span></p><span class="anchor" id="line-155"></span>
<h3 id="head-d47936fa3c21c07d857b27fdb811e5836635a100">FrontPage Loads Without Icons</h3>
<span class="anchor" id="line-156"></span><p class="line879">If the Apache Error log shows many error messages "File does not exist: C:/Apache/htdocs/wiki", then the <strong>Alias</strong> statement in <tt class="backtick">httpd.conf</tt> may be incorrect. <span class="anchor" id="line-157"></span></p><span class="anchor" id="bottom_Include_HelpOnInstalling/ApacheOnWin32"></span></div> <span class="anchor" id="line-72"></span></p><hr class="hr2" /><p class="line886"> <span class="anchor" id="line-73"></span><span class="anchor" id="win32iis-install"></span> <span class="anchor" id="line-74"></span>
<h1>Windows Installation using IIS</h1>
<div dir="ltr" id="Include_HelpOnInstalling/InternetInformationServer" lang="en"><span class="anchor" id="top_Include_HelpOnInstalling/InternetInformationServer"></span>
<span class="anchor" id="line-8"></span><span class="anchor" id="line-9"></span><p class="line903"><strong>Index</strong> <span class="anchor" id="line-10"></span><ol><li><a href="#head-060b14babb0736cc50274d972342cb03248902b9">Requirements</a></li><li><a href="#head-5ba445062f460e5652dc22727c85420aeece6353">Preparation</a><ol><li><a href="#head-4f6e8cac8cfeabe2476189c3adfc5c9782ab423b">Installing IIS</a></li><li><a href="#head-124918b94fdd224ff1d6bfff86c7525168676c98">Installing Python</a></li><li><a href="#head-a1cff6121b8b9ce2a1b1d94e923ae54f0b89ce4c">Installing MoinMoin</a></li></ol><li><a href="#head-c5d24a8b08d751dc989c57e5ec58363b55bef1b3">Creating a Wiki Instance</a><ol><li><a href="#head-890abdbd0d21bf874ce794be87067abf433a51d7">IIS 6.0 (Windows Server 2003)</a></li></ol><li><a href="#head-086499a2b43629c3fef3b36dc435cff210e32faa">Troubleshooting</a></li></ol> <span class="anchor" id="line-11"></span></p><span class="anchor" id="line-12"></span>
<h2 id="head-060b14babb0736cc50274d972342cb03248902b9">Requirements</h2>
<span class="anchor" id="line-13"></span><span class="anchor" id="line-14"></span><p class="line879">Before you install <a class="interwiki" href="" title="MoinMoin">MoinMoin</a>, make sure you have the necessary infra-structure in place, namely the <em>Internet Information Services</em> webserver (any version should be OK), and a <em>Python</em> installation (version 2.3 is required, the latest python release is recommended). <span class="anchor" id="line-15"></span></p><span class="anchor" id="line-16"></span><p class="line886">In the following description, we assume that you have installed or will install things to these locations: <span class="anchor" id="line-17"></span></p><ul><li><p class="line886">IIS to its default location <span class="anchor" id="line-18"></span></p></li><li><p class="line903"><tt class="backtick">C:\Python</tt> - the Python interpreter <span class="anchor" id="line-19"></span></p></li><li><p class="line903"><tt class="backtick">C:\Moin</tt> - Moin<tt class="backtick"></tt>Moin itself <span class="anchor" id="line-20"></span></p><span class="anchor" id="line-21"></span></li></ul><p class="line886">Quite often, you might want to install things elsewhere, which is no problem at all; you just have to adapt any paths that appear in a command or config file to the locations you have chosen. <span class="anchor" id="line-22"></span></p><span class="anchor" id="line-23"></span><p class="line886">This installation procedure was tested with IIS 5.1 for Windows running on Windows XP SP2, using Python 2.4. <span class="anchor" id="line-24"></span></p><span class="anchor" id="line-25"></span>
<h2 id="head-5ba445062f460e5652dc22727c85420aeece6353">Preparation</h2>
<span class="anchor" id="line-26"></span><span class="anchor" id="line-27"></span>
<h3 id="head-4f6e8cac8cfeabe2476189c3adfc5c9782ab423b">Installing IIS</h3>
<span class="anchor" id="line-28"></span><span class="anchor" id="line-29"></span><p class="line879">From Microsoft: (<a class="http" href=""></a>) <span class="anchor" id="line-30"></span></p><span class="anchor" id="line-31"></span><ul><li style="list-style-type:none"><p class="line886">To install IIS, add components, or remove components: <span class="anchor" id="line-32"></span></p><span class="anchor" id="line-33"></span><p class="line886">Click Start, point to Settings, click Control Panel and start the Add/Remove Programs application.  <span class="anchor" id="line-34"></span>Select Configure Windows, click the Components button, and then follow the on-screen instructions  <span class="anchor" id="line-35"></span>to install, remove, or add components to IIS.  <span class="anchor" id="line-36"></span></p><span class="anchor" id="line-37"></span></li></ul><p class="line879">Make sure that your webserver runs without problems before you start to install Moin<tt class="backtick"></tt>Moin; problems with your webserver installation are not in the scope of this document. <span class="anchor" id="line-38"></span></p><span class="anchor" id="line-39"></span>
<h3 id="head-124918b94fdd224ff1d6bfff86c7525168676c98">Installing Python</h3>
<span class="anchor" id="line-40"></span><span class="anchor" id="line-41"></span><p class="line879">Download <a class="http" href="">Python 2.3.4</a> and install it. Python installation is done via a standard Windows installer program. <span class="anchor" id="line-42"></span></p><span class="anchor" id="line-43"></span><p class="line879">Alternatively, you may download the <a class="http" href="">ActivePython distribution</a> as a Microsoft Installer package. <span class="anchor" id="line-44"></span></p><span class="anchor" id="line-45"></span>
<h3 id="head-a1cff6121b8b9ce2a1b1d94e923ae54f0b89ce4c">Installing MoinMoin</h3>
<span class="anchor" id="line-46"></span><span class="anchor" id="line-47"></span><p class="line879">Before creating a wiki instance, you have to download and install the basic Moin<tt class="backtick"></tt>Moin software. We assume you already have downloaded the distribution archive to the "<tt class="backtick">C:\TEMP</tt>" directory. <span class="anchor" id="line-48"></span></p><span class="anchor" id="line-49"></span><p class="line886">Open a console window and enter the following commands: <span class="anchor" id="line-50"></span><span class="anchor" id="line-51"></span></p><pre>C:
<span class="anchor" id="line-52"></span>cd \temp
<span class="anchor" id="line-53"></span>unzip
<span class="anchor" id="line-54"></span>cd moin-1.3
<span class="anchor" id="line-55"></span>python install --prefix=C:\Moin --record=install.log
<span class="anchor" id="line-56"></span></pre><span class="anchor" id="line-57"></span><ul><li style="list-style-type:none"><p class="line903"><img alt="/!\" height="15" src="wiki/htdocs/modern/img/alert.png" title="/!\" width="15" /> TODO: fix instructions for .tar.gz format used by recent moin versions. <span class="anchor" id="line-58"></span></p><span class="anchor" id="line-59"></span></li></ul><p class="line879">This will install all necessary files to the "<tt class="backtick">C:\Moin</tt>" directory, and create a "<tt class="backtick">install.log</tt>" file listing all the files that are created there. <span class="anchor" id="line-60"></span></p><span class="anchor" id="line-61"></span> <span class="anchor" id="line-62"></span><span class="anchor" id="line-63"></span>
<h2 id="head-c5d24a8b08d751dc989c57e5ec58363b55bef1b3">Creating a Wiki Instance</h2>
<span class="anchor" id="line-64"></span><span class="anchor" id="line-65"></span><p class="line886">Enter these commands in a console window from C:\Moin: <span class="anchor" id="line-66"></span><span class="anchor" id="line-67"></span></p><pre>md mywiki
<span class="anchor" id="line-68"></span>md mywiki\data
<span class="anchor" id="line-69"></span>md mywiki\underlay
<span class="anchor" id="line-70"></span>xcopy share\moin\data mywiki\data /E
<span class="anchor" id="line-71"></span>xcopy share\moin\underlay mywiki\underlay /E
<span class="anchor" id="line-72"></span>copy share\moin\server\moin.cgi mywiki\
<span class="anchor" id="line-73"></span>copy share\moin\config\ mywiki\
<span class="anchor" id="line-74"></span>copy share\moin\htdocs\index.html mywiki\default.htm
<span class="anchor" id="line-75"></span></pre><span class="anchor" id="line-76"></span><span class="anchor" id="line-77"></span><p class="line879">"<tt class="backtick">mywiki</tt>" is the name of your wiki instance, you might want to chose a different name best fitting the intended use of this instance; just don't name it simply "<tt class="backtick">wiki</tt>", because that would result in confusion and problems later on. <span class="anchor" id="line-78"></span></p><span class="anchor" id="line-79"></span><p class="line879">We have to make sure that <tt class="backtick">moin.cgi</tt> can find the Moin<tt class="backtick"></tt>Moin directory, so that "<tt>import&nbsp;MoinMoin</tt>" will work. The easiest way to make sure <tt class="backtick">MoinMoin</tt> can be imported is to append to <tt class="backtick">sys.path</tt> <em>within</em> <tt class="backtick">moin.cgi</tt>. <span class="anchor" id="line-80"></span></p><span class="anchor" id="line-81"></span><p class="line886">You can change the first two lines of code in moin.cgi to something like this: <span class="anchor" id="line-82"></span><span class="anchor" id="line-83"></span><span class="anchor" id="line-84"></span><span class="anchor" id="line-85"></span><span class="anchor" id="line-86"></span></p><div class="codearea" dir="ltr" lang="en">
<script type="text/javascript">
function isnumbered(obj) {
  return obj.childNodes.length && obj.firstChild.childNodes.length && obj.firstChild.firstChild.className == 'LineNumber';
function nformat(num,chrs,add) {
  var nlen = Math.max(0,chrs-(''+num).length), res = '';
  while (nlen>0) { res += ' '; nlen-- }
  return res+num+add;
function addnumber(did, nstart, nstep) {
  var c = document.getElementById(did), l = c.firstChild, n = 1;
  if (!isnumbered(c))
    if (typeof nstart == 'undefined') nstart = 1;
    if (typeof nstep  == 'undefined') nstep = 1;
    n = nstart;
    while (l != null) {
      if (l.tagName == 'SPAN') {
        var s = document.createElement('SPAN');
        s.className = 'LineNumber'
        s.appendChild(document.createTextNode(nformat(n,4,' ')));
        n += nstep;
        if (l.childNodes.length)
          l.insertBefore(s, l.firstChild)
      l = l.nextSibling;
  return false;
function remnumber(did) {
  var c = document.getElementById(did), l = c.firstChild;
  if (isnumbered(c))
    while (l != null) {
      if (l.tagName == 'SPAN' && l.firstChild.className == 'LineNumber') l.removeChild(l.firstChild);
      l = l.nextSibling;
  return false;
function togglenumber(did, nstart, nstep) {
  var c = document.getElementById(did);
  if (isnumbered(c)) {
  } else {
  return false;

<script type="text/javascript">
document.write('<a href="#" onclick="return togglenumber(\'CA-acbc60d12efe38198c86305c09c3ae16aba7d8ee_000\', 1, 1);" \
                class="codenumbers">Toggle line numbers<\/a>');
<pre dir="ltr" id="CA-acbc60d12efe38198c86305c09c3ae16aba7d8ee_000" lang="en"><span class="line"><span class="LineNumber">   1 </span><span class="Comment">#!python</span></span>
<span class="line"><span class="LineNumber">   2 </span><span class="Comment"></span><span class="ResWord">import</span> <span class="ID">sys</span></span>
<span class="line"><span class="LineNumber">   3 </span><span class="ID">sys</span><span class="Operator">.</span><span class="ID">path</span><span class="Operator">.</span><span class="ID">append</span><span class="Operator">(</span><span class="String">'C:/Moin/Lib/site-packages'</span><span class="Operator">)</span><span class="Text"></span></span>
</pre></div><span class="anchor" id="line-87"></span><p class="line879">Notice that we're pointing to the directory which contains the Moin<tt class="backtick"></tt>Moin directory, not the directory itself. <span class="anchor" id="line-88"></span></p><span class="anchor" id="line-89"></span><p class="line886">Next, you'll need to create two virtual directories in IIS. One for the shared data, and one for this specific wiki instance.  <span class="anchor" id="line-90"></span></p><span class="anchor" id="line-91"></span><p class="line879">Go to <em>Control Panel =&gt; Administrative Tools =&gt; Internet Information Service</em>. Open up the tree to <em>Default Web Site</em>.  <span class="anchor" id="line-92"></span></p><span class="anchor" id="line-93"></span><p class="line879">Right click on <em>Default Web Site</em> and choose <em>New =&gt; Virtual directory</em>. This will bring up a wizard with the mandatory useless first screen, hit next. Enter "<tt class="backtick">wiki</tt>" for the alias name and hit next. Browse to "<tt class="backtick">C:\Moin\share\moin\htdocs</tt>" and hit next. Leave the <em>Access permissions</em> at their defaults and hit next. And now you're done, hit finish! <span class="anchor" id="line-94"></span></p><span class="anchor" id="line-95"></span><p class="line879">Now follow the same steps, but set the alias to "<tt class="backtick">mywiki</tt>" and the path to "<tt class="backtick">C:\Moin\mywiki</tt>".  <span class="anchor" id="line-96"></span></p><span class="anchor" id="line-97"></span><p class="line879">Use IIS Admin to remove permissions to read the data directory: expand the "<tt class="backtick">mywiki</tt>" node, right click on <tt class="backtick">data</tt>, select <tt class="backtick">Properties</tt>, and uncheck <tt class="backtick">Read</tt>. Repeat these steps with the <tt class="backtick">underlay</tt> directory. <span class="anchor" id="line-98"></span></p><span class="anchor" id="line-99"></span><p class="line879">Now you need to setup the 'mywiki' alias so that it will run Python to interpret <tt class="backtick">.cgi</tt> files. On Windows Server 2003, you will need to click the <em>Create</em> button under <em>Application Settings</em> to create an application space. Right click on your new 'mywiki' alias and choose <em>Properties</em>. On the first tab (<em>Virtual Directory</em>), click the <em>Configuration</em> button. The first tab is the <em>App Mappings</em> tab, which defines which programs to use for each file exetension. Click <em>Add</em>. Browse to your <tt class="backtick">python.exe</tt> (probably something like <tt class="backtick">c:\pythonXX\python.exe</tt>). Then add <tt>-u&nbsp;"%s"&nbsp;"%s"</tt> after the Python executable path. The <em>Executable</em> line will look something like this: <tt>"C:\Python22\python.exe"&nbsp;-u&nbsp;"%s"&nbsp;"%s"</tt>. In the <em>Extension</em> box enter <tt>.cgi</tt> with the begining period. Make sure that the <em>Check that file exists</em> option is not checked (if it is, Moin<tt class="backtick"></tt>Moin won't be able to display sub pages). Ok, you're done with the alias configuration, click <em>OK</em> several times to get back out of all the dialog boxes. <span class="anchor" id="line-100"></span></p><span class="anchor" id="line-101"></span><p class="line879">If you add another wiki instance, you'll only need to setup the reference to its folder, they can safely share the "<tt class="backtick">wiki</tt>" alias which points to static files only. <span class="anchor" id="line-102"></span></p><span class="anchor" id="line-103"></span><p class="line879">That is all, try to access your new-born wiki with the URL "<tt class="backtick"></tt>". You should see the Front<tt class="backtick"></tt>Page, try to edit and save it, and if that works, see if your edit is reflected on the Recent<tt class="backtick"></tt>Changes page. <span class="anchor" id="line-104"></span></p><span class="anchor" id="line-105"></span><p class="line879">Finally, edit "<tt class="backtick"></tt>" and at least change "<tt class="backtick">sitename</tt>" and "<tt class="backtick">logo_string</tt>" to some personal values: <span class="anchor" id="line-106"></span><span class="anchor" id="line-107"></span></p><pre>sitename = u'My Wiki'
<span class="anchor" id="line-108"></span>logo_string = u'&lt;img src="/mywiki/images/mywiki-logo.gif" alt="MyWiki Logo"&gt;My Wiki'
<span class="anchor" id="line-109"></span></pre><span class="anchor" id="line-110"></span><p class="line879">Where "<tt class="backtick">images</tt>" is a directory under your "<tt class="backtick">mywiki</tt>" instance. <span class="anchor" id="line-111"></span></p><span class="anchor" id="line-112"></span><p class="line879">NOTE: The configuration variable "<tt class="backtick">url_prefix</tt>" in "<tt class="backtick"></tt>" should match the alias for "<tt class="backtick">C:\Moin\share\moin\htdocs</tt>" or themes will not work ("<tt class="backtick">/wiki</tt>" for the instructions above).  This way, any reference in "<tt class="backtick"></tt>" to "<tt class="backtick">/wiki/something</tt>" will look in the shared data directory and a reference to "<tt class="backtick">/mywiki/something</tt>" will look in the wiki instance directory.  These are considered absolute paths because relative paths will not work correctly. <span class="anchor" id="line-113"></span></p><span class="anchor" id="line-114"></span><p class="line903"><strong>Since <a href="">MoinMoin</a> 1.3.5</strong>, it seems you need to change the Custom Errors setting for 404 before you can create new pages. You can accomplish this by performing the following steps: <span class="anchor" id="line-115"></span></p><span class="anchor" id="line-116"></span><ol type="1"><li><p class="line886">Go into the IIS Manager, right-click on 'mywiki' (or whatever your wiki instance directory is called), and select properties. <span class="anchor" id="line-117"></span></p><span class="anchor" id="line-118"></span></li><li class="gap"><p class="line886">Next, go to the Custom Errors tab and find the 404 entry, and click the Edit button. <span class="anchor" id="line-119"></span></p><span class="anchor" id="line-120"></span></li><li class="gap"><p class="line886">Set "Message type" to "Default" and click click click until you're out of all the dialogs. <span class="anchor" id="line-121"></span></p><span class="anchor" id="line-122"></span></li></ol>
<h3 id="head-890abdbd0d21bf874ce794be87067abf433a51d7">IIS 6.0 (Windows Server 2003)</h3>
<span class="anchor" id="line-123"></span><span class="anchor" id="line-124"></span><p class="line879">The instructions below also apply to IIS 6.0 but the more aggressive security settings in newer version of IIS disallow the usage of <em>unknown CGI extensions</em>.  That means you will always get a 404 error unless you do this: <span class="anchor" id="line-125"></span></p><span class="anchor" id="line-126"></span><ol type="1"><li><p class="line879">Open IIS Manager by going to Start Menu-&gt;Programs-&gt;Administrative Tools-&gt;IIS Manager. <span class="anchor" id="line-127"></span></p><span class="anchor" id="line-128"></span></li><li class="gap"><p class="line879">Go to the <strong>Web Service Extensions</strong> folder. <span class="anchor" id="line-129"></span></p><span class="anchor" id="line-130"></span></li><li class="gap"><p class="line879">Under the <strong>Action</strong> menu, select <strong>Add a new Web service extension...</strong>. <span class="anchor" id="line-131"></span></p><span class="anchor" id="line-132"></span></li><li class="gap"><p class="line879">For Extension name, give it a name such as <em>.cgi</em> or <em>Python cgi</em> or something. <span class="anchor" id="line-133"></span></p><span class="anchor" id="line-134"></span></li><li class="gap"><p class="line879">Under <strong>Required files</strong> click the <strong>Add...</strong> button and type in the exact command-line string you used above. Eg: <em>c:\python24\python.exe -u "%s" "%s"</em>, then click the <strong>Ok</strong> button. <span class="anchor" id="line-135"></span></p><span class="anchor" id="line-136"></span></li><li class="gap"><p class="line879">Make sure the <strong>Set extension status to Allowed</strong> checkbox is checked and click the <strong>Ok</strong> button. <span class="anchor" id="line-137"></span></p><span class="anchor" id="line-138"></span></li></ol><p class="line886">Another change that may be necessary if you are receiving HTTP Error 403 19 1314 while using IIS 6.0 is to adjust the Identity settings for the Application Pool that is being used by your site.  The following steps assume you are adjusting the Default Web Site. <span class="anchor" id="line-139"></span></p><span class="anchor" id="line-140"></span><ol type="1"><li><p class="line879">Open IIS Manager by going to Start Menu-&gt;Programs-&gt;Administrative Tools-&gt;IIS Manager. <span class="anchor" id="line-141"></span></p><span class="anchor" id="line-142"></span></li><li class="gap"><p class="line879">Go to the <strong>Application Pool</strong> folder. <span class="anchor" id="line-143"></span></p><span class="anchor" id="line-144"></span></li><li class="gap"><p class="line879">Select the Application Pool you wish to adjust. (likely <strong>Default<tt class="backtick"></tt>App<tt class="backtick"></tt>Pool</strong> ) When you do this on the right you will see the Application pools for each site on the server.  This will include a Description (likely <strong>Default Application</strong> )and a Path (<strong>&lt;Default Web Site&gt;</strong>).  In this way you can be certain you are adjusting the appropriate Application Pool. <span class="anchor" id="line-145"></span></p><span class="anchor" id="line-146"></span></li><li class="gap"><p class="line879">With <strong>Default<tt class="backtick"></tt>App<tt class="backtick"></tt>Pool</strong> still selected right click and select <strong>Properties</strong>. <span class="anchor" id="line-147"></span></p><span class="anchor" id="line-148"></span></li><li class="gap"><p class="line879">Select the <strong>Identity</strong> tab and with <strong>Predefined</strong> clicked use the drop down box to change the <strong>Identity</strong> to <strong>Local System</strong> instead of Network Service. <span class="anchor" id="line-149"></span></p><span class="anchor" id="line-150"></span><p class="line903"><em>Please be aware that this is a workaround since you SHOULD set your group settings to allow Network Service to access the cgi scripts.</em> <span class="anchor" id="line-151"></span></p><span class="anchor" id="line-152"></span></li></ol><p class="line886">Under Windows Server 2003, you will also need to give your IUSR_MACHINENAME account Modify access to the mywiki\data and mywiki\underlay sub-directories, as file system permissions are more restricted by default than previous Windows versions. <span class="anchor" id="line-153"></span></p><span class="anchor" id="line-154"></span>
<h2 id="head-086499a2b43629c3fef3b36dc435cff210e32faa">Troubleshooting</h2>
<span class="anchor" id="line-155"></span><span class="anchor" id="line-156"></span><p class="line879">If you see an error like "<tt>ImportError:&nbsp;No&nbsp;module&nbsp;named&nbsp;MoinMoin</tt>", it means that python cannot find Moin<tt class="backtick"></tt>Moin. See above for how to add to <tt class="backtick">sys.path</tt>. <span class="anchor" id="line-157"></span></p><span class="anchor" id="line-158"></span><p class="line886">If you see an error like Error 13: Permission Denied, it means that your web user permissions for the files do not have write/modify enabled. <span class="anchor" id="line-159"></span></p><span class="anchor" id="line-160"></span><p class="line879">If the page never loads after hitting <tt class="backtick">Save&nbsp;Changes</tt>, you should check the permissions of the <tt class="backtick">data</tt> directory.  Make sure the IUSR_COMPUTERNAME user has modify permissions. <span class="anchor" id="line-161"></span></p><span class="anchor" id="line-162"></span><p class="line879">If some images like <a href="">InterWiki</a> and <a class="nonexistent nonexistent" href="">WorldWideWeb</a> don't show up, it could have been because of incorrect permissions or a bad "<tt class="backtick">url_prefix</tt>" in "<tt class="backtick"></tt>" or the cached pages need to be updated by an Edit or deleting them in the data folder. Or you are using MS IE which has broken CSS :before support - try another browser. <span class="anchor" id="line-163"></span></p><span class="anchor" id="line-164"></span><p class="line886">If you see an error message like: <span class="anchor" id="line-165"></span><span class="anchor" id="line-166"></span></p><pre>Check your URL regular expressions in the "wikis" list in "". Content-type: text/html;charset=utf-8
<span class="anchor" id="line-167"></span>MoinMoin Configuration Error
<span class="anchor" id="line-168"></span>Could not find a match for url: "servername/wikiname/moin.cgi?
<span class="anchor" id="line-169"></span>Check your URL regular expressions in the "wikis" list in "".
<span class="anchor" id="line-170"></span></pre><span class="anchor" id="line-171"></span><span class="anchor" id="line-172"></span><p class="line886">and you don't intend on using a serverfarm, remove the and farmconfig.pyc files and try again.  The error message shouldn't appear when you refresh the page.  <span class="anchor" id="line-173"></span></p><span class="anchor" id="line-174"></span><p class="line879">If you are using URLScan, you might have to add the following setting in the file <tt class="backtick">%SystemRoot%\system32\inetsrv\urlscan\urlscan.ini</tt>: <span class="anchor" id="line-175"></span></p><pre>[options]
<span class="anchor" id="line-176"></span>AllowHighBitCharacters=1
<span class="anchor" id="line-177"></span></pre><span class="anchor" id="line-178"></span><span class="anchor" id="bottom_Include_HelpOnInstalling/InternetInformationServer"></span></div> <span class="anchor" id="line-75"></span></p><hr class="hr2" /><p class="line886"> <span class="anchor" id="line-76"></span><span class="anchor" id="trouble-shooting"></span> <span class="anchor" id="line-77"></span>
<div dir="ltr" id="Include_HelpOnInstalling/TroubleShooting" lang="en"><span class="anchor" id="top_Include_HelpOnInstalling/TroubleShooting"></span>
<span class="anchor" id="line-8"></span><span class="anchor" id="line-9"></span><p class="line903"><strong>How to deal with common errors</strong> <span class="anchor" id="line-10"></span></p><span class="anchor" id="line-11"></span>
<h1 id="head-19c97c74376eccc15bf415113eb35925fb0600ef">First follow the instructions</h1>
<span class="anchor" id="line-12"></span><span class="anchor" id="line-13"></span><p class="line879">Moin has provided instructions for common usage.  Try creating a wiki using the default values within the instructions. Your wiki would then be stored where ours is, and named <tt class="backtick">mywiki</tt> ... but you can change that place, and this name, AFTER you have a working wiki. The default values have been chosen carefully to work for most people on most platforms, or at least be a good start. <span class="anchor" id="line-14"></span></p><span class="anchor" id="line-15"></span><ul><li><p class="line886">First follow the instructions <span class="anchor" id="line-16"></span></p></li><li><p class="line886">Do not change any configuration option unless you must. <span class="anchor" id="line-17"></span></p></li><li><p class="line886">Play with a working wiki before you try to customize it. <span class="anchor" id="line-18"></span></p><span class="anchor" id="line-19"></span></li></ul>
<h1 id="head-d6d40372ac4a2b91da396f084ba3faaf3e6c3845">Change one thing at a time</h1>
<span class="anchor" id="line-20"></span><span class="anchor" id="line-21"></span><p class="line886">When your wiki is running, go and customize it to your needs, but remember to change only one option at a time. You probably don't fully understand how all options work, and if you go and break few things in the same step, you will have hard time to fix it.  <span class="anchor" id="line-22"></span></p><span class="anchor" id="line-23"></span>
<h1 id="head-1372c460df94281a98cdde429b2496bdfd6e2677">Check That Your Webserver Can Use Python</h1>
<span class="anchor" id="line-24"></span><span class="anchor" id="line-25"></span><p class="line879">This is also in <a href="">HelpOnInstalling/BasicInstallation</a>.  Use this script: <span class="anchor" id="line-26"></span></p><span class="anchor" id="line-27"></span><span class="anchor" id="line-28"></span><pre>#!/bin/sh
<span class="anchor" id="line-29"></span>echo Content-Type: text/plain
<span class="anchor" id="line-30"></span>echo
<span class="anchor" id="line-31"></span>echo "Your web server is running as:"
<span class="anchor" id="line-32"></span>id
<span class="anchor" id="line-33"></span>echo "CGI scripts work"
<span class="anchor" id="line-34"></span>echo "Now we try to invoke Python interpreters and get their versions:"
<span class="anchor" id="line-35"></span>python -V 2&gt;&amp;1
<span class="anchor" id="line-36"></span>python2.3 -V 2&gt;&amp;1
<span class="anchor" id="line-37"></span>python2.4 -V 2&gt;&amp;1
<span class="anchor" id="line-38"></span>echo "Finished."
<span class="anchor" id="line-39"></span></pre><span class="anchor" id="line-40"></span><span class="anchor" id="line-41"></span><p class="line886">to see if you can get it to announce that cgi works. Then you will also know which versions of python are usable.  This is especially handy for users with no root access. <span class="anchor" id="line-42"></span></p><span class="anchor" id="line-43"></span>
<h1 id="head-82d34035b28a82ec380913906a9c676a0c20ecf3">Built-in test</h1>
<span class="anchor" id="line-44"></span><span class="anchor" id="line-45"></span><p class="line879">There's a built-in diagnostic mode that's useful when doing an install; just append "<tt class="backtick">?action=test</tt>" to the URL of your wiki: <span class="anchor" id="line-46"></span><span class="anchor" id="line-47"></span></p><pre>lynx --dump http://`hostname`/mywiki?action=test
<span class="anchor" id="line-48"></span></pre><span class="anchor" id="line-49"></span><span class="anchor" id="line-50"></span><p class="line886">If you see an import error here, but  <span class="anchor" id="line-51"></span></p><span class="anchor" id="line-52"></span><span class="anchor" id="line-53"></span><pre>python -c "import MoinMoin"
<span class="anchor" id="line-54"></span></pre><span class="anchor" id="line-55"></span><span class="anchor" id="line-56"></span><p class="line886">works, it's likely a result of missing file permissions or a wrong PYTHONPATH setting within the web server environment. <span class="anchor" id="line-57"></span></p><span class="anchor" id="line-58"></span>
<h1 id="head-68a88c328bf1907f03ed306eb15199cc98b2cd6a">Duelling Pythons</h1>
<span class="anchor" id="line-59"></span><span class="anchor" id="line-60"></span><p class="line879">The most common problem you might encounter is when you have an old Python version installed into "<tt class="backtick">/usr</tt>", and a newer Python distribution into "<tt class="backtick">/usr/local</tt>"; this is typical for GNU/Linux distributions that still come bundled with an old Python version. <span class="anchor" id="line-61"></span></p><span class="anchor" id="line-62"></span><p class="line879">In that case, if you enter "<tt class="backtick">python</tt>" on your prompt, you will usually get the more recent Python interpreter, because "<tt class="backtick">/usr/local/bin</tt>" is in your <tt class="backtick">PATH</tt>. The situation is different in your webserver environment, and thus you might have to change the bang path of "<tt class="backtick">moin.cgi</tt>", like this: <span class="anchor" id="line-63"></span><span class="anchor" id="line-64"></span></p><pre>#!/usr/local/bin/python
<span class="anchor" id="line-65"></span>
<span class="anchor" id="line-66"></span>"""
<span class="anchor" id="line-67"></span>    MoinMoin - CGI Driver Script
<span class="anchor" id="line-68"></span>...
<span class="anchor" id="line-69"></span>"""
<span class="anchor" id="line-70"></span></pre><span class="anchor" id="line-71"></span><span class="anchor" id="line-72"></span><ul><li><p class="line886">Debian stable users might want to look for backport of newer Python, or download and build Python from source. <span class="anchor" id="line-73"></span></p><span class="anchor" id="line-74"></span></li><li class="gap"><p class="line879">When installing, make sure you install with the version of python you want to run moin with. <tt class="backtick">python&nbsp;;install</tt> will install with the first python in the path, which may be the version you expect or not! <tt class="backtick">/usr/local/bin/python2.4</tt> will install in specific python. You will have to use the same path in the moin server script. <span class="anchor" id="line-75"></span></p><span class="anchor" id="line-76"></span></li></ul>
<h1 id="head-8e72ddd753a6ead652d17bd2c24324a9a0dc9512">Missing file permissions</h1>
<span class="anchor" id="line-77"></span><span class="anchor" id="line-78"></span><p class="line879">If you are root, the installed files may be readable only by root, but they must also be readable by the web server before the wiki will work. This includes both the Python modules and the site itself. For the data directory, the wiki engine also needs <em>write</em> access.  To fix this, first find out where the Python module directory is; look in <tt class="backtick">install.log</tt>, or run the command:  <span class="anchor" id="line-79"></span></p><span class="anchor" id="line-80"></span><span class="anchor" id="line-81"></span><pre>python -c "import sys; print '%s/lib/python%s/site-packages' % ( sys.prefix, sys.version[:3] )"
<span class="anchor" id="line-82"></span></pre><span class="anchor" id="line-83"></span><span class="anchor" id="line-84"></span><p class="line879">For the example below, we'll assume that the Python module directory is <tt class="backtick">/usr/local/lib/python2.3/site-packages</tt>. <span class="anchor" id="line-85"></span>Make the files world-readable using the following commands: <span class="anchor" id="line-86"></span><span class="anchor" id="line-87"></span></p><pre>cd /usr/local
<span class="anchor" id="line-88"></span>chmod -R a+rX lib/python2.3/site-packages/MoinMoin
<span class="anchor" id="line-89"></span></pre><span class="anchor" id="line-90"></span><span class="anchor" id="line-91"></span>
<h1 id="head-bf2856e568e384c1b4da0403cfee28297345e8a9">Set Your Variables Carefully</h1>
<span class="anchor" id="line-92"></span><span class="anchor" id="line-93"></span><p class="line879">Be especially careful when you retype instead of cut and paste. Quoting errors in <tt class="backtick"></tt> can cause things to fail.  The following items are also variable issues.  Also, some features only work if they are enabled by their option in either <tt class="backtick"></tt> or <tt class="backtick"></tt>. <span class="anchor" id="line-94"></span></p><span class="anchor" id="line-95"></span>
<h2 id="head-b3137d96e505ef20d7cff55253012674ea4a5d10">moin.cgi found, Moin doesn't run</h2>
<span class="anchor" id="line-96"></span><span class="anchor" id="line-97"></span><p class="line879">If you have to add the moin code location into the system path, make sure to specify the place <tt class="backtick"></tt>above<tt class="backtick"></tt> MoinMoin itself, so that the word MoinMoin is recognized during the import request.   <span class="anchor" id="line-98"></span></p><span class="anchor" id="line-99"></span>
<h2 id="head-ecc94aa011a0d0de8cfa6123fcfd70164d85a139">CSS files do not work</h2>
<span class="anchor" id="line-100"></span><span class="anchor" id="line-101"></span><p class="line879">Very common error is missing CSS styles. Your wiki look bare and ugly, unlike this nice wiki. In most cases, you did broke the configuration by not reading the instructions, or by trying to customize the instructions because you are smarter then us. <img alt=":-)" height="15" src="wiki/htdocs/modern/img/smile.png" title=":-)" width="15" /> <span class="anchor" id="line-102"></span></p><span class="anchor" id="line-103"></span><p class="line879">The fix is very easy: make sure your Apache Alias and <a class="nonexistent nonexistent" href="">ScriptAlias</a> are NOT the same. This Apache setup will never work: <span class="anchor" id="line-104"></span><span class="anchor" id="line-105"></span></p><pre>Alias /wiki/ "/prefix/share/moin/htdocs/"
<span class="anchor" id="line-106"></span>ScriptAlias /wiki/ "/var/www/wiki/moin.cgi"
<span class="anchor" id="line-107"></span></pre><span class="anchor" id="line-108"></span><span class="anchor" id="line-109"></span><p class="line879">Alias is used to server static files: css, images etc. <a class="nonexistent nonexistent" href="">ScriptAlias</a> is used to hide moin.cgi from the url. You must use different values! You can use anything you like for <a class="nonexistent nonexistent" href="">ScriptAlias</a>, or Alias, but Alias must match the <tt class="backtick">url_prefix</tt> configuration option. Here is an example that works (the default): <span class="anchor" id="line-110"></span><span class="anchor" id="line-111"></span></p><pre># Apache config
<span class="anchor" id="line-112"></span>Alias /wiki/ "/prefix/share/moin/htdocs/"
<span class="anchor" id="line-113"></span></pre><span class="anchor" id="line-114"></span><span class="anchor" id="line-115"></span><pre># Wiki config
<span class="anchor" id="line-116"></span>    url_prefix = '/wiki'
<span class="anchor" id="line-117"></span></pre><span class="anchor" id="line-118"></span><span class="anchor" id="bottom_Include_HelpOnInstalling/TroubleShooting"></span></div> <span class="anchor" id="line-78"></span></p><span class="anchor" id="bottom"></span></div><p id="pageinfo" class="info" lang="en" dir="ltr">MoinMaster: MoinMoin/InstallDocs  (last edited 2006-01-01 23:26:52 by <span title="??? @ localhost[]">localhost</span>)</p>
<div id="pagebottom"></div>