Localhost Setup with Docker
Steps to run OpenSign™ with docker in macos/linux:
-
-
- Firstly install docker and make sure it is running while moving to next steps. -
- Now open terminal then type
git clone https://github.com/OpenSignLabs/OpenSignand hitEnterit will clone OpenSign project in your local.
- - Then type
cd OpenSigncommand and hitEnterit will open OpenSign project in terminal.
- - Then type
make buildcommand it will start create container image. It will take sometime to build and start.
- - Next time if you want to run docker image just open docker and run opensign container by clicking on play button from actions. +
- Firstly, install Docker and ensure it is running before proceeding to the next steps. +
- Now, open the terminal and type the following command:
Note: If you want our updated features in your docker container just delete opensign container and just follow steps again.
+git clone https://github.com/OpenSignLabs/OpenSign.git
and Hit Enter to clone the OpenSign project locally.
+-
+
- Then, navigate to the project directory with the command: +
cd OpenSign
Hit Enter to access the OpenSign project in the terminal.
+-
+
- Execute the following command to build the container image: +
make build
This will initiate the process of creating the container image. It may take some time to complete.
+-
+
- For subsequent runs, open Docker and start the OpenSign container by clicking on the play button in the actions panel. +
Note: If you wish to incorporate our latest features into your Docker container, delete the existing OpenSign container and follow the steps again.
Steps to run OpenSign™ with docker in windows:
-
-
- Setup WSL 2 in windows. To install WSL 2 refer below video +
- Set up WSL 2 on Windows by referring to the video provided.
-
-
- Now install docker desktop in windows and open docker desktop. -
- Enable wsl in docker desktop by moving on this location
Setting > Resources > WSL Inegrationand click on check box and then click onapply & restartbutton and now minimize it.
+ - Install Docker Desktop on Windows and launch Docker Desktop. +
- Enable WSL in Docker Desktop by navigating to Settings > Resources > WSL Integration. Check the box and click on "Apply & Restart." Minimize Docker Desktop.

-
-
- Go to your desired destination in your windows then open powershell in that folder using
Shift + right click of mouseand selectOpen Powershell window herefrom options.
- - Open powershell and type
git clone https://github.com/OpenSignLabs/OpenSignand hitEnterit will clone OpenSign project in you local.
- - Then open OpenSign folder with vs code and go to
apps > mongo > mongo-init.shand change type of this file fromCRLFtoLFand then save this file and close vs code.
+ - Navigate to your desired location in Windows. Open PowerShell in that folder by holding Shift and right-clicking the mouse, then select "Open PowerShell window here." +
- In the PowerShell window, type the following command: +
git clone https://github.com/OpenSignLabs/OpenSign.git
and Hit Enter to clone the OpenSign project locally.
+-
+
- Open the OpenSign folder with Visual Studio Code. Go to
apps > mongo > mongo-init.sh. Change the file type from CRLF to LF, save the file, and close Visual Studio Code.

-
-
- Open ubuntu/WSL terminal and write command to navigate to folder where you have clone OpenSign project for e.g.
cd mnt/c/testing/docker/OpenSignand hitEnter.
- - Now type command
Make buildand it will start build image for docker, it will take some time to build and start. for more specific steps watch below video.
- - Next time if you want to run docker image just open docker and run opensign container by clicking on play button from actions. +
- Open the Ubuntu/WSL terminal and use the command to navigate to the folder where you cloned the OpenSign project, e.g., cd mnt/c/testing/docker/OpenSign. +
- Execute the following command to build the container image:
Note: If you want our updated features in your docker container just delete opensign container and just follow steps from 2 step again.
+make build
This will initiate the process of creating the container image. It may take some time to complete.
+-
+
- Refer below video for more specific details. +
- For subsequent runs, open Docker and start the OpenSign container by clicking on the play button in the actions panel. +
Note: If you wish to incorporate our latest features into your Docker container, delete the existing OpenSign container and follow the steps again.
Information About ENV variables which are used to setup OpenSign™ with Docker on Localhost
To set up OpenSign™ locally using Docker, the following prerequisites are required:
diff --git a/docs/self-host/intro/index.html b/docs/self-host/intro/index.html index 6da961bed..0cd4e55a5 100644 --- a/docs/self-host/intro/index.html +++ b/docs/self-host/intro/index.html @@ -5,7 +5,7 @@