weiyu/deploy/server/docs/assets/js/7d27dcec.9646080f.js

"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4448],{3466:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>d,toc:()=>l});const d=JSON.parse('{"id":"deploy/jar","title":"JAR Package Deployment","description":"- Operating System: Ubuntu 20.04 LTS","source":"@site/i18n/en/docusaurus-plugin-content-docs/current/deploy/jar.md","sourceDirName":"deploy","slug":"/deploy/jar","permalink":"/docs/docs/deploy/jar","draft":false,"unlisted":false,"editUrl":"https://github.com/bytedesk/bytedesk/docs/deploy/jar.md","tags":[],"version":"current","sidebarPosition":3,"frontMatter":{"sidebar_label":"JAR","sidebar_position":3},"sidebar":"tutorialSidebar","previous":{"title":"Docker","permalink":"/docs/docs/deploy/docker"},"next":{"title":"Desktop Client","permalink":"/docs/docs/deploy/desktop"}}');var r=s(5723),i=s(6246);const a={sidebar_label:"JAR",sidebar_position:3},o="JAR Package Deployment",t={},l=[{value:"Dependencies",id:"dependencies",level:2},{value:"Download",id:"download",level:2},{value:"MySQL 8.0",id:"mysql-80",level:3},{value:"Or PostgreSQL 16",id:"or-postgresql-16",level:3},{value:"Redis",id:"redis",level:3},{value:"Nginx",id:"nginx",level:2},{value:"AI",id:"ai",level:2},{value:"Download IM Server",id:"download-im-server",level:2},{value:"Configuration",id:"configuration",level:2},{value:"Local Preview",id:"local-preview",level:2}];function c(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"jar-package-deployment",children:"JAR Package Deployment"})}),"\n",(0,r.jsx)(n.admonition,{type:"tip",children:(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Operating System: Ubuntu 20.04 LTS"}),"\n",(0,r.jsx)(n.li,{children:"Server Requirements: Minimum 2 cores 4GB RAM, Recommended 4 cores 8GB RAM"}),"\n"]})}),"\n",(0,r.jsx)(n.h2,{id:"dependencies",children:"Dependencies"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/deploy/depend/jdk",children:"JDK"})}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.a,{href:"/docs/deploy/depend/mysql",children:"MySQL"})," or ",(0,r.jsx)(n.a,{href:"/docs/deploy/depend/postgresql",children:"PostgreSQL"})]}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/deploy/depend/redis",children:"Redis"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/deploy/depend/nginx",children:"Nginx"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/deploy/depend/letsencrypt",children:"Let's Encrypt"})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"download",children:"Download"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# Download JAR package\nwget https://github.com/bytedesk/bytedesk/releases/download/v1.0.0/bytedesk.jar\njava --version\n# java 17.0.4 2022-07-19 LTS\n"})}),"\n",(0,r.jsx)(n.h3,{id:"mysql-80",children:(0,r.jsx)(n.a,{href:"./depend/mysql",children:"MySQL 8.0"})}),"\n",(0,r.jsx)(n.p,{children:"MySQL is used by default"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# Modify application.properties\nspring.datasource.url=jdbc:mysql://127.0.0.1:3306/bytedesk\nspring.datasource.username=root\nspring.datasource.password=password\n"})}),"\n",(0,r.jsxs)(n.h3,{id:"or-postgresql-16",children:["Or ",(0,r.jsx)(n.a,{href:"./depend/postgresql",children:"PostgreSQL 16"})]}),"\n",(0,r.jsx)(n.p,{children:"Choose either MySQL or PostgreSQL, MySQL is used by default"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# Modify application.properties\nspring.datasource.url=jdbc:postgresql://127.0.0.1:5433/bytedesk\nspring.datasource.username=postgres\nspring.datasource.password=password\n"})}),"\n",(0,r.jsx)(n.h3,{id:"redis",children:(0,r.jsx)(n.a,{href:"./depend/redis",children:"Redis"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"spring.data.redis.database=0\nspring.data.redis.host=127.0.0.1\nspring.data.redis.port=6379\nspring.data.redis.password=password\n"})}),"\n",(0,r.jsx)(n.h2,{id:"nginx",children:(0,r.jsx)(n.a,{href:"./depend/nginx",children:"Nginx"})}),"\n",(0,r.jsx)(n.p,{children:"Not required for local deployment, only recommended for production environment where Nginx serves as reverse proxy."}),"\n",(0,r.jsx)(n.h2,{id:"ai",children:(0,r.jsx)(n.a,{href:"./depend/ai",children:"AI"})}),"\n",(0,r.jsx)(n.p,{children:"Optional, only used for knowledge base Q&A, can be skipped. If only using AI model for conversation, just fill in Zhipu AI key in configuration file."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"Download link: https://github.com/Bytedesk/bytedesk-ai\n"})}),"\n",(0,r.jsxs)(n.h2,{id:"download-im-server",children:["Download ",(0,r.jsx)(n.a,{href:"https://www.weiyuai.cn/download/weiyu-server.zip",children:"IM Server"})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# More downloads: https://www.weiyuai.cn/download\n# Extract\nunzip weiyu-server.zip\n"})}),"\n",(0,r.jsx)(n.h2,{id:"configuration",children:"Configuration"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# Edit configuration file: server/config/application.properties\n# Modify database connection info\nspring.datasource.url=jdbc:mysql://127.0.0.1:3306/bytedesk\nspring.datasource.username=root\nspring.datasource.password=password\n# Modify redis connection info\nspring.data.redis.database=0\nspring.data.redis.host=127.0.0.1\nspring.data.redis.port=6379\nspring.data.redis.password=password\n\n# Grant permissions\nchmod +x start.sh\nchmod +x stop.sh\n# Start\n# Run on Mac or Linux\n./start.sh\n# Run on Windows\nstart.bat\n# Stop\n# Run on Mac or Linux\n./stop.sh\n# Run on Windows\nstop.bat\n# After starting, wait a moment. Check port, if port 9003 exists, startup successful\nnetstat -ntlp\n# View logs\ntail -f logs/bytedeskim.log\n"})}),"\n",(0,r.jsx)(n.h2,{id:"local-preview",children:"Local Preview"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"web: http://127.0.0.1:9003/\nDeveloper portal: http://127.0.0.1:9003/dev\nAdmin dashboard: http://127.0.0.1:9003/admin, username: admin@email.com, password: admin\nAgent client: http://127.0.0.1:9003/agent/chat, username: admin@email.com, password: admin\nVisitor: http://127.0.0.1:9003/chat?org=df_org_uid&t=0&sid=df_ag_uid&\nAPI docs: http://127.0.0.1:9003/swagger-ui/index.html\nDatabase monitor: http://127.0.0.1:9003/druid, username: admin@email.com, password: admin\nActuator: http://127.0.0.1:9003/actuator\n"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},6246:(e,n,s)=>{s.d(n,{R:()=>a,x:()=>o});var d=s(2155);const r={},i=d.createContext(r);function a(e){const n=d.useContext(i);return d.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),d.createElement(i.Provider,{value:n},e.children)}}}]);