From 8f99cb05142088f8a380b63f40a8b15260d3c8b9 Mon Sep 17 00:00:00 2001 From: prafull-opensignlabs <93375423+prafull-opensignlabs@users.noreply.github.com> Date: Thu, 29 Aug 2024 19:59:30 +0530 Subject: [PATCH] Update run-locally.md --- docs/docs/self-host/docker/run-locally.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/docs/self-host/docker/run-locally.md b/docs/docs/self-host/docker/run-locally.md index af3283eb5..802931d00 100644 --- a/docs/docs/self-host/docker/run-locally.md +++ b/docs/docs/self-host/docker/run-locally.md @@ -7,7 +7,7 @@ import ReactPlayer from 'react-player'; 1. Firstly, install Docker and ensure it is running before proceeding to the next steps. Make sure that you have NodeJS & GIT installed on your machine. 2. Now, open the terminal and type the following command: -Command for linux/MacOS +Command for linux/MacOS ``` export HOST_URL=https://opensign.yourdomain.com && curl --remote-name-all https://raw.githubusercontent.com/OpenSignLabs/OpenSign/docker_beta/docker-compose.yml https://raw.githubusercontent.com/OpenSignLabs/OpenSign/docker_beta/Caddyfile https://raw.githubusercontent.com/OpenSignLabs/OpenSign/docker_beta/.env.local_dev && mv .env.local_dev .env.prod && docker compose up --force-recreate ``` @@ -17,8 +17,18 @@ $env:HOST_URL="https://opensign.yourdomain.com"; Invoke-WebRequest -Uri https:// ``` 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, it will be accessible at [https://localhost:3001](https://localhost:3001). You will need to accept Chrome's insecure certificate warning. Follow the steps from the screenshots. + 3. If want to run locally try out below commands and once the deployment is successful, the application will be accessible at [https://localhost:3001](https://localhost:3001). You will need to accept Chrome's insecure certificate warning. Follow the steps in the screenshots to proceed. +Command for linux/MacOS (localhost) +``` +curl --remote-name-all https://raw.githubusercontent.com/OpenSignLabs/OpenSign/docker_beta/docker-compose.yml https://raw.githubusercontent.com/OpenSignLabs/OpenSign/docker_beta/Caddyfile https://raw.githubusercontent.com/OpenSignLabs/OpenSign/docker_beta/.env.local_dev && mv .env.local_dev .env.prod && docker compose up --force-recreate +``` +Command for Windows (Powershell) (localhost) +``` +$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 +``` + +
localhost