doc: Update README about forge

Signed-off-by: 陳鈞 <jim60105@gmail.com>
jim60105 · Mar 13, 2024 · fe5bc56 · fe5bc56
1 parent 96c268b
commit fe5bc56
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -61,28 +61,27 @@ Output images will be stored at directory `./data/output` for default.
 
 ## 🔀 Switch between different versions/branches
 
-### Program Versions Corresponding to Image Tags
+### Docker Image Tags
 
-The program versions of the docker image tag corresponds to the non-RC version number from `v1.6.1` and its `dev` branch in [AUTOMATIC1111/stable-diffusion-webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui), as well as the `main` branch of [lllyasviel/stable-diffusion-webui-forge](https://github.com/lllyasviel/stable-diffusion-webui-forge).
+The docker image tag corresponds to the non-RC version number from `v1.6.1` and its `dev` branch in [AUTOMATIC1111/stable-diffusion-webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui).
 
 | Image tag    | Code version                                                                                                                |
 |--------------|-----------------------------------------------------------------------------------------------------------------------------|
 | dev (latest) | [AUTOMATIC1111/stable-diffusion-webui dev branch](https://github.com/AUTOMATIC1111/stable-diffusion-webui/tree/dev)         |
-| forge        | [lllyasviel/stable-diffusion-webui-forge main branch](https://github.com/lllyasviel/stable-diffusion-webui-forge/tree/main) |
 | v1.6.1       | [AUTOMATIC1111/stable-diffusion-webui v1.6.1 tag](https://github.com/AUTOMATIC1111/stable-diffusion-webui/tree/v1.6.1)      |
 | v1.7.0       | [AUTOMATIC1111/stable-diffusion-webui v1.7.0 tag](https://github.com/AUTOMATIC1111/stable-diffusion-webui/tree/v1.7.0)      |
 | v1.8.0       | [AUTOMATIC1111/stable-diffusion-webui v1.8.0 tag](https://github.com/AUTOMATIC1111/stable-diffusion-webui/tree/v1.8.0)      |
 
 You can check all available tags on [ghcr.io](https://github.com/jim60105/docker-stable-diffusion-webui/pkgs/container/stable-diffusion-webui)
 
-### Modify the image tag in the docker-compose.yml
+### Specify the image in the docker-compose.yml
 
 Change the tag after `ghcr.io/jim60105/stable-diffusion-webui` in the [`image` field of `docker-compose.yml`](https://github.com/jim60105/docker-stable-diffusion-webui/blob/f41cfe8458a3b66d8cbdeff14284bbcd91b73959/docker-compose.yml#L7) to your desired version.
 
-For example, if you want to use the `forge` version, you should modify it to:
+For example, if you want to use the `v1.7.0` version, you should modify it to:
 
 ```yml
-image: ghcr.io/jim60105/stable-diffusion-webui:forge
+image: ghcr.io/jim60105/stable-diffusion-webui:v1.7.0
 ```
 
 Then restart the service using the following command:
@@ -91,6 +90,25 @@ Then restart the service using the following command:
 docker compose down && docker compose up -d
 ```
 
+### Use the forge version
+
+There's a special version `forge` which is based on the `main` branch of [lllyasviel/stable-diffusion-webui-forge](https://github.com/lllyasviel/stable-diffusion-webui-forge).
+
+| Image tag | Code version                                                                                                                |
+|-----------|-----------------------------------------------------------------------------------------------------------------------------|
+| forge     | [lllyasviel/stable-diffusion-webui-forge main branch](https://github.com/lllyasviel/stable-diffusion-webui-forge/tree/main) |
+
+You can use it with the `docker-compose-forge.yml` file.
+
+```bash
+docker compose -f docker-compose-forge.yml up -d
+```
+
+> [!NOTE]  
+> Notice that they used the same port `7860`, so you can't run them at the same time.  
+> Please stop the running service before starting another one.  
+> ![image](https://github.com/jim60105/docker-stable-diffusion-webui/assets/16995691/f7aecb66-5416-4806-90d8-b6c6be6c1bad)
+
 ## 🛠️ Build instructions
 
 > [!IMPORTANT]  

diff --git a/README.zh.md b/README.zh.md
@@ -61,28 +61,27 @@
 
 ## 🔀 切換版本/分支
 
-### 映像標籤對應的程式版本
+### Docker Image Tags
 
-本專案的 docker image tag 對應於 [AUTOMATIC1111/stable-diffusion-webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui) 從 `v1.6.1` 起的非 RC 版本號和它的 `dev` 分支，以及 [lllyasviel/stable-diffusion-webui-forge](https://github.com/lllyasviel/stable-diffusion-webui-forge) 的 `main` 分支。
+Docker image tag 對應於 [AUTOMATIC1111/stable-diffusion-webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui) 從 `v1.6.1` 起的非 RC 版本號和它的 `dev` 分支。
 
 | Image tag    | Code version                                                                                                                |
 |--------------|-----------------------------------------------------------------------------------------------------------------------------|
 | dev (latest) | [AUTOMATIC1111/stable-diffusion-webui dev branch](https://github.com/AUTOMATIC1111/stable-diffusion-webui/tree/dev)         |
-| forge        | [lllyasviel/stable-diffusion-webui-forge main branch](https://github.com/lllyasviel/stable-diffusion-webui-forge/tree/main) |
 | v1.6.1       | [AUTOMATIC1111/stable-diffusion-webui v1.6.1 tag](https://github.com/AUTOMATIC1111/stable-diffusion-webui/tree/v1.6.1)      |
 | v1.7.0       | [AUTOMATIC1111/stable-diffusion-webui v1.7.0 tag](https://github.com/AUTOMATIC1111/stable-diffusion-webui/tree/v1.7.0)      |
 | v1.8.0       | [AUTOMATIC1111/stable-diffusion-webui v1.8.0 tag](https://github.com/AUTOMATIC1111/stable-diffusion-webui/tree/v1.8.0)      |
 
 你可以在 [ghcr.io](https://github.com/jim60105/docker-stable-diffusion-webui/pkgs/container/stable-diffusion-webui) 上查看所有可用的標籤。
 
-### 修改 docker-compose.yml 中的映像標籤
+### 指定 docker-compose.yml 中的映像標籤
 
 修改 [`docker-compose.yml` 中的 `image` 欄位](https://github.com/jim60105/docker-stable-diffusion-webui/blob/f41cfe8458a3b66d8cbdeff14284bbcd91b73959/docker-compose.yml#L7)，將 `ghcr.io/jim60105/stable-diffusion-webui` 後面的標籤改為你想要的版本。
 
-舉例來說，若你想要使用 `forge` 版本，你應該修改成:
+舉例來說，若你想要使用 `v1.7.0` 版本，你應該修改成:
 
 ```yml
-image: ghcr.io/jim60105/stable-diffusion-webui:forge
+image: ghcr.io/jim60105/stable-diffusion-webui:v1.7.0
 ```
 
 然後使用以下指令重新啟動服務:
@@ -91,6 +90,25 @@ image: ghcr.io/jim60105/stable-diffusion-webui:forge
 docker compose down && docker compose up -d
 ```
 
+### 使用 forge 版本
+
+有一個特殊版本 `forge`，它是基於 [lllyasviel/stable-diffusion-webui-forge](https://github.com/lllyasviel/stable-diffusion-webui-forge) 的 `main` 分支。
+
+| Image tag | Code version                                                                                                                |
+|-----------|-----------------------------------------------------------------------------------------------------------------------------|
+| forge     | [lllyasviel/stable-diffusion-webui-forge main branch](https://github.com/lllyasviel/stable-diffusion-webui-forge/tree/main) |
+
+請透過 `docker-compose-forge.yml` 使用它。
+
+```bash
+docker compose -f docker-compose-forge.yml up -d
+```
+
+> [!NOTE]  
+> 請注意，由於它們使用相同的埠號 `7860`，因此不能在同一時間運行。  
+> 請先停止運行中的服務再啟動另一個服務。  
+> ![image](https://github.com/jim60105/docker-stable-diffusion-webui/assets/16995691/f7aecb66-5416-4806-90d8-b6c6be6c1bad)
+
 ## 🛠️ 建置指南
 
 > [!IMPORTANT]