From 5a93207dc2725e9ecd5d514f139d4ba12918d1ac Mon Sep 17 00:00:00 2001 From: Andrew <148278535+andrew-opensignlabs@users.noreply.github.com> Date: Thu, 3 Oct 2024 12:55:03 +0530 Subject: [PATCH] Update s3.md --- docs/docs/self-host/cloud-storage/s3.md | 32 ++++++++++++++----------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/docs/docs/self-host/cloud-storage/s3.md b/docs/docs/self-host/cloud-storage/s3.md index 745dc8482..f0fe57be1 100644 --- a/docs/docs/self-host/cloud-storage/s3.md +++ b/docs/docs/self-host/cloud-storage/s3.md @@ -4,7 +4,7 @@ title: AWS S3 ## You can create an AWS S3 bucket to store your uploaded documents using OpenSign™ ### AWS S3 - -- Step 1 : Create a S3 bucket +- **Step 1 : Create a S3 bucket** - Login to [AWS console](https://aws.amazon.com/console/) - Navigate to S3 under services. ![Screenshot 2024-09-30 203247](https://github.com/user-attachments/assets/1a734349-1c1a-4f53-8582-7318c22911f5) @@ -42,20 +42,23 @@ title: AWS S3 } ] ``` - - Once done go to "Properties" there you will see region of bucket e.g us-east-1 - - set bucktname as "DO_SPACE" in ENV. - - set region as "DO_REGION" in ENV. - - Replace region in this url `s3.region.amazonaws.com` and set it as "DO_ENDPOINT" in ENV. - - Replace bucketName and region in this url `https://bucketName.s3.region.amazonaws.com` and set us as "DO_BASEURL" in ENV. -- Step 2 : Create a aws policy + - Once completed, navigate to "Properties," where you'll find the bucket region (e.g., us-east-1). + - Set the bucket name you created in step 1 as the value for "DO_SPACE" in the ENV file. + - Assign the region value to the "DO_REGION" variable in the ENV file. + - Replace the region in the URL s3.region.amazonaws.com and set it as "DO_ENDPOINT" in the ENV file. + - Replace both the bucket name and region in the URL https://bucketName.s3.region.amazonaws.com and set it as "DO_BASEURL" in the ENV file. + +- **Step 2 : Create a aws policy** - Navigate to IAM under services ![Screenshot 2024-09-30 200247](https://github.com/user-attachments/assets/8109d2bb-1afb-4407-b5cd-4886a070d5cc) - Now click on "Polices" from left side "access management" menu. - Hit "Create Policy" button on upper right corner. ![Screenshot 2024-09-30 200939](https://github.com/user-attachments/assets/1b3b5608-9a84-477d-b46e-aaf884a73343) - - Search for S3 and Tick PutObject and GetObject from Action Allowed list. + - Search for S3 and Tick "PutObject" and "GetObject" from "Specify permissions" screen. ![Screenshot 2024-09-30 200537](https://github.com/user-attachments/assets/7168d261-abc4-4789-8e64-628c81c79e24) ![Screenshot 2024-09-30 200607](https://github.com/user-attachments/assets/863f8e7c-74eb-4f1b-9ea5-41524ba249ca) + - Select "All" under Resources +![Screenshot 2024-09-30 200929](https://github.com/user-attachments/assets/c4b26336-aab0-49c3-a817-d2a71d603091) - provide policy name and hit on 'Create Policy". ![Screenshot 2024-09-30 200808](https://github.com/user-attachments/assets/4db2ab95-14bb-4ea1-a9a3-821e20e70038) - Step 3 : Create IAM user. @@ -64,17 +67,18 @@ title: AWS S3 - Provide username and click on Next button. - Now select "Attach policies directly" from Permissions options. ![Screenshot 2024-09-30 201731](https://github.com/user-attachments/assets/13c6d571-d3da-4259-8f04-8ec130d9091a) - - Now search policy in "Permission Policies" section which we have created in previous step. + - Now, search for the policy we created in the previous step within the "Permissions Policies" section. ![Screenshot 2024-09-30 201742](https://github.com/user-attachments/assets/c2b1643d-e3e3-49ee-920b-641e7ff819f5) - Now scroll down and Click on "Create User" Button. - Step 4 : Generate Credentials - Now Click on username form list which we have created in previous step. + - Navigate to "Security credentials". - Click on "Create Access Key" from right corner. ![Screenshot 2024-09-30 201850](https://github.com/user-attachments/assets/d25abe2f-0cfc-4cc0-a02c-6b9fc6559dd2) - In the next step select "Application running outside AWS". ![Screenshot 2024-09-30 201917](https://github.com/user-attachments/assets/f9b0cdb2-3718-4ae6-a4ba-68e144d1f4a1) - - In the next step you will see "Access key" and "Secret Access key". Copy both the values. - - Set the value of "Access key" to "DO_ACCESS_KEY_ID" environment variable. - - Set the value of "Secret Access key" to "DO_SECRET_ACCESS_KEY" environment variable. - Visit below link if you face any issues while following the above instructions - - - https://repost.aws/knowledge-center/create-access-key + - In the next step, you will see the "Access key" and "Secret Access key." Copy both values. + - Assign the "Access key" value to the "DO_ACCESS_KEY_ID" environment variable. + - Assign the "Secret Access key" value to the "DO_SECRET_ACCESS_KEY" environment variable. + +If you encounter any issues while following these instructions, refer to the link below: - https://repost.aws/knowledge-center/create-access-key