Updating MX to new version: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
m
m (further re-sequence)
(18 intermediate revisions by 2 users not shown)
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.




Line 18: Line 18:
Be aware that the developer needs to remember to update this link each time there is a new release.
Be aware that the developer needs to remember to update this link each time there is a new release.


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.
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==
==Any release developed by Mark Crossley==
Line 33: Line 33:


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.
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==
==Upgrading if you run MX as a service==


Don't forget to stop the service, before you do the upgrade.
Don't forget to stop the service, before you do the upgrade.


For  a Linux Operating system: <code>sudo systemctl stop cumulusmx</code>.
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)


==Upgrading if you run MX interactively==
==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.  
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.  




== 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.
#* 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.
Line 87: Line 107:
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.
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.


==Updating if you are running MX on a Linux computer==
==Upgrading if you are running MX on a Linux computer==


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


== Updating if you use the start/stop management script ==  
== Updating if you use the start/stop management script ==  
Line 105: Line 127:
<pre>/tmp/CumulusMXDist</pre> and hit the TAB Button
<pre>/tmp/CumulusMXDist</pre> and hit the TAB Button


4.Choose the zip file with the CumulusMX update and hit return.
4.Choose the zip file with the CumulusMX upgrade and hit return.


5. Follow the on screen instructions
5. Follow the on screen instructions
Line 114: Line 136:




CumulusMX will be restarted after update completes.
CumulusMX will be restarted after upgrade completes.


You can check if the update was successful by using option -s:
You can check if the upgrade was successful by using option -s:
<pre> /home/pi/CumulusMX/cumulusmx.sh -s</pre>
<pre> /home/pi/CumulusMX/cumulusmx.sh -s</pre>


=Considerations that determine when to update=
=Considerations that determine when to upgrade=


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 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 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.
*for other stations, without their own logging, all data is lost for the period when MX is not running.




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:
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:
* 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;
* 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;
* you may wish to avoid the loss of data mentioned above, by minimising the number of times that you stop MX;
* you may wish to avoid the loss of data mentioned above, by minimising the number of times that you stop MX;
Line 132: Line 154:
* 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 '''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.  
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.  


===Advice about skipping versions===
===Advice about skipping versions===
Line 138: Line 160:
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)
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)


The important point to make here is that when you do an update, 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.
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.


= What to read (and when) before upgrading =
= What to read (and when) before upgrading =


== Updating from immediately preceding build ==
== Upgrading from immediately preceding build ==


=== The release announcement ===
=== The release announcement ===
Line 162: 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 171: 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 210: 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 233: 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 a 3.7.y release ====


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.


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.


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.
====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
 
 
 


'''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 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).


====if using either 3.8.x or 3.9.y release====
====If using 3.0.0 (the MX original beta)====


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


====From 3.9.y to 3.10.x====
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.


The major aspects that changes at 3.10.1 (3.10.0 was withdrawn) are:
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.
* Changes to settings
** You need to open the [[MX Administrative Interface]] and work through all pages in the '''Settings''' menu.
*Changes to web files in <code>CumulusMX/web</code>, <code>CumulusMX/webfiles</code> and introduction of <code>CumulusMX/webfiles-legacy</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


====From 3.10.x to 3.11.y====
It does not involve any updates to the fields in the log files nor to the columns in any database tables you use.


Treat like any other major version upgrade as described above.


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 =
= Knowing when a new release is available =
Line 332: Line 406:
#... MX is running with connection to the internet, AND
#... MX is running with connection to the internet, AND
#...you restart MX
#...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'''):
... 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>
<pre>
2020-05-27 04:18:48.326 Calculating sunrise and sunset times
2020-05-27 04:18:48.326 Calculating sunrise and sunset times
Line 368: 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 443: Line 517:
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.
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 update if you use the standard web template files ==
== 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 do not use the example web template files, provided as standard, with a MX release, the remainder of this section can be ignored.
Line 481: Line 555:
**'''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.
**'''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 update - checking for bugs in MX or mistakes in your installation =
= After upgrade - 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|MXdiags folder]] to see if any errors are reported.  


In newer releases of MX, also see [[ServiceConsoleLog.txt]]
In newer releases of MX, also see [[ServiceConsoleLog.txt]]
5,838

edits

Navigation menu