Skip to content

Latest commit

 

History

History
237 lines (187 loc) · 8.23 KB

mdcx-src.md

File metadata and controls

237 lines (187 loc) · 8.23 KB

GitHub stars GitHub release Docker Pulls

0. 关于镜像

stainless403/mdcx-src-gui-base，是基于 jlesage/baseimage-gui 构建的适合python+QT5应用运行的镜像。

优点是轻量，缺点是只支持通过网页查看，且没有文件管理。

1. mdcx-src示例

使用脚本部署

复制以下命令到终端运行，第一步选择模版 3) mdcx-src-gui-base ，然后根据提示输入几个参数即可完成部署。

使用curl：

bash -c "$(curl -fsSL https://raw.githubusercontent.com/northsea4/mdcx-docker/main/install.sh)"

使用wget：

bash -c "$(wget https://raw.githubusercontent.com/northsea4/mdcx-docker/main/install.sh -O -)"

以下的步骤是手动部署的详细说明，即使使用了脚本部署，也请务必阅读一下了解更多细节，如安全、更新等。

stainless403/mdcx-src-gui-base镜像没有内置MDCx，如果想使用内置的，请使用stainless403/mdcx-builtin-gui-base镜像(🔗 查看部署说明)。

Tips: mdcx-src-gui-base支持运行已编译的应用，但mdcx-builtin-gui-base默认情况下不能运行应用源码。

下面主要讲述docker-compose的部署方式。docker-run的方式也有简单的示例。

1.1 准备项目目录

下载 示例项目，解压到合适的位置后，进入项目目录，之后的操作，如无特别说明，都是在该目录(假设名为mdcx-docker)内进行。

1.2 准备应用源码

  1. 执行update-src.sh即可自动下载源码到app目录。
./update-src.sh

整个项目的结构大致如下：

mdcx-docker
  |-- app   ------应用源码目录
    |-- libs
    |-- resources
    |-- src
    |-- main.py
    |-- requirements.txt
    |-- setup.py
    ...
  |-- data ------容器系统数据
    ...
  |-- mdcx-config --------应用配置文件目录
    |-- config.ini
    |-- MDCx.config
  |-- logs --------应用日志目录
    |-- 2023-02-04-01-15-00.txt
  |-- .env ------环境变量文件
  |-- .env.sample ------环境变量示例文件
  |-- .env.versions ------应用版本文件
  |-- mdcx-builtin.sample.yml
  |-- mdcx-src.sample.yml -------容器部署配置示例
  |-- docker-compose.yml -------容器部署配置
  |-- update-app.sh

1.3 设置参数

编辑.env文件，按需修改。 文件里每个参数都有具体的说明，.env.sample文件里可以查看原始的数值。

一般需要修改的参数：VNC_PASSWORD, WEB_PORT, VNC_PORT, USER_ID, GROUP_ID

参数名称 说明 默认值 必填
VNC_PASSWORD 访问密码，如不需要，留空。如果有在公网远程访问的需求，建议设置 无 否
WEB_PORT 网页访问端口 5800 是
VNC_PORT VNC监听端口 5900 是
USER_ID 运行应用的用户ID，通过id -u命令可以查看当前用户ID，id -u user1则可以查看用户user1的用户ID 0 是
GROUP_ID 运行应用的用户组ID，通过id -g命令可以查看当前用户组ID，id -g user1则可以查看用户user1的用户组ID 0 是
DISPLAY_WIDTH 应用窗口宽度 1200 否
DISPLAY_HEIGHT 应用窗口高度 750 否

1.4 完整docker-compose.yml示例

version: '3'

services:
  mdcx:
    image: stainless403/mdcx-src-gui-base:${MDCX_SRC_IMAGE_TAG}
    container_name: ${MDCX_CONTAINER_NAME}
    env_file:
      - .env
    volumes:
      # 系统数据目录
      - ./data:/config

      # 源码目录
      - ./app:/app

      # 配置文件目录
      - ./mdcx-config:/mdcx-config
      # `配置文件目录`标记文件
      - ./mdcx-config/MDCx.config:/app/MDCx.config

      # 日志目录
      - ./logs:/app/Log

      # 影片目录
      - /path/to/movies:/movies
    ports:
      - ${WEB_PORT}:5800
      - ${VNC_PORT}:5900
    restart: unless-stopped
    network_mode: bridge
    stdin_open: true

1.5 运行容器

docker-compose up -d

# 查看容器日志，容器名称请根据实际情况修改
# docker logs -f mdcx_gui
# 或者
# docker-compose logs -f

首次运行时会自动安装依赖，并在app目录 和 容器内的/tmp目录生成一个名为.mdcx_initialized的标记文件。 当启动脚本检查到这两个文件同时存在时，就认为已安装过依赖。而当重建容器时，由于新容器里没有标记文件，所以会进行一次安装依赖的处理。 如果由于网络等原因没有成功安装依赖，但.mdcx_initialized又已生成，删除app目录下的.mdcx_initialized文件即可(容器内的标记文件不需要删除)。

1.6 使用

假设服务器IP为192.168.1.100，使用默认端口5800，则访问地址为：http://192.168.1.100:5800

1.7 docker run运行示例

/path/to/ 替换为你实际的路径。

# 选一个合适的目录
MDCX_DOCKER_DIR=/path/to/mdcx-docker
mkdir -p $MDCX_DOCKER_DIR && cd $MDCX_DOCKER_DIR
# 必须：相关数据或日志目录
mkdir -p app mdcx-config logs data
# 必须：配置文件目录标记文件
echo "/mdcx-config/config.ini" > mdcx-config/MDCx.
# 确保有config.ini文件
touch mdcx-config/config.ini

# ！！！下载源码！！！最方便的就是使用`update-src.sh`脚本，自动下载源码文件到`app`目录
./update-src.sh

docker run -d --name mdcx \
  -p 5800:5800 `#Web访问端口` \
  -p 5900:5900 \
  -v $(pwd)/app:/app `#源码目录，请确保已下载好源码` \
  -v $(pwd)/data:/config `#容器系统数据` \
  -v $(pwd)/mdcx-config:/mdcx-config `#配置文件目录` \
  -v $(pwd)/mdcx-config/MDCx.config:/app/MDCx.config `#配置文件目录标记文件` \
  -v $(pwd)/logs:/app/Log `#日志目录` \
  -v /volume2:/volume2 `#影片目录` \
  -e TZ=Asia/Shanghai \
  -e DISPLAY_WIDTH=1200 \
  -e DISPLAY_HEIGHT=750 \
  -e VNC_PASSWORD=  `#查看密码` \
  -e USER_ID=$(id -u) `#运行应用的用户ID` \
  -e GROUP_ID=$(id -g) `#运行应用的用户组ID` \
  --restart unless-stopped \
  stainless403/mdcx-src-gui-base:latest

2. 更新

2.0 mdcx-src更新应用

cd /path/to/mdcx-docker

# 确保有执行权限（执行一次即可）
chmod +x ./update-src.sh

./update-src.sh --verbose

# 完成更新源码之后，重启容器
# docker restart mdcx_src_gui

⚠️ 如果你选择不使用脚本而是手动进行更新，请记得删除app目录下的.mdcx_initialized文件！

2.1 docker-compose方式更新镜像

cd /path/to/mdcx-docker
docker-compose pull
docker-compose up -d

注意，只有使用docker-compose方式部署的才能用该方式更新镜像。 另外其实使用docker-compose方式部署的，也可以使用下面说的watchtower进行更新。

2.2 docker-run方式更新

推荐使用watchtower工具更新。

  1. 一次性更新
docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  containrrr/watchtower \
  --run-once \
  容器名称
  1. 定时任务方式：

个人不太建议自动更新，请自行斟酌。

示例：每天的凌晨2点进行更新

docker run -d --name watchtower-mdcx \
  --restart unless-stopped \
  -v /var/run/docker.sock:/var/run/docker.sock \
  containrrr/watchtower \
  -c  --schedule "0 0 2 * * *" 容器名称

0 0 2 * * * 6个部分分别为： 秒 分 时 日 月 星期

参考：CRON_Expression_Format

取消定时更新：

docker rm -f watchtower-mdcx