Skip to content

Latest commit

 

History

History
207 lines (144 loc) · 11.7 KB

README.zh.md

File metadata and controls

207 lines (144 loc) · 11.7 KB
Raw

docker-stable-diffusion-webui

中文 | English

CodeFactor DeepSource GitHub Workflow Status (with event)

又一個來自社群的 AUTOMATIC1111/Stable Diffusion web UI Docker 映像。

這個映像的主要設計理念是保持 小巧並遵循最佳實踐。成功地將大小控制在約 10 GB 左右，相比其他現有的解決方案節省了大約 1/3 的容量。

這個尺寸使我能夠在 GitHub free runner 上以 CI workflow 持續地自動化建置 docker 映像。你可以從 ghcr 上拉取我預先建置的映像，而不必自己在本地建置以節省時間！

請由 GitHub 取得 Dockerfile 或者從 ghcr.io 拉取映像。

🚀 準備好讓你的 Docker 支援 GPU

Windows

只要完成安裝 Docker Desktop、CUDA Toolkit、NVIDIA Windows Driver，並確保 Docker 是使用 WSL2 運行，那麼你就準備好了。

以下官方文件提供參考
https://docs.nvidia.com/cuda/wsl-user-guide/index.html#nvidia-compute-software-support-on-wsl-2 https://docs.docker.com/desktop/wsl/use-wsl/#gpu-support

Linux, OSX

請安裝 NVIDIA GPU 驅動程式
https://docs.nvidia.com/datacenter/tesla/tesla-installation-notes/index.html

並按照此指南安裝 NVIDIA Container Toolkit
https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html

🖥️ 運行專案

  1. 將儲存庫 clone 到本地並導航到該目錄。

    git clone https://github.com/jim60105/docker-stable-diffusion-webui.git
cd docker-stable-diffusion-webui

  2. 啟動服務並等待載入。

    docker compose up -d

  3. 在 http://localhost:7860 訪問 Web UI。 (瀏覽器不會自動啟動！)

模型和設置將被儲存在目錄 ./data
在預設情況下，輸出的圖片將儲存在 ./data/output

🔀 切換版本/分支

Docker Image Tags

Docker image tag 對應於 AUTOMATIC1111/stable-diffusion-webui 從 v1.6.1 起的非 RC 版本號和它的 dev 分支。dev 標籤每週會自動重建以跟上最新的變更。

Image tag Code version
dev (latest) AUTOMATIC1111/stable-diffusion-webui dev branch
v1.6.1 AUTOMATIC1111/stable-diffusion-webui v1.6.1 tag
v1.7.0 AUTOMATIC1111/stable-diffusion-webui v1.7.0 tag
v1.8.0 AUTOMATIC1111/stable-diffusion-webui v1.8.0 tag
v1.9.4 AUTOMATIC1111/stable-diffusion-webui v1.9.4 tag
v1.10.1 AUTOMATIC1111/stable-diffusion-webui v1.10.1 tag

你可以在 ghcr.io 查看所有可用的標籤。

指定 docker-compose.yml 中的映像標籤

修改 docker-compose.yml 中的 image 欄位，將 ghcr.io/jim60105/stable-diffusion-webui 後面的標籤改為你想要的版本。

舉例來說，若你想要使用 v1.8.0 版本，你應該修改成:

image: ghcr.io/jim60105/stable-diffusion-webui:v1.8.0

然後使用以下指令重新啟動服務:

docker compose down && docker compose up -d

使用 forge 版本

有一個特殊版本 forge，它是基於 lllyasviel/stable-diffusion-webui-forge 的 main 分支。forge 標籤每週會自動重建以跟上最新的變更。

Image tag Code version
forge lllyasviel/stable-diffusion-webui-forge main branch
forge-previous lllyasviel/stable-diffusion-webui-forge previous tag

請透過 docker-compose.forge.yml 使用它。

docker compose -f docker-compose.forge.yml up -d

Note

請注意，由於它們使用相同的埠號 7860，因此不能在同一時間運行。
請先停止運行中的服務再啟動另一個服務。
image

runtime-deps 版本

Note

你可以使用以下建置參數來建置它: SKIP_REQUIREMENTS_INSTALL=true

在一些近期的版本會有 runtime-deps 映像可供選擇，例如 v1.8.0-runtime-deps、v1.9.4-runtime-deps 和 forge-runtime-deps。

這些映像中不包含 pip 套件依賴，相反地，它們將在首次啟動時進行下載和安裝。

第一次啟動時需要等待一段時間，但這能讓我把映像縮小至 1.3GB！

如果這符合您的需求，可以考慮使用它們。

Tip

它有一個特殊的使用方式： 透過 volume 保存並重複利用 /home/1001/.local 資料夾。
這就像是在不同的 Python 應用程式之間共用同一個環境。
我不推薦一般使用者採用這種方法...你必須完全清楚自己在做什麼。
對於進階使用者，請參考這個 commit 以查看更多資訊。
感謝社群提出這個驚人的想法！😆

🛠️ 建置指南

Important

Git clone 儲存庫時使用 --recursive 來包含子模組：
git clone --recursive https://github.com/jim60105/docker-stable-diffusion-webui.git

docker compose up -d --build

Note

若你使用舊版的 Docker 客戶端，建議在建置映像時啟用 BuildKit 模式。這是因為我使用了 COPY --link 功能，該功能在 Buildx v0.8 中被導入並可增強建置效能。
隨著 Docker Engine 23.0 和 Docker Desktop 4.19 的推出，Buildx 已成為預設的建置客戶端。因此，在使用最新版本時不必擔心這個問題喔！

🔄 從現有的設定檔遷移

  1. 編輯你現有的 config.json，將所有路徑修改為在 /data 之下，舉例來說：

    {
    "outdir_samples": "",
    "outdir_txt2img_samples": "/data/output/txt2img-images",
    "outdir_img2img_samples": "/data/output/img2img-images",
    "outdir_extras_samples": "/data/output/extras-images",
    "outdir_grids": "",
    "outdir_txt2img_grids": "/data/output/txt2img-grids",
    "outdir_img2img_grids": "/data/output/img2img-grids",
    "outdir_save": "/data/log/images",
    "outdir_init_images": "/data/output/init-images",
}

  2. 將 config.json 放置在 data 目錄下。

  3. 將模型和其他現有資料放入 data 目錄下相應的資料夾中。

  4. 請修正 data 資料夾中所有文件的權限。

    docker run -v ".:/app" -it busybox sh -c "chown -R 1001:0 /app/data && chmod -R 775 /app/data"

Note

這個指令使用 busybox 修改了 data 目錄的擁有者群組為 0 (root group)，並授予了 群組寫入權限。這符合 OpenShift 最佳實踐的 支援以任意 uid 運行。

Warning

這個映像遵循最佳實踐，使用非 root 用戶運行 並 限制非必要路徑的寫入權限。除非進行了適當的修改，否則你可能無法將文件儲存在 /data 路徑之外。

📝 LICENSE

Note

主要程式 AUTOMATIC1111/stable-diffusion-webui 是根據 AGPL-3.0 授權 發佈的。 請查閱他們的儲存庫以獲取源程式碼和許可證。 以下是此儲存庫中 Dockerfiles 和 CI workflow 的許可證。

agplv3

GNU AFFERO GENERAL PUBLIC LICENSE Version 3

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Caution

AGPLv3 授權的 Dockerfile 代表你 必須 以同樣的許可證發佈程式，若是你：

  • 重新發佈映像檔(若你沒有進行任何程式碼更改，則可以簡單地指向此 GitHub 儲存庫)
  • 發佈使用了此儲存庫程式碼的映像。
  • 或者發佈基於此映像的映像(在你的 Dockerfile 中使用 FROM ghcr.io/jim60105/stable-diffusion-webui)

"發佈"意味著使該映像可供其他人下載，通常是將其推送到公開倉庫。 若僅用於個人目的，這部份不會對你產生影響。

有關詳細信息，請參閱 LICENSE。