WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-08-23 16:12:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update env-variables.md

Browse Source
This commit is contained in:
prafull-opensignlabs
2025-02-27 17:01:32 +05:30
committed by GitHub
parent 73f7d1b32f
commit 06c7355efd
1 changed files with 15 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/self-host/guides/env-variables.md
+15 -9
View File
@@ -12,26 +12,32 @@ Environment Varaibles:
[//]: # "| 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:8080/app (use your local port number instead) |"
[//]: # "| REACT_APP_APPID | 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. |"
| Environment Varibale | Value | Description |
| Environment Varibale | Value | Description |
| ------------- | ------------- | ------------- |
| PUBLIC_URL | http://localhost:3000 | Set it to the URL form where the app home page will be accessed |
| APP_ID | opensignstgn | A 12 character long random app identifier. |
| PUBLIC_URL | https://localhost:3001 | Set it to the URL form where the app home page will be accessed |
| APP_ID | opensign | A 12 character long random app identifier. |
| 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. |
| MONGODB_URI | mongodb://host.docker.internal:27017/OpenSignDB | Mongodb URI to connect to |
| 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. |
| SERVER_URL | http://localhost:8080/app | Set it to the URL from where APIs will be accessible to the NodeJS functions, for local development it should be localhost:8080/app (use your local port number instead) |
| MONGODB_URI | mongodb://mongo-container:27017/OpenSignDB | Mongodb URI to connect to |
| 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. |
| SERVER_URL | http://localhost:8080/app | Set it to the URL from where APIs will be accessible to the NodeJS functions, for local development it should be localhost:8080/app|
| DO_SPACE | DOSPACENAME | Digital ocean space name or AWS S3 bucket name for uploading documents |
| DO_ENDPOINT | ams3.digitaloceanspaces.com | Digital ocean spaces endpoint or AWS S3 endpoint for uploading documents |
| DO_BASEURL |https://DOSPACENAME.ams3.digitaloceanspaces.com | Digital ocean baseurl or AWS S3 base URL |
| DO_BASEURL | https://dospace.ams3.digitaloceanspaces.com | Digital ocean baseurl or AWS S3 base URL |
| DO_ACCESS_KEY_ID | YOUR_S3_ACCESS_ID | Digital ocean spaces access key ID or AWS s3 Access key ID for uploading the docs |
| DO_SECRET_ACCESS_KEY | YOUR_S3_ACCESS_KEY | Digital ocean spaces secret access key or AWS s3 secret access key for uploading the docs |
| DO_REGION | YOUR_S3_REGION | Digital ocean spaces region or AWS s3 region |
| USE_LOCAL | FALSE | Set this to true in order to use local file storage to save files |
| USE_LOCAL | true | If this is set to true, local file storage will be used to save files, and DO credentials will be ignored. |
| MAILGUN_API_KEY | YOUR_MAILGUNAPI_KEY | Mailgun API Key |
| MAILGUN_DOMAIN | YOUR_MAILGUNAPI_DOMAIN | Mailgun API Domain |
| MAILGUN_SENDER | - | Mailgun Sender Mail ID |
| SMTP_ENABLE | false | If this is set to true, emails will be sent through SMTP, and Mailgun credentials will be ignored. |
| SMTP_HOST | smtp.yourhost.com | Provide smtp host |
| SMTP_PORT | 443 | Provide smtp port number |
| SMTP_USERNAME | - | Provide username of smtp |
| SMTP_USER_EMAIL | mailer@yourdomain.com | Provide user email of smtp |
| SMTP_PASS | password | Provide smtp password |
| PFX_BASE64 | - | Base64 encoded PFX or p12 document signing certificate file. You can generate base64 encoded self sign certificate using the passphrase. |
| PASS_PHRASE | opensign | Pass phrase of PFX or p12 document signing certificate file.|
| PASS_PHRASE | opensign | Pass phrase of PFX or p12 document signing certificate file. |
# Steps to generate self-signed document singing certificate
```