Category:Cumulus MX: Difference between revisions

1,310 bytes added ,  06:41, 18 April 2020
m
Line 482: Line 482:


= Updating to a new MX release =
= Updating to a new MX release =
If you have a monitor to see the output from the Cumulus MX engine in its console log, you will see a prompt when a new version is available. Equally if you can view the MXdiags file for the current session of MX, that will say if a new version of MX is available.
*If your update is from the immediately previous build, then just check the release announcement in the support forum, or the entry at [[Cumulus_MX_formal_release_versions]] in this wiki (if that is up to date) for which files have been affected.
*If your update is skipping some intermediate versions, then check the corresponding release announcements or Wiki entries for every version since the one you have been using before planning your upgrade.


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 you mess up installing the new version.
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 you mess up installing the new version.


Best way is to rename your current install directory, then unzip the new release, letting it create a new '''CumulusMX''' folder. Copy across Cumulus.ini into that new directory, and then copy the contents of the '''data''' and '''Reports''' directories from your ''current install'' to the new install.  However, if you are downloading on a different device, or on a different disc to where you are running MX, then after downloading simply copy the changed files into the existing MX directory on the device where you run MX.  
== two approaches ==
#One popular approach is to rename your current install directory, then unzip the new release, letting it create a new '''CumulusMX''' folder. Copy across Cumulus.ini into that new directory, and then copy the contents of the '''data''' and '''Reports''' directories from your ''current install'' to the new install.  Don't forget to copy '''strings.ini''' and any other set-up files across too.
 
#However, if you have a lot of set-up files, if you are downloading on a different device, or on a different disc to where you are running MX, then after downloading simply copy the changed files into the existing MX directory on the device where you run MX. Then you know all your existing files are there, and you only change the minimum number of files as specified in the release notes (on forum or in Wiki).
 


== Updating when files within release might overwrite your edits ===
If you have edited any files, see if the release notice says that file has been revised, if it has not then keep your edited file by not copying in the replacement file within the zip. If the release revises a 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. This includes any web pages you might have edited 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). If you have done major customisation to the standard website then you probably have your equivalents to the standard web page in a different directory and use '''Extra Files''' to specify where they are, so the new MX will still find them. If you have done any customisation to the '''interface''' then copy across just the files that you have customised of the ''interface folder from the current installation'' to the new installation - but be careful with this one, as many releases change the interface in some way and you must not lose any vital functionality.
If you have edited any files, see if the release notice says that file has been revised, if it has not then keep your edited file by not copying in the replacement file within the zip. If the release revises a 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. This includes any web pages you might have edited 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). If you have done major customisation to the standard website then you probably have your equivalents to the standard web page in a different directory and use '''Extra Files''' to specify where they are, so the new MX will still find them. If you have done any customisation to the '''interface''' then copy across just the files that you have customised of the ''interface folder from the current installation'' to the new installation - but be careful with this one, as many releases change the interface in some way and you must not lose any vital functionality.


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


Finally, don't delete your old installation for a week or so as you may notice something from the older version that you haven't copied across!
Finally, don't delete your old installation for a week or so as you may notice something from the older version that you haven't copied across! Check again that you copied across strings.ini, twitter.txt, Cumulus.ini, and similar files in the same folder level as CumulusMX.exe, as well as all the files in the data and Reports sub-folders.


== Updating if you use a virus Checker ==
== Updating if you use a virus Checker ==
5,838

edits