Merge pull request #1527 from pravinOpenSign/patch-27

Update upgrade-deployment.md
This commit is contained in:
prafull-opensignlabs
2025-01-02 20:46:25 +05:30
committed by GitHub
@@ -18,6 +18,23 @@ Run the following command to pull the latest OpenSign Docker images:
**Note:** If you've made any custom changes to your docker-compose.yml file, they will be lost when running the command below. This command is intended only for those who haven't made any custom modifications to their docker-compose.yml file.
## Running on a custom domain
**linux/MacOS**
```
export HOST_URL=https://opensign.yourdomain.com && curl --remote-name-all https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml && docker compose pull
```
**Windows** (Powershell)
```
$env:HOST_URL="https://opensign.yourdomain.com"; Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml -OutFile docker-compose.yml; docker compose pull
```
**Windows** (Command Prompt)
```
set HOST_URL=https://opensign.yourdomain.com && curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml && docker compose pull
```
- This command will fetch the most recent versions of the Docker images required by OpenSign.
- Wait for the pulling process to complete. You should see messages indicating the progress and completion of the download.
## Running locally
**linux/MacOS**
```
curl --remote-name-all https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml && docker compose pull
@@ -32,23 +49,16 @@ curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-comp
```
- This command will fetch the most recent versions of the Docker images required by OpenSign.
- Wait for the pulling process to complete. You should see messages indicating the progress and completion of the download.
<img width="550" alt="Pulling completed" src="https://github.com/user-attachments/assets/1b708b04-e6e6-45a0-9625-94e420a68343" />
### Step 3: Start the Updated OpenSign Deployment
After the images have been successfully pulled, run the following command to start the updated OpenSign deployment:
```
docker compose up
```
- This command will recreate and start all the necessary containers with the updated images.
- You should see logs indicating that the containers are being created or updated, and eventually, that they are up and running.
### Running Docker Compose in Detached Mode
To start your Docker Compose services in detached mode (running in the background), use the following command:
```
docker-compose up -d
docker compose up -d
```
**Explanation:**
- docker-compose up: This command starts the services defined in your docker-compose.yml file.
@@ -56,6 +66,14 @@ docker-compose up -d
<img width="550" alt="Docker compose up" src="https://github.com/user-attachments/assets/c573baaf-f70d-468e-a531-75b85a275647" />
### OR
If you have already run the above command, you do not need to execute this command.
```
docker compose up
```
- This command will recreate and start all the necessary containers with the updated images.
- You should see logs indicating that the containers are being created or updated, and eventually, that they are up and running.
## Note:
- The docker compose pull command ensures that you have the latest version of the Docker images, while the docker compose up command applies any updates and starts the containers.