5,838
edits
Updating MX to new version: Difference between revisions
m
→Introduction to updating MX: re-sequence
m (→From 3.9.y to 3.10.x: new section) |
m (→Introduction to updating MX: re-sequence) |
||
| Line 9: | Line 9: | ||
Cumulus MX has been updated so frequently in 2020, that you may be used to updating to a new build, and for you this article is not useful. | Cumulus MX has been updated so frequently in 2020, that you may be used to updating to a new build, and for you this article is not useful. | ||
=Introduction to | =Introduction to upgrading MX= | ||
<div style="background: LemonChiffon;padding:5px; margin:2px;"> | <div style="background: LemonChiffon;padding:5px; margin:2px;"> | ||
| Line 15: | Line 15: | ||
</div> | </div> | ||
[[Category:Cumulus MX]] | [[Category:Cumulus MX]] | ||
You can download and unzip in advance, but cannot replace existing files while they are being used, so how you stop MX is in next two sub-sections. | |||
==Upgrading if you run MX as a service== | |||
Don't forget to stop the service, before you do the upgrade. | |||
For a Linux Operating system: <code>sudo systemctl stop cumulusmx</code>. | |||
==Upgrading if you run MX interactively== | |||
If you do NOT run as a service, you will want to use '''Control and C''' to make the software close tidily. | |||
== Updating to the next MX release if you have not updated before == | |||
The simplest update is from the immediate preceding build, and the steps required are summarised as follows: | |||
# Download the release distribution zip for the next build (see later for where from) | |||
#* My advice is to have a separate download location away from the location where you are installing/running the software; it can retain older releases to make regression simple if the new release proves to have a bug. | |||
# Use '''Control-C''' to stop Cumulus MX (see later if running as a service) | |||
# Take a backup of your complete existing MX installation (as it is not running, no files will be locked) | |||
# Unzip the new distribution, overwriting the previous installation (the release announcement might ask you to delete obsolete files) | |||
# Run any one-off batch scripts needed to prepare for upgrade | |||
#* These might be needed if log files in the new release contain fields that were not in earlier release | |||
#* These might be needed if you use optional database functionality (see later for examples) | |||
# Do any actions that require you to use [[MX Administrative Interface|Admin Interface]] to change settings | |||
# Do any one-off actions in relation to any files provided by MX for you to run a web site with the default pages | |||
# Restart your Cumulus MX (consider running with '''-debug''' parameter if you are not sure the new build is bug free) | |||
The remainder of this article explains all options for updating, and is thus less simple than above. | |||
==Installer Option== | ==Installer Option== | ||
[https://cumulus.hosiene.co.uk/memberlist.php?mode=viewprofile&u=9016 HansR] on support forum has developed an | [https://cumulus.hosiene.co.uk/memberlist.php?mode=viewprofile&u=9016 HansR] on support forum has developed an multi-platform installer, see [https://cumulus.hosiene.co.uk/viewtopic.php?f=44&t=18916 Multiplatform Installer for CumulusMX] which makes life a lot easier if you do not wish to dive into the (file level contents) internals of CumulusMX. | ||
#Copy the InstallCMX.exe to any directory you want on the drive where you wish to install (or have installed) | #Copy the '''InstallCMX.exe''' to any directory you want, on the drive where you wish to install (or have previously installed) MX. | ||
#Copy the CumulusMX distribution zip(s) to that same directory if you have not already done so. You may have more than one distribution in the same directory. | #Copy the CumulusMX release distribution zip(s) to that same directory, if you have not already done so. You may have more than one distribution in the same directory. | ||
#*The install procedure gives you the possibility to select, or define, the Archive to install, and the location where to install. | |||
#Stop CumulusMX | #Stop CumulusMX | ||
#Run InstallCMX and confirm / fill in on the console where you wish to install (or update) CMX. The default for Windows is C:\CumulusMX\ and for Linux it is : /home/CumulusMX. The Installation directory can be modified. | #Run '''InstallCMX''' and confirm / fill in (on the console) where you wish to install (or update) CMX. The default for Windows is C:\CumulusMX\ and for Linux it is : /home/CumulusMX. The Installation directory can be modified. | ||
#* You can give the '''build number''', for the release distribution zip, to install as command line '''argument'''. | |||
#Start CumulusMX | #Start CumulusMX | ||
'''NOTE:''' On Windows you run the installer as any other | '''NOTE:''' On Windows you run the installer as any other command line executable and it is best to open a command window in which you start the installer. On Linux you run it on the command line as "mono ./InstallCMX.exe", the mono command can be omitted if mono is already active (e.g. if you run CumulusMX as a service, and stop it, mono remains active). | ||
'''NOTE:''' In an existing installation with modified files, make sure those are in a safe place. If they have the same name as files in the distribution they will be overwritten. | '''NOTE:''' In an existing installation with modified files, make sure those are in a different, either filename or folder (a safe place). If they have the same name as files in the distribution, they will be overwritten. | ||
'''NOTE:''' Check | '''NOTE:''' Check in the <code>webfiles</code> directory to see if any files there have been modified, since your last upload to your web server. If so, move those new files to the website. | ||
After the installation, there is a log file. Check the | After the installation, there is a '''log file'''. Check the log file to see everything has gone well. | ||
There is an ini file where you can control: | There is an '''ini file''' where you can control: | ||
* NormalMessageToConsole=true or (default) NormalMessageToConsole=false | |||
* TraceInfoLevel=Warning (out of: Error, Warning, Info, Verbose, None) | |||
Any reactions (thank you, issues and questions) please post in the [https://cumulus.hosiene.co.uk/viewtopic.php?f=44&t=18916 download thread of the installer]. | Any reactions (thank you, issues and questions) please post in the [https://cumulus.hosiene.co.uk/viewtopic.php?f=44&t=18916 download thread of the installer]. | ||
| Line 71: | Line 103: | ||
<pre> /home/pi/CumulusMX/cumulusmx.sh -s</pre> | <pre> /home/pi/CumulusMX/cumulusmx.sh -s</pre> | ||
=Considerations that determine when to update= | |||
Cumulus MX will nag you, in various places, to make you aware if you are not running the latest build. Some people will choose to update as soon after a new release as they can. However, each upgrade does involve a period when MX is not running, and that causes some loss of data: | Cumulus MX will nag you, in various places, to make you aware if you are not running the latest build. Some people will choose to update as soon after a new release as they can. However, each upgrade does involve a period when MX is not running, and that causes some loss of data: | ||
| Line 96: | Line 116: | ||
* you may just have more important ways to use your time than updating your MX software, and some new builds might not give you any benefits that make it worthwhile to change your priorities. | * you may just have more important ways to use your time than updating your MX software, and some new builds might not give you any benefits that make it worthwhile to change your priorities. | ||
It is perfectly possible to | It is perfectly possible to '''upgrade from rather old versions of MX, to the latest''', skipping intermediate versions, '''but there are some key versions that you should not skip over'''. This page, in subsequent sections, includes suggestions for which releases to install (and get running) before moving onto newer releases. This will be especially useful for those people who do not immediately update to new releases, as per above suggestions. | ||
===Advice about skipping versions=== | ===Advice about skipping versions=== | ||