# FTP (prebuilt connector)

## Description

The Patchworks FTP connector is used to connect FTP servers, for use in process flows.  

{% hint style="info" %}
An [SFTP connector](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/patchworks-connectors/sftp-prebuilt-connector) is also available - use this for secure connections.
{% endhint %}

## Authentication 

When adding connector instances of the Patchworks FTP connector, the following authentication methods are supported:

* [Anonymous](#anonymous)
* [Username & password](#username-and-password)

Guidance for using these authentication methods is summarised below.

{% hint style="warning" %}
If you are using a custom version of our prebuilt FTP connector (i.e. if the authentication method and/or endpoint settings have been updated after the original installation), please be aware that your settings and requirements may vary.
{% endhint %}

### Anonymous

<table><thead><tr><th width="240">Credential</th><th>Notes</th></tr></thead><tbody><tr><td><code>Host</code></td><td>Enter the host name provided by your FTP provider. For example: <code>eu-west-1.sftpcloud.io</code></td></tr><tr><td><code>Username</code></td><td>Enter the username provided by your FTP provider. </td></tr><tr><td><code>Port</code></td><td>Enter the port number provided by your FTP provider. </td></tr><tr><td><code>Root</code></td><td>Enter the initial directory that the FTP client connects to once a connection is made. This becomes the reference point for subsequent file operations. For example: <code>/</code></td></tr><tr><td><code>Path</code></td><td>Specify a location of specific files or directories relative to the root that you wish to use, or leave blank.<br><br><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FKvJZhQaEKfDOWvbHsbYe%2Ftip%20icon.svg?alt=media&#x26;token=975b37c4-e5e3-462c-a32f-cc72a5461cac" alt="" data-size="line"> Whenever the <a href="../../process-flows/building-process-flows/process-flow-shapes/standard-shapes/connector-shape/configuring-ftp-connections">FTP connector is added to a process flow</a>, you need to enter the required <code>path</code> to be accessed. With this in mind, there's no need to be too specific when setting up the instance - entering <code>/</code> here is fine.</td></tr><tr><td><code>Ignore passive address</code></td><td>The default setting of <code>true</code> means that you will use the default <code>active mode</code> for establishing a connection.  </td></tr><tr><td><code>Timeout</code></td><td>Leave the default setting of <code>10</code> seconds unless you experience any timeout issues with your connection.                                                                                                                                                                                                                                                       </td></tr></tbody></table>

### Username & password

If you choose to [add a connector instance](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance) with **username & password** authentication, you need to enter the following details: &#x20;

<table><thead><tr><th width="240">Credential</th><th>Notes</th></tr></thead><tbody><tr><td><code>Host</code></td><td>Enter the host name provided by your FTP provider. For example: <code>eu-west-1.sftpcloud.io</code></td></tr><tr><td><code>Username</code></td><td>Enter the username provided by your FTP provider. </td></tr><tr><td><code>Password</code></td><td>Enter the password provided by your FTP provider. </td></tr><tr><td><code>Port</code></td><td>Enter the port number provided by your FTP provider. </td></tr><tr><td><code>Root</code></td><td>Enter the initial directory that the FTP client connects to once a connection is made. This becomes the reference point for subsequent file operations. For example: <code>/</code></td></tr><tr><td><code>Path</code></td><td>Specify a location of specific files or directories relative to the root that you wish to use, or leave blank.<br><br><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FKvJZhQaEKfDOWvbHsbYe%2Ftip%20icon.svg?alt=media&#x26;token=975b37c4-e5e3-462c-a32f-cc72a5461cac" alt="" data-size="line"> Whenever the <a href="../../process-flows/building-process-flows/process-flow-shapes/standard-shapes/connector-shape/configuring-ftp-connections">FTP connector is added to a process flow</a>, you need to enter the required <code>path</code> to be accessed. With this in mind, there's no need to be too specific when setting up the instance - entering <code>/</code> here is fine.</td></tr><tr><td><code>SSL</code></td><td>Set this option to <code>true</code>if you want to use FTPS (an extension of FTP that adds a layer of security by using SSL/TLS (Secure Sockets Layer/Transport Layer Security) for encryption. </td></tr><tr><td><code>Ignore passive address</code></td><td>The default setting of <code>true</code> means that you will use the default <code>active mode</code> for establishing a connection.  </td></tr></tbody></table>