Cumulus Wiki

Cumulus.ini (preserving history): Difference between revisions

Cumulus.ini (preserving history) (view source)

Revision as of 17:58, 2 July 2020

1,562 bytes removed ,  17:58, 2 July 2020
m
→‎Section: FTP site
Line 1,279: Line 1,279:
|-
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Internet Settings, see individual entry for Cumulus 1 edits
|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=  
|DailyProgram=  
|Selected in the '''Daily''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block.  The name (including path) of a command-line program to be run once a day, after the daily 'rollover' has been performed.
|In Cumulus 1, set in the '''Daily''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block.  The name (including path) of a command-line program to be run once a day, after the daily 'rollover' has been performed.
*default - none
*default - none
|-
|-
|DailyParams=
|DailyParams=
|Selected in the '''Params''' box alongside the '''Daily''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block.  
|In Cumulus 1, set in the '''Params''' box alongside the '''Daily''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block.  
*default - none
*default - none
The corresponding 'parameters' for 'DailyProgram' used to specify any parameters to be passed to that command.
The corresponding 'parameters' for 'DailyProgram' used to specify any parameters to be passed to that command.
|-
|-
|Host=  
|Host=  
|Selected in the ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in web site block.  This is either the name, or the IP address, of the ftp server to which you connect when you upload pages to your web site. You probably used it with an external FTP program when you followed the instructions in the Cumulus ''Help'', '''Readme.txt''', or [[Simple_Website_setup]].
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in web site block.  This is either the name, or the IP address, of the ftp server to which you connect when you upload pages to your web site. You probably used it with an external FTP program when you followed the instructions in the Cumulus ''Help'', '''Readme.txt''', or [[Simple_Website_setup]].
''If you host your web site yourself, then "'''Host=localhost'''" might be appropriate''.
''If you host your web site yourself, then "'''Host=localhost'''" might be appropriate''.


Line 1,296: Line 1,303:
|-
|-
|Port=21  
|Port=21  
|Selected in the ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in web site block.
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in web site block.
Port used for FTP upload, default as shown is the normal port.
Port used for FTP upload, default as shown is the normal port.
|-
|-
|Username=  
|Username=  
|Select your web site FTP log-in Username in the ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in web site block
|In Cumulus 1, set your web site FTP log-in Username in the ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in web site block
|-
|-
|Password=  
|Password=  
Line 1,306: Line 1,313:
|-
|-
|Directory=  
|Directory=  
|Selected in the ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in web site block.  Directory (including path) on your server to which FTP will upload the files.  
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in web site block.  Directory (including path) on your server to which FTP will upload the files.  
*value is left Blank, default, the root position specified by ftp server (see Host above)  
*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)
*A path from the starting point as the position specified by ftp server (see Host above)
|-
|-
|IncludeSTD=1  
|IncludeSTD=1  
|Set in the ''Internet'' option of '''Configuration''' menu by the ''Include Standard Files'' at the top of  ''Files'' Tab screen
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu by the ''Include Standard Files'' at the top of  ''Files'' Tab screen
*0 = Disabled
*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).
*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  
|AutoUpdate=0  
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Auto Update''.
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Auto Update''.
*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.
*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).
*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
|ActiveFTP=0
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Use active FTP mode''.
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Use active FTP mode''.
*0 = Disabled (default)
*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.
*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
|FTPRename=0
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Use FTP rename''.
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Use FTP rename''.
*0 = Disabled (default), no name change after uploading onto the server
*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
*1 = Enabled,  the new update is loaded using temporary names, files are renamed on the sever afterwards
|-
|-
|DeleteBeforeUpload=0  
|DeleteBeforeUpload=0  
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Delete before upload''.
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Delete before upload''.
*0 = Disabled (default)
*0 = Disabled (default)
*1 = Enabled, files are deleted from sever before the new update is loaded
*1 = Enabled, files are deleted from sever before the new update is loaded
|-
|-
|UpdateInterval=15  
|UpdateInterval=15  
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab in '''Interval''' box.  The interval in minutes at which you wish Standard (not real-time) updates (either FTP to your website, or copy to a local directory on your pc) to automatically occur.  Default 15 minutes.
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab in '''Interval''' box.  The interval in minutes at which you wish Standard (not real-time) updates (either FTP to your website, or copy to a local directory on your pc) to automatically occur.  Default 15 minutes.
|-
|-
|ExternalProgram=
|ExternalProgram=
|Selected in the '''Program''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block. The name (including path) of a command-line program to be run at the 'normal' web update interval, after all of the other processing has been performed.
|In Cumulus 1, set in the '''Program''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block. The name (including path) of a command-line program to be run at the 'normal' web update interval, after all of the other processing has been performed.
|-
|-
|ExternalParams=
|ExternalParams=
Line 1,345: Line 1,366:
|-
|-
|EnableRealtime=0  
|EnableRealtime=0  
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Enable Realtime''.
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Enable Realtime''.
*0 = Disabled (default)
*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.
** - If you do not have ''Auto Update'' option set (top of Web Settings block), the ''realtime.txt'' file is not created/updated.
Line 1,356: Line 1,377:
|-
|-
|RealtimeFTPEnabled=0
|RealtimeFTPEnabled=0
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Enable Realtime FTP''.
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Enable Realtime FTP''.
*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.
*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.
*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.
Line 1,363: Line 1,384:
|-
|-
|RealtimeTxtFTP=0
|RealtimeTxtFTP=0
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Realtime.txt FTP''.
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Realtime.txt FTP''.
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.
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.
|-
|-
Line 1,376: Line 1,397:
|-
|-
|RealtimeProgram=
|RealtimeProgram=
|Selected in the '''Realtime Program''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block. The name (including path) of a command-line program to be run at the 'realtime' web update interval, after all of the processing has been performed.
|In Cumulus 1, set in the '''Realtime Program''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block. The name (including path) of a command-line program to be run at the 'realtime' web update interval, after all of the processing has been performed.
|-
|-
|RealtimeParams=
|RealtimeParams=
|Selected in the '''Params''' box alongside the '''Realtime Program''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block. The corresponding 'parameters' for 'RealtimeProgram' used to specify any parameters to be passed to that command.
|In Cumulus 1, set in the '''Params''' box alongside the '''Realtime Program''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block. The corresponding 'parameters' for 'RealtimeProgram' used to specify any parameters to be passed to that command.
|-
|-
|colspan="2" style="background:lightblue;"| Cumulus 1 only
|colspan="2" style="background:lightblue;"| Cumulus 1 only
Line 1,387: Line 1,408:
*0 = Disabled
*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'.
*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;"| Both Cumulus flavours - in MX edit in Internet Settings, see individual entry for Cumulus 1 edits
|-
|Logging=0
|This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen.
Note that if set on the user interface, it only remains set while Cumulus continues to run (in Cumulus 1 and MX, it defaults to off on restart).
*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.
|-
|-
|colspan="2" style="background:lightblue;"| Cumulus MX only - Internet Settings screen
|colspan="2" style="background:lightblue;"| Cumulus MX only - Internet Settings screen
|-
|-
|RealtimeGaugesTxtFTP=0
|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 realtime interval
|[[File:Badge vMx.png]]This parameter controls whether the file needed for the steel series Gauges plot is updated by FTP at the real-time interval
*0 (default) = the file is only uploaded at the standard interval
*0 (default) = the file is only uploaded at the standard interval
*1 = the file is uploaded by FTP at the real time interval
*1 = the file is uploaded by FTP at the real time interval
|-
|-
|DisableEPSV=0
|DisableEPSV=0
|[[File:Badge vMx.png]](Add this directly to the Cumulus.ini file with Cumulus stopped, it is not available on the Internet Settings page) The default is 0, change to 1 to Disable the Extended Passive FTP-mode.
|[[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
|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 Internet Settings screen.
|[[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
*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
*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
|ComportName=/dev/ttyUSB0
|[[File:Badge vMx.png]]This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen.
|[[File:Badge vMx.png]]This parameter (attribute=value) can be added directly to the file with MX stopped, but it is best to set the serial port name in the MX admin interface.
You can set the serial port name in the MX user interface, but if for some reason you want to do it by editing Cumulus.ini, note that the item in MX is called ComportName (which is a string, for the full device name, e.g. COM1 or /dev/ttyUSB0) rather than 'Port' which is just an integer
 
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
|DisableFtpsExplicit=0
Line 1,422: Line 1,436:
|ExtraLocalxx=
|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
|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)
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.


[[File:Badge vMx.png]] or "<currentextralogfile>" (from b3087) to specify the variable log file names
{{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.
|-
|-
|ExtraRemotexx=
|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
|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)
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]] or "<currentextralogfile>" (from b3087) to specify the variable log file names
[[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
|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
|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
*0 (default) = no processing required as local file does not contain web tags
*1 = file contains web tags and needs to be processed
*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
|ExtraBinaryxx=0
|Where 'xx' varies between 0 and 99; The format of the file named in Extra Local
|Where 'xx' varies between 0 and 99; The format of the file named in Extra Local
*0 (default) = File to be treated as being in ASCII or UTF format (another option later allows you to choose between these)  
*0 (default) = File to be treated as being [[Webtags#Encoding|encoded]] in ISO-8859-1 or UTF-8 format (another option later allows you to choose between these). use this to transfer any file that can be viewed in a text editor, such as log files, web pages, javaScript files, and PHP scripts.
*1 = file to be treated as being in binary format
*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
|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).
|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
*0 (default) = Not to be uploaded at real-time interval
*1 = to be uploaded at realtime interval, end of day interval must be set to 0.
*1 = to be uploaded at real-time interval, For MX only note that end of day interval must be set to 0.
 
{{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
|ExtraEODxx=0
Line 1,453: Line 1,503:
|-
|-
|colspan="2"| If both the above 2 parameters are set to 0, the upload will be at standard uploading interval
|colspan="2"| If both the above 2 parameters are set to 0, the upload will be at standard uploading interval
|-
|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 as local files)
*1 (default) = File named in ExtraLocal is to be uploaded by FTP (will work whether web server is on same machine or on some remote host)
|-
|ExtraUTFxx= 0
|Where 'xx' varies between 0 and 99; whether the file is to treated as in UTF (a format that supports a wider range of characters and therefore more languages than ASCII)
|-
|-
|colspan="3" style="background:lightblue;"| Cumulus 1 only
|colspan="3" style="background:lightblue;"| Cumulus 1 only
Line 1,500: Line 1,542:
*0 = Disabled (default)
*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'.  
*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'.  
|-
|ExtraLocal[0-9]=
|Set in the ''Internet'' option of '''Configuration''' menu by an entry in the ''Local'' column of the table on the  ''Files'' Tab screen.
*value is blank (default)
*Path and file name on local computer for alternate files #0 through #9. You can use "<currentlogfile>" (all versions of Cumulus 1 or MX) to specify reading current monthly log here.
|-
|ExtraLocal[10-99]=
|Path and file name on local computer for alternate file #10 through #99. These additional files can only be selected by adding parameter lines to the configuration file, they cannot be entered on any Configuration screen.  You can use "<currentlogfile>" (all versions of Cumulus 1 or MX) to specify reading current monthly log here.
|-
|ExtraRemote[0-9]=
|Set in the ''Internet'' option of '''Configuration''' menu by an entry in the ''Local'' column of the table on the  ''Files'' Tab screen.
*value is blank (default)
*Path and file name on web server for alternate files #0 through #9. Set in Internet Configuration Screen Files tab.  You can use "<currentlogfile>" (all versions of Cumulus 1 or MX) to specify reading current monthly log here.
|-
|ExtraRemote[10-99]=
|Path and file name on web server for alternate file #10 through #99. These additional paths/files can only be selected by adding parameter lines to the configuration file, they cannot be entered on any Configuration screen.  You can use "<currentlogfile>" (all versions of Cumulus 1 or MX) to specify reading current monthly log here.
|-
|ExtraProcess[0-9]=0
|Set in the ''Internet'' option of '''Configuration''' menu by selecting in the ''Process?'' column of the table on the  ''Files'' Tab screen.
*0 = Disabled, (default) extra file will not pass through the cumulus 'tag processor'.
*1 = Enabled, extra file will be passed through the 'tag processor' in Cumulus, in the same way that the standard Cumulus web pages are. This allows to you to create your own web pages into which Cumulus will insert the various weather parameters. See the "Web tags" section of the help file for a list of the tags which you can use. Cumulus will create a temporary file to hold the processed version of your file and then upload that.
|-
|ExtraProcess[10-99]=0
|Set in this config file only, they cannot be entered on any Configuration screen.
*0 = Disabled, alternate file #10 through #99 will not pass through the cumulus 'tag processor'.
*1 = Enabled, alternate file #10 through #99 will be passed through the 'tag processor' in Cumulus, in the same way that the standard Cumulus web pages are. This allows to you to create your own web pages into which Cumulus will insert the various weather parameters. See the "Web tags" section of the help file for a list of the tags which you can use. Cumulus will create a temporary file to hold the processed version of your file and then upload that
|-
|UTF8encode=1
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as '''UTF-8 encode''' from build 1093.
*0 = Standard Cumulus Web Templates are processed into '''charset=iso-8859-1''' web pages as for builds prior to 1093.
*1 = Default from build 1093, Standard Cumulus Web Templates are processed into '''charset=utf-8''' web pages
See [[FAQ#What_character_encoding_does_Cumulus_use_for_the_web_pages_it_generates.3F|here]] for related FAQ or [[Customised_templates#Coding_standard_and_character_encoding_for_Customised_Templates_using_the_same_names_as_Standard_Cumulus_Templates|this section]] for more information.
|-
|ExtraUTF[0-9]=0
|Set in the ''Internet'' option of '''Configuration''' menu by selecting in the ''UTF-8?'' column of the table on the  ''Files'' Tab screen from build 1093.
*0 = Default, Customised/extra Cumulus Web Templates are processed into '''charset=iso-8859-1''' web pages as for builds prior to 1093.
*1 = Customised/extra Cumulus Web Templates are processed into '''charset=utf-8''' web pages
|-
|ExtraUTF[10-99]=0
|Set in this config file only.
*0 = Default from build 1093, Customised Cumulus Web Templates are processed into '''charset=iso-8859-1''' web pages as for builds prior to 1093.
*1 = Customised Cumulus Web Templates are processed into '''charset=utf-8''' web pages from build 1093
|-
|ExtraBinary[0-9]=0
|Set in the ''Internet'' option of '''Configuration''' menu by selecting in the ''Binary?'' column of the table on the  ''Files'' Tab screen.
*0 = not binary (if pure ASCII characters)
*1 = Binary (e.g. images)
In general, setting to one is safest, but the default is zero.
|-
|ExtraBinary[10-99]=0
|Set in this config file only.
*0 = alternate file #10 through #99 is not binary (is pure ASCII characters)
*1 = alternate file #10 through #99 is Binary (e.g. images)
|-
|ExtraRealtime[0-9]=0
|Set in the ''Internet'' option of '''Configuration''' menu by selecting in the ''Realtime?'' column of the table on the  ''Files'' Tab screen.
*0 = Disabled, (default) file uploaded as part of normal upload
*1 = Enabled, file uploaded during Realtime upload
If you select this for any files, you will also need to select the  ''RealtimeFTPEnabled=1'' option, which in turns means you have to set ''EnableRealtime=1'' option (see Cumulus Help, or [[Simple_Website_setup#Configuration|this Wiki page]]).
|-
|ExtraRealtime[10-99]=0
|Set in this config file only.
*0 = Disabled, alternate file #10 through #99 uploaded as part of normal upload
*1 = Enabled, alternate file #10 through #99 uploaded during Realtime upload
If you select this for any files, you will also need to select the ''RealtimeFTPEnabled=1'' option, which in turns means you have to set ''EnableRealtime=1'' option.
|-
|ExtraFTP[0-9]=1
|Set in Internet Configuration Screen Files tab.
*0 = Disabled, File copied to the location specified in the Remote Filename box.
*1 = Enabled, (default) File uploaded  by FTP
Not intended for standard Cumulus web pages (tick box at top of screen, missing files will be ignored), nor for NOAA reports (FTF for them set up in '''NOAA Setup''' within Configuration menu).
|-
|ExtraFTP[10-99]=1
|Set in this config file only.
*0 = Disabled, alternate file #10 through #99 ''copied'' to the location specified in the Remote Filename box.
*1 = Enabled, alternate file #10 through #99 ''uploaded by FTP'' to the location specified in the Remote Filename box.
(Copying is appropriate if you have a local web server on your computer or network, FTP needed if your server is hosted elsewhere)
|-
|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 update a file called ''ftplog.txt'' in the same folder as the Cumulus executable by showing the messages sent to, and responses from, the FTP server.
|-
|MaxFTPconnectRetries=3
|Set in this config file only.
Allow configurable max FTP connect retries (default is retry up to 3 times).
|}
|}


Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/6534"