mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-09 11:17:39 +02:00
1 line
6.9 KiB
JavaScript
1 line
6.9 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6238],{93718:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>h,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var t=o(85893),s=o(11151);const r={title:"OpenSign\u2122 Self-Hosted 'Upgrade Deployment' Guide Using Docker on Linux, macOS, or Windows"},i=void 0,l={id:"self-host/docker/upgrade-deployment",title:"OpenSign\u2122 Self-Hosted 'Upgrade Deployment' Guide Using Docker on Linux, macOS, or Windows",description:"This guide provides step-by-step instructions to upgrade the deployment of OpenSign using Docker.",source:"@site/docs/self-host/docker/upgrade-deployment.md",sourceDirName:"self-host/docker",slug:"/self-host/docker/upgrade-deployment",permalink:"/docs/self-host/docker/upgrade-deployment",draft:!1,unlisted:!1,editUrl:"https://github.com/opensignlabs/opensign/tree/feat-docs/docs/docs/self-host/docker/upgrade-deployment.md",tags:[],version:"current",frontMatter:{title:"OpenSign\u2122 Self-Hosted 'Upgrade Deployment' Guide Using Docker on Linux, macOS, or Windows"},sidebar:"selfhostSidebar",previous:{title:"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows",permalink:"/docs/self-host/docker/run-locally"},next:{title:"Cloud Storage",permalink:"/docs/category/cloud-storage"}},d={},c=[{value:"Step 1: Open the Terminal",id:"step-1-open-the-terminal",level:3},{value:"Step 2: Pull the Latest Docker Images",id:"step-2-pull-the-latest-docker-images",level:3},{value:"Step 3: Start the Updated OpenSign Deployment",id:"step-3-start-the-updated-opensign-deployment",level:3},{value:"Running Docker Compose in Detached Mode",id:"running-docker-compose-in-detached-mode",level:3},{value:"Notes:",id:"notes",level:2},{value:"Troubleshooting:",id:"troubleshooting",level:2}];function a(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.p,{children:"This guide provides step-by-step instructions to upgrade the deployment of OpenSign using Docker."}),"\n",(0,t.jsx)(n.h3,{id:"step-1-open-the-terminal",children:"Step 1: Open the Terminal"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Windows:"})," Press Win + X and select Windows PowerShell or Windows Terminal from the menu."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"macOS:"}),' Go to Applications > Utilities > Terminal or search for "Terminal" using Spotlight (Cmd + Space).']}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Linux:"})," Open the terminal from the application menu or by pressing Ctrl + Alt + T."]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"step-2-pull-the-latest-docker-images",children:"Step 2: Pull the Latest Docker Images"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Before executing the commands below, make sure Docker is running on your machine."}),"\n",(0,t.jsxs)(n.li,{children:["Ensure that you are in the same directory where you executed the ",(0,t.jsx)(n.code,{children:"build"})," or ",(0,t.jsx)(n.code,{children:"compose"})," Docker command."]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Run the following command to pull the latest OpenSign Docker images:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"docker compose pull\n"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"This command will fetch the most recent versions of the Docker images required by OpenSign."}),"\n",(0,t.jsx)(n.li,{children:"Wait for the pulling process to complete. You should see messages indicating the progress and completion of the download."}),"\n"]}),"\n",(0,t.jsx)("img",{width:"550",alt:"Pulling completed",src:"https://github.com/user-attachments/assets/14525d84-d588-4d0d-bffd-f0608f3646f3"}),"\n",(0,t.jsx)(n.h3,{id:"step-3-start-the-updated-opensign-deployment",children:"Step 3: Start the Updated OpenSign Deployment"}),"\n",(0,t.jsx)(n.p,{children:"After the images have been successfully pulled, run the following command to start the updated OpenSign deployment:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"docker compose up\n"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"This command will recreate and start all the necessary containers with the updated images."}),"\n",(0,t.jsx)(n.li,{children:"You should see logs indicating that the containers are being created or updated, and eventually, that they are up and running."}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"running-docker-compose-in-detached-mode",children:"Running Docker Compose in Detached Mode"}),"\n",(0,t.jsx)(n.p,{children:"To start your Docker Compose services in detached mode (running in the background), use the following command:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"docker-compose up -d\n"})}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Explanation:"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"docker-compose up: This command starts the services defined in your docker-compose.yml file."}),"\n",(0,t.jsx)(n.li,{children:"-d: The detached mode flag, which runs the containers in the background and frees up your terminal."}),"\n"]}),"\n",(0,t.jsx)("img",{width:"550",alt:"Docker compose up",src:"https://github.com/user-attachments/assets/791b2ac0-206a-4ed8-a1aa-164b3cf5015b"}),"\n",(0,t.jsx)(n.h2,{id:"notes",children:"Notes:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"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."}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"troubleshooting",children:"Troubleshooting:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"If you encounter any errors, check Docker logs by running docker compose logs to get more details."}),"\n",(0,t.jsx)(n.li,{children:"Verify that your environment variables and Docker configuration files are set correctly."}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["If you require more help, feel free to reach out to our customer support on ",(0,t.jsx)(n.a,{href:"mailto:support@opensignlabs.com",children:"support@opensignlabs.com"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["For instant help and support, ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"https://discord.com/invite/xe9TDuyAyj",children:"join our Discord community!"})})]})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},11151:(e,n,o)=>{o.d(n,{Z:()=>l,a:()=>i});var t=o(67294);const s={},r=t.createContext(s);function i(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); |