5,838
edits
MX Administrative Interface: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
MX Administrative Interface (view source)
Revision as of 11:56, 12 April 2021
, 11:56, 12 April 2021Updated warning at top of page
m (→The Data Log Viewing and Editing interface: add warnings "may be out of date") |
m (Updated warning at top of page) |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<div style="background: LemonChiffon;padding:5px; margin:2px;"> | <div style="background: LemonChiffon;padding:5px; margin:2px;"> | ||
[[File:Crystal Clear info.png|40px]] This | [[File:Crystal Clear info.png|40px]] This page was last updated for the MX release in July 2020; that is no longer latest! | ||
Appeal to contributors: Please work through all MX release announcements and work out all the many updates needed for each section. | |||
For example recent releases have totally changed the content of all settings pages in the admin interface. | |||
Consequently, the whole page may even need either a replacement (set of) page(s), splitting of this page into multiple pages, or just a redesign of this section, for more recent releases! | |||
</div> | </div> | ||
=Terminology= | =Terminology= | ||
| Line 12: | Line 20: | ||
When he worked on Cumulus 2 alpha builds, he needed to explain how the design of his new software was different, and he talked about it separating "engine" and "user interface". Basically, the engine read information from the weather station, calculated derivatives, and monitored extreme records. The user interface was a web server generated by the engine, here you could amend settings, and see those weather derivatives (the alpha Cumulus 2 never had ability to feed any information to an external web server). | When he worked on Cumulus 2 alpha builds, he needed to explain how the design of his new software was different, and he talked about it separating "engine" and "user interface". Basically, the engine read information from the weather station, calculated derivatives, and monitored extreme records. The user interface was a web server generated by the engine, here you could amend settings, and see those weather derivatives (the alpha Cumulus 2 never had ability to feed any information to an external web server). | ||
Thus Steve Loft used the same terminology (engine and user interface) for his Cumulus 3 beta (also known as MX). When Mark Crossley took over development and brought MX out of beta, he added much more to the web server that the engine generated, and he talks about "the code" where Steve used "engine" and he uses "admin interface" for the enhanced collection of web pages generated by the code allowing you to do administrative tasks like correcting log files (both data logs and extreme record logs). | Thus Steve Loft used the same terminology (engine and user interface) for his Cumulus 3 beta (also known as MX). When Mark Crossley took over development and brought MX out of beta, he added much more to the web server that the engine generated, and he talks about "the code" where Steve used "engine" and he uses "admin interface" for the enhanced collection of web pages generated by "the code" allowing you to do many administrative tasks like correcting log files (both data logs and extreme record logs). Since then, Mark has redesigned almost every page that Steve Loft created, so there is effectively nothing of the old "user interface" left, and "admin interface" therefore describes the new functionality better. | ||
=How to see and use the Admin Interface= | =How to see and use the Admin Interface= | ||
| Line 75: | Line 83: | ||
== The Data Log Viewing and Editing interface == | == The Data Log Viewing and Editing interface == | ||
<div style="background: LemonChiffon;padding:5px; margin:2px;"> | |||
[[File:Crystal Clear info.png|40px]] This section was written around the MX release in July 2020; that is no longer latest! | |||
Appeal to contributors: Please work through all MX release announcements and work out all the many updates needed for this section, it may even need a redesign so it can correctly cover both past and more recent releases! | |||
</div> | |||
The '''Data logs''' tab in the admin interface, gives access to screens that can display the contents of 3 types of log files: | The '''Data logs''' tab in the admin interface, gives access to screens that can display the contents of 3 types of log files: | ||
| Line 165: | Line 178: | ||
[[File:Crystal Clear info.png|40px]] This section was written around the MX release in July 2020; that is no longer latest! | [[File:Crystal Clear info.png|40px]] This section was written around the MX release in July 2020; that is no longer latest! | ||
Appeal to contributors: Please work through all MX release announcements and work out all the many updates needed for | Appeal to contributors: Please work through all MX release announcements and work out all the many updates needed for these sections, they may even need a redesign so it can correctly cover both past and more recent releases! | ||
</div> | </div> | ||
All settings are stored in [[Cumulus.ini]], so when you stop and restart MX, it can continue without you entering settings again. | All settings are stored in [[Cumulus.ini]], so when you stop and restart MX, it can continue without you entering settings again. | ||
| Line 200: | Line 213: | ||
=== Station Settings === | === Station Settings === | ||
<div style="background: LemonChiffon;padding:5px; margin:2px;"> | |||
[[File:Crystal Clear info.png|40px]] This section was last updated for the MX release in July 2020; that is no longer latest! | |||
Appeal to contributors: Please work through all MX release announcements and work out all the many updates needed for this section, | |||
recent releases have totally changed the content of all settings pages in the admin interface, | |||
consequently, the whole page may even need either a replacement set of pages, splitting of this page into multiple pages, or just a redesign of this section, for more recent releases! | |||
</div> | |||
Each setting has a hint beside it (with a small 'i' for information before each hint). If you have used [[Cumulus_Screenshots#Station|Cumulus 1]], the layout and section headings will be familiar. No settings takes effect until '''Save''' button pressed. | Each setting has a hint beside it (with a small 'i' for information before each hint). If you have used [[Cumulus_Screenshots#Station|Cumulus 1]], the layout and section headings will be familiar. No settings takes effect until '''Save''' button pressed. | ||
| Line 427: | Line 453: | ||
=== Internet Settings === | === Internet Settings === | ||
<div style="background: LemonChiffon;padding:5px; margin:2px;"> | |||
[[File:Crystal Clear info.png|40px]] This section was last updated for the MX release in July 2020; that is no longer latest! | |||
Appeal to contributors: Please work through all MX release announcements and work out all the many updates needed for this section, | |||
recent releases have totally changed the content of all settings pages in the admin interface, | |||
consequently, the whole page may even need either a replacement set of pages, splitting of this page into multiple pages, or just a redesign of this section, for more recent releases! | |||
</div> | |||
All settings entered here are stored in [[Cumulus.ini]]. No settings take effect until '''Save''' button pressed. [[File:Include graph data files.PNG|right]] | All settings entered here are stored in [[Cumulus.ini]]. No settings take effect until '''Save''' button pressed. [[File:Include graph data files.PNG|right]] | ||
| Line 439: | Line 477: | ||
*some defaults are different in the two flavours. | *some defaults are different in the two flavours. | ||
While Cumulus 1 only supports standard FTP, MX supports | |||
==== Admin Interface: Settings Menu: Internet settings: '''Web/FTP settings''' ==== | |||
{{Version badge Mx}}[[File:Include graph data files.PNG|right]] | |||
#Click on this heading to expand settings as per illustration. | |||
#''Auto update'' | |||
#*Tick this to enable updates to a web server by MX. (Don't tick it if you don't have any web space). | |||
#''Include standard files'' | |||
#* Standard files are the web page templates in the web folder, each file as a name ending in "T.htm". Tick here if you want those files to be processed by MX and uploaded at standard web interval to the host and directory we have set earlier. | |||
#''Include graph data files'' | |||
#* These are files with an extension ".json" and MX generates these automatically, storing them in the web folder. Tick here (as arrowed) if you want those files to be processed by MX and uploaded at standard web interval to the host and directory we have set earlier. | |||
#''Include Moon image file'' | |||
#*We first need to set (later on this same settings page) that MX is to use system drawing to produce "moon.png" in the same web folder from "MoonBaseImage.png" in that folder. The base image is of a full moon, MX uses system drawing to generated a masked version of this image every hour that reflects the current phase of the moon and stores that in "moon.png". | |||
#*With "moon.png" being generated, we can tick here to include the new image in an upload by FTP every hour. | |||
#''ActiveFTP mode, FTP rename, Delete before upload'' | |||
#*Please be guided by the tips below these selections on the settings page. | |||
#''UTF-8 encoding'' | |||
#*Cumulus supports just two encodings, please see [[Webtags#Encoding|Encoding]] section in another article for more information. Here just tick this selection for standard web pages. | |||
#''FTP logging'' | |||
#*Normally, this is left unticked, but if you want to check MX is uploading (and you use the simple FTP protocol), you can tick this for every FTP transfer to be logged to [[MXDiags_folder]]. | |||
#''Upload interval'' | |||
#*Standard web pages are updated on the hour and every x minutes thereafter, where x is the number you enter here. Most people would choose 10, 15, 20, or 30, here depending how much uploading they want, and how up to date they want the displayed information to be. | |||
#*As an aside, if you are not using the standard web pages, many [[:Category:User Contributions|third party]] web pages use ajax (don't worry about what that is) to allow some of the web page content to be updated far more frequently than the actual web pages get uploaded. | |||
#The realtime settings are only needed for the gauges page and settings depend on your MX version, right hand picture is Cumulus MX settings screen)[[File:Cumulus MX realtime settings.png |Right]] | |||
From build 3042, MX automatically uploads the realtimegauges.txt file. | |||
Note that the realtimegaugesT.txt file for MX is slightly different to the one for Cumulus 1, and it is important to use the one supplied with MX for MX. | |||
You have now told Cumulus how to update your web space with the [[Customised_templates#The_Standard_Templates |Standard Cumulus Template]] files for the web. | |||
====ADDITIONAL INSTRUCTIONS FOR OLDER MX BUILDS:==== | |||
Prior to build 3042, you also need to specify an extra file in the table for the steel series gauges page to work:[[File:Extra web settings.png | Right]] | |||
#'Local filenames' column | |||
#*Enter the path and filename for the realtimegaugesT.txt file where shown by red box. This will normally be web\realtimegaugesT.txt on Windows, and web/realtimegaugesT.txt on other platforms. | |||
#'Remote filenames' column | |||
#*The green box shows where you must type the path to where you want the web page to appear (i.e. where the other web pages are uploaded to) ending with the file name '' realtimegauges.txt''. Typically the path will involve specifying the directory you entered on the 'Sites/Options' tab (see the 'Web Site' settings step 3 for that tab above). | |||
#'Process?' column | |||
#*Select this (ringed in purple), as ''realtimegaugesT.txt'' contains web tags and needs to be processed to create the remote file. | |||
#'Realtime?' column | |||
#*Select this (ringed in purple), only ''if you want the file to be created at whatever interval you have defined for real-time updates'' (see 'web settings' point 7 above for where you did that); otherwise it will be updated on your web site at the normal updating interval. | |||
# 'FTP?' column | |||
#*Select this (ringed in purple) if the destination is remote (don't select if the destination is local). | |||
#'UTF-8?' column | |||
#*This is irrelevant for this file. | |||
==== Other Internet Settings ==== | |||
While Cumulus 1 only supports standard FTP, MX supports that plus SFTP and FTPS. Which you select depends on your web site, it might be that you used a tool to manually upload files and so you can copy settings from that tool into the MX settings. | |||
Like Cumulus 1, MX has an '''External Programs''' section. Here you can enter a command and (in separate box) parameters for 3 possible timings (at real-time, at interval, and at end of day). Typically, on a windows device you would enter the name of a batch file (filename ends in .cmd). On a device running Linux, it could be a shell command file (ends in .sh) or indeed a command like "php" to run a php script whose name is specifed in parameters box. The final parameter might be preceded by ">" to direct the output to a log file. | Like Cumulus 1, MX has an '''External Programs''' section. Here you can enter a command and (in separate box) parameters for 3 possible timings (at real-time, at interval, and at end of day). Typically, on a windows device you would enter the name of a batch file (filename ends in .cmd). On a device running Linux, it could be a shell command file (ends in .sh) or indeed a command like "php" to run a php script whose name is specifed in parameters box. The final parameter might be preceded by ">" to direct the output to a log file. | ||
| Line 521: | Line 607: | ||
=== MySQL settings === | === MySQL settings === | ||
<div style="background: LemonChiffon;padding:5px; margin:2px;"> | |||
[[File:Crystal Clear info.png|40px]] This section was last updated for the MX release in July 2020; that is no longer latest! | |||
Appeal to contributors: Please work through all MX release announcements and work out any updates needed for this section, | |||
recent releases have totally changed the content of all settings pages in the admin interface, | |||
consequently, the whole page may even need either a replacement set of pages, splitting of this page into multiple pages, or just a redesign of this section, for more recent releases! | |||
</div> | |||
Cumulus MX includes functionality not in Cumulus 1, and this is one example of a new feature. It is designed to automate updating of MySQL databases whose schema has each table based on one of the Cumulus log files. This MX feature was developed from [[ImportCumulusFile|this script]] for Cumulus 1. | Cumulus MX includes functionality not in Cumulus 1, and this is one example of a new feature. It is designed to automate updating of MySQL databases whose schema has each table based on one of the Cumulus log files. This MX feature was developed from [[ImportCumulusFile|this script]] for Cumulus 1. | ||
