Skip to content

Commit

Permalink
Update run-locally.md
Browse files Browse the repository at this point in the history
  • Loading branch information
prafull-opensignlabs authored Aug 14, 2024
1 parent e8d692a commit beaa256
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/docs/self-host/docker/run-locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Command for Windows (Powershell)
```
$env:HOST_URL="https://opensign.yourdomain.com"; Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/docker_beta/docker-compose.yml -OutFile docker-compose.yml; Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/docker_beta/Caddyfile -OutFile Caddyfile; Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/docker_beta/.env.local_dev -OutFile .env.local_dev; Rename-Item -Path .env.local_dev -NewName .env.prod; docker compose up --force-recreate
```
and Hit Enter start the containers automatically. Make sure that you replace the host URL with your subdomain from where OpenSign will be accessible. You need to point the subdomain to the server you are running these commands by adding the necessary A record to your DNS.
and Hit Enter to start the containers automatically. Make sure to replace the host URL with your subdomain where OpenSign will be accessible. You need to point the subdomain to the server where you are running these commands by adding the necessary A record to your DNS.

3. If you want to test it locally, remove `export HOST_URL=https://opensign.yourdomain.com &&` for Linux/MacOS and `$env:HOST_URL="https://opensign.yourdomain.com";` for Windows. Once deployed successfully, follow the steps from the screenshots.
3. If you want to test it locally, remove `export HOST_URL=https://opensign.yourdomain.com &&` for Linux/MacOS and `$env:HOST_URL="https://opensign.yourdomain.com";` for Windows. Once deployed successfully, it will be accessible at [https://localhost:3001](https://localhost:3001). Follow the steps from the screenshots."

<div>
<img width="937" alt="localhost" src="https://github.com/user-attachments/assets/f5de1882-64d0-44ea-86e3-3a7c8405272c"/>
Expand All @@ -37,24 +37,24 @@ Add below Environment Varaibles to the ".env.prod" file that is automatically cr

| Environment Varibale | Value | Description |
| ------------- | ------------- | ------------- |
| PUBLIC_URL | https://localhost:3001 | Set it to the URL form where the app home page will be accessed |
| PUBLIC_URL | https://localhost:3001 or https://opensign.yourdomain.com | Set it to the URL form where the app home page will be accessed |
| APP_ID | opensign | 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. |
| appName | open_sign_server | Name of the app. It will be visible in the verification emails sent out. |
| 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://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 (use your local port number instead) |
| 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://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 | true | To use local file storage to save file |
| 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 | to enable SMTP
| 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_USER_EMAIL | [email protected] | Provide user email of smtp
Expand Down

0 comments on commit beaa256

Please sign in to comment.