- Docker
- docker-compose
-
使用官方安装脚本自动安装
curl -fsSL https://get.docker.com | bash -s docker --mirror Aliyun -
启动Docker
systemctl start docker
-
下载及安装Compose
curl -SL https://github.com/docker/compose/releases/download/v2.23.0/docker-compose-linux-x86_64 -o /usr/local/bin/docker-compose
-
给docker-compose设置可执行权限
chmod +x /usr/local/bin/docker-compose
-
执行
docker-compose命令是否有相关输出注意
如果
docker-compose命令无效，请检查docker-compose的路径。您也可以创建一个软连接到/usr/bin。如：sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
root@server:~# ./build.sh help用法： <命令> [选项] 命令： help 帮助 base [选项] 构建基础镜像 builder [选项] 构建Builder镜像 erpnext [选项] 构建指定版本的ERPNext镜像，该镜像已包含ERRNext、 ERPNext Chinese、ERPNext OOB，可直接部署使用。 custom [选项] 构建自定义APP镜像。在基于erpnext命令构建出来的镜像的 基础上添加自定义APP。 [镜像] [-h | --help] 镜像构建帮助 get-default 查看当前构建默认值 set-default [选项] 设置构建默认值 使用方法：set-default param1=value1 param2=value2 ... 支持以下参数： 镜像注册中心 registry 镜像命名空间 namespace 主版本 main_version 自定义镜像主版本 custom_main_version Frappe仓库 frappe_repo ERPNext仓库 erpnext_repo ERPNext Chinese仓库 erpnext_chinese_repo ERPNext OOB仓库 erpnext_oob_repo
构建镜像时基于几个默认变量来确定镜像名称，要推送到的注册中心，frappe框架版本等，默认值如下：
| 参数名称 | 参数 | 默认值 |
|---|---|---|
| 镜像注册中心 | registry | ccr.ccs.tencentyun.com |
| 镜像命名空间 | namespace | vnimy |
| 主版本 | main_version | version-15 |
| 自定义镜像主版本 | custom_main_version | version-15 |
| Frappe仓库地址 | frappe_repo | https://gitee.com/mirrors/frappe.git |
| ERPNext仓库地址 | erpnext_repo | https://gitee.com/mirrors/erpnext.git |
| ERPNext汉化仓库地址 | erpnext_chinese_repo | https://gitee.com/yuzelin/erpnext_chinese.git |
| ERPNext开箱即用仓库地址 | erpnext_oob_repo | https://gitee.com/yuzelin/erpnext_oob.git |
-
设置默认值
./build.sh set-default \ registry=ccr.ccs.tencentyun.com \ namespace=vnimy \ main_version=version-15 \ frappe_repo=https://gitee.com/mirrors/frappe.git
-
查看默认值
./build.sh get-default
-
构建镜像前请确保已经登陆镜像注册中心，否则会导致推送镜像失败
使用以下命令登录镜像中心：
docker login -u {用户名} -p {密码} {注册中心}
在构建ERP镜像之前需要有frappe-base和frappe-builder两个基础镜像支撑
frappe-base：为ERP的运行环境镜像，提供Python、Nodejs、Bench等支持，同时也是frappe-builder的基础镜像。frappe-builder：为构建ERP时初始化frappe框架及安装应用时提供环境支持。frappe-base和frappe-builder只需要构建一次即可，可供构建ERP镜像时重复使用。
-
构建并推送
frappe-base镜像./build.sh base
-
构建并推送
frappe-builder镜像./build.sh builder
-
设置默认值 由于基础镜像包含Frappe、ERPNext、ERPNext Chinese、ERPNext OOB等应用，因此需要提前设置好这些应用的仓库地址以及版本信息
./build.sh set-default \ registry=ccr.ccs.tencentyun.com \ namespace=vnimy \ main_version=version-15 \ frappe_repo=https://gitee.com/mirrors/frappe.git erpnext_repo=https://gitee.com/mirrors/erpnext.git erpnext_chinese_repo=https://gitee.com/yuzelin/erpnext_chinese.git erpnext_oob_repo=https://gitee.com/yuzelin/erpnext_oob.git
-
构建镜像
./build.sh erpnext
该命令构建并推送镜像
{$registry}/{$namespace}/erpnext:{$main_version}.{$(date '+%y%m%d')}如：ccr.ccs.tencentyun.com/vnimy/erpnext:version-15.241226
-
准备生产镜像 自定义镜像基于之前构建的生产镜像来安装自定已APP，因此需要提前准备好生产镜像； 如果之前有构建过生产镜像，可跳过此步骤； 如果需要更新生产镜像版本，请重新构建生产镜像；
-
准备构建配置 在项目目录中创建文件
custom.txt，并确保有以下内容app-name-1,app-repo-1,app-branch app-name-2,app-repo-2,app-branch app-name-3,app-repo-3,app-branch如何在构建时不需要密码和SSH Key拉取私有仓库APP？ 创建一个访问令牌，在仓库URL中使用令牌来拉取。如：
https://x-access-token:[email protected]/your-username/your-repo.git，具体令牌创建及访问方式视Git托管平台而定。设置默认基础镜像版本： 注意： 版本为上一步构建的版本，如果不需要基于更新的基础版本，可以不更改改默认值
./build.sh set-default custom_main_version=version-15.241226
-
构建自定义APP镜像 执行构建命令：
./build.sh custom
该命令会产生镜像
{$registry}/{$namespace}/erp:{$custom_main_version}.{$(date '+%y%m%d')}，镜像版本由自定义镜像主版本及构建日期组成，如：ccr.ccs.tencentyun.com/vnimy/erp:version-15.241226.241227。
设置一个目录作为ERP的部署目录，如：~/docker/erp，后面用{部署目录}代替。
-
创建部署目录
mkdir -p ~/docker cp -r deploy/compose ~/docker/erp cd ~/docker/erp
-
配置环境变量
cp .env.sample .env
修改
.env文件，设置ERP的镜像名称(IMAGE)、镜像版本(VERSION)、访问端口(FRONTEND_PORT)环境变量
docker-compose up -d -V-
新建站点
docker-compose exec backend \ bench new-site {站点域名} \ --mariadb-root-password {数据库管理员密码} \ --admin-password {管理员登陆密码} \ --no-mariadb-socket -
为站点安装应用
docker-compose exec backend \ bench --site {站点域名} install-app \ erpnext \ erpnext_chinese \ erpnext_oob \ {...更多应用}注意: 请确保需要安装的应用已经存在ERP镜像中
-
修改
.env的镜像版本 -
拉取最新镜像
docker-compose pull backend
-
重新创建ERP服务
docker-compose up -d -V
-
当更新的版本涉及到字段变动时，需要进行一次合并操作
docker-compose exec backend --site {站点域名} migrate
- Docker Swarm
- NFS服务
-
初始化Docker Swarm
docker swarm init --advertise-addr {本机内网IP地址}示例：
root@ubuntu:~# docker swarm init --advertise-addr 192.168.18.130 Swarm initialized: current node (djjwd24eft4b2b6wp192oc652) is now a manager. To add a worker to this swarm, run the following command: docker swarm join --token SWMTKN-1-4a8mnmeo8x12q3jykc4we9mefy27dnv6mtc06i5kiho0dx9ocx-1i2yhrwsoclekureu0rlpqrgj 192.168.18.130:2377 To add a manager to this swarm, run 'docker swarm join-token manager' and follow the instructions.
本次执行将初始化集群环境，并输出加入集群的token：
docker swarm join --token xxxxx -
其他主机加入集群 使用上一步生成的命令执行加入集群操作，如果忘记了命令，可以执行
docker swarm join-token manager来查看命令docker swarm join --token xxxxx
-
创建部署目录
mkdir -p ~/docker cp -r deploy/swarm ~/docker/erp cd ~/docker/erp
-
配置环境变量
cp .env.sample .env
修改
.env文件，设置ERP的镜像名称(IMAGE)、镜像版本(VERSION)、访问端口(FRONTEND_PORT)、NFS服务器(NFS_SERVER)# 镜像名称 IMAGE=ccr.ccs.tencentyun.com/vnimy/erp # 镜像版本 VERSION=version-15.231107 # ERP访问端口 FRONTEND_PORT=8080
NFS服务用于sites的持久化，所有需要用到sites的目录都需要挂在存储在NFS中的sites目录
修改.env文件，设置NFS服务器(NFS_SERVER)
# NFS设置，用于持久化sites目录
NFS_SERVER=192.168.200.88
# sites目录在NFS的位置
NFS_SITES_PATH=/erp/sites用法： <命令> [选项] 命令： help 帮助 version 查看当前镜像版本 ps 查看任务列表 services 查看服务列表 init 初始化全局配置 start 启动服务 restart 重启服务 down 关闭服务 update [版本] 更新到指定版本，如不指定版本则使用当前版本进行更新服务 migrate [站点域名] 合并指定站点 scale [实例数] 将backend、frontend、websocket服务的实例调整到指定数量 port 设置前端端口号，默认：8080 port [端口] 设置前端端口号 attach 进入backend容器终端
第一次运行服务前需要先初始化服务配置，用于生成sites目录的必要文件
./deploy.sh init./deploy.sh start通过输入./deploy.sh services命令来查看服务启动情况，确认REPLICAS全部正常
root@ubuntu:~/docker/erp# ./deploy.sh services
ID NAME MODE REPLICAS IMAGE PORTS
ij5j7yr0jvim erp_backend replicated 3/3 ccr.ccs.tencentyun.com/vnimy/erp:version-15.231107
r3iuc82t5fc8 erp_db replicated 1/1 mariadb:10.6 *:63306->3306/tcp
sr9gr7m7ecvm erp_frontend replicated 3/3 ccr.ccs.tencentyun.com/vnimy/erp:version-15.231107 *:8081->8080/tcp
2yum62qcmbtj erp_queue-default replicated 1/1 ccr.ccs.tencentyun.com/vnimy/erp:version-15.231107
hmddjx48quy4 erp_queue-long replicated 1/1 ccr.ccs.tencentyun.com/vnimy/erp:version-15.231107
o2i86xt1t1a7 erp_queue-short replicated 1/1 ccr.ccs.tencentyun.com/vnimy/erp:version-15.231107
pascw8zeu4l5 erp_redis-cache replicated 1/1 redis:6.2-alpine
oy8v3zf5bu1u erp_redis-queue replicated 1/1 redis:6.2-alpine
tpw6s0gslqgi erp_redis-socketio replicated 1/1 redis:6.2-alpine
2veav9jt1xtp erp_scheduler replicated 1/1 ccr.ccs.tencentyun.com/vnimy/erp:version-15.231107
j2xtpotdsmp4 erp_websocket replicated 3/3 ccr.ccs.tencentyun.com/vnimy/erp:version-15.231107-
进入backend容器
./deploy.sh attach
进入backend容器后可使用bench命令进行新建站点、安装应用、更新站点等操作
-
新建站点
bench new-site {站点域名} \ --mariadb-root-password {数据库管理员密码} \ --admin-password {管理员登陆密码} \ --no-mariadb-socket -
为站点安装应用
bench --site {站点域名} install-app \ erpnext \ erpnext_chinese \ erpnext_oob \ {...更多应用}注意: 请确保需要安装的应用已经存在ERP镜像中
-
执行更新命令
./deploy.sh update {版本号} -
当更新的版本涉及到字段变动时，需要进行一次合并操作
./deploy.sh migrate {站点域名}
-
复制
.env.sample到.envcp .env.sample .env
-
设置
.env环境变量# Chart包版本，可通过(-v|--chart_version)传入，可以在https://helm.erpnext.com/查询对应ERPNext版本的包版本 CHART_VERSION=6.0.96 # K8s命名空间，可通过(-n|--namespace)传入 NAMESPACE=frappe-bench-v14 # 默认站点，在不设置参数时默认使用的站点，单站点推荐设置，可通过(-t|--site)传入 SITE=site1.example.com # 安装的应用 INSTALL_APPS=erpnext,erpnext_chinese,erpnext_oob # 管理员密码，创建站点时必须，可通过(--admin-password)传入 ADMIN_PASSWORD=admin # 路由名称，创建路由时必须，可通过(--ingress_name)传入 INGRESS_NAME=site1-ingress # 路由SSL证书保密字典，创建路由时必须，需提前创建保密字典，可通过(--ingress_tls)传入 INGRESS_TLS_SECRET_NAME=site1-ssl # 数据库设置，需提前部署数据库服务 DB_HOST=mariadb.development DB_PORT=3306 DB_ROOT_USER=root DB_ROOT_PASSWORD=root # 镜像仓库的保密字典，需提前创建仓库保密字典 IMAGE_PULL_SECRET_NAME=tx-registry # 镜像仓库 IMAGE_REPOSITORY=ccr.ccs.tencentyun.com/vnimy/erp # 镜像版本，可通过(-t|--tag)传入 IMAGE_TAG=version-14.240222.2404061753 # 持久化数据设置，需提前创建存储类 PERSISTENCE_STORAGE_CLASS=nfs-client
# ./deploy help
用法：
<命令> [选项]
命令：
help 帮助
install [选项] 安装，可用参数-n|-v|-t
update [选项] 更新，可用参数-n|-v|-t|--migrate
uninstall [选项] 卸载，可用参数-n
new-site [选项] 新建站点，可用参数-n|-v|-s|-t
create-ingress [选项] 创建路由，可用参数-n|-v|-s|-t|--ingress
migrate [选项] 合并，可用参数-n|-v|-s|-t
get-default 查看部署默认值
set-default [选项] 设置部署默认值
使用方法：set-default param1=value1 param2=value2 ...
支持以下参数：
命名空间 namespace
Chart版本 chart_version
站点名称 site
镜像版本 image_tag
路由名称 ingress_name
路由TLS保密字典名称 ingress_tls_secret_name
管理员密码 admin_password
参数：
-n|--namespace 命名空间
-v|--chart_version Chart版本
-s|--site 站点名称
-t|--tag 镜像版本
--install_apps 安装的应用，多个应用用英文逗号分隔，用于新建站点
--admin_password 管理员密码，用于新建站点
--ingress_name 路由名称，用于创建路由
--ingress_tls 路由TLS保密字典名称，用于创建路由# 安装
./deploy.sh install -t version-14.240222.2404160935
# 更新
./deploy.sh update --migrate -t version-14.240222.2404160935
# 卸载
./deploy.sh uninstall
# 新建站点
./deploy.sh new-site \
-s site1.example.com \
-t version-14.240222.2404160935 \
--install_apps=erpnext,erpnext_chinese,erpnext_oob,custom_app1,custom_app2 \
--admin_password=admin
# 创建路由
./deploy.sh create-ingress \
-s site1.example.com \
-t version-14.240222.2404160935 \
--ingress_name site1-ingress \
--ingress_tls site1-ssl
# 合并
./deploy.sh migrate -s site1.example.com -t version-14.240222.2404160935修改.env文件，设置DB_HOST、DB_PORT以及DB_PASSWORD
# 数据库主机
DB_HOST=192.168.200.10
# 数据库端口
DB_PORT=3306
# 数据库root密码
DB_PASSWORD=root注意： 只能使用MariaDB
感谢余则霖对ERPNext本地化的贡献，基于此将界面汉化及开箱即用应用默认添加到erpnext生产镜像中。
- Frappe Framework https://frappeframework.com
- Frappe https://github.com/frappe/frappe
- ERPNext https://github.com/frappe/erpnext
- Frappe Docker https://github.com/frappe/frappe_docker
- ERPNext界面汉化 https://gitee.com/yuzelin/erpnext_chinese
- ERPNext开箱即用 https://gitee.com/yuzelin/erpnext_oob