S3-Compatible Storage
In this document we aim to discuss about the S3 compatible storages we have tested with Axinom Encoding. As explained in Storage Providers, you have to provide storage details to the Encoding job.
{
"Provider": "S3Compatible",
"ServiceUrl": "https://example.com",
"Bucket": "<your_bucket-name>",
"FolderPath": "<input-folder-path>",
"CredentialsName": "PLAINTEXT_USER",
"CredentialsSecret": "ENCRYPTED_PASSWORD",
"CredentialsProtection": "Encrypted",
"Region": "<provider-region>"
}
The Region property is optional. Some S3-compatible providers require it for Signature V4 authentication. If your provider does not require a region, you can omit the property.
The providers listed below are the S3-compatible storage providers that we have tested with Axinom Encoding. Other S3-compatible providers may also work when configured in the same way, but compatibility can vary because each provider can implement the S3 API differently. If you encounter issues with another provider, contact Axinom Support.
Tebi
Tebi (https://tebi.io/) is a S3 compatible storage we have tested with Axinom Encoding. You can create & manage buckets from the dashboard(https://client.tebi.io/) they have given.
When using Tebi, below are the details you have to enter in the encoding job.
- ServiceUrl : The S3 compatible URI (ex: https://s3.tebi.io/). Read more: https://docs.tebi.io/intro/connection.html#s3-protocol-connection-parameters
- Region: Tebi uses a global S3 endpoint, so this can be omitted unless Tebi recommends a specific value for your setup.
- Bucket : Your bucket name. You can create a bucket from https://client.tebi.io/buckets/. When you create a bucket, go to 'Edit' and allow necessary bucket permissions.
- FolderPath: Path to your input/output folder
- Credential Name: You can generate the secret key from https://client.tebi.io/keys/.
- CredentialsSecret: You can see the generated secret from https://client.tebi.io/keys/. Use Credentials Protection tool to encrypt your secret before passing it to the encoding job.
DigitalOcean
DigitalOcean Spaces (https://docs.digitalocean.com/products/spaces/how-to/create) is a S3 compatible storage we have tested with Axinom Encoding. You can create & manage buckets from the dashboard(https://cloud.digitalocean.com).
When using DigitalOcean, below are the details you have to enter in the encoding job.
- ServiceUrl : The S3 compatible URI (ex:
https://<region>.digitaloceanspaces.com). You can find the region of your bucket from the dashboard. - Region: The region code of your Space. Use the value shown in DigitalOcean for the Space location.
- Bucket : Name of your space.
- FolderPath: Path to your input/output folder
- Credential Name: The Access key ID . You can generate the Access keys from settings section of your space.
- CredentialsSecret: The Access key. Access key is only visible when you create the Access key. Otherwise you can regenerate the Access key. Use Credentials Protection tool to encrypt your secret before passing it to the encoding job.
Tencent
Tencent(https://www.tencentcloud.com/products/cos) is a S3 compatible storage we have tested with Axinom Encoding. You can create & manage buckets from the dashboard(https://console.tencentcloud.com/cos/bucket).
When using Tencent, below are the details you have to enter in the encoding job.
- ServiceUrl : The S3 compatible URI (ex:
https://cos.<region>.myqcloud.com). You can find the region of your bucket from the dashboard. - Region: The Tencent COS region code of your bucket. Use the value shown in Tencent Cloud for the bucket location.
- Bucket : Your bucket name. When you create a bucket, make sure to allow necessary bucket permissions.
- FolderPath: Path to your input/output folder
- Credential Name: This is the secret ID. You can create Credentails secrets from the Access keys section in the dashboard. (Click on your profile picture on the top right corner to find the Access keys section.)
- CredentialsSecret: This is the secret key. Access key is only visible when you create the secrets. Use Credentials Protection tool to encrypt your secret before passing it to the encoding job.
Akamai
Akamai Object Storage (https://www.akamai.com/products/object-storage) is an Amazon S3-compatible object storage service. Akamai Block Storage (https://www.akamai.com/products/block-storage) is a different storage product, so use Object Storage when you need an S3-compatible endpoint for Axinom Encoding. You can create & manage buckets and access keys from Akamai Cloud Manager.
When using Akamai, below are the details you have to enter in the encoding job.
- ServiceUrl : The S3 compatible URI for your selected Akamai Object Storage endpoint (ex:
https://<endpoint>.linodeobjects.com). You can find the endpoint hostname in Akamai Cloud Manager or from the Object Storage endpoints list. - Region: The Akamai cloud computing region code for the endpoint. Use the value shown in Akamai Cloud Manager or the Object Storage endpoints list.
- Bucket : Your bucket name. When you create a bucket, make sure to allow necessary bucket permissions.
- FolderPath: Path to your input/output folder
- Credential Name: The access key for Object Storage. You can generate access keys from Akamai Cloud Manager.
- CredentialsSecret: The secret key for the generated Object Storage access key. Use Credentials Protection tool to encrypt your secret before passing it to the encoding job.
Hetzner
Hetzner Object Storage (https://www.hetzner.com/storage/object-storage/) is the Hetzner S3-compatible storage product. Hetzner Storage Box (https://www.hetzner.com/storage/storage-box/) uses protocols such as FTP, SFTP, SMB, and WebDAV, so use Object Storage when you need an S3-compatible endpoint for Axinom Encoding.
When using Hetzner Object Storage, below are the details you have to enter in the encoding job.
- ServiceUrl : The S3 compatible URI (ex:
https://<region>.your-objectstorage.com). - Region: The location code of your bucket. Use the value shown in Hetzner Console for the bucket location.
- Bucket : Your bucket name. When you create a bucket, make sure to allow necessary bucket permissions.
- FolderPath: Path to your input/output folder
- Credential Name: The access key. You can generate S3 credentials from Hetzner Console.
- CredentialsSecret: The secret key. Secret keys are only visible when you create the credentials. Use Credentials Protection tool to encrypt your secret before passing it to the encoding job.
Wasabi
Wasabi (https://wasabi.com/) is a S3-compatible cloud object storage provider. You can create buckets and access keys from the Wasabi Console.
When using Wasabi, below are the details you have to enter in the encoding job.
- ServiceUrl : The S3 compatible URI for your Wasabi region. You can find the correct service URL in the Wasabi documentation or console for the bucket location.
- Region: The Wasabi region code of your bucket. Use the region value that matches the selected Wasabi service URL.
- Bucket : Your bucket name. When you create a bucket, make sure to allow necessary bucket permissions.
- FolderPath: Path to your input/output folder
- Credential Name: The access key. You can generate access keys from the Wasabi Console.
- CredentialsSecret: The secret key. Secret keys are only visible when you create the access key. Use Credentials Protection tool to encrypt your secret before passing it to the encoding job.