Cumulus.ini (preserving history)

From Cumulus Wiki
Revision as of 09:17, 17 October 2013 by Mcrossley (talk | contribs) (Undo revision 3105 by Mcrossley (talk))
Jump to navigationJump to search

Section: FTP Site

See individual entries for how to edit these parameters.

Parameter Line Entry Function
[FTP site] Section Name - the following parameters relate to your website FTP parameters
Host= Selected in the Internet Configuration screen Sites/Options tab. 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.

Leave blank if you are not using ftp, but simply creating the output files on your pc.

Port=21 Selected in the Internet Configuration screen Sites/Options tab. Port used for FTP upload, default =21
Username= Select in the Internet Configuration screen Sites/Options tab your web site FTP login Username
Password= Shows your web site FTP login password as entered in the Internet Configuration Screen (note: this is not encrypted)
Directory= Selected in the Internet Configuration screen Sites/Options tab. Directory (including path) on your server to which FTP will upload the files. Starting point is the position specified by ftp server (see Host above)
AutoUpdate=0 Set in the Internet Configuration Screen Web Settings block.
  • 0 = Disabled
  • 1 = Enabled, Cumulus will automatically upload your processed web pages to your web site at regular intervals (as specified by the 'Update Interval') using FTP to the directory as specified in 'Directory'.
UpdateInterval=15 Set in the Internet Configuration screen Sites/Options tab Web Settings block in Interval box. The interval in minutes at which you wish auto updates (either FTP to your website or output to a directory on your pc) to occur. Default 15 minutes.
IncludeSTD=1 Selected in the Internet Configuration Files Tab screen
  • 0 = Disabled
  • 1 = Enabled, (default) the standard web files provided with Cumulus will be processed and uploaded at each web update.
IncludeSTDImages=1 Selected in the Internet Configuration Files Tab screen
  • 0 = Disabled
  • 1 = Enabled,(default) the standard image files generated by Cumulus (graphs, etc) will be uploaded at each web update to a subfolder of the 'Directory' you specified called 'images'.
EnableRealtime=0 Set in the Internet Configuration screen Sites/Options tab Web Settings block.

The realtime.txt file contains various weather parameters and is used by the CumulusRealtime.swf (shock wave flash) real time wind gauges (as on the supplied 'gauges' web page).

  • 0 = Disabled (default) If you have the 'auto update' option set (and a suitable interval configured), Cumulus will create the realtime.txt file at the specified normal update Interval (not the Realtime Interval) so that you can specify it as an extra file to upload during the 'normal' upload, or use it for any other purpose on your PC.
  • 1 = Enabled, Cumulus will create the realtime.txt file, at the interval specified by Realtime Interval (see below).
RealtimeInterval=30 Set in the Internet Configuration screen Sites/Options tab Web Settings block.

The time in seconds between creates of the realtime.txt file (default is 30 seconds, see the 'Help' for this screen for advice on suitable time).

RealtimeFTPEnabled=0 Selected in the Internet Configuration screen Sites/Options tab Web Settings block

The 'EnableRealtime' setting must be set to 1 for this setting to have any effect.

  • 0 = Disabled (default)
  • 1 = Enabled, Cumulus will establish an FTP connection to your web site, at the real time interval set in previous parameter.
RealtimeTxtFTP=0 Selected in the Internet Configuration screen Sites/Options tab Web Settings block

The 'EnableRealtime' and 'RealtimeFTPEnabled' settings must both be set to 1 for this setting to have any effect.

  • 0 = Disabled (default)
  • 1 = Enabled, Cumulus will use FTP to upload the realtime.txt to your web site at realtime interval.
ActiveFTP=0 Set in the Internet Configuration Screen Sites/Options tab Web Settings block
  • 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 Selected in the Internet Configuration screen Sites/Options tab Web Settings block
  • 0 = Disabled (default)
  • 1 = Enabled, the new update is loaded using temporary names, files are renamed on the sever afterwards
DeleteBeforeUpload=0 Selected in Internet Configuration Screen Sites/Options tab Web Settings block
  • 0 = Disabled (default)
  • 1 = Enabled, files are deleted from sever before the new update is loaded
ResizeGraphs=0 Selected in the Internet Congfiguration Screen 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. 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 Internet Configuration Screen Files tab. Path and file name in LOCAL folder to which the generated image files are also copied at each web update interval, either the 'normal' interval, or the 'realtime' interval, depending on next parameter. Used if you want backups of generated images. See Cumulus Help.
ImageCopyRealtime=0 Set in Internet Configuration Screen Files tab.
  • 0 = files copied in 'normal' interval each web update (default)
  • 1 = files copied in 'real time' interval.
ExtraLocal[0-9]= Set in Internet Configuration Screen Files tab. Path and file name on local computer for alternate files #0 through #9. See cumulus Help for details of how 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 are not visible in the Internet Configuration screen Files tab.
ExtraRemote[0-9]= Path and file name on web server for alternate files #0 through #9. Set in Internet Configuration Screen Files tab. See cumulus Help for details of how to specify creating 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 are not visible in the Internet Configuration screen Files tab.
ExtraProcess[0-9]=0 Set in Internet Configuration Screen Files tab.
  • 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.
  • 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
ExtraBinary[0-9]=0 Set in Internet Configuration Screen Files tab.
  • 0 = not binary (if pure ASCII characters)
  • 1 = Binary (e.g. images)
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 Internet Configuration Screen Files tab. If you select this for any files, you will also need to select the Realtime option.
  • 0 = Disabled, (default) file uploaded as part of normal upload
  • 1 = Enabled, file uploaded during Realtime upload
ExtraRealtime[10-99]=0 Set in this config file only. If you select this for any files, you will also need to select the Realtime option.
  • 0 = Disabled, alternate file #10 through #99 uploaded as part of normal upload
  • 1 = Enabled, alternate file #10 through #99 uploaded during Realtime upload
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
ExternalProgram= The name (including path) of a command-line program to be run at the 'normal' web update interval, after all of the processing has been performed.
ExternalParams= The corresponding 'paramaters' for 'ExternalProgram' used to specify any parameters to be passed to the command.
RealtimeProgram= 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= The corresponding 'paramaters' for 'RealtimeProgram' used to specify any parameters to be passed to the command.
DailyProgram= The name (including path) of a command-line program to be run once a day, after the daily 'rollover' has been performed.
DailyParams= The corresponding 'paramaters' for 'DailyProgram' used to specify any parameters to be passed to the command.
MaxFTPconnectRetries=3 Set in this config file only. Allow configurable max FTP connect retries (default is retry up to 3 times)