chore: update readme

mnb3000 · Mar 19, 2024 · 4189ce9 · 4189ce9
1 parent f86dc6c
commit 4189ce9
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 73 deletions.
diff --git a/.github/workflows/docker-publish-testing.yml b/.github/workflows/docker-publish-testing.yml
@@ -57,4 +57,3 @@ jobs:
           push: true
         env:
           RELEASE: dev-build-${{ github.run_number }}
-          CIVITAI_TOKEN: ${{ secrets.CIVITAI_TOKEN }}
diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml
@@ -86,4 +86,3 @@ jobs:
           push: true
         env:
           RELEASE: ${{jobs.release-on-push.steps.release.outputs.tag_name}}
-          CIVITAI_TOKEN: ${{ secrets.CIVITAI_TOKEN }}
diff --git a/README.md b/README.md
@@ -1,68 +1,59 @@
-# Docker image for A1111 Stable Diffusion Web UI
+# Docker image for A1111 Forge with Deforum, Stable Video Diffusion XT 1.1, Stable Diffusion XL Base/Turbo
+
+> [!IMPORTANT]
+> You need to set `$CIVITAI_TOKEN` environment variable in order for Stable Video Diffusion XT 1.1 to download
 
 ## Installs
 
-* Ubuntu 22.04 LTS
-* CUDA 11.8
-* Python 3.10.12
-* Torch 2.1.2
-* xformers 0.0.23.post1
-* Jupyter Lab
-* [Automatic1111 Stable Diffusion Web UI](
-  https://github.com/AUTOMATIC1111/stable-diffusion-webui-forge) 1.8.0
-* [ControlNet extension](
-  https://github.com/Mikubill/sd-webui-controlnet) v1.1.441
-* [After Detailer extension](
-  https://github.com/Bing-su/adetailer) v24.3.0
-* [ReActor extension](https://github.com/Gourieff/sd-webui-reactor) (replaces roop)
-* [Deforum extension](https://github.com/deforum-art/sd-webui-deforum)
-* [Inpaint Anything extension](https://github.com/Uminosachi/sd-webui-inpaint-anything)
-* [Infinite Image Browsing extension](https://github.com/zanllp/sd-webui-infinite-image-browsing)
-* [CivitAI extension](https://github.com/civitai/sd_civitai_extension)
-* [CivitAI Browser+ extension](https://github.com/BlafKing/sd-civitai-browser-plus)
-* [sd_xl_base_1.0.safetensors](
-  https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0/resolve/main/sd_xl_base_1.0.safetensors)
-* [sd_xl_refiner_1.0.safetensors](
-  https://huggingface.co/stabilityai/stable-diffusion-xl-refiner-1.0/resolve/main/sd_xl_refiner_1.0.safetensors)
-* [sdxl_vae.safetensors](
-  https://huggingface.co/madebyollin/sdxl-vae-fp16-fix/resolve/main/sdxl_vae.safetensors)
-* [inswapper_128.onnx](
-  https://github.com/facefusion/facefusion-assets/releases/download/models/inswapper_128.onnx)
-* [runpodctl](https://github.com/runpod/runpodctl)
-* [OhMyRunPod](https://github.com/kodxana/OhMyRunPod)
-* [RunPod File Uploader](https://github.com/kodxana/RunPod-FilleUploader)
-* [croc](https://github.com/schollz/croc)
-* [rclone](https://rclone.org/)
-
-## Available on RunPod
-
-This image is designed to work on [RunPod](https://runpod.io?ref=2xxro4sy).
-You can use my custom [RunPod template](
-https://runpod.io/console/gpu-cloud?template=ts8ze6urzh&ref=2xxro4sy)
-to launch it on RunPod.
+### Bundled with image
+
+-   Ubuntu 22.04 LTS
+-   CUDA 11.8
+-   Python 3.10.12
+-   Torch 2.1.2
+-   xformers 0.0.23.post1
+-   Jupyter Lab
+-   [Automatic1111 Stable Diffusion Web UI Forge](https://github.com/lllyasviel/stable-diffusion-webui-forge) 1.7.0d
+-   [Deforum Forge extension](https://github.com/deforum-art/sd-forge-deforum)
+-   [Infinite Image Browsing extension](https://github.com/zanllp/sd-webui-infinite-image-browsing)
+-   [CivitAI extension](https://github.com/civitai/sd_civitai_extension)
+-   [CivitAI Browser+ extension](https://github.com/BlafKing/sd-civitai-browser-plus)
+-   [sdxl_vae.safetensors](https://huggingface.co/madebyollin/sdxl-vae-fp16-fix/resolve/main/sdxl_vae.safetensors)
+-   [runpodctl](https://github.com/runpod/runpodctl)
+-   [OhMyRunPod](https://github.com/kodxana/OhMyRunPod)
+-   [RunPod File Uploader](https://github.com/kodxana/RunPod-FilleUploader)
+-   [croc](https://github.com/schollz/croc)
+-   [rclone](https://rclone.org/)
+
+### Downloaded at first launch
+
+-   [sd_xl_base_1.0.safetensors](https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0/resolve/main/sd_xl_base_1.0.safetensors)
+-   [sd_xl_refiner_1.0.safetensors](https://huggingface.co/stabilityai/stable-diffusion-xl-refiner-1.0/resolve/main/sd_xl_refiner_1.0.safetensors)
+-   [stableVideoDiffusion_img2vidXt11.safetensors](https://civitai.com/models/207992)
+-   (Optional, set `ENABLE_SDXL_TURBO=true`) [sd_xl_turbo_1.0.safetensors](https://huggingface.co/stabilityai/sdxl-turbo/resolve/main/sd_xl_turbo_1.0.safetensors)
+
+<!-- ## Available on RunPod -->
+<!---->
+<!-- This image is designed to work on [RunPod](https://runpod.io?ref=2xxro4sy). -->
+<!-- You can use my custom [RunPod template](https://runpod.io/console/gpu-cloud?template=ts8ze6urzh&ref=2xxro4sy) -->
+<!-- to launch it on RunPod. -->
 
 ## Building the Docker image
 
 > [!NOTE]
 > You will need to edit the `docker-bake.hcl` file and update `USERNAME`,
-> and `RELEASE`.  You can obviously edit the other values too, but these
+> and `RELEASE`. You can obviously edit the other values too, but these
 > are the most important ones.
 
 > [!IMPORTANT]
 > In order to cache the models, you will need at least 32GB of CPU/system
-> memory (not VRAM) due to the large size of the models.  If you have less
+> memory (not VRAM) due to the large size of the models. If you have less
 > than 32GB of system memory, you can comment out or remove the code in the
 > `Dockerfile` that caches the models.
 
 ```bash
 # Clone the repo
-git clone https://github.com/ashleykleynhans/a1111-docker.git
-
-# Download the models
-cd a1111-docker
-wget https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0/resolve/main/sd_xl_base_1.0.safetensors
-wget https://huggingface.co/stabilityai/stable-diffusion-xl-refiner-1.0/resolve/main/sd_xl_refiner_1.0.safetensors
-wget https://huggingface.co/madebyollin/sdxl-vae-fp16-fix/resolve/main/sdxl_vae.safetensors
+git clone https://github.com/mnb3000/a1111-forge-svd-docker.git
 
 # Log in to Docker Hub
 docker login
@@ -75,8 +66,8 @@ docker buildx bake -f docker-bake.hcl --push
 
 ### Install Nvidia CUDA Driver
 
-- [Linux](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html)
-- [Windows](https://docs.nvidia.com/cuda/cuda-installation-guide-microsoft-windows/index.html)
+-   [Linux](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html)
+-   [Windows](https://docs.nvidia.com/cuda/cuda-installation-guide-microsoft-windows/index.html)
 
 ### Start the Docker container
 
@@ -88,47 +79,39 @@ docker run -d \
   -p 8888:8888 \
   -p 2999:2999 \
   -e VENV_PATH=/workspace/venvs/stable-diffusion-webui-forge \
-  ashleykza/a1111:latest
+  mnb3000/a1111-forge-svd-docker:latest
 ```
 
 You can obviously substitute the image name and tag with your own.
 
 ### Ports
 
 | Connect Port | Internal Port | Description                   |
-|--------------|---------------|-------------------------------|
+| ------------ | ------------- | ----------------------------- |
 | 3000         | 3001          | A1111 Stable Diffusion Web UI |
 | 8888         | 8888          | Jupyter Lab                   |
 | 2999         | 2999          | RunPod File Uploader          |
 
 ### Environment Variables
 
-| Variable             | Description                                   | Default                                 |
-|----------------------|-----------------------------------------------|-----------------------------------------|
-| VENV_PATH            | Set the path for the Python venv for the app  | /workspace/venvs/stable-diffusion-webui-forge |
-| JUPYTER_LAB_PASSWORD | Set a password for Jupyter lab                | not set - no password                   |
-| DISABLE_AUTOLAUNCH   | Disable Web UIs from launching automatically  | enabled                                 |
+| Variable             | Description                                  | Default                                       |
+| -------------------- | -------------------------------------------- | --------------------------------------------- |
+| VENV_PATH            | Set the path for the Python venv for the app | /workspace/venvs/stable-diffusion-webui-forge |
+| JUPYTER_LAB_PASSWORD | Set a password for Jupyter lab               | not set - no password                         |
+| DISABLE_AUTOLAUNCH   | Disable Web UIs from launching automatically | enabled                                       |
+| ENABLE_SDXL_TURBO    | Enable SDXL Turbo download on startup        | false                                         |
+| CIVITAI_TOKEN        | CivitAI access token                         |                                               |
 
 ## Logs
 
 Stable Diffusion Web UI creates a log file, and you can tail it instead of
 killing the services to view the logs
 
-| Application             | Log file                     |
-|-------------------------|------------------------------|
-| Stable Diffusion Web UI | /workspace/logs/webui.log    |
+| Application             | Log file                  |
+| ----------------------- | ------------------------- |
+| Stable Diffusion Web UI | /workspace/logs/webui.log |
 
 ## Community and Contributing
 
-Pull requests and issues on [GitHub](https://github.com/ashleykleynhans/a1111-docker)
+Pull requests and issues on [GitHub](https://github.com/mnb3000/a1111-forge-svd-docker)
 are welcome. Bug fixes and new features are encouraged.
-
-You can contact me and get help with deploying your container
-to RunPod on the RunPod Discord Server below,
-my username is **ashleyk**.
-
-<a target="_blank" href="https://discord.gg/pJ3P2DbUUq">![Discord Banner 2](https://discordapp.com/api/guilds/912829806415085598/widget.png?style=banner2)</a>
-
-## Appreciate my work?
-
-<a href="https://www.buymeacoffee.com/ashleyk" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>