Qencode
DEVELOPERS
All
All
API Reference
API Reference
Tutorials
Tutorials
Release Notes
Release Notes
Try QencodeSign In
HomeAPI ReferenceTutorialsRelease Notes
On this page
On this page

Saving to DigitalOcean Spaces

Introduction

This tutorial is crafted to guide you through the process of saving files to DigitalOcean Spaces, an S3-compatible object storage service that simplifies data storage and access.

By the end of this tutorial, you will be able to configure a destination object to save files to DigitalOcean Spaces, understanding the necessary parameters and the S3-compatible URL structure.

Supported Protocols

ProtocolDescription
s3://DigitalOcean Spaces URL

1
Creating a Space in DigitalOcean

  1. Log into your DigitalOcean account and navigate to the Spaces section.
  2. Create a new Space, selecting the appropriate region and unique name.

2
Finding Your DigitalOcean Spaces Credentials

  1. In your DigitalOcean dashboard, access the API section.
  2. Generate a new Spaces access key (access_key) and secret key (secret_key).

You can find the information about managing Administrative Access in the official DigitalOcean documentation.

3
Saving Output to DigitalOcean

In order to save your outputs to your DigitalOcean Storage, define your destination object using the following structure.

Destination Object Structure

"destination": {
  "url": "s3://[region].digitaloceanspaces.com/bucket/path",
  "key": "access_key",
  "secret": "secret_key",
  "permissions": "permissions"
}

Attributes of Azure Blob Destination Object

AttributeDescription
urlYour DigitalOcean URL.
keyYour DigitalOcean Spaces access key.
secretYour DigitalOcean Spaces secret key.
permissionsspecifies object access permissions. The default value is ‘private’ meaning the object is not publicly accessible with its URL. In case you want your objects to be accessed publicly, specify ‘public-read’ as a value for permissions.

DigitalOcean URL Structure

The url used for your DigitalOcean Storage destination object consists of region, bucket and path. Check the examples for single file and ABR formats like HLS and DASH below:

s3://[region].digitaloceanspaces.com/[bucket]/[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:

s3://[region].digitaloceanspaces.com/[bucket]/folder

URL Components

regionThe region where your DigitalOcean Space is hosted (e.g., nyc3, sfo2).
bucketYour Space name in DigitalOcean.
pathThe path within your Space where the file will be saved.

For an up-to-date list of all the available DigitalOcean regions refer to the official DigitalOcean documentation.

Destination Object Examples

"destination": {
  "url": "s3://nyc3.digitaloceanspaces.com/my-bucket/folder/output.mp4",
  "key": "myAccessKey",
  "secret": "mySecretKey",
  "permissions": "public-read"
}

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.

"destination": {
  "url": "s3://nyc3.digitaloceanspaces.com/my-bucket/folder",
  "key": "myAccessKey",
  "secret": "mySecretKey",
  "permissions": "public-read"
}

Considerations

  • Region Selection: Choose a region closest to your users for better performance.
  • S3 Compatibility: Take advantage of the S3-compatible interface for easy integration with existing tools and workflows.
  • Connection Issues: Ensure that the region, bucket name, and path in the URL are correct.
  • Authentication Errors: Double-check your access and secret keys for accuracy.
  • Explore advanced functionalities of DigitalOcean Spaces like CDN integrations and access management.