From 0201159b3170fe9ac0de32eb842fd2a7c9936b2e Mon Sep 17 00:00:00 2001 From: Amol Date: Tue, 12 Mar 2024 11:55:47 +0530 Subject: [PATCH] Update INSTALLATION.md --- docs/docs/contribute/INSTALLATION.md | 44 ++++------------------------ 1 file changed, 5 insertions(+), 39 deletions(-) diff --git a/docs/docs/contribute/INSTALLATION.md b/docs/docs/contribute/INSTALLATION.md index 8d69b672f..5119416e4 100644 --- a/docs/docs/contribute/INSTALLATION.md +++ b/docs/docs/contribute/INSTALLATION.md @@ -23,11 +23,15 @@ Below are the steps to follow - ``` git clone https://github.com/OpenSignLabs/OpenSign.git ``` +- Switch to the newly created OpenSign directory. + ``` + cd OpenSign + ``` - Copy the .env.frontend_dev file to apps/OpenSign/.env using below command(on mac & linux). For windows use COPY command instead. ``` cp .env.frontend_dev apps/OpenSign/.env ``` -- Switch to OpenSign directory. +- Switch to apps/OpenSign directory. ``` cd apps/OpenSign ``` @@ -42,43 +46,5 @@ Below are the steps to follow - You should be able to access the application from http://localhost:3000 after this. Create an account by signing-up and start contributing. -## You will need to create an AWS S3 bucket or digital ocean space in order to store your uploaded documents - -### AWS S3 - -- Step 1 : Create a S3 bucket - - Login to [AWS console](https://aws.amazon.com/console/) - - Navigate to S3 under services - - Hit "Create Bucket" button on upper right corner - - Remove the check from "block all public access" checkbox(we need this in order to provide access to not-logged in users after OTP verification) - - Set bucket versioning and tags as per your requirements - - Hit "Create bucket" button -- Step 2 : Create IAM user and provide access to AWS bucket - - Search for "IAM" on the search bar in AWS console - - On IAM dashboard, click the number of users(count) under IAM resources table - - Hit "create user" button on the upper right corner of the page - - Enter the user name & click next - - Click create policy, search for S3 and provide the Read, Write & list permissions - - Click next and click "Create user" - - Step 3 : Generate Credentials - - Go to IAM/Users in AWS console - - Hit the hyperlink for the user created in the previous step - - Click the "Security credentials" tab - - Scroll down to "Access keys" and hit "Create access key" - - In the next step select "Application running outside AWS" - - Add a description tag if needed & hit "Create access key" - - 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 -- Step 3 : Copy bucket credentials - - Visit "Amazon S3 -> Buckets" in aws console - - Click the bucket created in previous steps & visit the properties tab - - Under "Bucket overview" you will find the value of AWS region(for ex. ap-south-1). Set that value to env variable "DO_REGION" - - You can create the value for "DO_ENDPOINT" env variable by appending the region value to amazonaws.com (for ex. s3.ap-south-1.amazonaws.com) - - You can create the value for "DO_BASEURL" by adding the bucketname in front of the endpoint value(for ex. https://bucketname.s3.ap-south-1.amazonaws.com) - - Visit below link if you face any issues while following the above instructions - - - https://repost.aws/knowledge-center/create-access-key - - ## Localhost(Docker) - Please refer this documentation => [click here](https://docs.opensignlabs.com/docs/self-host/docker/run-locally)