diff --git a/.env.versions b/.env.versions index b17887a..f04c3ec 100644 --- a/.env.versions +++ b/.env.versions @@ -1,5 +1,5 @@ # 本项目版本 -PROJECT_VERSION=0.7.2 +PROJECT_VERSION=0.7.3 #=== start === gui-base images ========================== diff --git a/README.md b/README.md index fe4dca5..e83638c 100644 --- a/README.md +++ b/README.md @@ -1,130 +1,12 @@ [![GitHub stars](https://img.shields.io/github/stars/northsea4/mdcx-docker.svg?style=flat&label=Stars&maxAge=3600)](https://GitHub.com/northsea4/mdcx-docker) [![GitHub release](https://img.shields.io/github/release/northsea4/mdcx-docker.svg?style=flat&label=Release)](https://github.com/northsea4/mdcx-docker/releases/tag/latest) -👇🏻👇🏻👇🏻👇🏻👇🏻👇🏻👇🏻👇🏻👇🏻👇🏻👇🏻👇🏻👇🏻👇🏻👇🏻👇🏻👇🏻 +# MDCx Docker -📢 上游源码项目已更改为[sqzw-x/mdcx](https://github.com/sqzw-x/mdcx)，请阅读下面的[更改新源码后的更新说明](https://github.com/northsea4/mdcx-docker#更改新源码后的更新说明)。 -👆🏻👆🏻👆🏻👆🏻👆🏻👆🏻👆🏻👆🏻👆🏻👆🏻👆🏻👆🏻👆🏻👆🏻👆🏻👆🏻👆🏻 +📢 上游源码项目已更改为 [sqzw-x/mdcx](https://github.com/sqzw-x/mdcx)。 ---- - -## 更改新源码后的更新说明 -由于上游源码变更，本项目也做了相应的调整。如果需要使用`20231014`之后的版本，请参考以下说明进行更新。 - -### 建议的操作 -直接部署新容器，然后将旧容器的配置文件等数据复制到新容器目录中。 - -如果想更新已有的容器，请参考下面的说明。 - -### builtin镜像 -即`mdcx-builtin-gui-base`和`mdcx-builtin-webtop-base`镜像。 - -简单来说，拉取新版镜像，然后重新部署即可。 - -> 注意`.env`里的`MDCX_BUILTIN_IMAGE_TAG`应该是`latest`或者最新的版本号。 - -> 建议先备份配置文件等数据，以免部署失败或未知问题导致数据丢失。 - - docker-compose方式，适用于`mdcx-builtin-gui-base`和`mdcx-builtin-webtop-base` -```shell -cd /path/to/mdcx-docker -# 拉取新版镜像 -docker-compose pull -# 重新部署 -docker-compose up -d -``` - -docker-cli方式，适用于`mdcx-builtin-gui-base` -```shell -cd /path/to/mdcx-docker -# 拉取新版镜像 -docker pull stainless403/mdcx-builtin-gui-base:latest -# 停止并删除容器，容器名称请根据实际情况修改 -docker stop mdcx_builtin_gui -docker rm mdcx_builtin_gui -# 重新部署，此处省略具体命令，请根据部署文档执行相关命令 -docker run ... -``` - -docker-cli方式，适用于`mdcx-builtin-webtop-base` -```shell -cd /path/to/mdcx-docker -# 拉取新版镜像 -docker pull stainless403/mdcx-builtin-webtop-base:latest -# 停止并删除容器，容器名称请根据实际情况修改 -docker stop mdcx_builtin_webtop -docker rm mdcx_builtin_webtop -# 重新部署，此处省略具体命令，请根据部署文档执行相关命令 -docker run ... -``` +👉🏻 如果您当前使用的是`20231014`或之前的版本，请阅读 [更改新源码后的更新说明](https://github.com/northsea4/mdcx-docker/blob/dev/docs/about-new-src.md)。 -### src镜像 -即`mdcx-src-gui-base`和`mdcx-src-webtop-base`镜像。 - -简单来说，下载新版源码，拉取新版镜像，然后重新部署即可。 - -> 注意`.env`里的`MDCX_SRC_IMAGE_TAG`应该是`latest`或者最新的版本号。 - -> 建议先备份配置文件等数据，以免部署失败或未知问题导致数据丢失。 - -#### 下载新版源码 -##### mdcx-src-gui-base -```shell -cd /path/to/mdcx-docker -# 备份旧版源码 -mv app app-bak -# 下载新版`下载源码脚本` -mv update-src.sh update-src.sh-bak -curl -fsSL https://github.com/northsea4/mdcx-docker/raw/main/gui-base/update-src.sh -o update-src.sh -# 下载新版源码 -bash update-src.sh --verbose -``` - -##### mdcx-src-webtop-base -```shell -cd /path/to/mdcx-docker -# 备份旧版源码 -mv app app-bak -# 下载新版`下载源码脚本` -mv update-src.sh update-src.sh-bak -curl -fsSL https://github.com/northsea4/mdcx-docker/raw/main/webtop-base/update-src.sh -o update-src.sh -# 下载新版源码 -bash update-src.sh --verbose -``` - -#### 重新部署 -##### docker-compose方式，适用于`mdcx-src-gui-base`和`mdcx-src-webtop-base` -```shell -cd /path/to/mdcx-docker -# 拉取新版镜像 -docker-compose pull -# 重新部署 -docker-compose up -d -``` - -##### docker-cli方式，适用于`mdcx-src-gui-base` -```shell -cd /path/to/mdcx-docker -# 拉取新版镜像 -docker pull stainless403/mdcx-src-gui-base:latest -# 停止并删除容器，容器名称请根据实际情况修改 -docker stop mdcx_src_gui -docker rm mdcx_src_gui -# 重新部署，此处省略具体命令，请根据部署文档执行相关命令 -docker run ... -``` - -##### docker-cli方式，适用于`mdcx-src-webtop-base` -```shell -cd /path/to/mdcx-docker -# 拉取新版镜像 -docker pull stainless403/mdcx-src-webtop-base:latest -# 停止并删除容器，容器名称请根据实际情况修改 -docker stop mdcx_src_webtop -docker rm mdcx_src_webtop -# 重新部署，此处省略具体命令，请根据部署文档执行相关命令 -docker run ... -``` --- @@ -169,6 +51,8 @@ mkdir -p $MDCX_DOCKER_DIR && cd $MDCX_DOCKER_DIR mkdir -p mdcx-config logs data # 必须：配置文件目录标记文件 echo "/mdcx-config/config.ini" > mdcx-config/MDCx.config +# 确保有config.ini文件 +touch mdcx-config/config.ini docker run -d --name mdcx \ -p 5800:5800 `#Web访问端口` \ @@ -200,6 +84,8 @@ mkdir -p $MDCX_DOCKER_DIR && cd $MDCX_DOCKER_DIR mkdir -p mdcx-config logs data # 必须：配置文件目录标记文件 echo "/mdcx-config/config.ini" > mdcx-config/MDCx.config +# 确保有config.ini文件 +touch mdcx-config/config.ini docker run -d --name mdcx \ -p 3000:3000 `#Web访问端口` \ diff --git a/docs/about-new-src.md b/docs/about-new-src.md new file mode 100644 index 0000000..adf2642 --- /dev/null +++ b/docs/about-new-src.md @@ -0,0 +1,117 @@ +## 更改新源码后的更新说明 +由于上游源码变更，本项目也做了相应的调整。如果需要使用`20231014`之后的版本，请参考以下说明进行更新。 + +### 建议的操作 +直接部署新容器，然后将旧容器的配置文件等数据复制到新容器目录中。 + +如果想更新已有的容器，请参考下面的说明。 + +### builtin镜像 +即`mdcx-builtin-gui-base`和`mdcx-builtin-webtop-base`镜像。 + +简单来说，拉取新版镜像，然后重新部署即可。 + +> 注意`.env`里的`MDCX_BUILTIN_IMAGE_TAG`应该是`latest`或者最新的版本号。 + +> 建议先备份配置文件等数据，以免部署失败或未知问题导致数据丢失。 + + docker-compose方式，适用于`mdcx-builtin-gui-base`和`mdcx-builtin-webtop-base` +```shell +cd /path/to/mdcx-docker +# 拉取新版镜像 +docker-compose pull +# 重新部署 +docker-compose up -d +``` + +docker-cli方式，适用于`mdcx-builtin-gui-base` +```shell +cd /path/to/mdcx-docker +# 拉取新版镜像 +docker pull stainless403/mdcx-builtin-gui-base:latest +# 停止并删除容器，容器名称请根据实际情况修改 +docker stop mdcx_builtin_gui +docker rm mdcx_builtin_gui +# 重新部署，此处省略具体命令，请根据部署文档执行相关命令 +docker run ... +``` + +docker-cli方式，适用于`mdcx-builtin-webtop-base` +```shell +cd /path/to/mdcx-docker +# 拉取新版镜像 +docker pull stainless403/mdcx-builtin-webtop-base:latest +# 停止并删除容器，容器名称请根据实际情况修改 +docker stop mdcx_builtin_webtop +docker rm mdcx_builtin_webtop +# 重新部署，此处省略具体命令，请根据部署文档执行相关命令 +docker run ... +``` + +### src镜像 +即`mdcx-src-gui-base`和`mdcx-src-webtop-base`镜像。 + +简单来说，下载新版源码，拉取新版镜像，然后重新部署即可。 + +> 注意`.env`里的`MDCX_SRC_IMAGE_TAG`应该是`latest`或者最新的版本号。 + +> 建议先备份配置文件等数据，以免部署失败或未知问题导致数据丢失。 + +#### 下载新版源码 +##### mdcx-src-gui-base +```shell +cd /path/to/mdcx-docker +# 备份旧版源码 +mv app app-bak +# 下载新版`下载源码脚本` +mv update-src.sh update-src.sh-bak +curl -fsSL https://github.com/northsea4/mdcx-docker/raw/main/gui-base/update-src.sh -o update-src.sh +# 下载新版源码 +bash update-src.sh --verbose +``` + +##### mdcx-src-webtop-base +```shell +cd /path/to/mdcx-docker +# 备份旧版源码 +mv app app-bak +# 下载新版`下载源码脚本` +mv update-src.sh update-src.sh-bak +curl -fsSL https://github.com/northsea4/mdcx-docker/raw/main/webtop-base/update-src.sh -o update-src.sh +# 下载新版源码 +bash update-src.sh --verbose +``` + +#### 重新部署 +##### docker-compose方式，适用于`mdcx-src-gui-base`和`mdcx-src-webtop-base` +```shell +cd /path/to/mdcx-docker +# 拉取新版镜像 +docker-compose pull +# 重新部署 +docker-compose up -d +``` + +##### docker-cli方式，适用于`mdcx-src-gui-base` +```shell +cd /path/to/mdcx-docker +# 拉取新版镜像 +docker pull stainless403/mdcx-src-gui-base:latest +# 停止并删除容器，容器名称请根据实际情况修改 +docker stop mdcx_src_gui +docker rm mdcx_src_gui +# 重新部署，此处省略具体命令，请根据部署文档执行相关命令 +docker run ... +``` + +##### docker-cli方式，适用于`mdcx-src-webtop-base` +```shell +cd /path/to/mdcx-docker +# 拉取新版镜像 +docker pull stainless403/mdcx-src-webtop-base:latest +# 停止并删除容器，容器名称请根据实际情况修改 +docker stop mdcx_src_webtop +docker rm mdcx_src_webtop +# 重新部署，此处省略具体命令，请根据部署文档执行相关命令 +docker run ... +``` \ No newline at end of file