Signiant
Integration
To integrate Storj with Signiant, you will need to create S3 credentials in Storj and add them within Signiant.
Requirements
- An active Storj account
- A bucket for use with Signiant in your Storj instance
- An active Signiant Management Console account
Create an Account
To begin, you will need to create a Storj account.
Navigate to https://www.storj.io/signup?partner=Signiant to sign up, or log in https://storj.io/login if you already have an account.
Create a Bucket
Once you have your Storj account you can create a bucket for your data to be stored in.
Navigate to Browse on the left side menu.
Click on the New Bucket button.
Assign the bucket an easily identifiable name, such as "my-bucket".
Optional: Enable Object Lock (required for immutability in many applications).
- If you enable Object Lock, you can also set a default retention period using either Governance or Compliance Mode
Optional: Enable Object Versioning (note that this will be enabled by default if Object Lock is enabled)
Click Create bucket
Generate S3 credentials
Storj has an Amazon S3 compatible API and you'll need generate S3 credentials to use it. S3 credentials consist of an access key, secret key, and endpoint.
Create S3 credentials in the Storj console:
Navigate to Access Keys on the left side menu.
Click the New Access Key button.
When the New Access dialog comes up, set specifications according to the following guidelines:
- Name: The name of the credentials (e.g. my-access)
- Type: S3 Credentials
Choose Full Access or Advanced
- In most cases, you DO NOT want to choose full access.
Provide Access encryption Information
In order to see the data uploaded to your bucket in the Storj console, you must unlock the bucket with the same encryption passphrase as the credentials.
- Use the current passphrase: this is default option
- Advanced: you may provide a different encryption phrase either your own or generate a new one.
- Enter a new passphrase: use this option, if you would like to provide your own new encryption phrase
- Generate 12-word passphrase: use this option, if you would like to generate a new encryption phrase
Select the permissions you want to allow:
- Read
- Write
- List
- Delete
Select the object lock permissions you want to allow
- PutObjectRetention
- GetObjectRetention
- BypassGovernanceRetention
- PutObjectLegalHold
- GetObjectLegalHold
- PutObjectLockConfiguration
- GetObjectLockConfiguration
Choose the buckets you want the access to include:
- All Buckets
- Select Buckets
Set an expiration
Click Create Access to finish creation of your S3 credentials
Your S3 credentials are created. Write them down and store them, or click the Download all button. You will need these credentials for the following steps.
Object Lock Permission Details
| Permission Name | Description |
|---|---|
| PutObjectRetention | Allows you to set retention policies, protecting objects from deletion or modification until the retention period expires. |
| GetObjectRetention | Allows you to view the retention settings of objects, helping ensure compliance with retention policies. |
| BypassGovernanceRetention | Allows you to bypass governance-mode retention, enabling deletion of objects before the retention period ends. |
| PutObjectLegalHold | Allows you to place a legal hold on objects, preventing deletion or modification regardless of retention policies. |
| GetObjectLegalHold | Allows you to view the legal hold status of objects, which is useful for auditing and compliance purposes. |
| PutObjectLockConfiguration | Allows you to set retention policies on the specified bucket, automatically applying them to every new object added to that bucket. |
| GetObjectLockConfiguration | Allows you to view the default retention policies configured for the specified bucket. |
Connecting Signiant to Storj
Cloud Credentials Configuration
Important: From Signiant’s S3 Compatible documentation source: “For best performance, ensure that SDCX Server software is installed on a server near your S3 compatible storage location.”
The lower the latency between the SDCX server and Storj’s endpoint (gateway.storjshare.io) is, the better the throughput will be.
The performance achieved in the Storj + Signiant blog post was from a SDCX server installed on a Vultr instance located in the same city where a Storj endpoint was running.
Vultr’s “Looking Glass” ping test can be used to see which Vultr locations have single-digit-ms latency to gateway.storjshare.io.
Log into the Signiant Media Shuttle management console: https://manage.mediashuttle.com/
Go to Storage - Add
Select S3 Compatible
Select a SDCX server, then enter in all of the S3 information:
- Service Endpoint: gateway.storjshare.io
- Bucket: your-bucket-name
- Subfolder: your-prefix-name
- Access Key: your-access-key
- Secret Key: your-secret-key
- Access Parameters: Check Use SSL and Bucket Access Style Virtual Host
Assign the newly created storage to the Media Shuttle Portal by clicking Assign
