comparison docs/UPDATE.html @ 5594:41eaf2255cb6

make install-docs interwiki
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Sun, 28 Feb 2010 15:59:29 +0100
parents 19cd37af7e99
children b0bb4e06ff2d
comparison
equal deleted inserted replaced
5593:2386006b83ac 5594:41eaf2255cb6
4 <link rel="shortcut icon" href="http://static.moinmo.in/favicon.ico"> 4 <link rel="shortcut icon" href="http://static.moinmo.in/favicon.ico">
5 <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> 5 <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
6 <meta name="robots" content="noindex,nofollow"> 6 <meta name="robots" content="noindex,nofollow">
7 7
8 <title>HelpOnUpdating - 1.9 Master Wiki</title> 8 <title>HelpOnUpdating - 1.9 Master Wiki</title>
9 <script type="text/javascript" src="/moin_static191/common/js/common.js"></script> 9 <script type="text/javascript" src="/moin_static192/common/js/common.js"></script>
10 10
11 11
12 <link rel="stylesheet" type="text/css" charset="utf-8" media="all" href="../MoinMoin/web/static/htdocs/modernized/css/common.css"> 12 <link rel="stylesheet" type="text/css" charset="utf-8" media="all" href="../MoinMoin/web/static/htdocs/modernized/css/common.css">
13 <link rel="stylesheet" type="text/css" charset="utf-8" media="all" href="../MoinMoin/web/static/htdocs/modernized/css/print.css"> 13 <link rel="stylesheet" type="text/css" charset="utf-8" media="all" href="../MoinMoin/web/static/htdocs/modernized/css/print.css">
14 14
57 <h3 id="Download_and_unpack_the_new_MoinMoin_archive">Download and unpack the new MoinMoin archive</h3> 57 <h3 id="Download_and_unpack_the_new_MoinMoin_archive">Download and unpack the new MoinMoin archive</h3>
58 <span class="anchor" id="line-15"></span><p class="line862">Download the <a href="http://master19.moinmo.in/MoinMoin">MoinMoin</a> code that you are interested in updating to. If you are not a developer, this is usually the distribution archive for 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"> 58 <span class="anchor" id="line-15"></span><p class="line862">Download the <a href="http://master19.moinmo.in/MoinMoin">MoinMoin</a> code that you are interested in updating to. If you are not a developer, this is usually the distribution archive for 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">
59 <h3 id="Reading_the_docs">Reading the docs</h3> 59 <h3 id="Reading_the_docs">Reading the docs</h3>
60 <span class="anchor" id="line-18"></span><p class="line867"><span class="anchor" id="line-19"></span><span class="anchor" id="line-20"></span><span class="anchor" id="line-21"></span><span class="anchor" id="line-22"></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-23"></span><span class="anchor" id="line-24"></span><p class="line867"> 60 <span class="anchor" id="line-18"></span><p class="line867"><span class="anchor" id="line-19"></span><span class="anchor" id="line-20"></span><span class="anchor" id="line-21"></span><span class="anchor" id="line-22"></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-23"></span><span class="anchor" id="line-24"></span><p class="line867">
61 <h3 id="Backup">Backup</h3> 61 <h3 id="Backup">Backup</h3>
62 <span class="anchor" id="line-25"></span><p class="line867"><span class="anchor" id="line-26"></span><span class="anchor" id="line-27"></span><span class="anchor" id="line-28"></span><span class="anchor" id="line-29"></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_static191/modernized/img/angry.png" title="X-(" width="16" /> </div><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://master19.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="/moin_static191/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.wsgi file (or other server 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"> 62 <span class="anchor" id="line-25"></span><p class="line867"><span class="anchor" id="line-26"></span><span class="anchor" id="line-27"></span><span class="anchor" id="line-28"></span><span class="anchor" id="line-29"></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_static192/modernized/img/angry.png" title="X-(" width="16" /> </div><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://master19.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="/moin_static192/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.wsgi file (or other server 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">
63 <h3 id="Code_update">Code update</h3> 63 <h3 id="Code_update">Code update</h3>
64 <span class="anchor" id="line-43"></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-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.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"> 64 <span class="anchor" id="line-43"></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-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.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">
65 <h3 id="Configuration_update">Configuration update</h3> 65 <h3 id="Configuration_update">Configuration update</h3>
66 <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"> 66 <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">
67 <h3 id="Static_stuff_update">Static stuff update</h3> 67 <h3 id="Static_stuff_update">Static stuff update</h3>
77 <h3 id="Clean_your_cache">Clean your cache</h3> 77 <h3 id="Clean_your_cache">Clean your cache</h3>
78 <span class="anchor" id="line-78"></span><p class="line862">Finally, stop moin, delete cached data by running <tt class="backtick">moin&nbsp;...&nbsp;maint&nbsp;cleancache</tt>, start moin. <span class="anchor" id="line-79"></span><span class="anchor" id="line-80"></span><p class="line867"> 78 <span class="anchor" id="line-78"></span><p class="line862">Finally, stop moin, delete cached data by running <tt class="backtick">moin&nbsp;...&nbsp;maint&nbsp;cleancache</tt>, start moin. <span class="anchor" id="line-79"></span><span class="anchor" id="line-80"></span><p class="line867">
79 <h3 id="Troubleshooting">Troubleshooting</h3> 79 <h3 id="Troubleshooting">Troubleshooting</h3>
80 <span class="anchor" id="line-81"></span><p class="line874">Hints: <span class="anchor" id="line-82"></span><ul><li>Use absolute pathes, not relative ones. <span class="anchor" id="line-83"></span><span class="anchor" id="line-84"></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-85"></span><span class="anchor" id="line-86"></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-87"></span><span class="anchor" id="line-88"></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-89"></span><span class="anchor" id="line-90"></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-91"></span><span class="anchor" id="line-92"></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://master19.moinmo.in/MoinMoin">MoinMoin</a> code and configuration). <span class="anchor" id="line-93"></span><span class="anchor" id="line-94"></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-95"></span><span class="anchor" id="line-96"></span></li></ul><p class="line867"> 80 <span class="anchor" id="line-81"></span><p class="line874">Hints: <span class="anchor" id="line-82"></span><ul><li>Use absolute pathes, not relative ones. <span class="anchor" id="line-83"></span><span class="anchor" id="line-84"></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-85"></span><span class="anchor" id="line-86"></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-87"></span><span class="anchor" id="line-88"></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-89"></span><span class="anchor" id="line-90"></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-91"></span><span class="anchor" id="line-92"></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://master19.moinmo.in/MoinMoin">MoinMoin</a> code and configuration). <span class="anchor" id="line-93"></span><span class="anchor" id="line-94"></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-95"></span><span class="anchor" id="line-96"></span></li></ul><p class="line867">
81 <h2 id="Version_specific_notes">Version specific notes</h2> 81 <h2 id="Version_specific_notes">Version specific notes</h2>
82 <span class="anchor" id="line-97"></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-98"></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-99"></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-100"></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-101"></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:54 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> 82 <span class="anchor" id="line-97"></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-98"></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-99"></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-100"></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-101"></span></li><li><p class="line862">For 1.8.x to 1.9.x, see <a class="interwiki" href="http://moinmo.in/RickVanderveer/UpgradingFromMoin18ToMoin19" title="MoinMoin">RickVanderveer/UpgradingFromMoin18ToMoin19</a>. <span class="anchor" id="line-102"></span></li></ul><span class="anchor" id="bottom"></span></div><p id="pageinfo" class="info" lang="en" dir="ltr">MoinMaster: HelpOnUpdating (last edited 2010-02-11 06:49:09 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>
83 <div id="pagebottom"></div> 83 <div id="pagebottom"></div>
84 </div> 84 </div>
85 </body> 85 </body>
86 </html> 86 </html>
87 87