1,840
edits
Updating MX to new version: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
→Installer Option
m (→From 3.9.y releases: add warning re Mono) |
|||
| (6 intermediate revisions by 3 users not shown) | |||
|
For a Linux Operating system: <code>sudo systemctl stop cumulusmx</code>.
For Microsoft Windows Operating System:
Open Windows Administration Tools from Windows Task Bar, select Component Services, click on Services (local)
In middle window select CumulusMX service from the list; click on Stop the service option. (click on Start the service after upgrade)
==Upgrading if you run MX interactively==
[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 contents of the '''[https://cumulus.hosiene.co.uk/viewtopic.php?p=150084#p150084 InstallCMX.
#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. Note that for an ''image install'' you have to use /opt/CumulusMX.
#* You can give the '''build number''', for the release distribution zip, to install as command line '''argument'''.
#Start CumulusMX
'''NOTE:''' On Windows you run
'''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 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 log file to see everything has gone well.
There is also 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].
Modifications and additions on user request can be discussed (e.g. think about automated start/stop, upload of webfiles to the directory etc....), use the talk for this page and create a post in the above thread.
==Upgrading if you are running MX on a Linux computer==
The changes between any 3.10.x release and any 3.11.y release were minor, but ''you can't go from 3.10.x to the latest release'', because you must use 3.12.0 to convert [[Cumulus.ini]].
====From 3.9.y releases ====▼
If you are using any release in the 3.9.y series (note release announcement 3.9.1 warning about Mono if you use that), and you are using web pages that were provided by MX...
* Changes to settings
** You need to open the [[MX Administrative Interface]] and work through all pages in the '''Settings''' menu.
*Changes to web files included in two folders in distribution: <code>[[Web folder|CumulusMX/web]]</code>, <code>
**If you used the provided templates to produce web pages in earlier releases, or you had directly customised provided [[Customised templates|web templates]], these will no longer work
**Please see [[New Default Web Site Information|New Default Web Site Information page]] for further advice
Note: The folder <code>CumulusMX/webfiles-legacy</code> mentioned in the new default web site information page, with some alternative web pages that have no ongoing support, is only available from a 3.10.0 or 3.10.1 download (find from [https://github.com/cumulusmx/CumulusMX/releases this Github page]).
====if using either 3.8.x or 3.9.y release====▼
See next sub-section, that describes similar process, '''upgrade directly to 3.9.6, or any later build, within 3.9.x''', without any major change.▼
See sub-section directly above, that describes similar process,
'''IMPORTANT''' one-off actions needed:▼
▲
* There is a one-off change described in [https://cumulus.hosiene.co.uk/viewtopic.php?p=146957#p146957 v3.9.0 - b3095 release announcement] for those using RG-11 rain sensor. ▼
* or to 3.12.0 with major change
* There is a further on-off change described in [https://cumulus.hosiene.co.uk/viewtopic.php?p=147329#p147329 release announcement for Patch release 3.9.1 - b3096] for those who use '''Mono''' to enable the executables to run.▼
It is optional to install release 3.9.6 build 3101, because that is a safe release to use while there were bugs in the builds in all 3.8.z versions, and in other 3.9.x releases, however please action the one-off changes noted as IMPORTANT here:
▲'''IMPORTANT''' one-off actions needed:
▲Only 3.7.0 was ever released, it introduced a lot of changes, so that is why staged upgrades recommend that this version is implemented, and run for a while, before continuing to upgrade.
▲* There is a one-off change described in [https://cumulus.hosiene.co.uk/viewtopic.php?p=146957#p146957 v3.9.0 - b3095 release announcement] for those using RG-11 rain sensor.
▲* There is a further on-off change described in [https://cumulus.hosiene.co.uk/viewtopic.php?p=147329#p147329 release announcement for Patch release 3.9.1 - b3096] for those who use '''Mono''' to enable the executables to run.
▲Version 3.8.0 was a major release, as it introduced the ability to run Cumulus MX as a service. However, there were bugs in the builds in all 3.8.z versions, and in some 3.9.x versions, so that is why you need to skip through intermediate builds below 3101.
Be aware that 3.10.0 was withdrawn, but it was a major release that totally changed the files in [[Web folder]] and [[Webfiles folder]] within the release download. However, you can skip directly from 3.9.6 (if you have implemented that) to 3.12.0 as soon as you are happy to change your web server contents (if you are using web pages that MX provides), see sub-section above for further advice re web pages. You should continue in stages because it is mandatory to install 3.12.0 as only that release can rewrite your [[Cumulus.ini]] file ready for subsequent release, so ensure that 3.12.0 is working before installing current release as instructed in sub-sections for those using subsequent releases.
====If using a 3.5.x release ====
*'''If you use commas to separate integer and decimal parts of real numbers''', then various releases from 3.6.0 to 3.7.0 add "rc=y" to various web tags, that option will replace the decimal commas you use by decimal points that are required for some script languages (like the JavaScript used by HighCharts), and that makes it easier if you want to customise your web site.
When you are happy with running 3.7.0, then you should continue to upgrade, but in steps (
====If using either 3.1.x, 3.2.y, 3.3.z, or 3.4.w releases====
First, upgrade to 3.5.1 by downloading it at [[https://github.com/cumulusmx/CumulusMX/releases/tag/b3072 Mark's Github respository]]. The actual installation is done using the instructions early in this Wiki page for simple next build upgrades. You can safely skip reading the intermediate release announcements, as there are no special one-off actions. There are one-off actions at 3.5.1, see release announcement. It does not involve any updates to the fields in the log files nor to the columns in any database tables you use.
When you are happy running 3.5.1, then you should continue to upgrade, initially follow instructions given
====If using 3.0.0 (the MX original beta)====
▲Upgrade from the beta directly to 3.5.1 by downloading it at https://github.com/cumulusmx/CumulusMX/releases/tag/b3072.
Upgrade from the beta directly to 3.5.1 by downloading it at https://github.com/cumulusmx/CumulusMX/releases/tag/b3072. There are one-off actions at 3.5.1, see release announcement. This skips you past the problems in 3.5.0. It gives you benefits introduced in 3.1.x, 3.2.y, 3.3.z, and 3.4.w releases.
This gives you essential new functionality in the admin interface like editors for the log files and extreme records. But it also fixes multiple bugs in the beta you were using and adds some useful validation missing in the beta.
It does not involve any updates to the fields in the log files nor to the columns in any database tables you use.
Now follow instructions in other sub-sections, to upgrade in stages to where there are significant actions to do, until you reach latest release and get support from developer.
= Knowing when a new release is available =
| |||
