converted to 1.6 markup
|Deletions are marked like this.||Additions are marked like this.|
|Line 9:||Line 9:|
|This page describes the installation procedure applying to MoinMaster:MoinMoin version 1.1 and up. In the next section, there is a list of real-world [#installscenarios Installation Scenarios] that help you to understand how to apply the instructions in different environments.||This page describes the installation procedure applying to MoinMaster:MoinMoin version 1.1 and up. In the next section, there is a list of real-world [[#installscenarios|Installation Scenarios]] that help you to understand how to apply the instructions in different environments.|
|Line 11:||Line 11:|
|[#basic-install Basic Installation] explains the "`setup.py`" step of the installation in more detail. This applies equally to all scenarios, and you should read it before trying a live installation.||[[#basic-install|Basic Installation]] explains the "`setup.py`" step of the installation in more detail. This applies equally to all scenarios, and you should read it before trying a live installation.|
|Line 13:||Line 13:|
|[#trouble-shooting Trouble-shooting] helps with fixing any general problems you might encounter, which apply to any installation platform.||[[#trouble-shooting|Trouble-shooting]] helps with fixing any general problems you might encounter, which apply to any installation platform.|
|Line 20:||Line 20:|
|Line 26:||Line 26:|
|* [#unix-install UNIX Installation]||* [[#unix-install|UNIX Installation]]|
|Line 29:||Line 29:|
| * [#win32apache-install Windows Installation using Apache]
* [#win32iis-install Windows Installation using IIS]
| * [[#win32apache-install|Windows Installation using Apache]]
* [[#win32iis-install|Windows Installation using IIS]]
|Line 33:||Line 33:|
|* [#macosx-install Mac OS X Installation]||* [[#macosx-install|Mac OS X Installation]]|
|Line 36:||Line 36:|
| * [#fastcgi-install FastCGI Setup using Apache]
* [#modpy-install mod_python Setup using Apache]
* [#twisted-install Setup using twisted]
| * [[#fastcgi-install|FastCGI Setup using Apache]]
* [[#modpy-install|mod_python Setup using Apache]]
* [[#twisted-install|Setup using twisted]]
|Line 40:||Line 40:|
|Line 43:||Line 43:|
|Line 45:||Line 45:|
|[[Include(HelpOnInstalling/TroubleShooting, "Trouble-shooting", 1)]]||<<Include(HelpOnInstalling/TroubleShooting, "Trouble-shooting", 1)>>|
|Line 47:||Line 47:|
|Line 49:||Line 49:|
|[[Include(HelpOnInstalling/ApacheOnUnix, "UNIX Installation", 1)]]||<<Include(HelpOnInstalling/ApacheOnUnix, "UNIX Installation", 1)>>|
|Line 51:||Line 51:|
|Line 53:||Line 53:|
|[[Include(HelpOnInstalling/ApacheOnWin32, "Windows Installation using Apache", 1)]]||<<Include(HelpOnInstalling/ApacheOnWin32, "Windows Installation using Apache", 1)>>|
|Line 55:||Line 55:|
|Line 57:||Line 57:|
|[[Include(HelpOnInstalling/InternetInformationServer, "Windows Installation using IIS", 1)]]||<<Include(HelpOnInstalling/InternetInformationServer, "Windows Installation using IIS", 1)>>|
|Line 59:||Line 59:|
|Line 61:||Line 61:|
|[[Include(HelpOnInstalling/ApacheOnMacOsx, "Mac OS X Installation using Apache", 1)]]||<<Include(HelpOnInstalling/ApacheOnMacOsx, "Mac OS X Installation using Apache", 1)>>|
|Line 63:||Line 63:|
|Line 65:||Line 65:|
|[[Include(HelpOnInstalling/ApacheWithFastCgi, "FastCGI Setup using Apache", 1)]]||<<Include(HelpOnInstalling/ApacheWithFastCgi, "FastCGI Setup using Apache", 1)>>|
|Line 67:||Line 67:|
|Line 69:||Line 69:|
|[[Include(HelpOnInstalling/ApacheWithModPython, "mod_python Setup using Apache", 1)]]||<<Include(HelpOnInstalling/ApacheWithModPython, "mod_python Setup using Apache", 1)>>|
|Line 71:||Line 71:|
|Line 73:||Line 73:|
|[[Include(HelpOnInstalling/TwistedWeb, "Setup using Twisted", 1)]]||<<Include(HelpOnInstalling/TwistedWeb, "Setup using Twisted", 1)>>|
This HTML page contains the basic install docs that can be found on http://moinmaster.wikiwikiweb.de/MoinMoin/InstallDocs. 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 HelpOnInstalling page, which might contain more up-to-date information.
After following the procedures on this page, you should have a working wiki and can browse the rest of the online docs there.
How to install your own MoinMoin Wiki
This page describes the installation procedure applying to MoinMoin version 1.1 and up. In the next section, there is a list of real-world Installation Scenarios that help you to understand how to apply the instructions in different environments.
Basic Installation explains the "setup.py" step of the installation in more detail. This applies equally to all scenarios, and you should read it before trying a live installation.
Trouble-shooting helps with fixing any general problems you might encounter, which apply to any installation platform.
After a successful installation, you might want to read more about configuration and other options that you, as the wiki administrator, can set up. HelpOnAdministration contains links to pages that cover these topics. Especially, the HelpOnConfiguration and HelpOnUpdating pages provide additional information regarding wiki setup and maintenance. MoinMoinWinCvs and MoinMoinUnixCvs describe how to run your wiki using the current development version from the SourceForge CVS repository.
Please make sure that you do not accidently put your wiki's data/ directory under a directory directly accessible by your web server (like below document root). Or at least forbid your web server serving anything below data/ to a user - this is neither needed nor wanted! Your web server needs to serve moin.cgi and the stuff below htdocs only.
Sample Installation Scenarios
The following links lead you to concrete examples of installation sessions, showing the commands used and explaining what they do. It is highly recommended that you first read the general information on installing (especially the next section of this page) before choosing an installation scenario that best fits your intended use of MoinMoin.
Mac OS X:
Before you can integrate MoinMoin into your web environment, you have to do the basic installation using the standard Python distutils mechanism. We'll explain the usual steps you need to take to do this. For more details on the distutils installation process, consult the Installing Python Modules document of your Python manual.
NOTE: You will need the Python Development package installed on UNIX systems for distutils to work correctly.
The first step is to unpack the distribution archive, which you have done already when you loaded this instructions from your disk. If you read this on the web, the distribution comes in a versioned ZIP or TAR archive, which you can unpack in the usual ways, into a temporary directory (/tmp on UNIX, C:\TEMP on Windows). The distribution archive will always unpack into a directory named moin-<version>, for example moin-1.1. To download the distribution archive, go to the download area.
After unpacking, to install into a specific directory (C:\moin in our example), call setup.py after changing your current directory to the distribution directory. The following commands can be used to complete theses steps:
unzip moin-1.1.zip cd moin-1.1 python setup.py --quiet install --prefix=C:\moin
This creates the following directories in "C:\moin" (note that on a UNIX system, the directory layout will be slightly different):
MoinMoin MoinMoin/action MoinMoin/formatter MoinMoin/i18n MoinMoin/macro MoinMoin/parser MoinMoin/scripts MoinMoin/support MoinMoin/twisted MoinMoin/webapi Scripts share share/moin share/moin/cgi-bin share/moin/data share/moin/data/backup share/moin/data/cache share/moin/data/pages share/moin/data/plugin share/moin/data/plugin/action share/moin/data/plugin/macro share/moin/data/text share/moin/data/user share/moin/htdocs share/moin/htdocs/css share/moin/htdocs/img
You will likely see the following warning:
- warning: install: modules installed to 'C:\moin\', which is not in Python's module search path (sys.path) -- you'll have to change the search path yourself
This means exactly what it says, you need to add your install directory to the search path of Python. There are several ways to do this:
- Environment variable
Change PYTHONPATH in a way that is persistent (/etc/profile.d on UNIX, AUTOEXEC.BAT on W9x, the Properties item in the context menu of My Computer on NT4 and W2K)
- Apache "httpd.conf"
Use the SetEnv directive to set PYTHONPATH to a suitable value, for example:
SetEnv PYTHONPATH "C:\moin"
- Directly add your installation directory to
the CGI driver script, like this:
import sys sys.path.append('C:/moin')
If you use the following default installation command, MoinMoin will be installed to the Python directory:
python setup.py --quiet install
You won't need to change your PYTHONPATH then, but depending on your system environment you might not be able to use that command, especially when you are not the root user on a UNIX system. If you don't know where your Python directory is, this command will tell you:
python -c "import sys; print sys.prefix"
The directory structure we showed above will then be created in that directory. If you're interested in the exact list of files that are installed, use the --record option of distutils.
There's a built-in diagnostic mode that's useful when doing an install; just append "?test" to the URL of your wiki:
lynx --dump http://`hostname`/mywiki?test
If you see an import error here, but "python -c "import MoinMoin"" works, it's likely a result of missing file permissions or a wrong PYTHONPATH setting within the web server environment.
- Installation when you are root or the webmaster
- Installation into your home directory
Installation when you are root or the webmaster
When you are root or the webmaster on the host you want to install MoinMoin on, you can place the software in a "standard" location, and also better integrate MoinMoin into your webserver. Especially, you can use a "nice" base URL that does not include "cgi-bin" or "moin.cgi" at all.
Most GNU/Linux distributions come with Apache pre-installed. In the following description, we assume a file system layout with:
/etc/httpd/httpd.conf - the main httpd configuration file
/var/log/httpd/error_log - log containing error messages
Before creating a wiki instance, you have to download and install the basic MoinMoin software. We assume you already have downloaded the distribution archive to "/tmp" 1.
Open a shell and enter the following commands:
cd /tmp tar xzf moin-1.1.tgz cd moin-1.1 python setup.py install --record=install.log
This will install all necessary files into the sys.prefix directory of your Python interpreter (usually either "/usr" or "/usr/local"), and create a "install.log" file listing all the files that are created there. The command "python -c 'import sys; print sys.prefix'" will tell you where your Python interpreter is installed, we assume "/usr/local" here.
If you want to install the current development version from CVS, replace "/tmp" with your "moin" working directory. (1)
Creating a wiki instance
You could run your wiki directly using the sample wiki created in "/usr/local/share/moin", but this is not recommended for two reasons:
- updating your wiki is more complicated and more dangerous.
- creating a second wiki instance, even if you currently don't plan for one, is much easier.
We need to know what user and group your Apache server runs on, so issue this command:
jh@localhost:~ > egrep "^User|^Group" /etc/httpd/httpd.conf User wwwrun Group nogroup
This shows a typical result "wwwrun.nogroup", which we will use later on.
To create an instance named "mywiki", enter these commands on a root shell prompt:
cd /usr/local/share/moin mkdir mywiki cp -r data mywiki cp cgi-bin/* mywiki chown -R wwwrun.nogroup mywiki chmod a+rx mywiki/*.cgi
"mywiki" 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 "wiki", because that would result in problems later on.
Then, append these lines to "/etc/httpd/httpd.conf":
Alias /wiki/ "/usr/local/share/moin/htdocs/" ScriptAlias /mywiki "/usr/local/share/moin/mywiki/moin.cgi"
The first line you only need once; the second line is needed once for each wiki instance (of course, each one with another wiki name and path).
That is all, restart your Apache server (usually "/etc/init.d/apache restart") and try to access your new-born wiki with the URL "http://127.0.0.1/mywiki/". You should see the FrontPage, try to edit and save it, and if that works, see if your edit is reflected on the RecentChanges page.
Finally, edit "moin_config.py" and at least change "sitename" and "logo_url" to some personal values:
sitename = 'My Wiki' logo_url = '/images/mywiki-logo.gif'
For a personal or intranet installation, you'll normally also add the line
allowed_actions = ['DeletePage', 'AttachFile']
The first thing to do when your wiki does not work as expected is to issue the command "tail /var/log/httpd/error_log" to display the most recent errors. Usually, you will get a hint on what went wrong, like missing file system permissions. Also, always consult the HelpOnInstalling/TroubleShooting page for further hints on your problem.
The most common problem you might encounter is when you have an old Python version installed into "/usr", and a newer Python distribution into "/usr/local"; this is typical for GNU/Linux distributions that still come bundled with an old Python version.
In that case, if you enter "python" on your prompt, you will usually get the more recent Python interpreter, because "/usr/local/bin" is in your PATH. The situation is different in your webserver environment, and thus you might have to change the bang path of "moin.cgi", like this:
""" MoinMoin - CGI Driver Script ... """
Distutils does not work
If you have problems with the distutils install step, note that you need to have the Python development package installed on some Unix distributions. On Mandrake, you need to "rpm -i python-devel-2.x.x-xmdk.i586.rpm".
Missing file permissions
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 web server also needs write access. To fix this, first find out where the Python module directory is; look in install.log, or run the command:
python -c "import sys; print '%s/lib/python%s/site-packages' % ( sys.prefix, sys.version[:3] )"
For the example below, we'll assume that the Python module directory is /usr/local/lib/python2.3/site-packages. Make the files world-readable using the following commands:
cd /usr/local chmod -R a+rX lib/python2.3/site-packages/MoinMoin share/moin
Note that by making everything under /usr/local/share/moin world-readable, local users can read the files containing your wiki. You don't really need to do that, since the mywiki directory is owned by the webserver. If you don't want that, you do a "chmod -R o-rwx share/moin/mywiki" after the above commands.
Installation into your home directory
Installation into your shell account's home directory is typically used on a host shared by many users and where you are not the root user. This usually implies that you cannot change the httpd.conf file, and also you cannot copy files into the machine's cgi-bin and htdocs directories. For this situation, Apache includes the UserDir directive, which maps all URLs that start with "/~username" to a directory in your home directory, where you have write permissions and thus can install MoinMoin.
Making sure /~username URLs work
This kind of setup can only work if your webmaster has configured the host's Apache server so that the UserDir mechanism works. Here's how to check for this:
jh@localhost:~ > ls -ld public_html drwxr-xr-x 2 jh users 35 Jan 31 00:29 public_html
If this does not show a listing like above, then you might need to create the public_htmldirectory. Note that this directory must be readable (r-x) by the web server.
jh@localhost:~ > lynx -error_file=/dev/stderr -dump http://localhost/~jh/ >/dev/null URL=http://localhost/~jh/ (GET) STATUS=HTTP/1.1 200 OK
You see here that we get a "200 OK" status response, which means that you can access your public_html area. If it does not work, you will probably get a "403 Forbidden" or a "404 Not Found" response. The first one normally indicates that you need to fix the permissions of your home directory (~) or your ~/public_html. But we also need to be able to execute CGI scripts, so we test that, too.
jh@localhost:~ > `'''`cat >~/public_html/test.cgi #!/bin/sh echo Content-Type: text/plain echo echo IT WORKS <CTRL-D> jh@localhost:~ > chmod a+rx ~/public_html/test.cgi jh@localhost:~ > lynx -dump http://localhost/~jh/test.cgi IT WORKS
If you see anything else than "IT WORKS", then you are not allowed to execute CGI scripts. How you get that to work is not in the scope of this description, ask your webmaster!
A working Python installation is also assumed.
jh@localhost:~ > python -V Python 2.3
The command line examples show your input after the prompt (jh@localhost:~ >). The examples use "jh" as the user's name, which means you have to replace your own one whereever "jh" appears. The same is true for version numbers (1.1) and download URLs.
Doing the basic installation
The following commands will fetch and install a moin tarball. Use an appropriate URL to the version you want to install.
mkdir ~/tmp cd ~/tmp wget http://moin.sf.net/files/moin-1.1.tar.gz tar xfz moin-1.1.tar.gz cd moin-1.1 python setup.py --quiet install --home=$HOME --record=install.log
This will install the MoinMoin software into the directories "~/lib/python/MoinMoin", "~/bin", and "~/share/moin". You'll find a detailed file list in "install.log".
Setting up a wiki instance
The next step is to create a copy of the wiki data and the config file.
mkdir ~/wiki cd ~/wiki cp ~/share/moin/cgi-bin/moin_config.py . cp -r ~/share/moin/data . chmod -R o+rwX data vi moin_config.py
The last command starts the editor, you need to at least change the "data_dir" and "url_prefix" config values, as you can see in the following diff:
@@ -28,4 +28,4 @@ interwikiname = None -data_dir = './data/' -url_prefix = '/wiki' +data_dir = '/home/jh/wiki/data/' +url_prefix = '/~jh/wiki' logo_url = url_prefix + '/img/moinmoin.png'
Setting up public_html and testing the installation
Now we create the public part of the wiki, which is directly accessible by the web browser.
cd ~/public_html cp -r ~/share/moin/htdocs wiki cp ~/share/moin/cgi-bin/*.cgi . chmod a+rx *.cgi
To be able to execute the CGI script in your home directory, you need to extend Python's path within that script, and possibly adapt the bang path (that is the first line of the script). So, change "moin.cgi" similarly to this diff:
@@ -1,2 +1,2 @@ -#! /usr/bin/env python +#! /usr/local/bin/python2.3 @@ -11,4 +11,4 @@ -#import sys -#sys.path.append('/usr/local/home/USERNAME/lib/python') +import sys +sys.path.extend(['/home/jh/wiki', '/home/jh/lib/python'])
Finally, you can test your wiki installation by running the MoinMoin CGI Diagnosis:
lynx -dump http://localhost/~jh/moin.cgi?test
And now, your wiki should work and is available at the URL "http://localhost/~jh/moin.cgi". Conclude your tests by editing and saving the FrontPage and checking out RecentChanges, which should reflect that edit.