Difference between revisions of "OS4X plugin os4xplugin ftp upload"

From OS4X
Jump to navigation Jump to search
Line 24: Line 24:
 
*after upload, the file is being renamed to the virtual filename without the leading dot.
 
*after upload, the file is being renamed to the virtual filename without the leading dot.
  
Since the plugin has no specific configuration for proxies, the plugin uses the system-wide proxy settings of your system (see [[OS4X HTTP Proxy support]]).
+
Since the plugin has no specific configuration for proxies, the plugin uses the system-wide proxy settings of your system (see [[OS4X HTTP Proxy support]]), if a HTTP target is being adressed.
 +
 
 +
When using a FTP proxy, you have to define an environment variable, either:
 +
*ftp_proxy
 +
*all_proxy
 +
The syntax of these environment variables is the same as the one for HTTP (described [[OS4X HTTP Proxy support|here]]).
  
 
[[Category:Plugins]]
 
[[Category:Plugins]]

Revision as of 11:08, 1 July 2016

Purpose

For simple FTP upload tasks, this plugin can transfer all job files to a target FTP server

Configuration

The plugin must be configured on per-partner level and has no global configuration.

Configuration parameters are:

  • Server: server incl. protocol being used. Supported protocols are (at least, but not limited to) "ftp".
  • Path: target path where to upload files to.
    • Syntax: /<pathToUpload>
    • Example: /upload
    • Missing leading slashes will be appended automatically, but you should configure this.
    • Trailing slashes will be removed automatically, but you should not configure these.
  • (optionally) Username: The username used for login to the server.
  • (optionally) Password: The password used for login to the server.

Behaviour

The plugin loops over all files of the job and handles them separately (one after another). For each file, the plugin

  • connects to the FTP server
  • uploads the file to the target directory with the temporary name with a leading dot (".") in front of the virtual filename
  • after upload, the file is being renamed to the virtual filename without the leading dot.

Since the plugin has no specific configuration for proxies, the plugin uses the system-wide proxy settings of your system (see OS4X HTTP Proxy support), if a HTTP target is being adressed.

When using a FTP proxy, you have to define an environment variable, either:

  • ftp_proxy
  • all_proxy

The syntax of these environment variables is the same as the one for HTTP (described here).