5,838
edits
Cumulus.ini (preserving history): Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
→Section: FTP site
|
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Internet Settings, see individual entry for Cumulus 1 edits
|-
|Logging=0
|Determines whether enhanced "debugging" logging takes place where Cumulus 1 or MX makes a detailed record of each action that takes place.
*0 (default) = Cumulus 1 or MX will not add debug logging.
*1 = For '''debug''' logging when Cumulus 1 or MX (re-)starts, add ''Logging=1'' to the station section of Cumulus.ini while Cumulus is stopped.
[[File:Badge vMx.png]] In MX only, it can also be set in the admin interface internet settings screen. Note that if set on the admin interface, it only remains set while Cumulus continues to run, and resets to default off when MX re-starts. For MX, if you want debugging output every time it runs, then add "-debug" parameter as explained at [[Cumulus_MX#Parameter_for_adding_debugging|Parameter_for_adding_debugging]]
|-
|DailyProgram=
|
*default - none
|-
|DailyParams=
|
*default - none
The corresponding 'parameters' for 'DailyProgram' used to specify any parameters to be passed to that command.
|-
|Host=
|
''If you host your web site yourself, then "'''Host=localhost'''" might be appropriate''.
|-
|Port=21
|
Port used for FTP upload, default as shown is the normal port.
|-
|Username=
|
|-
|Password=
|-
|Directory=
|
*value is left Blank, default, the root position specified by ftp server (see Host above)
*A path from the starting point as the position specified by ftp server (see Host above)
|-
|IncludeSTD=1
|
*0 = Disabled
*1 = Enabled, (default) the standard web files provided with Cumulus will be processed and uploaded at each automatic or manual web update to the FTP root or any 'Directory' you have specified (see above).
|-
|AutoUpdate=0
|
*0 = Disabled, an upload will only occur if ''Web upload'' is selected manually either from the '''File''' menu or the right click menu if Cumulus is minimised.
*1 = Enabled, Cumulus will automatically upload your processed web pages to your web site at regular intervals (as specified by the 'Update ''Interval'' ' - see below) using FTP to the directory as specified in 'Directory' (see above).
|-
|FTPlogging=0
|Set (Cumulus 1) by selecting ''FTP Logging'' in '''Configuration''' menu, or by adding this line to 'FTP site' section of Cumulus.ini.
*0 (default) = Cumulus will not store messages from FTP server.
*1 = Cumulus will show the messages sent to, and responses from, the FTP server.
{{Version badge 1}} Cumulus 1 stores this output in [[Ftplog|a separate FTP log file " ftplog.txt "]].
[[File:Badge vMx.png]] MX stores this output in the same [[MXDiags]] file as other diagnostics, it does not use that separate file. Also MX allows use of alternative secure protocols instead of standard FTP, and this parameter is ignored for secure transfers.
|-
|MaxFTPconnectRetries=3
|Set in this config file only.
Allow configurable max FTP connect retries (default is retry up to 3 times).
|-
|ActiveFTP=0
|
*0 = Disabled (default)
*1 = Enabled, Cumulus will use 'active' FTP mode instead of the default 'passive' mode. You should only select active mode if you are having problems with FTP uploads.
|-
|FTPRename=0
|
*0 = Disabled (default), no name change after uploading onto the server
*1 = Enabled, the new update is loaded using temporary names, files are renamed on the sever afterwards
|-
|DeleteBeforeUpload=0
|
*0 = Disabled (default)
*1 = Enabled, files are deleted from sever before the new update is loaded
|-
|UpdateInterval=15
|
|-
|ExternalProgram=
|
|-
|ExternalParams=
|-
|EnableRealtime=0
|
*0 = Disabled (default)
** - If you do not have ''Auto Update'' option set (top of Web Settings block), the ''realtime.txt'' file is not created/updated.
|-
|RealtimeFTPEnabled=0
|
*0 = Disabled (default), without FTP it is only possible to upload files at the realtime interval if the required remote location is on same device as that running Cumulus.
*1 = Enabled, Cumulus will establish an FTP connection to your web site, so that the realtime.txt file, and any other files you specify, can be uploaded when realtime processing takes place.
|-
|RealtimeTxtFTP=0
|
When set to 1 Cumulus will upload the [[realtime.txt]] to your web site during realtime processing. The 'EnableRealtime' and 'RealtimeFTPEnabled' settings must both be set to 1 for this setting to have any effect.
|-
|-
|RealtimeProgram=
|
|-
|RealtimeParams=
|
|-
|colspan="2" style="background:lightblue;"| Cumulus 1 only
*0 = Disabled
*1 = Enabled,(default) the standard image files generated by Cumulus 1 (moon, graphs, etc) will be uploaded at each automatic or manual web update to a sub-folder of the 'Directory' you specified called 'images'.
|-
|colspan="2" style="background:lightblue;"| Cumulus MX only - Internet Settings screen
|-
|RealtimeGaugesTxtFTP=0
|[[File:Badge vMx.png]]This parameter controls whether the file needed for the steel series Gauges plot is updated by FTP at the
*0 (default) = the file is only uploaded at the standard interval
*1 = the file is uploaded by FTP at the real time interval
|-
|DisableEPSV=0
|[[File:Badge vMx.png]](Add this directly to the Cumulus.ini file with Cumulus stopped, it is not available on the MX Internet Settings page) The default is 0, change to 1 to Disable the Extended Passive FTP-mode.
|-
|IncludeMoonImage=1
|[[File:Badge vMx.png]] Cumulus MX (from version 3.5.0) uploads only one image (moon), control whether it is uploaded in the MX Internet Settings screen.
*0 = Disabled
*1 = Enabled,(default) the standard image file generated by Cumulus MX (moon only) will be uploaded at first (after MX is started) automatic web update to a sub-folder of the 'Directory' you specified called by the name specified in [[#Graphs|[Graphs] section]], and uploaded again each hour on the hour showing any change in the phase in the preceding hour. You can choose which sub-folder (default 'images') in the MX internet settings page
|-
|ComportName=/dev/ttyUSB0
|[[File:Badge vMx.png]]This parameter (attribute=value) can be added directly to the file with MX stopped, but it
If you have moved from Cumulus 1 to MX, and for some reason you want to edit Cumulus.ini, note that the item called ComportName has to be added for MX and that it is a string, for the full device name, e.g. COM1 or /dev/ttyUSB0; while the Cumulus 1 'Port' parameter which is just an integer is no longer needed and should be deleted from the file.
|-
|DisableFtpsExplicit=0
|ExtraLocalxx=
|Where 'xx' varies between 0 and 99; used to specify path to local file that is to be optionally processed by Cumulus, then to be copied or FTPed to another location at interval indicated
You can use "<currentlogfile>" (all versions of Cumulus 1 or MX) on its own to represent the name of the standard log file that is currently being used.
{{Version badge 1}}For Cumulus 1, only 0 to 9 are set in the Internet option of Configuration menu by an entry in the Local column of the table on the Files Tab screen, 10 to 99 have to be inserted manually by adding parameter lines to the configuration file, they cannot be entered on any Configuration screen.
[[File:Badge vMx.png]]All
|-
|ExtraRemotexx=
|Where 'xx' varies between 0 and 99; used to specify path to remote file that is created by Cumulus, by being copied or FTPed from local location set above at interval indicated below.
You can use "<currentlogfile>" (all versions of Cumulus 1 or MX) on its own to represent the name of the standard log file that is currently being used, or as part of another file specifier if you want a different destination file to be used each month (so those for previous months are not overwritten).
{{Version badge 1}}For Cumulus 1, only 0 to 9 are set in the Internet option of Configuration menu by an entry in the Local column of the table on the Files Tab screen, 10 to 99 have to be inserted manually by adding parameter lines to the configuration file, they cannot be entered on any Configuration screen.
[[File:Badge vMx.png]]All of 0 to 99 are added using "Extra web files" screens in the settings menu of the admin interface. From build 3087, MX also allows you to use "<currentextralogfile>"to specify the name of the extra sensor log files being currently used.
|-
|ExtraProcessxx=0
|Where 'xx' varies between 0 and 99; used to specify if file named in ExtraLocal parameter is a template containing web tags and needs to be processed by Cumulus before it is copied or FTPed to remote location
*0 (default) = no processing required as local file does not contain web tags
*1 = file contains web tags and needs to be processed
{{Version badge 1}}For Cumulus 1, only 0 to 9 are set in the Internet option of Configuration menu by an entry in the Local column of the table on the Files Tab screen, 10 to 99 have to be inserted manually by adding parameter lines to the configuration file, they cannot be entered on any Configuration screen.
[[File:Badge vMx.png]]All of 0 to 99 are added using "Extra web files" screens in the settings menu of the admin interface.
|-
|ExtraBinaryxx=0
|Where 'xx' varies between 0 and 99; The format of the file named in Extra Local
*0 (default) = File to be treated as being [[Webtags#Encoding|encoded]] in
*1 = file to be treated as being in binary format. Use this to transfer images, executable files, and other files that cannot be read with a text editor.
{{Version badge 1}}For Cumulus 1, only 0 to 9 are set in the Internet option of Configuration menu by an entry in the Local column of the table on the Files Tab screen, 10 to 99 have to be inserted manually by adding parameter lines to the configuration file, they cannot be entered on any Configuration screen.
[[File:Badge vMx.png]]All of 0 to 99 are added using "Extra web files" screens in the settings menu of the admin interface.
|-
|ExtraFTPxx=1
|Where 'xx' varies between 0 and 99; whether the file upload is to use File Transfer process
*0= File named in ExtraLocal is to be uploaded by copying from local to remote location (used when web server is on same machine or network as local files)
*1 (default) = File named in ExtraLocal is to be uploaded by FTP (will work whether web server is on same local network or on some remote host)
{{Version badge 1}}For Cumulus 1, only 0 to 9 are set in the Internet option of Configuration menu by an entry in the Local column of the table on the Files Tab screen, 10 to 99 have to be inserted manually by adding parameter lines to the configuration file, they cannot be entered on any Configuration screen.
[[File:Badge vMx.png]]All of 0 to 99 are added using "Extra web files" screens in the settings menu of the admin interface.
|-
|ExtraUTFxx= 0
|Where 'xx' varies between 0 and 99; whether the file is to treated as in UTF-8 (a format that supports a wider range of characters and therefore more languages than alternative). Note that the "binary" option mentioned earlier overrides this setting if that is set to 1.
*0 (default) = File to be treated as being [[Webtags#Encoding|encoded]] in ISO-8859-1
*1 (recommended)= File to be treated as being [[Webtags#Encoding|encoded]] in UTF-8 format
{{Version badge 1}}For Cumulus 1, only 0 to 9 are set in the Internet option of Configuration menu by an entry in the Local column of the table on the Files Tab screen, 10 to 99 have to be inserted manually by adding parameter lines to the configuration file, they cannot be entered on any Configuration screen.
[[File:Badge vMx.png]]All of 0 to 99 are added using "Extra web files" screens in the settings menu of the admin interface.
|-
|ExtraRealtimexx=0
|Where 'xx' varies between 0 and 99; if the file named in ExtraLocal is to be uploaded at realtime interval (requires that interval to be enabled, and if FTP is to be used required FTP to be enabled at that interval (see earlier for those options in Cumulus 1 and MX section).
*0 (default) = Not to be uploaded at real-time interval
*1 = to be uploaded at
{{Version badge 1}}For Cumulus 1, only 0 to 9 are set in the Internet option of Configuration menu by an entry in the Local column of the table on the Files Tab screen, 10 to 99 have to be inserted manually by adding parameter lines to the configuration file, they cannot be entered on any Configuration screen.
[[File:Badge vMx.png]]All of 0 to 99 are added using "Extra web files" screens in the settings menu of the admin interface.
|-
|colspan="2" style="background:lightblue;"| Cumulus MX only - Internet Settings screen
|-
|ExtraEODxx=0
|-
|colspan="2"| If both the above 2 parameters are set to 0, the upload will be at standard uploading interval
|-
|colspan="3" style="background:lightblue;"| Cumulus 1 only
*0 = Disabled (default)
*1 = Enabled, the optional sunshine graph image file generated by Cumulus will be uploaded at each automatic or manual web update to a sub-folder of the 'Directory' you specified called 'images'.
|}
| |||
