On this page

Saving to FTP(s)

Introduction

This tutorial will guide you through the process of saving files to an FTP or FTPS (FTP Secure) server, a method for transferring files over the internet.

After completing this tutorial, you will be able to set up and configure a destination object to save files to an FTP or FTPS server, understanding the necessary parameters and options for secure and efficient file transfer.

Supported Protocols

Protocol	Description
ftp://	File Transfer Protocol
ftps://	Secure File Transfer Protocol

1
Setting Up an FTP Server

Choose an FTP server software (like FileZilla Server) and install it on your server.
Configure the server settings, including user accounts and directory permissions.

2
Getting Your FTP Credentials

Create a user account on your FTP server.
Note the username and password; these will be your credentials.

3
Saving Output to FTP(s)

In order to save your outputs to your FTP server, you must properly define your destination object.

Destination Object Attributes

Attribute	Description
url	Your FTP URL.
key	Your FTP username.
secret	Your FTP password.
permissions	Defines the file permissions on the server (if applicable).
is_passive	Set to '1' for passive mode, '0' for active mode.
use_tls	Set to '1' for secure FTPS connections, '0' for standard FTP.

URL Structure for FTP

The FTP url consists of a hostname or IP address, port if applicable, and path. The default port for FTP is 21, and the default port for FTPs is 990. Check the examples for single file and ABR formats like HLS and DASH below:

ftp://[hostname_or_ip][:port]/[path]

When saving ABR outputs like HLS or DASH, please specify the path to a folder where the contents of the HLS or DASH stream should be located:

ftp://[hostname_or_ip][:port]/folder

Components of URL

hostname_or_ip	The IP address or hostname of your FTP server.
port	Optional. The default port for FTP is 21, and for FTPS it is 990.
path	The complete path of the output, including the filename.

Destination Object Example

"destination":{
    "url": "ftp://192.168.1.10/my-folder/output.mp4",
    "key": "myUsername",
    "secret": "myPassword",
    "is_passive": "1",
    "use_tls": "1"
}