Updating MX to new version: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Updating MX to new version (view source)

Revision as of 18:07, 11 December 2021

14,923 bytes added ,  18:07, 11 December 2021
m
→‎if using any 3.7.y release, any 3.8.x release, or 3.9.y release
m (cut)
(34 intermediate revisions by 3 users not shown)
Line 1: Line 1:
=Who this article is for=
=Who this article is for=


Please be aware that if you want to move from Cumulus 1 to MX, you should read [[Moving_from_Cumulus_1_to_MX]] article instead.
Please be aware that if you want to move from Cumulus 1 to MX, you should read [[Migrating_from_Cumulus_1_to_MX]] article instead.


This article is for those who already use MX, and so are comfortable with basic MX installation and running.
This article is for those who already use MX, and so are comfortable with basic MX installation and running.
Line 7: Line 7:
=Who is not intended reader=
=Who is not intended reader=


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 upgrading to a new build, and for you this article is not useful.


=Introduction to updating MX=


==Installer Option==
=Where to download a release distribution=
 
==Latest release==
 
Download release distribution zip from  [[Software|the Software article in this Wiki]] for latest version.
 
Be aware that the developer needs to remember to update this link each time there is a new release.
 
An image that contains a '''Raspberry Pi lite operating system''' and a recent CumulusMX release already included, can be downloaded from the same wiki article. Not every CumulusMX release is provided as a Raspberry Pi image, so you may need to perform an update to get the latest release. The Raspberry Pi image places CumulusMX in /opt/CumulusMX.
 
==Any release developed by Mark Crossley==
 
Download release distribution zip from https://github.com/cumulusmx/CumulusMX/releases for earlier versions.
 
 
=Introduction to upgrading MX=
 
<div style="background: LemonChiffon;padding:5px; margin:2px;">
[[File:Crystal Clear info.png|40px]] This document is 'Work In Progress' so content may not be complete or accurate!
</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.
 
My preference, after download, and unzip into a holding area, is to copy (it would be file transfer if you download on another device) over my existing installation all files except:
*CumulusMX.exe
*CumulusMX.exe.config
while MX is still running. I then stop MX for minimal time needed to replace just those two files before I restart MX.  That way I minimise downtime, especially useful for a patch release when few files have changed, as it takes some time to replace all the files in the installation.
 
For simplicity, in guidance below, MX is stopped before any files are replaced.
 
==Upgrading on a Raspberry Pi (RPi) computer by commands from a Microsoft Windows computer (PC)==
 
I recommend you download WinSCP (this and PuTTy share some settings). This will allow you to connect your PC to your rPi and copy files back and forth.  You can use it to copy the MX distribution, you download and unzip on your PC, onto the RPi. You can also use it to take a back-up of your RPI files onto your PC, and to pick certain files off your RPi. e.g. copy log files  from [[MXdiags folder]] to your PC to read diagnostics etc.
 
You can download PuTTy (shares some settings with WinSCP) to enable you to open a terminal session and send commands to your RPi computer.
 
If you have Cumulus MX setup to run as a service then you will need to do one of these, should you wish to add debugging when the upgraded MX begins...
# Edit the CumulusMX service file (see [[MX_on_Linux#Running_as_a_service]]) to add the -debug parameter (do this if always want debugging on, not usually needed)
# Just set it from Program Settings | Logging Options (easiest for turning debug on when you need it and off when you don't need it)
# Edit the Cumulus.ini file and enable it in there (no longer recommended)
 
==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>.
 
For Microsoft Windows Operating System:  (a contributor who uses Microsoft Windows needs to modify this page)


HansR on support forum is developing an installer as this is being typed, see [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=18893 this topic]. He proposes to start a new topic when his installer is ready for general use, and I hope he will update this section appropriately.
==Upgrading if you run MX interactively==


==Updating if you are running MX on a Linux computer==
If you do NOT run as a service, you will want to use '''Control and C''' in the terminal (or command) window running MX to make the software close tidily.


You might want to read galfert's post on the support forum [https://cumulus.hosiene.co.uk/viewtopic.php?p=148851#p148851 here] for the relevant Linux instructions in a concise format.


== Updating to the next MX release if you have not updated before ==
== Updating to the next MX release if you have not upgraded before ==


The simplest update is from the immediate preceding build, and the steps required are summarised as follows:
The simplest upgrade 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)
# 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)
# 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)
# 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)
# 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)
# 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)
# 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.
The remainder of this article explains all options for updating, and is thus less simple than above.


==Considerations that determine when to update==
==Installer Option==


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:
[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.
*for some weather station types readings taken every minute, or more frequently, are replaced by whatever period you station data logger records at;
*for other stations, without their own logging, all data is lost for the period when MX is not running.


#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 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


Other, more cautious, people (like the present writer) will not update each time a new release becomes available (and there are a lot of new releases in 2020), here are some of the reasons:
'''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).
* you will see in the Cumulus Support Forum that many builds have bugs, and so you realise that it is better to stick with your fully working release, than install one with bugs;
'''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.
* you may wish to avoid the loss of data mentioned above, by minimising the number of times that you stop MX;
'''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.
* you may run MX on a computer that you rarely visit, perhaps even in a remote location not often visited, so you prefer to leave it untouched, rather than risk possibility of being unable to restart remotely;
* 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 update from old versions of MX to the latest, skipping intermediate versions, but there are some key versions that you should not skip over. This article also 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.
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:
* NormalMessageToConsole=true or (default) NormalMessageToConsole=false
* TraceInfoLevel=Warning (out of: Error, Warning, Info, Verbose, None)


===Advice about skipping versions===
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].


Early builds of MX were all assigned to the same version number, recently the version number seems to change with every new build. Thus the following simple advice about skipping versions might not be applicable in 2021 onwards.
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.


One would assume that, skipping minor releases in an update (from 3.x.y to 3.x.z, i.e. only final digit of version number changing is a minor release) would always be simple, even if several intermediate builds are skipped. Most developers would not introduce a new feature in a minor release that requires a one-off extra action for a successful upgrade. Unfortunately, some minor releases of MX have required you to do special actions.
==Upgrading if you are running MX on a Linux computer==


One might assume that the ease of doing a major update (i.e. where middle part of version number changes) involves greater difficulty. Most developers would only classify a new release as a major update if there was new functionality being introduced that, depending on what functionality you use, might involve a one-off extra action to prepare for upgrade to that version. It is harder to understand why some MX releases are classified as major version number change, and some as minor version number change.
You might want to read galfert's post on the support forum [https://cumulus.hosiene.co.uk/viewtopic.php?p=148851#p148851 here] for the relevant Linux instructions in a concise format.


You may be using an old version of MX that is actually several versions behind, or even still using a beta version released by Steve Loft, don't worry because this article covers upgrading however old a version you are using. You can update skipping some major updates, but as that can be more complex, there is a separate section later with advice on how to update in stages from an early build to a recent build.
If you want more detailed information, on any Linux (including Raspberry Pi operating system) aspects of the upgrade instructions on this page, see [[MX on Linux]] page.


= Knowing when a new release is available =
== Updating if you use the start/stop management script ==  


== CREDIT ==
This section contributed by ''Jank'' on support forum.  Note the version on the forum might have been updated from the original included here.


Thanks to ''Billy'' on support forum for suggesting text for this section.
1. look on [[Software|Software download page]], find the link to latest version, and fill out the '...' below appropriately as you run these 2 commands on your device where you do downloads:
<pre>cd /tmp
wget https://github.com/cumulusmx/CumulusMX/ ... .zip</pre>


== Using forum notifications ==
2. Once that download is complete, start cumulusmx.sh with option -u
<pre>/home/pi/CumulusMX/cumulusmx.sh -u</pre>


As new releases are announced in [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 Cumulus MX Announcements and Download - PLEASE READ FIRST] topic, you can use the spanner tool to '''subscribe''' to this topic to receive notifications of a new post announcing a new release (or any other release-related announcement).
3.When asked for the zip file, enter
<pre>/tmp/CumulusMXDist</pre> and hit the TAB Button


== MX terminal message ==
4.Choose the zip file with the CumulusMX upgrade and hit return.


If ...
5. Follow the on screen instructions
#...you have a monitor to see the terminal output from the Cumulus MX engine (Windows calls this either a command window, powershell window, or a terminal window depending on how you invoke it, for Unix-based implementations this is the output window when using the terminal functionality), AND
#...your device running MX is connected to internet, AND
#...your MONO (if not Windows) is not obsolete (SSL certificate out of date), AND
#...you restart MX
... then you will see a prompt when a new version of MX is available.


It is worth stressing that if you leave MX running, then this feature will leave you blissfully unaware that an update is available; it only checks when MX is restarted.
6. With each update component .....you can choose: [y]es, [n]o, [A]ll, [N]one, [r]ename


== MXDiags ==
I would recommend select '''A''' as that will simply replace all files without further action.
 
In addition ...
#...if you can view the MXdiags file for the current session of MX, AND
#... MX is running with connection to the internet, AND
#...you restart MX
... if a new version of MX is available, the MXDiags file will say so (the message is not easy to spot as there is a lot of output before it, and variation in what output appears before it). Anyway, here is one example, just one example as in my experience '''the message has appeared at different places for each of the recent updates'''):
<pre>
2020-05-27 04:18:48.326 Calculating sunrise and sunset times
2020-05-27 04:18:48.326 Sunrise: 04:58:11
2020-05-27 04:18:48.326 Sunset : 21:19:54
2020-05-27 04:18:48.326 Tomorrow sunrise: 04:57:08
2020-05-27 04:18:48.326 Tomorrow sunset : 21:21:11
2020-05-27 04:18:48.388 You are not running the latest version of CumulusMX, build 3080 is available.
2020-05-27 04:18:48.763 Station type:</pre>


There is no message in whatever place it can appear ...
*... if you are using latest version, OR
* ... if you are not connected to the internet, OR
*... if you keep MX running all the time!


== Start/Stop script ==
CumulusMX will be restarted after upgrade completes.


When the '''Status''' option of this script is used, whenever a new release of MX is available, it will output a message.
You can check if the upgrade was successful by using option -s:
<pre> /home/pi/CumulusMX/cumulusmx.sh -s</pre>


== Dashboard in MX Admin Interface ==
=Considerations that determine when to upgrade=


In recent releases, one of the alarm indicators shown at the bottom of the dashboard page of the administrative interface, will flash red when you are not running latest build, and glow green when there is no newer release compared to the one you are running.
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 upgrade 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:
*for some weather station types readings taken every minute, or more frequently, are replaced by whatever period you station data logger records at;
*for other stations, without their own logging, all data is lost for the period when MX is not running.


== Web Tags ==


Since 3.7.0 release of MX, two relevant web tags have become available:
Other, more cautious, people (like the present writer) will not upgrade each time a new release becomes available (and there are a lot of new releases in 2020), here are some of the reasons:
* <#NewBuildAvailable> Returns a boolean value
* you will see in the Cumulus Support Forum that many builds have bugs, and so you realise that it is better to stick with your fully working release, than install one with bugs;
**  0 - MX running the latest build available
* you may wish to avoid the loss of data mentioned above, by minimising the number of times that you stop MX;
**  1 - MX is running an earlier build than the latest public release
* you may run MX on a computer that you rarely visit, perhaps even in a remote location not often visited, so you prefer to leave it untouched, rather than risk possibility of being unable to restart remotely;
* <#NewBuildNumber>  Displays the latest public release build number
* 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.


=Where to download a release distribution=
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 upgrade to new releases, as per above suggestions.


==Latest release==
===Advice about skipping versions===


Download release distribution zip from  [[Software|the Software article in this Wiki]] for latest version.
Please see [[Updating_MX_to_new_version#Updating_from_a_very_old_version]] sub-section later on this page (and preceding sub-sections where relevant)


Be aware that the developer needs to remember to update this link each time there is a new release.
The important point to make here is that when you do an upgrade, you should copy in '''ALL''' files from the release distribution you want to run next. This is because there are dependencies between files within a distribution, so missing out any particular file may stop other files from working. However, if you are skipping versions, read the in-between release announcements to see if there are any one-off actions.


An image that contains a '''Rapberry Pi lite operating system''' and the latest Cumulus MX release already included, may be downloaded from the same wiki article.
= What to read (and when) before upgrading =


==Any release developed by Mark Crossley==
== Upgrading from immediately preceding build ==
 
Download release distribution zip from https://github.com/cumulusmx/CumulusMX/releases for earlier versions.
 
= What to read (and when) before updating =
 
== Updating from immediately preceding build ==


=== The release announcement ===
=== The release announcement ===
Line 150: Line 184:
***That may mean you are advised to regress to an earlier version and use that
***That may mean you are advised to regress to an earlier version and use that
***It might mean that some supporting files in current version are wrong, and you only need to regress those named files
***It might mean that some supporting files in current version are wrong, and you only need to regress those named files
***There might be an emergency release to fix the bugs, and you need to update to that emergency release
***There might be an emergency release to fix the bugs, and you need to upgrade to that emergency release
***Finally you might be given advice to avoid using certain parts of the functionality or take some other action until the next release is available.
***Finally you might be given advice to avoid using certain parts of the functionality or take some other action until the next release is available.


Line 159: Line 193:
You can also view the latest [https://github.com/cumulusmx/CumulusMX/blob/master/Updates.txt Updates.txt].
You can also view the latest [https://github.com/cumulusmx/CumulusMX/blob/master/Updates.txt Updates.txt].


===Deciding whether to update to new release ===
===Deciding whether to upgrade to new release ===


This has been covered earlier in this article, but I repeat here 2 critical considerations:
This has been covered earlier in this article, but I repeat here 2 critical considerations:
Line 198: Line 232:
*Basically, check the corresponding release announcements for every version since the one you have been using before planning your upgrade.  
*Basically, check the corresponding release announcements for every version since the one you have been using before planning your upgrade.  
**Make a note of any one-off actions required at particular in-between versions, remember these actions are only in forum release announcements.
**Make a note of any one-off actions required at particular in-between versions, remember these actions are only in forum release announcements.
**Although one-off actions will not be described in the Wiki (whether on the [[Software]] page or the [[Cumulus_MX_formal_release_versions]] page), the Wiki can give you an idea of what functionality has been improved to help you decide whether to update.
**Although one-off actions will not be described in the Wiki (whether on the [[Software]] page or the [[Cumulus_MX_formal_release_versions]] page), the Wiki can give you an idea of what functionality has been improved to help you decide whether to upgrade.
*It is still worth reading all the points made above for updating from immediately preceding build.
*It is still worth reading all the points made above for updating from immediately preceding build.


Line 221: Line 255:
===Recommendations for staged updating===
===Recommendations for staged updating===


<big>This section will need to be updated, new contributors are needed to keep this advice current.</big>
<big>'''This section will need to be updated, new contributors are needed to keep this advice current.'''</big>
 
Do read all release announcements, to see if the developer has made a major change since those described below that means you need to stage your updates if you are currently running an old release.
 
 
 
 
 
 
 
 
 
 
 
====If using a release up to 3.11.4 and want to use any later release====
 
Upgrade exactly to release 3.12.0 (no later) by using zip at [https://github.com/cumulusmx/CumulusMX/releases/download/b3141/CumulusMXDist3141.zip download/b3141/CumulusMXDist3141.zip].
 
Run that release, it will rename your [[Cumulus.ini]] file, and create a new file with same name, but different settings.
 
You need to work through all the settings pages in the interface, and ensure all settings are correct, then close MX so it writes away the new settings according to your preferences.
 
Now [[Software#Latest_build_distribution_download|download the latest release]], and copy in all the files from the zip, before restarting MX at the release that is supported by developer.
 
 
 
 
 
 
====Currently running 3.10.x or 3.11.y====
 
Treat like any other major version upgrade as described above.
 
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]].
 
 
 
 
 
 
====Currently using one of the 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...
 
Then you need to be aware that 3.10.1 (3.10.0 was withdrawn) got rid of the HTML templates that you have been using, and introduced a lot of new settings.
 
The good news is that you can now jump straight to 3.12.0 as that release will rename your existing [[Cumulus.ini]] and create a new file with all the new settings:
* 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>[[Webfiles folder|CumulusMX/webfiles]]</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 3.0.0 (the MX original beta)====


Update to 3.5.1 by downloading it at https://github.com/cumulusmx/CumulusMX/releases/tag/b3072.


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.
====if using 3.7.0 release, any 3.8.x  release, or 3.9.y release====


It 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.
See sub-section directly above, that describes similar process,
* EITHER '''upgrade directly to 3.9.6, or any later build, within 3.9.x, without any major change,'''
* or to 3.12.0 with major change
*  (find either release from [https://github.com/cumulusmx/CumulusMX/releases this Github page]).


Now follow instructions below, for ''If using a 3.5.x release''
If you are using a release earlier that 3.7.0, you can note 3.7.0 was only build in 3.7.y series, but because 3.7.0 introduced a lot of changes these staged upgrades recommend that 3.7.0 is implemented, and run for a while, before continuing to upgrade.


====If using either 3.1.x, 3.2.y, 3.3.z, or 3.4.w releases====
Be aware that 3.8.0 was a major release, as it introduced the ability to run Cumulus MX as a service, but there is no reason to install it as the ability to run either interactively, or as a service, continues to be available in all subsequent releases.  


As above, update 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 above for simple next build upgrades. You can safely skip reading the intermediate release announcements, as there are no special one-off actions.
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:
* 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.


When you are happy running 3.5.1, then you should continue to upgrade, initially follow instructions in next sub-section.
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 using a 3.5.x release ====


My advice is to update directly to 3.7.0 available at [https://github.com/cumulusmx/CumulusMX/releases Mark's Github repository].   
My advice is to upgrade directly to 3.7.0 available at [https://github.com/cumulusmx/CumulusMX/releases Mark's Github repository].   


You should skip the intermediate releases because several 3.6.y releases have bugs in them, and you want to avoid those problems (the bugs vary in severity between mistakes in calculations done by MX to particular functionality not working).
''You should skip the intermediate releases because several 3.6.y releases have bugs in them'', and you want to avoid those problems (the bugs vary in severity between mistakes in calculations done by MX to particular functionality not working).


But there may be additional actions you need to do when moving from 3.5.x to 3.7.y, depending on what features you use in MX:
But there may be additional actions you need to do when moving from 3.5.x to 3.7.y, depending on what features you use in MX:
*there are no additional actions if '''you use standard web pages and you do not use database tables''', just enjoy the bug fixes and extra features after your update!
*there are no additional actions if '''you use standard web pages and you do not use database tables''', just enjoy the bug fixes and extra features after your update!
*'''If you use database tables''', be aware that the schema (Column names that must be in a table) varies between 3.5.x versions and 3.7.y versions.
*'''If you use database tables''', be aware that the <big>schema (Column names that must be in a table) varies</big> between 3.5.x versions and 3.7.y versions.
**The updating database table features in MX will only work if all the columns named in each such upload update ''already exist'' in the database table it is trying to update.
**The '''updating database table features in MX will only work''' if all the columns named in each such upload update ''already exist'' in the database table it is trying to update.
**Look at individual release announcements for both 3.6.0 and 3.7.0, to see the SQL provided for adding the columns added at particular versions.
**Look at individual release announcements for both 3.6.0 and 3.7.0, to see the SQL provided for adding the columns added at particular versions.
***At 3.6.0 the SQL was provided as a separate attachment to the release announcement (read [https://cumulus.hosiene.co.uk/viewtopic.php?p=142085#p142085 UpdateMYSQL-b3076.zip])
***At 3.6.0 the SQL was provided as a separate attachment to the release announcement (read [https://cumulus.hosiene.co.uk/viewtopic.php?p=142085#p142085 UpdateMYSQL-b3076.zip])
***At 3.7.0 the SQL was provided as part of the main zip (read [https://cumulus.hosiene.co.uk/viewtopic.php?p=145048#p145048 AlterSQLTables3098.sql])
***At 3.7.0 the SQL was provided as part of the main zip (read [https://cumulus.hosiene.co.uk/viewtopic.php?p=145048#p145048 AlterSQLTables3098.sql])
***In both cases, the SQL provided assumes you are using the default names for database tables, it does not read [[Cumulus.ini]] to see whether you have selected different names for the tables (unlike ExportMySQL.exe and standard CumulusMX.exe uploads which check what tables names you have selected for updates).
***In both cases, the SQL provided assumes you are using the default names for database tables, it does not read [[Cumulus.ini]] to see whether you have selected different names for the tables (unlike ExportMySQL.exe which used to be provided in the MX release zip with standard CumulusMX.exe;  both of those (at MX release 3.7.0) check what tables names you have selected for updates).
*'''If you have your own customised web pages''', then there are changes to web tags that might lead to you needing to edit your web pages.
*'''If you have your own customised web pages''', then there are changes to web tags that might lead to you needing to edit your web pages.
*'''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.
*'''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, and the next sub-section describes what to do next.
When you are happy with running 3.7.0, then you should continue to upgrade, but in steps (optionally try 3.9.6 because that will test some new features, then mandatory upgrade to exactly 3.12.0 which will rewrite your Cumulus.ini file, then you can continue your upgrade to latest) as described in earlier sub-sections for later releases.
 
 
 
 
====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 for later releases
 
 
 
 
 
 
====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.  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 =
 
== CREDIT ==
 
Thanks to ''Billy'' on support forum for suggesting text for this section.
 
== Using forum notifications ==
 
As new releases are announced in [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 Cumulus MX Announcements and Download - PLEASE READ FIRST] topic, you can use the spanner tool to '''subscribe''' to this topic to receive notifications of a new post announcing a new release (or any other release-related announcement).
 
== MX terminal message ==
 
If ...
#...you have a monitor to see the terminal output from the Cumulus MX engine (Windows calls this either a command window, powershell window, or a terminal window depending on how you invoke it, for Unix-based implementations this is the output window when using the terminal functionality), AND
#...your device running MX is connected to internet, AND
#...your MONO (if not Windows) is not obsolete (SSL certificate out of date), AND
#...you restart MX
... then you will see a prompt when a new version of MX is available.
 
It is worth stressing that if you leave MX running, then this feature will leave you blissfully unaware that an update is available; it only checks when MX is restarted.
 
== MXDiags ==
 
In addition ...
#...if you can view the MXdiags file for the current session of MX, AND
#... MX is running with connection to the internet, AND
#...you restart MX
... if a new version of MX is available, the MXDiags file will say so (the message is not easy to spot as there is a lot of output before it, and variation in what output appears before it). Anyway, here is one example, just one example as in my experience '''the message has appeared at different places for each of the recent upgrades'''):
<pre>
2020-05-27 04:18:48.326 Calculating sunrise and sunset times
2020-05-27 04:18:48.326 Sunrise: 04:58:11
2020-05-27 04:18:48.326 Sunset : 21:19:54
2020-05-27 04:18:48.326 Tomorrow sunrise: 04:57:08
2020-05-27 04:18:48.326 Tomorrow sunset : 21:21:11
2020-05-27 04:18:48.388 You are not running the latest version of CumulusMX, build 3080 is available.
2020-05-27 04:18:48.763 Station type:</pre>


====if using a 3.7.y release ====
There is no message in whatever place it can appear ...
*... if you are using latest version, OR
* ... if you are not connected to the internet, OR
*... if you keep MX running all the time!


If you are using 3.7.0 (there were no other builds in 3.7.y series), then you should upgrade directly to version 3.9.6 - build 3101.
== Start/Stop script ==


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.
When the '''Status''' option of this script is used, whenever a new release of MX is available, it will output a message.


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.
== Dashboard in MX Admin Interface ==


'''IMPORTANT''' one-off actions needed:
In recent releases, one of the alarm indicators shown at the bottom of the dashboard page of the administrative interface, will flash red when you are not running latest build, and glow green when there is no newer release compared to the one you are running.
* 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.


When you are happy with running version 3.9.6 build 3101, you can continue to upgrade, and that will be covered in subsequent sub-sections (assuming someone is bothered to keep this article up to date).
== Web Tags ==


====if using either 3.8.x or 3.9.y release====
Since 3.7.0 release of MX, two relevant web tags have become available:
* <#NewBuildAvailable> Returns a boolean value
**  0 - MX running the latest build available
**  1 - MX is running an earlier build than the latest public release
* <#NewBuildNumber>  Displays the latest public release build number


See previous entry, upgrade directly to 3.9.6, or any later build without any major change.


= Recommended Actions when Updating =
= Recommended Actions when Updating =
Line 283: Line 442:
== Back-ups ==
== Back-ups ==


It is always best to take a backup of your existing MX installation before you do an update, this allows you to regress back to the earlier version if either you mess up installing the new version, or the new version has a issue that prevents it working with the versions of other software (like MONO) that your installation uses.
It is always best to take a backup of your existing MX installation before you do an upgrade, this allows you to regress back to the earlier version if either you mess up installing the new version, or the new version has a issue that prevents it working with the versions of other software (like MONO) that your installation uses.


== The two approaches ==
== The two approaches ==
Line 334: Line 493:
If you won't listen to best practice advice, and have decided to for example modify the provided Cumulus web templates without allocating new names, then installing the whole release distribution will overwrite your edited file(s) with the standard file content provided by the developer. Therefore you need to do a customised approach where you select which files from the distribution to copy into your installation. If you have changed one or more web templates, you might think it safe just to omit the relevant files in the zip within folder '''web''', but some builds change the files in the '''webfiles''' folder too, and you need to retain consistency.
If you won't listen to best practice advice, and have decided to for example modify the provided Cumulus web templates without allocating new names, then installing the whole release distribution will overwrite your edited file(s) with the standard file content provided by the developer. Therefore you need to do a customised approach where you select which files from the distribution to copy into your installation. If you have changed one or more web templates, you might think it safe just to omit the relevant files in the zip within folder '''web''', but some builds change the files in the '''webfiles''' folder too, and you need to retain consistency.


== After an update if you use the standard web template files ==
==== Updating when files within release might overwrite your own edits ====
 
To further explain the customised approach, here are some more examples.
 
===== web site files =====
 
If you have edited any files that sit on your '''web site''', then these can remain on your web site. However, if those web pages are generated from templates that you expect MX to process and upload for you, you do need to take special action. Maybe you edited a template to give the look you desire, or the content you want (e.g. adding rain this month to this month page, or combining this month and this year page).
 
The first step is to see if the release notice says that file has been revised, if it has not then it is easy to keep your edited file by not copying in the replacement file from within the zip.  If the release revises any file you previously edited, take a backup of your edited file, before you copy the new file into your folder. You can then use a file comparing tool to see what has changed in the release and what you changed and hopefully manage to merge to a new file that keeps any functionality change in a new release and keeps your customisation. Do think about changing name of the template file, or placing it in a different folder, and using the '''Extra Files''' settings. That will make it easier for you next time you do an upgrade to a new MX build.
 
If you have done major customisation to the standard website then you probably have followed the guidance and stored your new web page templates in a different directory and you use '''Extra Files''' to specify where they are, so they cannot be overwritten, and the new MX will still find them. It might be that new web tags have been added since whatever build you were running before, and that you decide to edit your customised template file, but that can be done any time after you install the new MX build.
 
===== admin interface files =====
 
If you have done any customisation to the '''interface''' (perhaps you don't like seeing solar in the tables when you don't measure that) then again you can skip over these files when copying. Hopefully you will have copies of the files that you have customised of the ''interface folder'' so you have ability to copy them back into installation if you do overwrite with the release version. 
 
'''You do have to be careful''', as many releases change the interface in some way, even if the change is not in the file you have customised, it might be in an asociated file, and all the various components of the interface have to work together as a coherent unit. For instance when feels like was added to MX, the api used for sending data from the MX engine to the admin interface was updated. In some releases, a new web page is added to the admin interface, with the consequence that all the navigation menus were adjusted in all web pages. Any HTML page in the admin interface may be edited to refer to a different styling page (so it, and the .css file, must be updated together) or to a different script (so the .HTML, and the .js file, must be updated together).  The settings pages in the admin interface are dependent on the correct pair of json files to define the options or values that appear on that web page, so again all must be consistent. 
 
To sum up, admin interface files are interdependent, and you cannot always update some, but not all, of the admin interface pages.
 
Be prepared to go back to the standard file for whatever you customised if something it depends upon has changed, after all you must not lose any vital functionality.
 
On my site, my own versions of interface files have a "_" (underline character) added to the start of the standard MX file name. This applies to both HTML pages, and JavaScript files that I have edited. I edit the menu items within my edited pages so those all go to my versions where I have a HTML customised page, leaving unchanged the menu items that can still go to a standard MX web page where I don't have my own version of the .HTML page.  This makes it easy for me to navigate between my pages, as all of them link to my other pages.  If I am on a standard MX page and want to go to one of my customised pages, I select the equivalent standard page, then edit the URL to add the underline and get easily to my page.  This naming means I can always use a standard page instead of my customised page when I need to, and I never miss out on any new features.
 
== After an upgrade if you use the standard web template files ==
 
If you do not use the example web template files, provided as standard, with a MX release, the remainder of this section can be ignored.
 
If you use the third party [[CumulusMX and Cumulus1 UI style Multilingual Websites]] web pages, as maintained by BCJKiwi, follow any instructions in his package as to which of the files in this section are required and any announcements in his forum topic about when such files need to be upgraded.


=== web folder from zip ===
=== web folder from zip ===


The new web template files will be in your '''web''' folder and MX will process the new files and upload the web pages produced as before with no further action by you.
If you do use the example web templates to produce web pages for your web server, and you have copied all files from the release distribution ....
 
....MX will find any new web template files in your '''web''' folder,  MX will process those template files, and upload the web pages produced, ''as before with no further action by you''.


=== webfiles folder from zip ===
=== webfiles folder from zip ===
<br/>
<big>PLEASE COULD SOMEONE USING LATEST MX RELEASE ENSURE THIS IS KEPT UP TO DATE</big>
<br/>


You do need a further action, if any files in this folder have been updated.  The updated files must be uploaded to your web site.
You do need a further action, if any files in this folder have been updated.  The updated files must be uploaded to your web site.
Line 351: Line 545:
*'''weatherstyle.css''' has not been updated since its last update by Steve Loft in 2009.
*'''weatherstyle.css''' has not been updated since its last update by Steve Loft in 2009.
*subfolder '''images''' contains 2 pictures that have stayed same since MX launch
*subfolder '''images''' contains 2 pictures that have stayed same since MX launch
*subfolder '''js''' contains one file. The file '''\CumulusMX\webfiles\js\cumuluscharts.js''' has changed in a lot of releases.  The standard web page '''trends.htm''' will only work if the correct version of that file has been uploaded to your web site and placed in a sub-folder "js" of where "trends.htm" is installed. BCJKiwi's user interface '''charts.php''' also requires the same JavaScript file, so upload the file anytime it is updated in a MX release.
*subfolder '''js''' contains one file or two files (depending on which MX release you are using:
**The standard web page '''trends.htm''' will only work if the correct version of any file here has been uploaded to your web site, and placed in a sub-folder "js" of where "trends.htm" is installed. .
*** BCJKiwi's user interface '''charts.php''' also requires the same JavaScript file (or files?), so upload the file(s0 anytime there is a change in a MX release.
** The file '''\CumulusMX\webfiles\js\cumuluscharts.js''' has changed in a lot of releases, it is updated whenever there is a change in the JSON files used for providing data to the charts, and you must use the right upgrade.
** The file '''historiccharts.js'' (it was introduced from release 3.8.7) is similar to previous script, but drives the historic chart functionality on your web server
*subfolder '''lib''' currently contains 3 folders:
*subfolder '''lib''' currently contains 3 folders:
**'''highstock''' - this folder is no longer needed on your web site
**'''highstock''' - this folder is no longer needed on your web site (and the most recent MX releases have emptied it)
**'''jquery''' - this folder is needed for "trends,htm" to work, but it has not been updated since 2014. Both the files included are obsolete packages, no longer officially available, and there are no plans to replace them.
**'''jquery''' - this folder is needed for "trends,htm" to work, but it has not been updated since 2014. Both the files included are obsolete packages, no longer officially available, and there are no plans to replace them.
**'''steelseries''' - this folder has 3 sub-folders, and I can only think of 2 MX releases when anything was changed here, and I don't anticipate any further changes.
**'''steelseries''' - this folder has 3 sub-folders, I can only think of 2 MX releases when anything was changed here, and I don't anticipate any further changes.
 
= After upgrade - checking for bugs in MX or mistakes in your installation =


== After update - checking for bugs in MX or mistakes in your installation ==
Start the new installation of MX and watch out for any errors - If the device you run MX on has a monitor, then look in the terminal/command window. In all cases look at the latest file in the [[MXdiags_folder|MXdiags folder]] to see if any errors are reported.


Start the new installation of MX and watch out for any errors - If the device you run MX on has a monitor, then look in the terminal/command window. In all cases look at the latest file in the MXdiags folder to see if any errors are reported.
In newer releases of MX, also see [[ServiceConsoleLog.txt]]


Also keep an eye on the support forum for first few days, some releases do have bugs, as developer cannot test all possible configurations.
Also keep an eye on the support forum for first few days, some releases do have bugs, as developer cannot test all possible configurations.
Line 365: Line 565:
== Updating if you use a virus Checker ==
== Updating if you use a virus Checker ==
You may find that virus checkers such as Windows Defender reject your new version of MX. They need to be told it is safe.
You may find that virus checkers such as Windows Defender reject your new version of MX. They need to be told it is safe.
== Updating if you use the start/stop management script ==
This section contributed by ''Jank'' on support forum.  Note the version on the forum might have been updated from the original included here.
1. look on [[Software|Software download page]], find the link to latest version, and fill out the '...' below appropriately as you run these 2 commands on your device where you do downloads:
<pre>cd /tmp
wget https://github.com/cumulusmx/CumulusMX/ ... .zip</pre>
2. Once that download is complete, start cumulusmx.sh with option -u
<pre>/home/pi/CumulusMX/cumulusmx.sh -u</pre>
3.When asked for the zip file, enter
<pre>/tmp/CumulusMXDist</pre> and hit the TAB Button
4.Choose the zip file with the CumulusMX update and hit return.
5. Follow the on screen instructions
6. With each update component .....you can choose: [y]es, [n]o, [A]ll, [N]one, [r]ename
I would recommend select '''A''' as that will simply replace all files without further action.
CumulusMX will be restarted after update completes.
You can check if the update was successful by using option -s:
<pre> /home/pi/CumulusMX/cumulusmx.sh -s</pre>
Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/7490...10079"

Navigation menu