diff docs/UPDATE.html @ 5761:2955339b8b03

updated install-docs
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Thu, 06 Jan 2011 13:22:30 +0100
parents b0bb4e06ff2d
children 044b2a46063d
line wrap: on
line diff
--- a/docs/UPDATE.html	Thu Jan 06 13:21:52 2011 +0100
+++ b/docs/UPDATE.html	Thu Jan 06 13:22:30 2011 +0100
@@ -6,7 +6,7 @@
 <meta name="robots" content="noindex,nofollow">
 
 <title>HelpOnUpdating - 1.9 Master Wiki</title>
-<script type="text/javascript" src="/moin_static193/common/js/common.js"></script>
+<script type="text/javascript" src="../MoinMoin/web/static/htdocs/common/js/common.js"></script>
 
 
 <link rel="stylesheet" type="text/css" charset="utf-8" media="all" href="../MoinMoin/web/static/htdocs/modernized/css/common.css">
@@ -21,20 +21,20 @@
 
 
 
-<link rel="Start" href="http://master19.moinmo.in/FrontPage">
-<link rel="Alternate" title="Wiki Markup" href="http://master19.moinmo.in/HelpOnUpdating?action=raw">
-<link rel="Alternate" media="print" title="Print View" href="http://master19.moinmo.in/HelpOnUpdating?action=print">
-<link rel="Search" href="http://master19.moinmo.in/FindPage">
-<link rel="Index" href="http://master19.moinmo.in/TitleIndex">
-<link rel="Glossary" href="http://master19.moinmo.in/WordIndex">
-<link rel="Help" href="http://master19.moinmo.in/HelpOnFormatting">
+<link rel="Start" href="/FrontPage">
+<link rel="Alternate" title="Wiki Markup" href="/HelpOnUpdating?action=raw">
+<link rel="Alternate" media="print" title="Print View" href="/HelpOnUpdating?action=print">
+<link rel="Search" href="/FindPage">
+<link rel="Index" href="/TitleIndex">
+<link rel="Glossary" href="/WordIndex">
+<link rel="Help" href="/HelpOnFormatting">
 </head>
 
 <body  lang="en" dir="ltr">
 <div id="page" lang="en" dir="ltr">
-<span id="interwiki"><a href="http://master19.moinmo.in/FrontPage" rel="nofollow">MoinMaster</a><span class="sep">: </span></span>
+<span id="interwiki"><a href="/FrontPage" rel="nofollow">MoinMaster</a><span class="sep">: </span></span>
 <ul id="pagelocation">
-<li><a class="backlink" href="http://master19.moinmo.in/4ct10n/fullsearch/HelpOnUpdating?action=fullsearch&amp;context=180&amp;value=linkto%3A%22HelpOnUpdating%22" rel="nofollow" title="Click to do a full-text search for this title">HelpOnUpdating</a></li>
+<li><a class="backlink" href="/4ct10n/fullsearch/HelpOnUpdating?action=fullsearch&amp;context=180&amp;value=linkto%3A%22HelpOnUpdating%22" rel="nofollow" title="Click to do a full-text search for this title">HelpOnUpdating</a></li>
 </ul>
 <div dir="ltr" id="content" lang="en"><span class="anchor" id="top"></span>
 <span class="anchor" id="line-1"></span><span class="anchor" id="line-2"></span><span class="anchor" id="line-3"></span><span class="anchor" id="line-4"></span><span class="anchor" id="line-5"></span><span class="anchor" id="line-6"></span><span class="anchor" id="line-7"></span><span class="anchor" id="line-8"></span><p class="line867">
@@ -62,13 +62,13 @@
 <h3 id="Reading_the_docs">Reading the docs</h3>
 <span class="anchor" id="line-17"></span><p class="line867"><span class="anchor" id="line-18"></span><span class="anchor" id="line-19"></span><span class="anchor" id="line-20"></span><span class="anchor" id="line-21"></span><div class="note"><span class="anchor" id="line-1-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-1"></span><span class="anchor" id="line-3-1"></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-22"></span><span class="anchor" id="line-23"></span><p class="line867">
 <h3 id="Backup">Backup</h3>
-<span class="anchor" id="line-24"></span><p class="line867"><span class="anchor" id="line-25"></span><span class="anchor" id="line-26"></span><span class="anchor" id="line-27"></span><span class="anchor" id="line-28"></span><div class="warning"><span class="anchor" id="line-1-2"></span><p class="line867"><strong>Before you update an existing wiki, MAKE A BACKUP!</strong> <span class="anchor" id="line-2-2"></span><span class="anchor" id="line-3-2"></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="/moin_static193/modernized/img/angry.png" title="X-(" width="16" />  </div><span class="anchor" id="line-29"></span><span class="anchor" id="line-30"></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-31"></span><span class="anchor" id="line-32"></span><p class="line874">This is what you should backup (the real paths depend on your installation): <span class="anchor" id="line-33"></span><ul><li><p class="line862">The directory containing the <a href="http://master19.moinmo.in/MoinMoin">MoinMoin</a> code files (e.g. <tt>/usr/lib/python*.*/site-packages/MoinMoin</tt>) <span class="anchor" id="line-34"></span><ul><li><p class="line891"><img alt="(!)" height="16" src="/moin_static193/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-35"></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-36"></span></li><li>your moin.wsgi file (or other server adaptor file you use) <span class="anchor" id="line-37"></span></li><li>your wikiconfig.py or farmconfig.py or other wiki configuration files <span class="anchor" id="line-38"></span></li><li>your web server configuration files <span class="anchor" id="line-39"></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-40"></span><span class="anchor" id="line-41"></span></li></ul><p class="line867">
+<span class="anchor" id="line-24"></span><p class="line867"><span class="anchor" id="line-25"></span><span class="anchor" id="line-26"></span><span class="anchor" id="line-27"></span><span class="anchor" id="line-28"></span><div class="warning"><span class="anchor" id="line-1-2"></span><p class="line867"><strong>Before you update an existing wiki, MAKE A BACKUP!</strong> <span class="anchor" id="line-2-2"></span><span class="anchor" id="line-3-2"></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="../MoinMoin/web/static/htdocs/modernized/img/angry.png" title="X-(" width="16" />  </div><span class="anchor" id="line-29"></span><span class="anchor" id="line-30"></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-31"></span><span class="anchor" id="line-32"></span><p class="line874">This is what you should backup (the real paths depend on your installation): <span class="anchor" id="line-33"></span><ul><li><p class="line862">The directory containing the <a href="http://master19.moinmo.in/MoinMoin">MoinMoin</a> code files (e.g. <tt>/usr/lib/python*.*/site-packages/MoinMoin</tt>) <span class="anchor" id="line-34"></span><ul><li><p class="line891"><img alt="(!)" height="16" src="../MoinMoin/web/static/htdocs/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-35"></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-36"></span></li><li>your moin.wsgi file (or other server adaptor file you use) <span class="anchor" id="line-37"></span></li><li>your wikiconfig.py or farmconfig.py or other wiki configuration files <span class="anchor" id="line-38"></span></li><li>your web server configuration files <span class="anchor" id="line-39"></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-40"></span><span class="anchor" id="line-41"></span></li></ul><p class="line867">
 <h3 id="Code_update">Code update</h3>
 <span class="anchor" id="line-42"></span><p class="line862">First remove the old <a href="http://master19.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-43"></span><span class="anchor" id="line-44"></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-45"></span><span class="anchor" id="line-46"></span><p class="line874">If you are using some Linux (or other) distributor's package, please read their docs. <span class="anchor" id="line-47"></span><span class="anchor" id="line-48"></span><p class="line874">Please also upgrade your 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-49"></span><span class="anchor" id="line-50"></span><p class="line867">
 <h3 id="Configuration_update">Configuration update</h3>
 <span class="anchor" id="line-51"></span><span class="anchor" id="line-52"></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-53"></span><span class="anchor" id="line-54"></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-55"></span><span class="anchor" id="line-56"></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-57"></span><span class="anchor" id="line-58"></span><p class="line867">
 <h3 id="Static_files">Static files</h3>
-<span class="anchor" id="line-59"></span><p class="line874">Since release 1.9.0, moin has a built-in static file webserver to serve the CSS, images, javascript, etc. files that come with moin. <span class="anchor" id="line-60"></span><span class="anchor" id="line-61"></span><p class="line862">This static file web server serves the files contained in path <tt class="backtick">MoinMoin/web/static/htdocs/</tt> at URL <tt class="backtick">&lt;script&nbsp;URL&gt;&nbsp;+&nbsp;&lt;url_prefix_static&gt;</tt>. <span class="anchor" id="line-62"></span><span class="anchor" id="line-63"></span><p class="line862">So, if you run your wiki at the root of your site (/) the default <tt class="backtick">url_prefix_static</tt> will work for you. <span class="anchor" id="line-64"></span><span class="anchor" id="line-65"></span><p class="line862">The default <tt class="backtick">url_prefix_static</tt> is something like <tt class="backtick">/moin_staticVVV</tt> (VVV is 190 for moin release 1.9.0) and VVV will change on every release (moin 1.9.1 will use <tt class="backtick">/moin_static191</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. Even if you don't use a long cache lifetime, a changing <tt class="backtick">url_prefix_static</tt> makes sure that if you upgrade your wiki all your wiki users will immediately get the fresh static stuff. <span class="anchor" id="line-66"></span><span class="anchor" id="line-67"></span><p class="line862">If you run your wiki at a different base path, you need to set <tt class="backtick">url_prefix_static</tt> to the correct value, e.g. <tt class="backtick">url_prefix_static&nbsp;=&nbsp;'/mywiki'&nbsp;+&nbsp;url_prefix_static</tt> if you run your wiki at <tt class="backtick">/mywiki</tt>. <span class="anchor" id="line-68"></span><span class="anchor" id="line-69"></span><p class="line862">If you want moin to serve a different directory than the default <tt class="backtick">MoinMoin/web/static/htdocs/</tt>, you can change the path in <tt class="backtick">moin.wsgi</tt> like <tt class="backtick">shared='/my/path/to/htdocs'</tt> to serve static files from that path. <span class="anchor" id="line-70"></span><span class="anchor" id="line-71"></span><p class="line867"><img alt="(!)" height="16" src="/moin_static193/modernized/img/idea.png" title="(!)" width="16" /> Please note that if you serve the static files from a different than the "builtin" directory, you are responsible for updating those files from <tt class="backtick">MoinMoin/web/static/htdocs/</tt> when you upgrade your moin installation. <span class="anchor" id="line-72"></span><span class="anchor" id="line-73"></span><p class="line862">Alternatively to using moin's builtin static files server, you can also serve the static files with some external webserver (e.g. with Apache, if that is your main web server). If you want to do this, just have your web server catch the requests for stuff below the <tt class="backtick">url_prefix_static</tt> URL (before they reach the moin script) and serve those requests with the files from <tt class="backtick">MoinMoin/web/static/htdocs/</tt> (or a copy of them). <span class="anchor" id="line-74"></span><span class="anchor" id="line-75"></span><span class="anchor" id="line-76"></span><p class="line867">
+<span class="anchor" id="line-59"></span><p class="line874">Since release 1.9.0, moin has a built-in static file webserver to serve the CSS, images, javascript, etc. files that come with moin. <span class="anchor" id="line-60"></span><span class="anchor" id="line-61"></span><p class="line862">This static file web server serves the files contained in path <tt class="backtick">MoinMoin/web/static/htdocs/</tt> at URL <tt class="backtick">&lt;script&nbsp;URL&gt;&nbsp;+&nbsp;&lt;url_prefix_static&gt;</tt>. <span class="anchor" id="line-62"></span><span class="anchor" id="line-63"></span><p class="line862">So, if you run your wiki at the root of your site (/) the default <tt class="backtick">url_prefix_static</tt> will work for you. <span class="anchor" id="line-64"></span><span class="anchor" id="line-65"></span><p class="line862">The default <tt class="backtick">url_prefix_static</tt> is something like <tt class="backtick">../MoinMoin/web/static/htdocs</tt> (VVV is 190 for moin release 1.9.0) and VVV will change on every release (moin 1.9.1 will use <tt class="backtick">../MoinMoin/web/static/htdocs</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. Even if you don't use a long cache lifetime, a changing <tt class="backtick">url_prefix_static</tt> makes sure that if you upgrade your wiki all your wiki users will immediately get the fresh static stuff. <span class="anchor" id="line-66"></span><span class="anchor" id="line-67"></span><p class="line862">If you run your wiki at a different base path, you need to set <tt class="backtick">url_prefix_static</tt> to the correct value, e.g. <tt class="backtick">url_prefix_static&nbsp;=&nbsp;'/mywiki'&nbsp;+&nbsp;url_prefix_static</tt> if you run your wiki at <tt class="backtick">/mywiki</tt>. <span class="anchor" id="line-68"></span><span class="anchor" id="line-69"></span><p class="line862">If you want moin to serve a different directory than the default <tt class="backtick">MoinMoin/web/static/htdocs/</tt>, you can change the path in <tt class="backtick">moin.wsgi</tt> like <tt class="backtick">shared='/my/path/to/htdocs'</tt> to serve static files from that path. <span class="anchor" id="line-70"></span><span class="anchor" id="line-71"></span><p class="line867"><img alt="(!)" height="16" src="../MoinMoin/web/static/htdocs/modernized/img/idea.png" title="(!)" width="16" /> Please note that if you serve the static files from a different than the "builtin" directory, you are responsible for updating those files from <tt class="backtick">MoinMoin/web/static/htdocs/</tt> when you upgrade your moin installation. <span class="anchor" id="line-72"></span><span class="anchor" id="line-73"></span><p class="line862">Alternatively to using moin's builtin static files server, you can also serve the static files with some external webserver (e.g. with Apache, if that is your main web server). If you want to do this, just have your web server catch the requests for stuff below the <tt class="backtick">url_prefix_static</tt> URL (before they reach the moin script) and serve those requests with the files from <tt class="backtick">MoinMoin/web/static/htdocs/</tt> (or a copy of them). <span class="anchor" id="line-74"></span><span class="anchor" id="line-75"></span><span class="anchor" id="line-76"></span><p class="line867">
 <h3 id="Wiki_pages_update">Wiki pages update</h3>
 <span class="anchor" id="line-77"></span><p class="line867">
 <h4 id="System_and_Help_pages">System and Help pages</h4>