S3 Connections

S3 connections let you integrate Amazon S3 or any S3-compatible storage service with your Zedoc pipelines. This includes services like MinIO, Cloudflare R2, and DigitalOcean Spaces.

Creating an S3 Connection

  1. Go to Organization Settings > Connections
  2. Click Add Connection
  3. Select Amazon S3 / S3-Compatible
  4. Choose the provider type and fill in the configuration fields
  5. Click Test Connection to verify your credentials
  6. Once the test passes, click Create Connection

Provider Types

When creating an S3 connection, you choose between two provider types:

AWS S3

For standard Amazon S3 buckets.

S3-Compatible

For non-AWS services that implement the S3 API (e.g. MinIO, Cloudflare R2, DigitalOcean Spaces).

Configuration Fields

FieldAWS S3S3-CompatibleDescription
Connection NameRequiredRequiredA friendly name to identify this connection
Bucket NameRequiredRequiredThe bucket or container name (e.g. my-publisher-bucket)
RegionRequiredOptionalThe AWS region (e.g. us-east-1). May be required by some S3-compatible providers.
Endpoint URLRequiredThe service endpoint (e.g. https://s3.example.com)
Access Key IDRequiredRequiredAn IAM or service access key with permissions to the bucket
Secret Access KeyRequiredRequiredThe corresponding secret key
Path PrefixOptionalOptionalA prefix prepended to all file paths (e.g. zedoc/output/)

IAM Permissions

The IAM user or role associated with your access key needs the following permissions on the target bucket:

  • s3:PutObject — Upload files
  • s3:GetObject — Download files
  • s3:ListBucket — List bucket contents (used during connection testing)

A minimal IAM policy example:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": ["s3:PutObject", "s3:GetObject", "s3:ListBucket"],
      "Resource": ["arn:aws:s3:::my-publisher-bucket", "arn:aws:s3:::my-publisher-bucket/*"]
    }
  ]
}

Editing an S3 Connection

You can update any field of an existing connection from the connections list. When editing, credential fields are blank by default — leave them empty to keep the current credentials, or enter new values to update them.

After making changes, you must test the connection again before saving.

S3-Compatible Services

Here are common S3-compatible services and their typical endpoint formats:

ServiceEndpoint Format
MinIOhttps://minio.example.com or http://localhost:9000
Cloudflare R2https://<account-id>.r2.cloudflarestorage.com
DigitalOcean Spaceshttps://<region>.digitaloceanspaces.com
Backblaze B2https://s3.<region>.backblazeb2.com
Wasabihttps://s3.<region>.wasabisys.com