From e36557e844c11d91136866923586cbf3479aed0c Mon Sep 17 00:00:00 2001 From: EDIflyer Date: Sun, 8 Sep 2024 15:41:22 +0100 Subject: [PATCH 1/3] Update run-locally.md Remove reference to NodeJS and Git as these aren't required for Docker as are included within it. --- docs/docs/self-host/docker/run-locally.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/self-host/docker/run-locally.md b/docs/docs/self-host/docker/run-locally.md index 60f757bd3..c9a055313 100644 --- a/docs/docs/self-host/docker/run-locally.md +++ b/docs/docs/self-host/docker/run-locally.md @@ -4,7 +4,7 @@ title: Self-host OpenSign™ with Docker on Linux/MacOS/Windows import ReactPlayer from 'react-player'; ## Steps to run OpenSign™ with docker on Linux/MacOS/Windows: - 1. Firstly, install [Docker](https://www.docker.com/products/docker-desktop/) and ensure it is running before proceeding to the next steps. Make sure that you have [NodeJS](https://nodejs.org/en) & [GIT](https://git-scm.com/downloads) installed on your machine. + 1. Firstly, install [Docker](https://www.docker.com/products/docker-desktop/) and ensure it is running before proceeding to the next steps. 2. Now, start Docker and ensure it runs in the background. Open the terminal and type the following command: Command for linux/MacOS From f117aeb7c44ee53b48a430f4cba9b43bc4049c32 Mon Sep 17 00:00:00 2001 From: EDIflyer Date: Sun, 8 Sep 2024 15:44:20 +0100 Subject: [PATCH 2/3] Add comment re CPU architecture As per Discord discussions --- docs/docs/self-host/docker/run-locally.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/docs/self-host/docker/run-locally.md b/docs/docs/self-host/docker/run-locally.md index c9a055313..8c10b1e8d 100644 --- a/docs/docs/self-host/docker/run-locally.md +++ b/docs/docs/self-host/docker/run-locally.md @@ -3,6 +3,8 @@ title: Self-host OpenSign™ with Docker on Linux/MacOS/Windows --- import ReactPlayer from 'react-player'; +OpenSign™ is available of x86/x64 and Apple M-series CPU architectures. ARM64 is not currently supported. + ## Steps to run OpenSign™ with docker on Linux/MacOS/Windows: 1. Firstly, install [Docker](https://www.docker.com/products/docker-desktop/) and ensure it is running before proceeding to the next steps. 2. Now, start Docker and ensure it runs in the background. Open the terminal and type the following command: From ca756983281cd4a96412663a573e03ce19aa8378 Mon Sep 17 00:00:00 2001 From: EDIflyer Date: Sun, 8 Sep 2024 15:49:37 +0100 Subject: [PATCH 3/3] better differentiate between custom domain and local --- docs/docs/self-host/docker/run-locally.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/docs/self-host/docker/run-locally.md b/docs/docs/self-host/docker/run-locally.md index 8c10b1e8d..e3c60d23c 100644 --- a/docs/docs/self-host/docker/run-locally.md +++ b/docs/docs/self-host/docker/run-locally.md @@ -7,8 +7,9 @@ OpenSign™ is available of x86/x64 and Apple M-series CPU architectures. ARM64 ## Steps to run OpenSign™ with docker on Linux/MacOS/Windows: 1. Firstly, install [Docker](https://www.docker.com/products/docker-desktop/) and ensure it is running before proceeding to the next steps. - 2. Now, start Docker and ensure it runs in the background. Open the terminal and type the following command: + 2. Now, start Docker and ensure it runs in the background. +### Running on a custom domain Command for linux/MacOS ``` export HOST_URL=https://opensign.yourdomain.com && curl --remote-name-all https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/.env.local_dev && mv .env.local_dev .env.prod && docker compose up --force-recreate @@ -23,7 +24,8 @@ set HOST_URL=https://opensign.yourdomain.com && curl -O https://raw.githubuserco ``` 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 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. +### Running locally +If instead 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) ```