Simple Storage Service (S3)
- Hammad Siddiqui
- Matthew Miao
Simple Storage Service or S3 is a data-storage service provided by many cloud companies such as AWS (known as S3 buckets). S3 stores varied types of data and is famous for its simple integration and auto data management features which saves you from the hassle of managing your database on your own.
Integration With UChat
Open your S3 dashboard and create a new bucket.
Make sure when you are creating the bucket that it has read/write permissions and is a public bucket
.
From the side menu "App Keys", you can add new application key, you need to have the permission read and write.
After creating the key, save or copy the details.
Inside UChat’s dashboard, click on Integration and then S3 storage option.
Enter the details with respect to your bucket in the fields and click on save and your S3 storage has been integrated with UChat to use.
There is a global restriction of uploading files larger than 5mb.
Implementation Of S3 Inside UChat
S3 storage replaces the default UChat storage server, hence every file (picture, video, pdf, media files etc) you will upload will be uploaded directly to your S3 bucket instead of UChat’s server.
This helps keeping your data saved in case UChat faces an outage and ensures your flows are kept running properly.
An example of implementation will be to make a Send Message node, and upload an image using the Rich Media feature.
After the upload is completed, save the flow and publish it.
Click on the node again and observe the image URL you just uploaded.
The URL of the image has been changed from UChat’s default server uri to your S3’s bucket URL.
In this way, after integration, all your files will be uploaded directly to your bucket.
Tutorial of S3
How to Connect Your Google Cloud S3 Storage
This guide will walk you through connecting your Google Cloud S3 storage to UChat. This allows you to directly upload files from your UChat flows to your Google Cloud storage buckets.
Prerequisites
A UChat account
A Google Cloud project with an S3 storage bucket
Steps
Locate the S3 Storage Integration in UChat
Navigate to the left-hand side menu in UChat.
Click on "Integrations."
Select "Data File Storage."
Choose "S3 Storage" from the list of integrations.
Gather S3 Storage Credentials
The overview page will display several parameters required for connection:
Endpoint: This is a generic URL and remains constant ( https://storage.googleapis.com ).
Bucket Name: The name you assigned to your S3 bucket.
Region: The geographical location where your bucket resides (e.g., Europe for GDPR compliance).
Access Key: A unique identifier used for API access (to be created in Google Cloud).
Secret Key: A confidential key used for API access (to be created in Google Cloud).
Create a Google Cloud Storage Bucket (if needed)
Access your Google Cloud project.
Click on the hamburger menu (navigation menu) in the top left corner.
Search for "Cloud Storage" and select "Buckets."
Click the "Create Bucket" button.
Assign a name to your bucket (e.g., "uchat-demo").
Choose a region (e.g., Europe for GDPR compliance).
Select "Fine Grain" access control for now.
Choose "Object Versioning" for data protection (optional).
Select "Google Managed Encryption Key" for data encryption.
Uncheck "Enforced Public Access prevention on this bucket" (required for UChat access).
Confirm the bucket creation.
Generate Access Key and Secret Key
Click on the hamburger menu (navigation menu) in the top left corner.
Navigate to the "IAM & Admin" and "Service Accounts".
Select the service account you want to use for UChat access.
Ensure the following permissions are enabled for the service account:
Storage Object Admin
Storage Object Creator
Storage Object User
If you cannot manage permissions, access them through "IAM" ->This means the permissions are inherited from the connected admin user. If you navigate to Identity and Access Management (IAM), you should be able to set up the required permissions. Go to "Edit Principal" and then "Add another Rule." Search for "Storage Object Admin", "Storage Object Creator", "Storage Object User" to find the specific storage permissions you need.
Go to "Cloud Storage Settings" -> "Interoperability."
Create a new key and copy the "Access Key" and "Secret Key."
Connect S3 Storage to UChat
Return to the S3 Storage integration page in UChat.
Paste the copied endpoint URL ( https://storage.googleapis.com ).
Enter your bucket name.
Select the appropriate region from the dropdown menu.
Paste the copied access key and secret key into their respective fields.
Click "Save."
A "Verified" status should appear if the connection is successful.
You can now utilize your Google Cloud S3 storage within your UChat flows. Files uploaded through your flows will be saved directly to the designated S3 bucket.
Video tutorial to connect your Google Cloud S3 Storage