Difference between revisions of "Seon plugin seonplugin ftp upload"
From Seon
(New page: Category:Plugins == 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-p...) |
|||
| (8 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Plugins]] | [[Category:Plugins]] | ||
| − | |||
== Purpose == | == Purpose == | ||
| − | |||
For simple FTP upload tasks, this plugin can transfer all job files to a target FTP server | For simple FTP upload tasks, this plugin can transfer all job files to a target FTP server | ||
| − | |||
== Configuration == | == Configuration == | ||
| Line 10: | Line 7: | ||
Configuration parameters are: | Configuration parameters are: | ||
| − | * | + | *Server: server incl. protocol being used. Supported protocols are (at least, but not limited to) "ftp". |
| + | **Syntax: <nowiki>ftp://<ip or hostname></nowiki> | ||
| + | **Traling slashed are being eliminated automatically, but you should not configure these. | ||
| + | **Example: <code>ftp://192.168.1.2</code> or <code>ftp://ftp.myserver.com</code> | ||
| + | *Path: target path where to upload files to. | ||
| + | **Syntax: /<pathToUpload> | ||
| + | **Example: <code>/upload</code> | ||
| + | **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. | ||
| + | *''(optionally)'' Verbose output: all protocol specific communication (incoming and outgoing) will be logged. | ||
| + | *''(optionally)'' Disable proxy: no proxy will be used, even is there is one configured elsewhere in the system. | ||
| + | *''(optionally)'' Force HTTP 1.0 for proxy communication: Bugfix for several proxy systems which support HTTP 1.0 (i.e. for FTP transfers), but don't support the default HTTP 1.1 behaviour. | ||
| + | |||
| + | == 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 ("<code>.</code>") 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 [[Seon HTTP Proxy support]]). | ||
| + | |||
| + | |||
| + | 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 [[Seon HTTP Proxy support|here]]). | ||
| − | == | + | == Protocol support == |
| + | The plugin is compiled with the following contained protocols. For details, please refer to the CURL library: | ||
| + | * DICT | ||
| + | * FILE | ||
| + | * FTP | ||
| + | * FTPS | ||
| + | * GOPHER | ||
| + | * HTTP | ||
| + | * HTTPS | ||
| + | * IMAP | ||
| + | * IMAPS | ||
| + | * POP3 | ||
| + | * POP3S | ||
| + | * RTSP | ||
| + | * SCP | ||
| + | * SFTP | ||
| + | * SMB | ||
| + | * SMBS | ||
| + | * SMTP | ||
| + | * SMTPS | ||
| + | * TELNET | ||
| + | * TFTP | ||
Latest revision as of 11:24, 15 September 2017
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".
- Syntax: ftp://<ip or hostname>
- Traling slashed are being eliminated automatically, but you should not configure these.
- Example:
ftp://192.168.1.2orftp://ftp.myserver.com
- 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.
- (optionally) Verbose output: all protocol specific communication (incoming and outgoing) will be logged.
- (optionally) Disable proxy: no proxy will be used, even is there is one configured elsewhere in the system.
- (optionally) Force HTTP 1.0 for proxy communication: Bugfix for several proxy systems which support HTTP 1.0 (i.e. for FTP transfers), but don't support the default HTTP 1.1 behaviour.
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 Seon HTTP Proxy support).
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).
Protocol support
The plugin is compiled with the following contained protocols. For details, please refer to the CURL library:
- DICT
- FILE
- FTP
- FTPS
- GOPHER
- HTTP
- HTTPS
- IMAP
- IMAPS
- POP3
- POP3S
- RTSP
- SCP
- SFTP
- SMB
- SMBS
- SMTP
- SMTPS
- TELNET
- TFTP
