5,838
edits
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
, 18:07, 11 December 2021→if using any 3.7.y release, any 3.8.x release, or 3.9.y release
| (7 intermediate revisions by the same user not shown) | |||
| Line 255: | 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.7.0 release, any 3.8.x release, or 3.9.y release==== | |||
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]). | |||
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. | |||
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. | |||
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. | |||
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 ==== | ||
| Line 280: | Line 337: | ||
My advice is to upgrade 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 | ***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, | 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 = | = Knowing when a new release is available = | ||
