Cumulus Wiki

CumulusUtils: Difference between revisions

Page Discussion

CumulusUtils (view source)

Revision as of 19:31, 22 February 2026

993 bytes removed ,  22 February
m
→‎Installation
== Installation ==
 
# ''CumulusUtils'' is available in a distribution which can be downloaded from the [https://cumulus.hosiene.co.uk/viewtopic.php?f=44&t=17998 forum]. In the CumulusMX directory the user must create a directory ''utils'' (case dependent) and must copy the files of the distribution (including the subdirectories) to that directory.
# Rename ''CutilsCharts-default-for-use.def : when used rename'' to ''CutilsCharts.def''▼
# Then, on the domain for the website, the user needs to make two directories in the webroot: 'lib' and 'css'. In addition the distribution directory CUicons must be copied as a whole - with contents - to the webroot.
# Updating ''CumulusUtils'' is done by completely overwriting the contents of the installation directory utils as if it were an installation. If you want to save the old installation, make a copy of the utils directory.
# The language setting of CumulusUtils is for display/language handling only and does not affect the reading of the data in any way apart for the monthly log file name.
# <s>NOTE a seemingly important issue: the datafiles (the naming and the contents) are dependent for their format on the locale / country setting of your machine. If you install and run from scratch and do not bother CMX will take the country setting from the settings of the computer. You may also give the country setting on the commandline when starting CMX. However, it is important to know that CumulusUtils does not handle datafiles with mixed languages and produces lots of errors. When starting with a new install this is not a big deal. But if you have years of old data which you wish to analyse as well you must consider carefully which country setting of CMX is required. Note that the language setting of CumulusUtils is for display/language handling only and does not affect the reading of the data in any way apart for the monthly log file name. If you use a different locale than the one you use for CMX, the please fill in the parameter ''MonthsOfMiracleAndWonder'' (section [General]) with the abbreviated filenames of the locale you use for CMX.</s>
# From CMX version 4, the logfiles are written as invariant and the above striked through note has become invalid.
# From CMX version 4.7 (.NET 10; later rename version 5.0) there are changes in the database which require CMX to run before CUtils 8.2.0 can run.
 
When installed you are ready to run. The first run after an install or an update MUST be without [[Thrifty - Cutils Command Qualifier|Thrifty]].
|--- lib (JavaScript libraries, uploaded by CumulusUtils during a run)
|--- css (css files, uploaded by CumulusUtils during a run)
|--- CUicons (required to be manually copied once)
 
=== Updating CumulusUtils ===
#CUserAbout-example.txt : as an example of the user about file - when used rename to ''CUserAbout.txt''
#CutilsMenu-example-for-use.def : as an example of the menu structure - when used rename to ''CutilsMenu.def''
▲#CutilsCharts-default-for-use.def : when used rename to ''CutilsCharts.def''
#CutilsCharts-examples.def : not intended for direct use, contains some more elaborate examples of the [[ChartsCompiler]] possibilities
 
 
=== Manually installing without FTP ===
NOTE: Not using the automatic upload system is disadvised. Because CumulusUtils is datadriven it requires the JSON files and the ''realtime.txt'' and ''realtimegauges.txt'' from CMX. Besides those, if you are using the ''UserAskedData'' feature of CumulusUtils there will be additional JSON files required for the server and without the upload module youryou will need a way to get them there. There is no copy feature like CMX has as CumulusUtils is designed as a website tool and an upload method is implicitelyimplicitly assumed present. However, manual handling can be done but is not advised.
 
All required installation and generated files are present in the utils directory and copied with ''FTP'' or ''PHP upload'' to the server during a run of CumulusUtils.
 
If you don't use ''FTP'' or ''PHP upload'' you will have to copy manually.
 
The PHP upload is by far preferred.
 
=== Files involved ===
Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/12353"