5,838
edits
Software: Difference between revisions
m
no edit summary
m (→Other utilities: Change grouping) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
= Cumulus MX = | = Cumulus MX = | ||
: a cross platform version of Cumulus | : a cross platform version of Cumulus (M Crossley update) that runs on Microsoft Windows, all varieties of UNIX and Linux (including the Raspberry Pi Operating System), and Mac OS X. | ||
:'''NOTE: On Linux/RPi/macOS, Mono version 5, or 6, is needed for CreateMissing.Exe, ExportToMySQL.exe, and CumulusMX.exe. All of these relating to MX Release v3.9.1 or later. | |||
: Mono v4 is subject to random crashes.''' | |||
{{TOCright}} | |||
<br /><br /> | |||
==Usage Restriction== | |||
Note: '''Cumulus MX is strictly for non-commercial, non-government use only.''' | Note: '''Cumulus MX is strictly for non-commercial, non-government use only.''' | ||
Both the mandatory [[MX Administrative Interface| | Both the mandatory [[MX Administrative Interface|MX Interface]], and the optional [[New Default Web Site Information|default web site]], contains products produced by [https://www.highcharts.com Highsoft] which are not free for commercial and governmental use. | ||
== Help with ‘Stable’ MX releases == | |||
Please read the announcement for the latest MX release in [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 the forum] before installing it (to see what changes affect you, and what actions you may need to take). | |||
If you need any help with Cumulus MX, please first consult, in this Wiki, [[What_to_do_when_I_have_a_problem_with_MX]], or use the entry point of | |||
the [[:Category:Cumulus MX]] page for pointers to other Wiki pages connected with MX that may help. | |||
If you cannot answer your questions from those links, then use the [https://cumulus.hosiene.co.uk/viewforum.php?f=40 correct MX support forum] to see if others have answers. | |||
==Upgrading== | ==Upgrading== | ||
We strongly advise | We strongly advise [[Updating_MX_to_new_version#Introduction_to_upgrading_MX|upgrading]] to the latest version, if only for the fact that later versions offer more functionality, and may fix any bugs in an earlier release. Also the developer can more easily offer support if you are using the build he most recently released. | ||
release. | |||
It is strongly recommended that you install all files (there are inter-dependencies) in the download for a new release of MX directly over your existing installation. There is an [[Updating_MX_to_new_version#Installer_Option|installer utility]] available to help with upgrading. | |||
*Important, please read all of the release notes (in the appropriate forum announcement threads) for the builds since the version you are upgrading from. | |||
*If you are currently running | *Important, please read all of the release notes (in the [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 appropriate forum announcement] threads) for the builds since the version you are upgrading from, especially noting when there are references to necessary once-off actions. | ||
*If you have never upgraded before, or you are currently running a fairly old release of MX, you are advised to read the [[Updating MX to new version]] page in this Wiki, | |||
** overwriting an existing installation will add any new files, but it won't remove obsolete files, and sometimes [[MX_Basic_info#Library_software|replacement files]] have different names to their predecessors | |||
** (a few builds will include one-off actions, e.g. rewriting [[Cumulus.ini]] or changes to columns in database tables, in these cases you need to upgrade in multiple steps, to ensure these special actions are done). | |||
*If you are upgrading from a previous version of the legacy Cumulus 1, then you might want to read [[Migrating from Cumulus 1 to MX]] page; and if you need more justification read [[Compare_C1_and_MX|Compare legacy Cumulus and MX]] page | *If you are upgrading from a previous version of the legacy Cumulus 1, then you might want to read [[Migrating from Cumulus 1 to MX]] page; and if you need more justification read [[Compare_C1_and_MX|Compare legacy Cumulus and MX]] page | ||
Note by Steve Loft: you may find that anti-virus software flag a new release of Cumulus as a ‘threat’, for a few days or weeks after a new version has been released, even though it does not actually contain a virus of any kind. This is due to a system they call ‘reputation’ where they automatically block any versions of software | Note by Steve Loft: you may find that anti-virus software flag a new release of Cumulus as a ‘threat’, for a few days or weeks after a new version has been released, even though it does not actually contain a virus of any kind. This is due to a system they call ‘reputation’ where they automatically block any versions of software that have recently been released. You may want to consider complaining to the provider of your anti-virus software about this ridiculous system, or better still, use some better anti-virus software. | ||
== Current Release == | |||
===Latest build distribution download=== | |||
: Download [https://github.com/cumulusmx/CumulusMX/releases/download/b3160/CumulusMXDist3160.zip Cumulus MX v3.14.1 build 3160, 21-December-2021] | |||
== | ===Raspberry Pi Image=== | ||
: Download [//{{SERVERNAME}}/Downloads/rpi-CMX-3.13.0.zip Raspberry Pi Image for Cumulus MX 3.13.0] | |||
: As at December 2020, the image includes Raspberry Pi. O. S. 10 "Buster" version of Linux. | |||
<br> | |||
* This is a pre-built disk image file for your first installation onto a Raspberry Pi computer. | |||
* This contains all you need; | |||
*# the lite version of the Raspberry Pi operating system | |||
*#* (this excludes all the graphical user interface, so is designed for a "headless" operation), | |||
*# latest mono-complete | |||
*#* ('''built on a model 3'', there might be issues when used on a model in a different series), | |||
*# a MX installation (in "/opt/CumulusMX") at the release version advertised above, | |||
*# code to create a temporary RAM drive | |||
*#* (using the memory on the chip will reduce wear of input/output operations on micro-SD card) | |||
*# a set of symbolic links in [[Web folder|CumulusMX/web folder]] so that the temporary files created by MX are physically stored on that RAM drive | |||
*#* (any temporary file content lost on reboot). | |||
*The instructions for using this image can be found here: [[Raspberry_Pi_Image|Raspberry Pi Image]] | |||
** Please note, this image may not always contain latest MX release, but once you have installed a release of MX on your Raspberry Pi, [[Updating MX to new version|upgrading]] is done using main software download link, as none of the other components in the image need to be upgraded (unless the release announcement states that the new release needs a specific version of Mono). | |||
==Source download== | |||
*[https://github.com/cumulusmx/CumulusMX Cumulus MX Current Source Code] | |||
This code base is updated for all releases resulting from development by M Crossley. | |||
==Older releases== | ==Older releases== | ||
| Line 59: | Line 84: | ||
Find link to earlier MX release distributions on [[Main Page]]. | Find link to earlier MX release distributions on [[Main Page]]. | ||
(You can search using the history tab on this Wiki page to see which past builds were made available as Raspberry Pi images, as these are not created for all releases, but there is no way to tell if the old filenames can still be downloaded. Generally, it is easiest to download a different normal MX release distribution over whatever MX release was in the image you downloaded.) | |||
= Other utilities = | = Other utilities = | ||
==By Mark Crossley== | |||
=== Create Missing === | |||
The CreateMissing.exe ''v1.2.0'' download dated 05 December 2021 (works with release of MX 3.14.0 onwards) [https://github.com/cumulusmx/CreateMissing/releases/download/v1.2.0/CreateMissing-v1.2.0.zip is here]. | |||
If you are using an earlier MX release, upgrade that, before using this utility. | |||
This is a MX utility, by Mark Crossley, to populate any missing [[Calculate_Missing_Values#Derived_value|derived fields]] from the [[Calculate_Missing_Values#Source_value|source values]] in your [[Standard log files|month by month (MMMyylog.txt)]], and to insert missing lines in [[dayfile.txt|daily summary (dayfile.txt)]]. | |||
More information by the author of the utility can be [https://github.com/cumulusmx/CreateMissing/blob/master/README.md found here.] | |||
* Learn when this utility might be useful, and when not, by reading the [[Calculate Missing Values]] page. | |||
* Check in the support forum for information about status of bugs in this utility, e.g. it was reported that there were problems concerning storing the line in dayfile.txt for the first of some months | |||
* For full information about solving problems with your '''dayfile.txt''' file read the [[Amending dayfile|amending daily summary file]] page. | |||
=== Export ''To'' MySQL === | |||
A utility, by Mark Crossley, to export content of Cumulus MX [[Standard log files|month by month (MMMyylog.txt)]] and [[dayfile.txt|daily summary (dayfile.txt)]] [[Category:Files with Comma Separated Values|files]] to a [[Your Own Server|MySQL, or Maria, database server]]. | |||
The ExportToMySQL.exe ''v1.4.0'' download dated 05 December 2021 (works with release of MX 3.14.0 onwards) [https://github.com/cumulusmx/ExportToMySQL/releases/download/v1.4.0/ExportToMySQL-v1.4.0.zip is here.] | |||
If you are using an earlier MX release, upgrade that, before using this utility. | |||
More information by the author of the utility can be [https://github.com/cumulusmx/ExportToMySQL/blob/main/README.md found here.] | |||
''This new utility replaces the "ExportMySQL.exe" (no "To" in that name) utility included by Steve Loft in his MX beta distributions.'' That is not compatible with any recent MX releases. | |||
==By Steve Loft== | ==By Steve Loft== | ||
| Line 94: | Line 146: | ||
[https://cumuluswiki.org/a/File:WLconverter.zip WLconverter.zip] | [https://cumuluswiki.org/a/File:WLconverter.zip WLconverter.zip] | ||
== Third Party Contributions by other Cumulus Users == | == Third Party Contributions by other Cumulus Users == | ||