5,838
edits
Updating MX to new version: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
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) |
||
|
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
<div style="background: LemonChiffon;padding:5px; margin:2px;">
</div>
[[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)▼
#* 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==
[https://cumulus.hosiene.co.uk/memberlist.php?mode=viewprofile&u=9016 HansR] on support forum has developed an
#Copy the '''InstallCMX.exe''' to any directory you want, on the drive where you wish to install (or have previously installed)
#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
#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
'''NOTE:''' On Windows you run the installer as any other
'''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
After the installation, there is a '''log file'''. Check the
There is an '''ini file''' where you can control:
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].
<pre> /home/pi/CumulusMX/cumulusmx.sh -s</pre>
▲== 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)
▲# 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 (see later for examples)
▲# 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.
▲==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:
* 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
===Advice about skipping versions===
| |||
