| 1 | # Docker
|
| 2 |
|
| 3 | 您也可以使用 [Docker](https://www.docker.com/) 來執行 `dmhy-subscribe`。在無法透過 npm 安裝、設定過於複雜、或有其他支援問題的作業系統中使用 `dmhy-subscribe`。
|
| 4 |
|
| 5 | 專案中的 Docker 設定整合了 `dmhy-subscribe` 、 `cron`(排程) 和 `aria2`(下載器) 的功能。
|
| 6 |
|
| 7 | * [Requirements 依賴軟體](#Requirements-依賴軟體)
|
| 8 | * [Installation 安裝方式](#Installation-安裝方式)
|
| 9 | * [dmhy-subscribe 個人化設定](#dmhy-subscribe-個人化設定)
|
| 10 | * [Aria2 設定](#Aria2-設定)
|
| 11 | * [Docker Compose 設定](#Docker-Compose-設定)
|
| 12 | * [重要設定](#重要設定)
|
| 13 | * [執行方式](#執行方式)
|
| 14 |
|
| 15 | ## Requirements 依賴軟體
|
| 16 |
|
| 17 | * Docker
|
| 18 | * [Ubuntu](https://docs.docker.com/install/linux/docker-ce/ubuntu/)
|
| 19 | * [MacOS](https://docs.docker.com/docker-for-mac/install/)
|
| 20 | * [Windows](https://docs.docker.com/docker-for-windows/install/)
|
| 21 | * [Synology NAS](https://www.synology.com/zh-tw/dsm/packages/Docker)
|
| 22 | * 其他 Linux 系統族繁不及備載，敬請自行研究。
|
| 23 | * [Docker Compose](https://docs.docker.com/compose/install/) (optional)
|
| 24 |
|
| 25 | ## Installation 安裝方式
|
| 26 |
|
| 27 | 下載本專案原始碼後，進入 `docker` 目錄，可以用以下方式建立 Docker Image:
|
| 28 |
|
| 29 | ```sh
|
| 30 | # 直接從 DockerHub 上下載 Image
|
| 31 | docker pull wabilin/dmhy-subscribe
|
| 32 | docker tag wabilin/dmhy-subscribe dmhy-subscribe
|
| 33 |
|
| 34 | # 或自行 build image
|
| 35 | docker build . -t dmhy-subscribe
|
| 36 | ```
|
| 37 |
|
| 38 | 執行 `setup.bash` 建立必要之檔案環境與設定檔。
|
| 39 |
|
| 40 | 這個腳本會建立 `data` 資料夾，包含了 `dmhy-subscribe` 、 `cron` 和 `aria2` 的設定檔。
|
| 41 |
|
| 42 | ```sh
|
| 43 | ./setup.bash
|
| 44 | ```
|
| 45 |
|
| 46 | 可以直接使用或參考下面設定說明依個人需求修改。
|
| 47 |
|
| 48 | ## dmhy-subscribe 個人化設定
|
| 49 |
|
| 50 | 在 `setup.bash` 內可以設定個人化參數
|
| 51 |
|
| 52 | ```sh
|
| 53 | # dmhy 的語系設定
|
| 54 | export LANG='C.UTF-8'
|
| 55 | # LANG='zh_TW.utf8' # 中文
|
| 56 |
|
| 57 | # cron 的排程週期設定
|
| 58 | export CRON_FREQ='0 * * * *'
|
| 59 | ```
|
| 60 |
|
| 61 | ## Aria2 設定
|
| 62 |
|
| 63 | 我們使用 [docker-aria2-with-webui](https://github.com/abcminiuser/docker-aria2-with-webui) 作為下載容器。如果要修改相關設定請參考連結說明。
|
| 64 |
|
| 65 | 為相容 MacOS，預設 `file-allocation` 為 `prealloc`，若系統允許可以更改 `data/aria2` 中的設定檔為更高速的 `falloc`。
|
| 66 |
|
| 67 | ## Docker Compose 設定
|
| 68 |
|
| 69 | 可以修改 `docker-compose.yml` 以進行設定。
|
| 70 |
|
| 71 | ### 重要設定
|
| 72 |
|
| 73 | 請使用 `id` 指令查看自己的 `UID` 和 `GID`，並將 `docker-compose.yml` 中的 `PUID` 和 `PGID` 分別設定為個人之 `UID` 與 `GID` ，以確保 aria2 有正確的讀寫權限。
|
| 74 |
|
| 75 | `setup.bash` 會試著設定目前使用者的 `UID` 及 `GID`。
|
| 76 |
|
| 77 | ## 執行方式
|
| 78 |
|
| 79 | 啟動 dmhy-subscribe 背景服務:
|
| 80 |
|
| 81 | ```sh
|
| 82 | # 執行服務
|
| 83 | docker-compose up -d
|
| 84 |
|
| 85 | # 暫停服務
|
| 86 | docker-compose stop
|
| 87 |
|
| 88 | # 完全清除容器
|
| 89 | docker-compose down
|
| 90 | ```
|
| 91 |
|
| 92 | 在啟用服務之後，可以在 `http://localhost:6880` 看到 aria2 的 WebUI。
|
| 93 |
|
| 94 | 若發現有連線到 RPC 伺服器但出現警告，是因為 WebUI 有設定 token，預設為 `dockerdmhy` (可在 `docker-compose.yml` 設定)，可以到 **設定>連線設定>密碼令牌** 輸入
|
| 95 |
|
| 96 | 要執行 dmhy 指令可以透過以下方式:
|
| 97 |
|
| 98 | ```sh
|
| 99 | # 進入 container 進行操作
|
| 100 | docker exec -it dmhy sh
|
| 101 |
|
| 102 | # 或直接傳送命令
|
| 103 | # 以 dmhy ls 為例:
|
| 104 | docker exec dmhy dmhy ls
|
| 105 | ```
|