You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .env.local_dev
+57-3Lines changed: 57 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -42,15 +42,69 @@ DO_SECRET_ACCESS_KEY=
42
42
# Digital ocean spaces region or AWS s3 region
43
43
DO_REGION=us-west
44
44
# local storage
45
-
USE_LOCAL=TRUE
45
+
USE_LOCAL=FALSE
46
46
47
47
# Email mailgun config (The app will not initialize if any of these 3 variables are not set) *********************************************************************************************************************
Copy file name to clipboardExpand all lines: INSTALLATION.md
+60-2Lines changed: 60 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -88,5 +88,63 @@ You can install all 3 components on digital ocean using the button below -
88
88
89
89
## Localhost(Docker)
90
90
91
-
Below are the steps to follow -
92
-
- Execute `make build`
91
+
For local Setup we need to need following prerequisite:
92
+
93
+
Environment Varaibles:
94
+
95
+
| Environment Varibale | Value | Description |
96
+
| ------------- | ------------- | ------------- |
97
+
| CI | false | Set CI to false while running the app locally |
98
+
| PUBLIC_URL |http://localhost:3000| Set it to the URL form where the app home page will be accessed |
99
+
| GENERATE_SOURCEMAP | false | Set it to true if you want to generate the Sourcemap for debugging |
100
+
| REACT_APP_SERVERURL |http://localhost:8080/app| Set it to the URL from where APIs will be accessible, for local development it should be localhost:3000/api/app (use your local port number instead) |
101
+
| REACT_APP_APPID |http://localhost:3000| Set it to the URL form where the app home page will be accessed |
102
+
| PUBLIC_URL | opensignstgn | A 12 character long random app identifier. The value of this should be same as APP_ID which is a variable used by backend API. |
103
+
| APP_ID | opensignstgn | A 12 character long random app identifier. The value of this should be same as REACT_APP_APPID which is a variable used by Frontend React App. |
104
+
| appName | open_sign_server | Name of the app. It will be visible in the verification emails sent out. |
105
+
| MASTER_KEY | XnAadwKxxByMr | A 12 character long random secret key that allows access to all the data. It is used in Parse dashboard config to view all the data in the database. |
106
+
| MONGODB_URI | mongodb://host.docker.internal:27017/OpenSignDB | Mongodb URI to connect to |
107
+
| PARSE_MOUNT |/app | Path on which APIs should be mounted. Do not change this. This variable shall be removed & value hardcoded in the source code in coming versions. |
108
+
| SERVER_URL |http://127.0.0.1:8080/app| Set it to the URL from where APIs will be accessible to the NodeJS functions, for local development it should be localhost:3000/api/app (use your local port number instead) |
109
+
| DO_SPACE | DOSPACENAME | Digital ocean space name or AWS S3 bucket name for uploading documents |
110
+
| DO_ENDPOINT | ams3.digitaloceanspaces.com | Digital ocean spaces endpoint or AWS S3 endpoint for uploading documents |
111
+
| DO_BASEURL |https://DOSPACENAME.ams3.digitaloceanspaces.com| Digital ocean baseurl or AWS S3 base URL |
112
+
| DO_ACCESS_KEY_ID | YOUR_S3_ACCESS_ID | Digital ocean spaces access key ID or AWS s3 Access key ID for uploading the docs |
113
+
| DO_SECRET_ACCESS_KEY | YOUR_S3_ACCESS_KEY | Digital ocean spaces secret access key or AWS s3 secret access key for uploading the docs |
114
+
| DO_REGION | YOUR_S3_REGION | Digital ocean spaces region or AWS s3 region |
115
+
| USE_LOCAL | FALSE | To use local file storage to save file |
116
+
| MAILGUN_API_KEY | YOUR_MAILGUNAPI_KEY | Mailgun API Key |
117
+
| MAILGUN_DOMAIN | YOUR_MAILGUNAPI_DOMAIN | Mailgun API Domain |
118
+
| MAILGUN_SENDER | - | Mailgun Sender Mail ID |
119
+
| PFX_BASE64 | - | Base64 encoded PFX or p12 document signing certificate file. You can generate base64 encoded self sign certificate using the passphrase `emudhra`|
120
+
121
+
# Steps to Generate Self Sign Certificate
122
+
```
123
+
# execute below command and use passphrase emudhra
As document storage is delegated to S3-compatible services that reside in a different host than the OpenSign one, document operations (loading, storing, deleting) are subject to [Cross-Origin Resource Sharing](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) restriction policies; as a consequence, OpenSign app may fail with (browser console) errors like the following:
133
+
```
134
+
Access to fetch at 'https://foo.nyc3.digitaloceanspaces.com/exported_file_4627_0000-00-00T00%3A45%3A43.344Z.pdf'
135
+
from origin 'http://localhost:3000' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header
136
+
is present on the requested resource. If an opaque response serves your needs, set the request's mode to
137
+
'no-cors' to fetch the resource with CORS disabled.
138
+
```
139
+
140
+
In order to address this, your document storage system must be instructed to accept requests from other hosts; below the relevant documentation links:
141
+
-[How to Configure CORS on DigitalOcean Spaces](https://docs.digitalocean.com/products/spaces/how-to/configure-cors/)
142
+
-[Configuring cross-origin resource sharing on AWS S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html)
0 commit comments