5,838
edits
Cumulus.ini (preserving history): Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
→Section: FTP site
|
|style="background:lightgray;"|[FTP site]
|style="background:lightgray;"|Section Name - the following parameters relate to your website FTP parameters
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours
|-
|DailyProgram=
*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
|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.
|-
|colspan="2" style="background:lightblue;"| Cumulus 1 only
|-
|IncludeSTDImages=1
|{{Version badge 1}}Set in the ''Internet'' option of '''Configuration''' menu of Cumulus 1 by the ''Include Standard Images'' at the top of ''Files'' Tab screen.
*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'.
|-
|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
|-
|DisableEPSV=0
|(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.
|-
|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.
*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
|This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen.
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
|-
|DisableFtpsExplicit=0
|(Add to Cumulus.ini file, no option in station settings screen) Default 0 use Explicit FTPS; Change to 1 to use Implicit mode
|-
|colspan="3" style="background:lightblue;"| Cumulus MX only - Extra Web Files screen
|-
|ExtraLocalxx=
|Where 'xx' varies between 0 and 99; used to specify path to local file that is to be optionally processes by Cumulus, to be copied or FTPed to another location at interval indicated
|-
|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
|-
|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
|-
|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 in ASCII or UTF format (another option later allows you to choose between these)
*1 = file to be treated as being in binary format
|-
|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 realtime interval, end of day interval must be set to 0.
|-
|ExtraEODxx=0
|Where 'xx' varies between 0 and 99; if the file named in ExtraLocal is to be uploaded after end of meteorological day
*0 (default) = Not to be uploaded at end of day
*1 = to be uploaded at end of day, the realtime interval must be set to 0.
|-
|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
|-
|ResizeGraphs=0
|Set in the ''Internet'' option of '''Configuration''' menu in Web graphs block.
*0 = Disabled (default) Cumulus uploads the default 750 x 300 pixel graphs.
*1 = Cumulus resizes the large graph images when creating them for upload to your web site. Specify the required height and width in the corresponding boxes of same Web graphs block (see below for related parameters). Note that the images are simply scaled to the new size; there will be some loss of quality.
|-
|GraphHeight=300
|Graph height, default is 300 (pixels) - see previous parameter
|-
|GraphWidth=750
|Graph width, default is 750 (pixels) - see ResizeGraphs parameter
|-
|ImageFolder=
|Set in the ''Internet'' option of '''Configuration''' menu by the ''Copy Images to folder'' at the bottom of ''Files'' Tab screen.
*value is blank (default) no action
*Path and file name in LOCAL folder to which the generated image files are also copied after each upload, either at manual web update and the 'normal' automatic interval, or the 'real time' interval, depending on next parameter. Used if you want backups of generated images. See Cumulus Help.
|-
|ImageCopyRealtime=0
|Set in the ''Internet'' option of '''Configuration''' menu by the ''Realtime?'' at the bottom of ''Files'' Tab screen.
*0 = (default) the generated image files are copied at each manual web update and automatically in 'normal' interval
*1 = the generated image files are copied in 'real time' interval.
|-
|IncludeSolarChart=0
|Set in the ''Internet'' option of '''Configuration''' menu by the ''Solar'' at the top of ''Files'' Tab screen.
*0 = Disabled (default)
*1 = Enabled, the optional solar 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'.
|-
|IncludeUVChart=0
|Set in the ''Internet'' option of '''Configuration''' menu by the ''UV'' at the top of ''Files'' Tab screen.
*0 = Disabled (default)
*1 = Enabled, the optional UV 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'.
|-
|IncludeSunshineChart=0
|Set in the ''Internet'' option of '''Configuration''' menu by the ''Sunshine'' at the top of ''Files'' Tab screen.
*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'.
|-
|ExtraLocal[0-9]=
| |||
