changeset 5137:f7052dd8d150

make install-docs interwiki
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Mon, 07 Sep 2009 13:28:47 +0200
parents d28f315d0ac0
children d57cfa1a3724
files docs/INSTALL.html docs/UPDATE.html
diffstat 2 files changed, 23 insertions(+), 17 deletions(-) [+]
line wrap: on
line diff
--- a/docs/INSTALL.html	Mon Sep 07 13:25:10 2009 +0200
+++ b/docs/INSTALL.html	Mon Sep 07 13:28:47 2009 +0200
@@ -80,7 +80,7 @@
 &gt;&gt;&gt;</pre><span class="anchor" id="HelpOnInstalling.2BAC8-BasicInstallation.line-155"></span><span class="anchor" id="HelpOnInstalling.2BAC8-BasicInstallation.line-156"></span><p class="line862">then you have to tune your installation. Try modifying <tt class="backtick">sys.path</tt>, as described above. <span class="anchor" id="HelpOnInstalling.2BAC8-BasicInstallation.line-157"></span><span class="anchor" id="HelpOnInstalling.2BAC8-BasicInstallation.line-158"></span><p class="line867">
 <h1 id="HelpOnInstalling.2BAC8-BasicInstallation.What_has_been_installed">What has been installed</h1>
 <span class="anchor" id="HelpOnInstalling.2BAC8-BasicInstallation.line-159"></span><span class="anchor" id="HelpOnInstalling.2BAC8-BasicInstallation.line-160"></span><p class="line862">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="HelpOnInstalling.2BAC8-BasicInstallation.line-161"></span><span class="anchor" id="HelpOnInstalling.2BAC8-BasicInstallation.line-162"></span><p class="line867"><img alt="/!\" height="16" src="http://static.moinmo.in/moin_static182/modernized/img/alert.png" title="/!\" width="16" /> 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="HelpOnInstalling.2BAC8-BasicInstallation.line-163"></span><span class="anchor" id="HelpOnInstalling.2BAC8-BasicInstallation.line-164"></span><p class="line862">In the following descriptions, <tt class="backtick">PREFIX</tt> is what you used with the <tt class="backtick">setup.py</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>, <tt class="backtick">2.4</tt> or <tt class="backtick">2.5</tt>. <span class="anchor" id="HelpOnInstalling.2BAC8-BasicInstallation.line-165"></span><span class="anchor" id="HelpOnInstalling.2BAC8-BasicInstallation.line-166"></span><p class="line862">Look into <tt class="backtick">install.log</tt> to find out about following important locations: <span class="anchor" id="HelpOnInstalling.2BAC8-BasicInstallation.line-167"></span><span class="anchor" id="HelpOnInstalling.2BAC8-BasicInstallation.line-168"></span><ul><li><p class="line891"><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="HelpOnInstalling.2BAC8-BasicInstallation.line-169"></span></li><li><p class="line891"><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="HelpOnInstalling.2BAC8-BasicInstallation.line-170"></span><ul><li><p class="line891"><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="HelpOnInstalling.2BAC8-BasicInstallation.line-171"></span></li><li><p class="line891"><strong><tt class="backtick">underlay</tt></strong> directory (wiki pages) - only Moin<tt class="backtick"></tt>Moin should access this <span class="anchor" id="HelpOnInstalling.2BAC8-BasicInstallation.line-172"></span></li><li><p class="line891"><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="HelpOnInstalling.2BAC8-BasicInstallation.line-173"></span></li><li><p class="line891"><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="HelpOnInstalling.2BAC8-BasicInstallation.line-174"></span></li><li><p class="line891"><strong><tt class="backtick">config</tt></strong> - Moin<tt class="backtick"></tt>Moin example configuration files (like <tt class="backtick">wikiconfig.py</tt>) <span class="anchor" id="HelpOnInstalling.2BAC8-BasicInstallation.line-175"></span></li></ul></li><li><p class="line891"><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="HelpOnInstalling.2BAC8-BasicInstallation.line-176"></span><span class="anchor" id="HelpOnInstalling.2BAC8-BasicInstallation.line-177"></span></li></ul><p class="line862">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. Please see <a class="nonexistent" href="http://master18.moinmo.in/WikiInstanceCreation">WikiInstanceCreation</a> <span class="anchor" id="HelpOnInstalling.2BAC8-BasicInstallation.line-178"></span><span class="anchor" id="HelpOnInstalling.2BAC8-BasicInstallation.bottom"></span></div> <span class="anchor" id="line-48"></span><hr class="hr2" /><p class="line874"> <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="HelpOnInstalling.2BAC8-WikiInstanceCreation.content" lang="en"><span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.top"></span>
-<span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-8"></span><span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-9"></span><p class="line862">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="http://master18.moinmo.in/HelpOnInstalling/BasicInstallation">../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="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-10"></span><span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-11"></span><p class="line862">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 independent from the others, with a different configuration, different pages, different users, etc. <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-12"></span><span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-13"></span><p class="line874">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="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-14"></span><span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-15"></span><p class="line862">Linux users can <a class="attachment" href="http://master18.moinmo.in/HelpOnInstalling/WikiInstanceCreation?action=AttachFile&amp;do=view&amp;target=createinstance.sh" title="attachment:createinstance.sh">download and use createinstance.sh</a> (a bash script that creates the instance) instead of doing all steps manually: <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-16"></span><ol type="1"><li>If anything is unclear, just read the sections below for more hints. <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-17"></span></li><li>Have a look into the script before running it, if all settings are correct for your setup: <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-18"></span><ul><li><p class="line862">If your system does not have <tt class="backtick">/bin/bash</tt>. try <tt class="backtick">/bin/sh</tt> (or whatever your shell is called) - see the first line in the script. <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-19"></span></li><li>USER and GROUP should be the user and group used by your web-server for running moin. <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-20"></span></li><li><p class="line862">SHARE is where the shared files were copied to, see install.log from the <tt class="backtick">setup.py&nbsp;install</tt> step <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-21"></span></li></ul></li><li><p class="line862">Make the script executable (e.g. <tt class="backtick">chmod&nbsp;+x&nbsp;createinstance.sh</tt>). <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-22"></span></li><li>The script takes a single parameter: the location of your wiki instance (see "Choose a location" section below): <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-23"></span><span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-24"></span><span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-25"></span><pre># ./createinstance.sh /path/to/mywiki</pre><span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-26"></span></li><li>Now continue in section "Tune configuration" <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-27"></span><span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-28"></span></li></ol><p class="line867">
+<span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-8"></span><span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-9"></span><p class="line862">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="http://master18.moinmo.in/HelpOnInstalling/BasicInstallation">../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="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-10"></span><span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-11"></span><p class="line862">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 independent from the others, with a different configuration, different pages, different users, etc. <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-12"></span><span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-13"></span><p class="line874">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="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-14"></span><span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-15"></span><p class="line862">Linux users can <a class="attachment" href="http://master18.moinmo.in/HelpOnInstalling/WikiInstanceCreation?action=AttachFile&amp;do=view&amp;target=createinstance.sh" title="download and use createinstance.sh">download and use createinstance.sh</a> (a bash script that creates the instance) instead of doing all steps manually: <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-16"></span><ol type="1"><li>If anything is unclear, just read the sections below for more hints. <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-17"></span></li><li>Have a look into the script before running it, if all settings are correct for your setup: <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-18"></span><ul><li><p class="line862">If your system does not have <tt class="backtick">/bin/bash</tt>. try <tt class="backtick">/bin/sh</tt> (or whatever your shell is called) - see the first line in the script. <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-19"></span></li><li>USER and GROUP should be the user and group used by your web-server for running moin. <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-20"></span></li><li><p class="line862">SHARE is where the shared files were copied to, see install.log from the <tt class="backtick">setup.py&nbsp;install</tt> step <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-21"></span></li></ul></li><li><p class="line862">Make the script executable (e.g. <tt class="backtick">chmod&nbsp;+x&nbsp;createinstance.sh</tt>). <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-22"></span></li><li>The script takes a single parameter: the location of your wiki instance (see "Choose a location" section below): <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-23"></span><span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-24"></span><span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-25"></span><pre># ./createinstance.sh /path/to/mywiki</pre><span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-26"></span></li><li>Now continue in section "Tune configuration" <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-27"></span><span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-28"></span></li></ol><p class="line867">
 <h1 id="HelpOnInstalling.2BAC8-WikiInstanceCreation.Read_this_first">Read this first</h1>
 <span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-29"></span><span class="anchor" id="HelpOnInstalling.2BAC8-WikiInstanceCreation.line-30"></span><p class="line867">
 <h2 id="HelpOnInstalling.2BAC8-WikiInstanceCreation.Security_warnings">Security warnings</h2>
@@ -515,7 +515,7 @@
 <h3 id="HelpOnInstalling.2BAC8-TwistedWeb.on_Windows">on Windows</h3>
 <span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-75"></span><span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-76"></span><p class="line862">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="HelpOnInstalling.2BAC8-TwistedWeb.line-77"></span><span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-78"></span><p class="line862">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="HelpOnInstalling.2BAC8-TwistedWeb.line-79"></span><span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-80"></span><p class="line867">
 <h4 id="HelpOnInstalling.2BAC8-TwistedWeb.A_windows_service_runner_written_in_Python">A windows service runner written in Python</h4>
-<span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-81"></span><p class="line867"><a class="https" href="https://twitter.com/zhangchunlin">I</a> have written a service runner to help configuring a windows service to run, because I prefer to run moin using Twisted. <span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-82"></span><span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-83"></span><p class="line874">Usage: <span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-84"></span><ol type="1"><li>install pywin32 <span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-85"></span></li><li>download servicerunner.py <span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-86"></span></li><li>modify the "mointwisted" and "mointwisted_dir" according to your system <span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-87"></span></li><li>run "servicerunner.py install" on the command line <span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-88"></span><span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-89"></span></li></ol><p class="line867"><a class="attachment" href="http://master18.moinmo.in/HelpOnInstalling/TwistedWeb?action=AttachFile&amp;do=view&amp;target=servicerunner.py" title="attachment:servicerunner.py">servicerunner.py</a> <span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-90"></span><span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.bottom"></span></div> <span class="anchor" id="line-63"></span><hr class="hr2" /><p class="line874"> <span class="anchor" id="line-64"></span><span class="anchor" id="linuxstandalone-install"></span> <span class="anchor" id="line-65"></span>
+<span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-81"></span><p class="line867"><a class="https" href="https://twitter.com/zhangchunlin">I</a> have written a service runner to help configuring a windows service to run, because I prefer to run moin using Twisted. <span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-82"></span><span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-83"></span><p class="line874">Usage: <span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-84"></span><ol type="1"><li>install pywin32 <span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-85"></span></li><li>download servicerunner.py <span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-86"></span></li><li>modify the "mointwisted" and "mointwisted_dir" according to your system <span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-87"></span></li><li>run "servicerunner.py install" on the command line <span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-88"></span><span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-89"></span></li></ol><p class="line867"><a class="attachment" href="http://master18.moinmo.in/HelpOnInstalling/TwistedWeb?action=AttachFile&amp;do=view&amp;target=servicerunner.py" title="">servicerunner.py</a> <span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.line-90"></span><span class="anchor" id="HelpOnInstalling.2BAC8-TwistedWeb.bottom"></span></div> <span class="anchor" id="line-63"></span><hr class="hr2" /><p class="line874"> <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="HelpOnInstalling.2BAC8-StandaloneServer.content" lang="en"><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.top"></span>
 <span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-9"></span><p class="line867"><strong>Installing and configuring standalone server</strong> <span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-10"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-11"></span><p class="line862">See also: <a href="http://master18.moinmo.in/HelpOnConfiguration/IntegratingWithApache">HelpOnConfiguration/IntegratingWithApache</a> <span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-12"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-13"></span><p class="line874">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="HelpOnInstalling.2BAC8-StandaloneServer.line-14"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-15"></span><p class="line867">
@@ -592,7 +592,10 @@
 <span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-89"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-90"></span><p class="line874">The sample config file should be just fine. <span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-91"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-92"></span><p class="line862">The default value of <tt class="backtick">url_prefix_static</tt> is hardcoded into the standalone server script, do not change it or it won't work! <span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-93"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-94"></span><p class="line867">
 <h2 id="HelpOnInstalling.2BAC8-StandaloneServer.Using_the_secure_standalone_server">Using the secure standalone server</h2>
 <span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-95"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-96"></span><p class="line862">The standalone server supports SSL when using the <a class="nonexistent" href="http://master18.moinmo.in/SecureThreadPoolServer">SecureThreadPoolServer</a> server class. The SSL support is provided by the <a class="http" href="http://trevp.net/tlslite/">TLSLite library</a>. <strong>All wiki traffic is forced to SSL when using the <a class="nonexistent" href="http://master18.moinmo.in/SecureThreadPoolServer">SecureThreadPoolServer</a></strong>.  <span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-97"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-98"></span><p class="line862">Two additional configuration options are required when using the <a class="nonexistent" href="http://master18.moinmo.in/SecureThreadPoolServer">SecureThreadPoolServer</a>. First, <tt class="backtick">ssl_privkey</tt> must point to the server's private key. Second, <tt class="backtick">ssl_certificate</tt> must point to the server's certificate.  <span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-99"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-100"></span><p class="line867"><img alt="/!\" height="16" src="http://static.moinmo.in/moin_static182/modernized/img/alert.png" title="/!\" width="16" /> <em>TLSLite does not support a password protected private key unless additional libraries are used. Consult the TLSLite webpage for more information.</em> <span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-101"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-102"></span><p class="line862">Typically a certificate would be purchased from an certificate authority, such as Thawte (<a class="http" href="http://www.thawte.com">http://www.thawte.com</a>). However, since the suggested usage of the standalone server is for personal use, a self signed certificate may be appropriate. For more information on how to generate a server private key, and a self signed certificate, see the <a class="http" href="http://www.openssl.org/docs/HOWTO/">openssl HOWTO pages</a>. <span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-103"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-104"></span><p class="line874">For example, to create the server's private key, run the following: <span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-105"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-106"></span><p class="line867"><tt class="backtick">openssl&nbsp;genrsa&nbsp;-out&nbsp;privkey.pem&nbsp;2048</tt> <span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-107"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-108"></span><p class="line874">To create a self signed certificate for the newly created private key, run the following: <span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-109"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-110"></span><p class="line867"><tt class="backtick">openssl&nbsp;req&nbsp;-new&nbsp;-x509&nbsp;-key&nbsp;privkey.pem&nbsp;-out&nbsp;cacert.pem&nbsp;-days&nbsp;1095</tt> <span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-111"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-112"></span><p class="line862">moin.py then needs to be told about the generated files <tt class="backtick">privkey.pem</tt> and <tt class="backtick">cacert.pem</tt>. For the example above, the following lines would need to be added to moin.py: <span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-113"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-114"></span><p class="line867"><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-115"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-116"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-117"></span><pre>    ssl_privkey = "/secure/path/to/privkey.pem"
-    ssl_certificate = "/secure/path/to/cacert.pem"</pre><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-118"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-119"></span><p class="line867"><img alt="/!\" height="16" src="http://static.moinmo.in/moin_static182/modernized/img/alert.png" title="/!\" width="16" /> Using a self signed certificate will cause your browser to generate a warning that it cannot verify the identify of the wiki server. This is because the certificate was not signed by a recognized certificate authority (CA). In order to get rid of this warning, you must purchase a certificate from a CA. <span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-120"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.bottom"></span></div> <span class="anchor" id="line-66"></span><hr class="hr2" /><p class="line874"> <span class="anchor" id="line-67"></span><span class="anchor" id="macosx-install"></span> <span class="anchor" id="line-68"></span>
+    ssl_certificate = "/secure/path/to/cacert.pem"</pre><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-118"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-119"></span><p class="line867"><img alt="/!\" height="16" src="http://static.moinmo.in/moin_static182/modernized/img/alert.png" title="/!\" width="16" /> Using a self signed certificate will cause your browser to generate a warning that it cannot verify the identify of the wiki server. This is because the certificate was not signed by a recognized certificate authority (CA). In order to get rid of this warning, you must purchase a certificate from a CA. <span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-120"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-121"></span><p class="line867">
+<h3 id="HelpOnInstalling.2BAC8-StandaloneServer.Serving_Port_443">Serving Port 443</h3>
+<span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-122"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-123"></span><p class="line862">A secure standalone server may be run to listen on port 443, but this requires root to start the server. An alternative, is to use <tt class="backtick">iptables</tt> to run a secure standalone server on an unprivileged port such as 8081 but redirect traffic through privileged port 443 (setting iptables requires root): <span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-124"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-125"></span><p class="line867"><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-126"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-127"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-128"></span><pre>/sbin/iptables -t nat -A PREROUTING -p tcp --dport 443 -j REDIRECT --to-port 8081
+/sbin/iptables -t nat -A OUTPUT -o lo -p tcp --dport 443 -j REDIRECT --to-port 8081</pre><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-129"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-130"></span><p class="line862">It is also necessary to indicate that the https scheme is to be used instead of http. In the <tt class="backtick">wikiserverconfig.py</tt> configuration (see above), a property must be set as: <span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-131"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-132"></span><p class="line867"><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-133"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-134"></span><pre>    properties = { "is_ssl": 1 }</pre><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.line-135"></span><span class="anchor" id="HelpOnInstalling.2BAC8-StandaloneServer.bottom"></span></div> <span class="anchor" id="line-66"></span><hr class="hr2" /><p class="line874"> <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="HelpOnInstalling.2BAC8-ApacheOnMacOsx.content" lang="en"><span class="anchor" id="HelpOnInstalling.2BAC8-ApacheOnMacOsx.top"></span>
 <span class="anchor" id="HelpOnInstalling.2BAC8-ApacheOnMacOsx.line-8"></span><span class="anchor" id="HelpOnInstalling.2BAC8-ApacheOnMacOsx.line-9"></span><p class="line874">These instructions will walk you through, step by step, setting up Moin on Mac OS X <span class="anchor" id="HelpOnInstalling.2BAC8-ApacheOnMacOsx.line-10"></span><span class="anchor" id="HelpOnInstalling.2BAC8-ApacheOnMacOsx.line-11"></span><p class="line867"><div class="table-of-contents"><p class="table-of-contents-heading">Contents<ol><li>
@@ -832,7 +835,7 @@
 <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-125"></span><p class="line862">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="HelpOnInstalling.2BAC8-InternetInformationServer.line-126"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-127"></span><ol type="1"><li><p class="line862">Open <strong>IIS Manager</strong> (Start &gt; Programs &gt; Administrative Tools &gt; IIS Manager). <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-128"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-129"></span></li><li class="gap"><p class="line862">Go to the <strong>Web Service Extensions</strong> folder. <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-130"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-131"></span></li><li class="gap"><p class="line862">Under the <strong>Action</strong> menu, select <strong>Add a new Web service extension...</strong>. <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-132"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-133"></span></li><li class="gap"><p class="line862">For Extension name, give it a name such as <em>.cgi</em> or <em>Python cgi</em> or similar. <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-134"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-135"></span></li><li class="gap"><p class="line862">Under <strong>Required files</strong> click the <strong>Add...</strong> button and type in the exact command-line string you used above. Eg: <tt>c:\python24\python.exe&nbsp;-u&nbsp;"%s"&nbsp;"%s"</tt>, then click the <strong>Ok</strong> button. <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-136"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-137"></span></li><li class="gap"><p class="line862">Make sure the <strong>Set extension status to Allowed</strong> checkbox is checked and click the <strong>Ok</strong> button. <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-138"></span></li></ol><p class="line874">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="HelpOnInstalling.2BAC8-InternetInformationServer.line-139"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-140"></span><ol type="1"><li><p class="line862">Open <strong>IIS Manager</strong> (Start &gt; Programs &gt; Administrative Tools &gt; IIS Manager). <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-141"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-142"></span></li><li class="gap"><p class="line862">Go to the <strong>Application Pool</strong> folder. <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-143"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-144"></span></li><li class="gap"><p class="line862">Select the Application Pool you wish to adjust. (likely <strong>DefaultAppPool</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="HelpOnInstalling.2BAC8-InternetInformationServer.line-145"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-146"></span></li><li class="gap"><p class="line862">With <strong>DefaultAppPool</strong> still selected right click and select <strong>Properties</strong>. <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-147"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-148"></span></li><li class="gap"><p class="line862">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. <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="HelpOnInstalling.2BAC8-InternetInformationServer.line-149"></span></li></ol><p class="line862">Under Windows Server 2003, you will also need to give your IUSR_MACHINENAME account <em>Modify</em> 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="HelpOnInstalling.2BAC8-InternetInformationServer.line-150"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-151"></span><p class="line862">That is all, try to access your new-born wiki with the URL <a class="http" href="http://127.0.0.1/mywiki/">http://127.0.0.1/mywiki/</a>. 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. <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-152"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-153"></span><p class="line867">
 <h3 id="HelpOnInstalling.2BAC8-InternetInformationServer.Configuring_wikiconfig.py">Configuring wikiconfig.py</h3>
 <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-154"></span><p class="line862">Finally, edit "<tt>wikiconfig.py</tt>" and at least change "<tt>sitename</tt>" and "<tt>logo_string</tt>" to some personal values: <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-155"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-156"></span><p class="line867"><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-157"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-158"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-159"></span><pre>sitename = u'My Wiki'
-logo_string = u'&lt;img src="/mywiki/images/mywiki-logo.gif" alt="MyWiki Logo"&gt;My Wiki'</pre><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-160"></span><p class="line862">Where "<tt>images</tt>" is a directory under your "<tt>mywiki</tt>" instance. <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-161"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-162"></span><p class="line862">NOTE: The configuration variable "<tt>url_prefix</tt>" in "<tt>wikiconfig.py</tt>" should match the alias for "<tt>C:\Moin\share\moin\htdocs</tt>" or themes will not work ("<tt>/wiki</tt>" for the instructions above). This way, any reference in "<tt>wikiconfig.py</tt>" to "<tt>/wiki/something</tt>" will look in the shared data directory and a reference to "<tt>/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="HelpOnInstalling.2BAC8-InternetInformationServer.line-163"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-164"></span><p class="line874">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="HelpOnInstalling.2BAC8-InternetInformationServer.line-165"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-166"></span><ol type="1"><li>Go into the IIS Manager, right-click on 'mywiki' (or whatever your wiki instance directory is called), and select properties. <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-167"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-168"></span></li><li class="gap"><p class="line862">Next, go to the Custom Errors tab and find the 404 entry, and click the <em>Set to Default</em> button. <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-169"></span></li></ol><p class="line867">
+logo_string = u'&lt;img src="/mywiki/images/mywiki-logo.gif" alt="MyWiki Logo"&gt;My Wiki'</pre><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-160"></span><p class="line862">Where "<tt>images</tt>" is a directory under your "<tt>mywiki</tt>" instance. <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-161"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-162"></span><p class="line862">NOTE: The configuration variable "<tt>url_prefix_static</tt>" in "<tt>wikiconfig.py</tt>" should match the alias for "<tt>C:\Moin\share\moin\htdocs</tt>" or themes will not work ("<tt>/wiki</tt>" for the instructions above). This way, any reference in "<tt>wikiconfig.py</tt>" to "<tt>/wiki/something</tt>" will look in the shared data directory and a reference to "<tt>/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="HelpOnInstalling.2BAC8-InternetInformationServer.line-163"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-164"></span><p class="line874">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="HelpOnInstalling.2BAC8-InternetInformationServer.line-165"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-166"></span><ol type="1"><li>Go into the IIS Manager, right-click on 'mywiki' (or whatever your wiki instance directory is called), and select properties. <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-167"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-168"></span></li><li class="gap"><p class="line862">Next, go to the Custom Errors tab and find the 404 entry, and click the <em>Set to Default</em> button. <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-169"></span></li></ol><p class="line867">
 <h2 id="HelpOnInstalling.2BAC8-InternetInformationServer.Troubleshooting">Troubleshooting</h2>
 <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-170"></span><ul><li><p class="line862">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>sys.path</tt>. <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-171"></span></li><li>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="HelpOnInstalling.2BAC8-InternetInformationServer.line-172"></span></li><li><p class="line862">If the page never loads after hitting <tt>Save&nbsp;Changes</tt>, you should check the permissions of the <tt>data</tt> directory. Make sure the IUSR_COMPUTERNAME user has modify permissions. <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-173"></span></li><li><p class="line862">If some images like InterWiki and WorldWideWeb don't show up, it could have been because of incorrect permissions or a bad "<tt>url_prefix</tt>" in "<tt>wikiconfig.py</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="HelpOnInstalling.2BAC8-InternetInformationServer.line-174"></span></li><li><p class="line862">If you see an error message like:<br>
  <span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-175"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-176"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-177"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-178"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-179"></span><span class="anchor" id="HelpOnInstalling.2BAC8-InternetInformationServer.line-180"></span><pre>Check your URL regular expressions in the "wikis" list in "farmconfig.py". Content-type: text/html;charset=utf-8
--- a/docs/UPDATE.html	Mon Sep 07 13:25:10 2009 +0200
+++ b/docs/UPDATE.html	Mon Sep 07 13:28:47 2009 +0200
@@ -46,33 +46,36 @@
 <a href="#InterWiki_data">InterWiki data</a></li><li>
 <a href="#Your_valuable_own_pages">Your valuable own pages</a></li></ol></li><li>
 <a href="#Clean_your_cache">Clean your cache</a></li><li>
-<a href="#Troubleshooting">Troubleshooting</a></li></ol></li></ol></li></ol></div><p class="line874"> <span class="anchor" id="line-12"></span><span class="anchor" id="line-13"></span><p class="line867">
+<a href="#Troubleshooting">Troubleshooting</a></li></ol></li><li>
+<a href="#Version_specific_notes">Version specific notes</a></li></ol></li></ol></div><p class="line874"> <span class="anchor" id="line-12"></span><span class="anchor" id="line-13"></span><p class="line867">
 <h2 id="General_procedures">General procedures</h2>
 <span class="anchor" id="line-14"></span><p class="line867">
 <h3 id="Download_and_unpack_the_new_MoinMoin_archive">Download and unpack the new MoinMoin archive</h3>
-<span class="anchor" id="line-15"></span><p class="line862">Download the <a href="http://master18.moinmo.in/MoinMoin">MoinMoin</a> code that you are interested in updating to. If you are not a developer, this is usually the latest released version from the project homepage. <span class="anchor" id="line-16"></span><span class="anchor" id="line-17"></span><p class="line867"><img alt="(!)" height="16" src="http://static.moinmo.in/moin_static182/modernized/img/idea.png" title="(!)" width="16" /> Often it is better (and easy enough) to install <em>latest</em> release from distribution archive than relying on some outdated package provided by your Linux distribution. Some people use moin as a package, because they hope for easy upgrades and security fixes. But often, there are either no upgrades or they are not easy and in the worst case, there are not even security fixes. <span class="anchor" id="line-18"></span><span class="anchor" id="line-19"></span><span class="anchor" id="line-20"></span><p class="line867">
+<span class="anchor" id="line-15"></span><p class="line862">Download the <a href="http://master18.moinmo.in/MoinMoin">MoinMoin</a> code that you are interested in updating to. If you are not a developer, this is usually the latest released version from the project homepage. <span class="anchor" id="line-16"></span><span class="anchor" id="line-17"></span><span class="anchor" id="line-18"></span><p class="line867">
 <h3 id="Reading_the_docs">Reading the docs</h3>
-<span class="anchor" id="line-21"></span><p class="line862">Please read the files <tt class="backtick">docs/CHANGES</tt> and <tt class="backtick">docs/README.migration</tt> contained in the moin distribution archive for details on what changed and how to upgrade. <span class="anchor" id="line-22"></span><span class="anchor" id="line-23"></span><p class="line867"><img alt="/!\" height="16" src="http://static.moinmo.in/moin_static182/modernized/img/alert.png" title="/!\" width="16" /> The docs might contain import installation, compatibility and upgrade hints we won't repeat here. <span class="anchor" id="line-24"></span><span class="anchor" id="line-25"></span><p class="line867">
+<span class="anchor" id="line-19"></span><p class="line867"><span class="anchor" id="line-20"></span><span class="anchor" id="line-21"></span><span class="anchor" id="line-22"></span><span class="anchor" id="line-23"></span><div class="note"><span class="anchor" id="line-1"></span><p class="line862">Please read the files <tt class="backtick">docs/CHANGES</tt> and <tt class="backtick">docs/README.migration</tt> contained in the moin distribution archive for details on what changed and how to upgrade. <span class="anchor" id="line-2"></span><span class="anchor" id="line-3"></span><p class="line874">The docs might contain import installation, compatibility and upgrade hints we won't repeat here. </div><span class="anchor" id="line-24"></span><span class="anchor" id="line-25"></span><p class="line867">
 <h3 id="Backup">Backup</h3>
-<span class="anchor" id="line-26"></span><span class="anchor" id="line-27"></span><p class="line867"><img alt="/!\" height="16" src="http://static.moinmo.in/moin_static182/modernized/img/alert.png" title="/!\" width="16" /> <strong>Before you update an existing wiki, MAKE A BACKUP!</strong> <span class="anchor" id="line-28"></span><span class="anchor" id="line-29"></span><p class="line862">You have been warned, and it's not our fault when you end up like this: <img alt="X-(" height="16" src="http://static.moinmo.in/moin_static182/modernized/img/angry.png" title="X-(" width="16" />  <span class="anchor" id="line-30"></span><span class="anchor" id="line-31"></span><p class="line862">As you want to make a <em>complete</em> backup (not even losing a single edit), you want to stop your wiki server process now. <span class="anchor" id="line-32"></span><span class="anchor" id="line-33"></span><p class="line874">This is what you should backup (the real paths depend on your installation): <span class="anchor" id="line-34"></span><ul><li><p class="line862">The directory containing the <a href="http://master18.moinmo.in/MoinMoin">MoinMoin</a> code files (e.g. <tt>/usr/lib/python*.*/site-packages/MoinMoin</tt>) <span class="anchor" id="line-35"></span><ul><li><p class="line891"><img alt="(!)" height="16" src="http://static.moinmo.in/moin_static182/modernized/img/idea.png" title="(!)" width="16" /> after you have a backup of this, you might want to delete the <tt class="backtick">MoinMoin</tt> directory there to avoid having old code files there that are not overwritten by the new code, but maybe interfering with it) <span class="anchor" id="line-36"></span></li></ul></li><li><p class="line862">The directory containing your data (e.g. <tt>/usr/share/moin/wikiname/data</tt> - see data_dir in your moin_config.py).  <span class="anchor" id="line-37"></span></li><li>your moin.cgi file (or moin.fcg or other adaptor file you use) <span class="anchor" id="line-38"></span></li><li>your wikiconfig.py or farmconfig.py or other wiki configuration files <span class="anchor" id="line-39"></span></li><li>your web server configuration files <span class="anchor" id="line-40"></span></li><li>optionally you can also backup your underlay_data_dir (it shouldn't contain data from you, but it is maybe easier to rollback if you have a backup of it and don't need to get it from some other place) <span class="anchor" id="line-41"></span><span class="anchor" id="line-42"></span></li></ul><p class="line867">
+<span class="anchor" id="line-26"></span><span class="anchor" id="line-27"></span><p class="line867"><span class="anchor" id="line-28"></span><span class="anchor" id="line-29"></span><span class="anchor" id="line-30"></span><span class="anchor" id="line-31"></span><div class="warning"><span class="anchor" id="line-1-1"></span><p class="line867"><strong>Before you update an existing wiki, MAKE A BACKUP!</strong> <span class="anchor" id="line-2-1"></span><span class="anchor" id="line-3-1"></span><p class="line862">You have been warned, and it's not our fault when you end up like this: <img alt="X-(" height="16" src="http://static.moinmo.in/moin_static182/modernized/img/angry.png" title="X-(" width="16" />  </div><span class="anchor" id="line-32"></span><span class="anchor" id="line-33"></span><p class="line862">As you want to make a <em>complete</em> backup (not even losing a single edit), you want to stop your wiki server process now. <span class="anchor" id="line-34"></span><span class="anchor" id="line-35"></span><p class="line874">This is what you should backup (the real paths depend on your installation): <span class="anchor" id="line-36"></span><ul><li><p class="line862">The directory containing the <a href="http://master18.moinmo.in/MoinMoin">MoinMoin</a> code files (e.g. <tt>/usr/lib/python*.*/site-packages/MoinMoin</tt>) <span class="anchor" id="line-37"></span><ul><li><p class="line891"><img alt="(!)" height="16" src="http://static.moinmo.in/moin_static182/modernized/img/idea.png" title="(!)" width="16" /> after you have a backup of this, you might want to delete the <tt class="backtick">MoinMoin</tt> directory there to avoid having old code files there that are not overwritten by the new code, but maybe interfering with it) <span class="anchor" id="line-38"></span></li></ul></li><li><p class="line862">The directory containing your data (e.g. <tt>/usr/share/moin/wikiname/data</tt> - see data_dir in your moin_config.py).  <span class="anchor" id="line-39"></span></li><li>your moin.cgi file (or moin.fcg or other adaptor file you use) <span class="anchor" id="line-40"></span></li><li>your wikiconfig.py or farmconfig.py or other wiki configuration files <span class="anchor" id="line-41"></span></li><li>your web server configuration files <span class="anchor" id="line-42"></span></li><li>optionally you can also backup your underlay_data_dir (it shouldn't contain data from you, but it is maybe easier to rollback if you have a backup of it and don't need to get it from some other place) <span class="anchor" id="line-43"></span><span class="anchor" id="line-44"></span></li></ul><p class="line867">
 <h3 id="Code_update">Code update</h3>
-<span class="anchor" id="line-43"></span><p class="line862">First remove the old <a href="http://master18.moinmo.in/MoinMoin">MoinMoin</a> code (including any <tt class="backtick">*.pyc</tt> and <tt class="backtick">*.pyo</tt> files). <span class="anchor" id="line-44"></span><span class="anchor" id="line-45"></span><p class="line862">If you are installing from the original distribution archive, run "<tt>python&nbsp;setup.py&nbsp;install</tt>" as root to install the new version. <span class="anchor" id="line-46"></span><span class="anchor" id="line-47"></span><p class="line874">If you are using some Linux (or other) distributor's package, please read their docs. <span class="anchor" id="line-48"></span><span class="anchor" id="line-49"></span><p class="line874">Please also upgrade your moin.cgi (or moin.wsgi or other) server adaptor file. You likely have to edit it to fix some pathes and you also need to set some specific user/group/mode on that file (just look at the old one before replacing it). <span class="anchor" id="line-50"></span><span class="anchor" id="line-51"></span><p class="line867">
+<span class="anchor" id="line-45"></span><p class="line862">First remove the old <a href="http://master18.moinmo.in/MoinMoin">MoinMoin</a> code (including any <tt class="backtick">*.pyc</tt> and <tt class="backtick">*.pyo</tt> files). <span class="anchor" id="line-46"></span><span class="anchor" id="line-47"></span><p class="line862">If you are installing from the original distribution archive, run "<tt>python&nbsp;setup.py&nbsp;install</tt>" as root to install the new version. <span class="anchor" id="line-48"></span><span class="anchor" id="line-49"></span><p class="line874">If you are using some Linux (or other) distributor's package, please read their docs. <span class="anchor" id="line-50"></span><span class="anchor" id="line-51"></span><p class="line874">Please also upgrade your moin.cgi (or moin.wsgi or other) server adaptor file. You likely have to edit it to fix some pathes and you also need to set some specific user/group/mode on that file (just look at the old one before replacing it). <span class="anchor" id="line-52"></span><span class="anchor" id="line-53"></span><p class="line867">
 <h3 id="Configuration_update">Configuration update</h3>
-<span class="anchor" id="line-52"></span><span class="anchor" id="line-53"></span><p class="line874">After upgrading, your existing wiki should continue to work (the goal is to have sane defaults for any new config values, but then there can be bugs and also changes that must break compatibility). <span class="anchor" id="line-54"></span><span class="anchor" id="line-55"></span><p class="line862">Check that this is indeed the case, and then take the time to check the CHANGES file in your distribution archive. Often, new features will be invisible unless you extend your configuration in <tt class="backtick">wikiconfig.py</tt>. <span class="anchor" id="line-56"></span><span class="anchor" id="line-57"></span><p class="line862">Check that you have the latest "intermap.txt" file; If you have your own entries, you can point "shared_intermap" at a file loaded <em>before</em> the file in your data directory, which takes precedence (i.e. have global entries in the shared one, private entries the data dir file). <span class="anchor" id="line-58"></span><span class="anchor" id="line-59"></span><p class="line867">
+<span class="anchor" id="line-54"></span><span class="anchor" id="line-55"></span><p class="line874">After upgrading, your existing wiki should continue to work (the goal is to have sane defaults for any new config values, but then there can be bugs and also changes that must break compatibility). <span class="anchor" id="line-56"></span><span class="anchor" id="line-57"></span><p class="line862">Check that this is indeed the case, and then take the time to check the CHANGES file in your distribution archive. Often, new features will be invisible unless you extend your configuration in <tt class="backtick">wikiconfig.py</tt>. <span class="anchor" id="line-58"></span><span class="anchor" id="line-59"></span><p class="line862">Check that you have the latest "intermap.txt" file; If you have your own entries, you can point "shared_intermap" at a file loaded <em>before</em> the file in your data directory, which takes precedence (i.e. have global entries in the shared one, private entries the data dir file). <span class="anchor" id="line-60"></span><span class="anchor" id="line-61"></span><p class="line867">
 <h3 id="Static_stuff_update">Static stuff update</h3>
-<span class="anchor" id="line-60"></span><span class="anchor" id="line-61"></span><p class="line874">On every update, you should copy the content of the "wiki/htdocs/" directory we provide to the directory visible to your web server, normally a new release has some new images, CSS and Javascript in it. <span class="anchor" id="line-62"></span><span class="anchor" id="line-63"></span><p class="line862">You also have to change your web server / directory setup to match the <tt class="backtick">url_prefix_static</tt> setting of moin. This defaults to <tt class="backtick">/moin_staticVVV</tt> (VVV is 170 for moin release 1.7.0) and the default will change on every release (moin 1.7.1 will use <tt class="backtick">/moin_static171</tt> by default). This is done to be able to use a very long cache lifetime for the static stuff, so your wiki will be faster and cause less load and traffic. <span class="anchor" id="line-64"></span><span class="anchor" id="line-65"></span><p class="line867">
+<span class="anchor" id="line-62"></span><span class="anchor" id="line-63"></span><p class="line874">On every update, you should copy the content of the "wiki/htdocs/" directory we provide to the directory visible to your web server, normally a new release has some new images, CSS and Javascript in it. <span class="anchor" id="line-64"></span><span class="anchor" id="line-65"></span><p class="line862">You also have to change your web server / directory setup to match the <tt class="backtick">url_prefix_static</tt> setting of moin. This defaults to <tt class="backtick">/moin_staticVVV</tt> (VVV is 170 for moin release 1.7.0) and the default will change on every release (moin 1.7.1 will use <tt class="backtick">/moin_static171</tt> by default). This is done to be able to use a very long cache lifetime for the static stuff, so your wiki will be faster and cause less load and traffic. <span class="anchor" id="line-66"></span><span class="anchor" id="line-67"></span><p class="line867">
 <h3 id="Wiki_pages_update">Wiki pages update</h3>
-<span class="anchor" id="line-66"></span><p class="line867">
+<span class="anchor" id="line-68"></span><p class="line867">
 <h4 id="System_and_Help_pages">System and Help pages</h4>
-<span class="anchor" id="line-67"></span><p class="line862">System and help pages are separately stored in the <tt class="backtick">underlay</tt> directory. Just use the fresh underlay directory we provide in the distribution archive (move the old one to your backup directory). <span class="anchor" id="line-68"></span><span class="anchor" id="line-69"></span><p class="line867">
+<span class="anchor" id="line-69"></span><p class="line862">System and help pages are separately stored in the <tt class="backtick">underlay</tt> directory. Just use the fresh underlay directory we provide in the distribution archive (move the old one to your backup directory). <span class="anchor" id="line-70"></span><span class="anchor" id="line-71"></span><p class="line862">If you previously modified some system page in your wiki (see <a href="http://master18.moinmo.in/EditedSystemPages">EditedSystemPages</a> on your wiki), you might want to <em>Delete</em> them to use moinmoin's updated version (warning: you can't un-delete that page later). <span class="anchor" id="line-72"></span><span class="anchor" id="line-73"></span><p class="line867">
 <h4 id="InterWiki_data">InterWiki data</h4>
-<span class="anchor" id="line-70"></span><p class="line862">Copy <tt class="backtick">intermap.txt</tt> from the distribution archive into your wiki data  <span class="anchor" id="line-71"></span><span class="anchor" id="line-72"></span><p class="line867">
+<span class="anchor" id="line-74"></span><p class="line862">Copy <tt class="backtick">intermap.txt</tt> from the distribution archive into your wiki data  <span class="anchor" id="line-75"></span><span class="anchor" id="line-76"></span><p class="line867">
 <h4 id="Your_valuable_own_pages">Your valuable own pages</h4>
-<span class="anchor" id="line-73"></span><p class="line862">See CHANGES and README.migration for maybe necessary steps to convert your <tt class="backtick">data_dir</tt> to what we expect. <span class="anchor" id="line-74"></span><span class="anchor" id="line-75"></span><p class="line867">
+<span class="anchor" id="line-77"></span><p class="line862">See CHANGES and README.migration for maybe necessary steps to convert your <tt class="backtick">data_dir</tt> to what we expect. <span class="anchor" id="line-78"></span><span class="anchor" id="line-79"></span><p class="line867">
 <h3 id="Clean_your_cache">Clean your cache</h3>
-<span class="anchor" id="line-76"></span><p class="line862">Finally, delete cached data by running <tt class="backtick">moin&nbsp;...&nbsp;maint&nbsp;cleancache</tt>. This is necessary for things like the updated <a href="http://master18.moinmo.in/InterWiki">InterWiki</a> data to trickle down into the pages that use it. <span class="anchor" id="line-77"></span><span class="anchor" id="line-78"></span><p class="line867">
+<span class="anchor" id="line-80"></span><p class="line862">Finally, delete cached data by running <tt class="backtick">moin&nbsp;...&nbsp;maint&nbsp;cleancache</tt>. This is necessary for things like the updated <a href="http://master18.moinmo.in/InterWiki">InterWiki</a> data to trickle down into the pages that use it. <span class="anchor" id="line-81"></span><span class="anchor" id="line-82"></span><p class="line867">
 <h3 id="Troubleshooting">Troubleshooting</h3>
-<span class="anchor" id="line-79"></span><p class="line874">Use absolute pathes, not relative ones. <span class="anchor" id="line-80"></span><span class="anchor" id="line-81"></span><p class="line874">Make sure you have an adequate logging configuration (see server adaptor script and the logging configuration file) and carefully read the log! <span class="anchor" id="line-82"></span><span class="anchor" id="line-83"></span><p class="line862">Make sure python can find the MoinMoin code package and your wiki configuration files (fix <tt class="backtick">sys.path</tt> in the server adaptor script or PYTHONPATH in the environment). <span class="anchor" id="line-84"></span><span class="anchor" id="line-85"></span><p class="line862">Make sure MoinMoin can find the data_dir and data_underlay_dir (see <tt class="backtick">wikiconfig.py</tt>). <span class="anchor" id="line-86"></span><span class="anchor" id="line-87"></span><p class="line862">When you are editing python code files (e.g. <tt class="backtick">wikiconfig.py</tt>), be careful to indent correctly (use 4 spaces, not tabs) and also be careful not to make syntax errors. If you have a working config, do not make too many changes at once (and have a backup of a working version). <span class="anchor" id="line-88"></span><span class="anchor" id="line-89"></span><p class="line862">Check permissions (the moin process needs read/write access to <tt class="backtick">data_dir</tt> and <tt class="backtick">data_underlay_dir</tt>, it needs at least read access to the <a href="http://master18.moinmo.in/MoinMoin">MoinMoin</a> code and configuration). <span class="anchor" id="line-90"></span><span class="anchor" id="line-91"></span><p class="line862">Depending on your installation, more tightly secured permissions are a good idea. Ideally, you assign all files in the data directory to the user the web server runs under, and then you use <tt class="backtick">700</tt> or <tt class="backtick">770</tt> - see also the <tt class="backtick">config.umask</tt> setting. <span class="anchor" id="line-92"></span><span class="anchor" id="bottom"></span></div><p id="pageinfo" class="info" lang="en" dir="ltr">MoinMaster: HelpOnUpdating  (last edited 2008-07-16 18:34:31 by <span title="SamMorris @ 78.146.165.120[78.146.165.120]"><a class="interwiki" href="http://moinmo.in/SamMorris" title="SamMorris @ 78.146.165.120[78.146.165.120]">SamMorris</a></span>)</p>
+<span class="anchor" id="line-83"></span><p class="line874">Hints: <span class="anchor" id="line-84"></span><span class="anchor" id="line-85"></span><ul><li>Use absolute pathes, not relative ones. <span class="anchor" id="line-86"></span><span class="anchor" id="line-87"></span></li><li class="gap">Make sure you have an adequate logging configuration (see server adaptor script and the logging configuration file) and carefully read the log! <span class="anchor" id="line-88"></span><span class="anchor" id="line-89"></span></li><li class="gap"><p class="line862">Make sure python can find the MoinMoin code package and your wiki configuration files (fix <tt class="backtick">sys.path</tt> in the server adaptor script or PYTHONPATH in the environment). <span class="anchor" id="line-90"></span><span class="anchor" id="line-91"></span></li><li class="gap"><p class="line862">Make sure MoinMoin can find the data_dir and data_underlay_dir (see <tt class="backtick">wikiconfig.py</tt>). <span class="anchor" id="line-92"></span><span class="anchor" id="line-93"></span></li><li class="gap"><p class="line862">When you are editing python code files (e.g. <tt class="backtick">wikiconfig.py</tt>), be careful to indent correctly (use 4 spaces, not tabs) and also be careful not to make syntax errors. If you have a working config, do not make too many changes at once (and have a backup of a working version). <span class="anchor" id="line-94"></span><span class="anchor" id="line-95"></span></li><li class="gap"><p class="line862">Check permissions (the moin process needs read/write access to <tt class="backtick">data_dir</tt> and <tt class="backtick">data_underlay_dir</tt>, it needs at least read access to the <a href="http://master18.moinmo.in/MoinMoin">MoinMoin</a> code and configuration). <span class="anchor" id="line-96"></span><span class="anchor" id="line-97"></span></li><li class="gap"><p class="line862">Depending on your installation, more tightly secured permissions are a good idea. Ideally, you assign all files in the data directory to the user the web server runs under, and then you use <tt class="backtick">700</tt> or <tt class="backtick">770</tt> - see also the <tt class="backtick">config.umask</tt> setting. <span class="anchor" id="line-98"></span><span class="anchor" id="line-99"></span></li></ul><p class="line867">
+<h2 id="Version_specific_notes">Version specific notes</h2>
+<span class="anchor" id="line-100"></span><ul><li><p class="line862">For 1.2.x to 1.3.x, you maybe find some useful hints on <a class="interwiki" href="http://moinmo.in/MauricioHernandez/HowToSurviveMigration" title="MoinMoin">MauricioHernandez/HowToSurviveMigration</a>. <span class="anchor" id="line-101"></span></li><li><p class="line862">For 1.5.x to 1.6.x, see <a class="interwiki" href="http://moinmo.in/RickVanderveer/UpgradingFromMoin15ToMoin16" title="MoinMoin">RickVanderveer/UpgradingFromMoin15ToMoin16</a>. <span class="anchor" id="line-102"></span></li><li><p class="line862">For 1.6.x to 1.7.x, see <a class="interwiki" href="http://moinmo.in/RickVanderveer/UpgradingFromMoin16ToMoin17" title="MoinMoin">RickVanderveer/UpgradingFromMoin16ToMoin17</a>. <span class="anchor" id="line-103"></span></li><li><p class="line862">For 1.7.x to 1.8.x, see <a class="interwiki" href="http://moinmo.in/RickVanderveer/UpgradingFromMoin17ToMoin18" title="MoinMoin">RickVanderveer/UpgradingFromMoin17ToMoin18</a>. <span class="anchor" id="line-104"></span></li></ul><span class="anchor" id="bottom"></span></div><p id="pageinfo" class="info" lang="en" dir="ltr">MoinMaster: HelpOnUpdating  (last edited 2009-06-27 13:36:05 by <span title="FranklinPiat @ klabs.be[82.224.65.140]"><a class="interwiki" href="http://moinmo.in/FranklinPiat" title="FranklinPiat @ klabs.be[82.224.65.140]">FranklinPiat</a></span>)</p>
 <div id="pagebottom"></div>
 </div>
 </body>