Category:Cumulus MX: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
mNo edit summary
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Documentation for MX ==
This category lists all the pages that are relevant to MX, so is a good starting point.
* There are pages in this category for all folders and files, used by MX
* If you contribute a new page, add it to this category by quoting '''<nowiki>[[Category:Cumulus MX]]</nowiki>''' on your new page.
* ''[[Migrating_from_Cumulus_1_to_MX|How to migrate to MX]]''  - For those still using the original Cumulus software


=== Cross reference to article on [[Moving from Cumulus 1 to MX]] (includes general issues regarding running on Windows) ===
SOME KEY INFORMATIVE PAGES (FOR NOVICES):
* [[What to do when I have a problem with MX]] - read this before you seek advice in the Cumulus Support Forum
* [[Raspberry_Pi_Image|Setting up Raspberry Pi using a pre-built Image]] - install MX on a Raspberry Pi computer, (with all access to the Pi done from another computer on same network).
* [[MX_on_Linux|MX on Linux]] - MX is really easy to install, and run, on any simple computer running any UNIX derivative
* [[MX_on_Windows_OS|MX on Windows Op Sys]] - you can install MX on a Windows PC, or laptop
* [[Updating MX to new version|How to upgrade to new MX release]] - comprehensive guide
* [[MX Administrative Interface|Administrative Interface]]- all about the pages used for settings, correcting log files, and viewing your weather derivatives locally
* [[Cumulus.ini]] - comprehensive guide to settings and configuration file
* [[Samplestring.ini]] - configuration samples for customisations
* [[:Category:Ini Files]] for all pages that deal with the files storing highs and lows


Whether you have been using Cumulus 1, or are new to Cumulus, you may be tempted to install MX on a PC, or other device, running Windows Operating System; the article linked in the heading will help you.
SPECIALIST GUIDES (NOT FOR NOVICES):
* [[:Category:JSON Files]] for all pages dealing with files used to get data to your web site
* [[Webtags/Parameters]] - see this page if you want to vary how data appears on web pages
* [[Cumulus_MX_Local_API|MX application programming local interface]] - the developer explains how data is made available for local interfaces
* [[MX Basic info]]  -  contains details like the library functions used by MX, and how the end of day process works.
* [[Cs Code Modules]] - quick guide to the components compiled up to make the MX executable


=== Cross reference to article on [[Raspberry_Pi_Image|Setting up Raspberry Pi using a pre-built Image]] for Cumulus ===
PAGES THAT WERE CREATED FOR MX BETA:
These were created in a rush when there was a threat that the support forum would close, they need a willing contributor to sort them into useful pages:
You may be tempted to install MX on a Raspberry Pi, operating in headless mode (instead of connecting a screen and keyboard to it, you do all access to the Pi from another computer on same network). The developer has made life easy for you by combining the '''Raspberry Pi Lite Operating System''' with a pre-installation copy of MX.
* [[MX Issues]] Detailed known issues with 3.0.0 beta releases
 
* [[Cumulus MX FAQ]] Was intended to be quick reference answers to frequent questions
Find out more about using this pre-built Raspberry Pi image file to create a basic headless server in the article linked in the heading.
 
=== Cross reference to article on [[Setting up Raspberry Pi]] for Cumulus ===
Whether you have been using Cumulus 1, or are new to Cumulus, you may be tempted to install MX on a Raspberry Pi. A Raspberry Pi computer (and similar devices from other manufacturers) is much simpler than a normal computer, but it can still run various operating systems that allow you to use it perhaps for both running MX and a web server. Find out more in the article linked in the heading.
 
=== Cross reference to article on [[Updating MX to new version]] ===
 
Whether you have not updated for a long time, or simply wonder whether you are updating the easiest way, follow the link in the heading for this section, to an article that contains advice '''both''' for those updating each time there is a new release available '''and''' how to upgrade from an old version in a series of steps, skipping some in-between versions.  So read the article linked in the section heading whether you are still using Steve Loft's beta version of MX or an old Mark Crossley release.
 
=== Cross reference to [[Cumulus MX FAQ]] ===
 
A new FAQ for MX has been started at [[Cumulus_MX_FAQ|another page]]. As I add the link here, the Cumulus MX FAQ is in a mess, but hopefully someone will have time to sort it out.
 
=== Cross reference to [[MX Issues]] ===
 
The [[MX Issues|Cumulus MX Known Issues]] article was based on [https://cumulus.hosiene.co.uk/viewtopic.php?f=39&t=12943 Steve Loft's forum post] so based on an early beta version of MX, and there has been minimal attempt to update the contents as MX has been developed further and come out of the original beta. <big>Anyone willing to check the linked article and do a further update?</big>
 
 
=== Cross-reference to [[What to do when I have a problem with MX]] ===
 
The text that was here has been moved to a separate article, that makes it more accessible, please see [[What to do when I have a problem with MX|What to do when I have a problem with MX article]]
 
Although you may end up asking for advice on the Cumulus Support Forum, read the article linked in the heading first, as it will help you to provide the information that is needed for others to quickly help you.
 
=== Cross reference to [[MX Administrative Interface|Administrative Interface]] ===
 
This requires a whole topic to itself, and indeed it has an article to itself, reached from link in heading for this section.
 
=== Cross reference to the application programming interface (api) used by MX ===
 
The MX application programming local interface has been fully documented by the developer in [[Cumulus_MX_Local_API|this article]].
 
There is also some older information [[MX_Administrative_Interface#The_API_interface|here]] which explains how the api is used in the administrative interface.

Revision as of 04:23, 9 August 2021

This category lists all the pages that are relevant to MX, so is a good starting point.

  • There are pages in this category for all folders and files, used by MX
  • If you contribute a new page, add it to this category by quoting [[Category:Cumulus MX]] on your new page.
  • How to migrate to MX - For those still using the original Cumulus software

SOME KEY INFORMATIVE PAGES (FOR NOVICES):

SPECIALIST GUIDES (NOT FOR NOVICES):

PAGES THAT WERE CREATED FOR MX BETA: These were created in a rush when there was a threat that the support forum would close, they need a willing contributor to sort them into useful pages:

  • MX Issues Detailed known issues with 3.0.0 beta releases
  • Cumulus MX FAQ Was intended to be quick reference answers to frequent questions

Subcategories

This category has the following 5 subcategories, out of 5 total.