> For the complete documentation index, see [llms.txt](https://docs.couchdrop.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.couchdrop.io/storage/integrations/s3-compatible-storage.md).

# S3 Compatible Storage

Learn how to connect Couchdrop to S3 compatible storage

## Overview

Couchdrop can connect to storage providers that implement the S3 API.

Once connected, the S3-compatible storage can be mapped into Couchdrop and used with Couchdrop file transfer and workflow features while files remain in the connected storage platform.

## How to connect S3 Compatible storage

{% hint style="warning" %}

#### Before you start

To connect an S3-compatible storage provider, you will need:

* The provider's S3-compatible endpoint URL
* An access key
* The corresponding secret access key
* A bucket name, if you want to connect directly to a specific bucket
* A region name, if required by your provider
  {% endhint %}

{% stepper %}
{% step %}

### Add a new storage connection

In Couchdrop, add a new storage connection and select **S3 Compatible** from the list of available connections.
{% endstep %}

{% step %}

### Configure the S3 connection

Enter a **Name for this integration** and select the **Couchdrop folder path** where the connection will appear.

Enter the connection details provided by your storage provider:

* **S3 Compatible Endpoint URL** — The S3 API endpoint for the storage service.
* **S3 Compatible Access Key** — The access key Couchdrop will use to authenticate.
* **S3 Compatible Access Key Secret** — The corresponding secret access key.
* **S3 Compatible Bucket** — Optionally enter a bucket to connect directly to that bucket.
* **S3 Compatible Bucket Region Name** — Optionally enter the region associated with the bucket.

Select **Save and Test** to verify the connection.
{% endstep %}

{% step %}

### Map your storage folder

After the connection has been tested, you can optionally select a specific folder to map into Couchdrop.

Leaving the folder selection blank allows Couchdrop to map the storage connection directly without restricting it to a specific folder.
{% endstep %}

{% step %}

### Save and use your connection

Optionally, configure **Transfer Shield** and select a content rule group to surface or block unexpected, non-compliant, or malicious files uploaded through this connection.

When the configuration is complete, save the integration.
{% endstep %}
{% endstepper %}

## Frequently asked questions

<details>

<summary>What is an S3-compatible storage provider?</summary>

An S3-compatible storage provider is a storage platform that implements the S3 API. Couchdrop connects to the provider using its S3-compatible endpoint and access credentials.

</details>

<details>

<summary>Does an S3-compatible connection have to use Amazon S3?</summary>

No. This connection is intended for storage platforms that implement the S3 API but are not necessarily hosted by AWS.

</details>

<details>

<summary>Do I need to specify a bucket?</summary>

No. The **S3 Compatible Bucket** field is optional.

If you provide a bucket, Couchdrop connects directly to that bucket. If you leave it blank, the connection is not restricted by that field.

</details>

<details>

<summary>Do I need to provide a region?</summary>

The **S3 Compatible Bucket Region Name** field is optional.

Whether you need to provide it depends on the requirements of the S3-compatible storage provider you are connecting to.

</details>

<details>

<summary>Can I map Couchdrop to a specific folder?</summary>

Yes. After the connection has been successfully tested, you can optionally select a specific folder or manually enter a path.

Leaving the folder selection blank allows Couchdrop to map the storage connection directly.

</details>

<details>

<summary>Can I use Transfer Shield with an S3-compatible connection?</summary>

Yes. You can optionally apply a Transfer Shield content rule group to surface or block unexpected, non-compliant, or malicious files uploaded through the connection.

</details>