Merge pull request #574 from DDS-Derek/deploy_docs

docs: docker & docker-compose & local deploy
EstrellaXD · Oct 14, 2023 · a544ef1 · a544ef1
2 parents 49b497c + 1d8c399
commit a544ef1
Show file tree

Hide file tree

Showing 8 changed files with 44 additions and 17 deletions.
diff --git a/docs/deploy/docker-cli.md b/docs/deploy/docker-cli.md
@@ -10,10 +10,8 @@ AutoBangumi 2.6 版本后支持直接在 WebUI 中配置，你可以选择直接
 
 ```shell
 # 使用 bind mount
-mkdir -p AutoBangumi
-cd AutoBangumi
-mkdir -p ./config
-mkdir -p ./data
+mkdir -p ${HOME}/AutoBangumi/{config,data}
+cd ${HOME}/AutoBangumi
 ```
 
 Bind mount 与 Docker volume 二选一
@@ -32,9 +30,13 @@ docker volume create AutoBangumi_data
 ```shell
 docker run -d \
   --name=AutoBangumi \
-  -v ./config:/app/config \
-  -v ./data:/app/data \
+  -v ${HOME}/AutoBangumi/config:/app/config \
+  -v ${HOME}/AutoBangumi/data:/app/data \
   -p 7892:7892 \
+  -e TZ=Asia/Shanghai \
+  -e PUID=1000 \
+  -e PGID=1000 \
+  -e UMASK=022 \
   --network=bridge \
   --dns=8.8.8.8 \
   --restart unless-stopped \

diff --git a/docs/deploy/docker-compose.md b/docs/deploy/docker-compose.md
@@ -24,10 +24,8 @@ docker compose -v
 ### 创建 AutoBangumi及数据 文件夹
 
 ```bash
-mkdir -p AutoBangumi
-cd AutoBangumi
-mkdir -p config # 如果不存在则会报错
-mkdir -p data
+mkdir -p ${HOME}/AutoBangumi/{config,data}
+cd ${HOME}/AutoBangumi
 ```
 
 ### 选项1: 自定义 Docker Compose 配置文件
@@ -49,7 +47,11 @@ services:
       - 223.5.5.5
     network_mode: bridge
     environment:
+      - TZ=Asia/Shanghai
       - AB_METHOD=Advance
+      - PGID=1000
+      - PUID=1000
+      - UMASK=022
 ```
 
 复制上面的内容到 `docker-compose.yml` 文件中。

diff --git a/docs/deploy/dsm.md b/docs/deploy/dsm.md
@@ -34,7 +34,11 @@ services:
       - "./data:/app/data"
     network_mode: bridge
     environment:
+      - TZ=Asia/Shanghai
       - AB_METHOD=Advance
+      - PGID=1000
+      - PUID=1000
+      - UMASK=022
 ```
 
 点击 **下一步**，然后点击 **完成**。
@@ -74,6 +78,7 @@ services:
       - TZ=Asia/Shanghai
       - PGID=1000  #需要自行修改填入
       - PUID=1000  #需要自行修改填入
+      - UMASK=022
       - AB_DOWNLOADER_HOST=127.0.0.1:8989  #建议自行修改端口号
     volumes:
       - /volume1/docker/ab/config:/app/config

diff --git a/docs/deploy/local.md b/docs/deploy/local.md
@@ -27,14 +27,14 @@ cd AutoBangumi
 确认你的电脑本地已经安装了 `python3.10` 以上的版本，以及 `pip` 包管理工具。
 
 ```bash
+cd src
 python3 -m venv env
 python3 pip install -r requirements.txt
 ```
 
 ## 运行 AutoBangumi
 
 ```bash
-cd src
 python3 main.py
 ```
 

diff --git a/docs/deploy/quick-start.md b/docs/deploy/quick-start.md
@@ -10,10 +10,8 @@
 
 ```shell
 # 使用 bind mount
-mkdir "AutoBangumi"
-cd "AutoBangumi"
-mkdir -p ./config
-mkdir -p ./data
+mkdir -p ${HOME}/AutoBangumi/{config,data}
+cd ${HOME}/AutoBangumi
 ```
 
 bind mount 与 Docker volume 二选一
@@ -35,9 +33,13 @@ docker volume create AutoBangumi_data
 ```shell
 docker run -d \
   --name=AutoBangumi \
-  -v ./config:/app/config \
-  -v ./data:/app/data \
+  -v ${HOME}/AutoBangumi/config:/app/config \
+  -v ${HOME}/AutoBangumi/data:/app/data \
   -p 7892:7892 \
+  -e TZ=Asia/Shanghai \
+  -e PUID=1000 \
+  -e PGID=1000 \
+  -e UMASK=022 \
   --network=bridge \
   --dns=8.8.8.8 \
   --restart unless-stopped \
@@ -65,7 +67,11 @@ services:
     dns:
       - 223.5.5.5
     environment:
+      - TZ=Asia/Shanghai
       - AB_METHOD=Advance
+      - PGID=1000
+      - PUID=1000
+      - UMASK=022
 ```
 
 运行以下命令启动容器。

diff --git a/docs/resource/docker-compose/AutoBangumi/docker-compose.yml b/docs/resource/docker-compose/AutoBangumi/docker-compose.yml
@@ -14,4 +14,8 @@ services:
     dns:
       - 223.5.5.5
     environment:
+      - TZ=Asia/Shanghai
       - AB_METHOD=Advance
+      - PGID=1000 #需要自行修改填入
+      - PUID=1000 #需要自行修改填入
+      - UMASK=022
diff --git a/docs/resource/docker-compose/qBittorrent+AutoBangumi/docker-compose.yml b/docs/resource/docker-compose/qBittorrent+AutoBangumi/docker-compose.yml
@@ -30,7 +30,11 @@ services:
       - 223.5.5.5
     restart: unless-stopped
     environment:
+      - TZ=Asia/Shanghai
       - AB_METHOD=Advance
+      - PGID=1000 #需要自行修改填入
+      - PUID=1000 #需要自行修改填入
+      - UMASK=022
       - AB_DOWNLOADER_HOST=127.0.0.1:8989 #如8989被修改,请修改为相应端口
       - AB_DOWNLOADER_USERNAME=admin
       - AB_DOWNLOADER_PASSWORD=adminadmin

diff --git a/docs/resource/unraid.xml b/docs/resource/unraid.xml
@@ -27,4 +27,8 @@
   <Config Name="WebUI" Target="7892" Default="7892" Mode="tcp" Description="" Type="Port" Display="always" Required="false" Mask="false">7892</Config>
   <Config Name="Config" Target="/app/config" Default="" Mode="rw" Description="" Type="Path" Display="always" Required="false" Mask="false">/mnt/user/appdata/AutoBangumi/config</Config>
   <Config Name="Data" Target="/app/data" Default="" Mode="rw" Description="" Type="Path" Display="always" Required="false" Mask="false">/mnt/user/appdata/AutoBangumi/data</Config>
+  <Config Name="PUID" Target="PUID" Default="99" Mode="" Description="" Type="Variable" Display="always" Required="false" Mask="false"/>
+  <Config Name="PGID" Target="PGID" Default="100" Mode="" Description="" Type="Variable" Display="always" Required="false" Mask="false"/>
+  <Config Name="UMASK" Target="UMASK" Default="022" Mode="" Description="" Type="Variable" Display="always" Required="false" Mask="false"/>
+  <Config Name="TZ" Target="TZ" Default="Asia/Shanghai" Mode="" Description="" Type="Variable" Display="always" Required="false" Mask="false"/>
 </Container>