diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..7e6882b --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "files.eol": "\n" +} diff --git a/README.md b/README.md index ba19aa9..9c1a499 100644 --- a/README.md +++ b/README.md @@ -1,82 +1,82 @@ -# Stable Diffusion WebUI Docker - -Run Stable Diffusion on your machine with a nice UI without any hassle! - -This repository provides the [WebUI](https://github.com/hlky/stable-diffusion-webui) as a docker image for easy setup and deployment. Please note that the WebUI is experimental and evolving quickly, so expect some bugs. - -## Features - -- Interactive UI with many features, and more on the way! -- Support for 6GB GPU cards. -- GFPGAN for face reconstruction, RealESRGAN for super-sampling. -- Experimental: - - [Textual Inversion](https://github.com/hlky/sd-enable-textual-inversion) - - Latent Diffusion Super Resolution - - GoBig - - GoLatent -- many more! - -## Setup - -Make sure you have an **up to date** version of docker installed. Download this repo and run: - -``` -docker compose build -``` - -you can let it build in the background while you download the different models - -- [Stable Diffusion v1.4 (4GB)](https://www.googleapis.com/storage/v1/b/aai-blog-files/o/sd-v1-4.ckpt?alt=media), rename to `model.ckpt` -- (Optional) [GFPGANv1.3.pth (333MB)](https://github.com/TencentARC/GFPGAN/releases/download/v1.3.0/GFPGANv1.3.pth). -- (Optional) [RealESRGAN_x4plus.pth (64MB)](https://github.com/xinntao/Real-ESRGAN/releases/download/v0.1.0/RealESRGAN_x4plus.pth) and [RealESRGAN_x4plus_anime_6B.pth (18MB)](https://github.com/xinntao/Real-ESRGAN/releases/download/v0.2.2.4/RealESRGAN_x4plus_anime_6B.pth). -- (Optional) [LDSR (2GB)](https://heibox.uni-heidelberg.de/f/578df07c8fc04ffbadf3/?dl=1) and [its configuration](https://heibox.uni-heidelberg.de/f/31a76b13ea27482981b4/?dl=1), rename to `LDSR.ckpt` and `LDSR.yaml` respectively. - - -Put all of the downloaded files in the `models` folder, it should look something like this: - -``` -models/ -├── model.ckpt -├── GFPGANv1.3.pth -├── RealESRGAN_x4plus.pth -├── RealESRGAN_x4plus_anime_6B.pth -├── LDSR.ckpt -└── LDSR.yaml -``` - -## Run - -After the build is done, you can run the app with: - -``` -docker compose up --build -``` - -Will start the app on http://localhost:7860/ - -Note: the first start will take sometime as some other models will be downloaded, these will be cached in the `cache` folder, so next runs are faster. - -## Config - -in the `docker-compose.yml` you can change the `CLI_ARGS` variable, which contains the arguments that will be passed to the WebUI. By default: `--extra-models-cpu --optimized-turbo` are given, which allow you to use this model on a 6GB GPU. However, some features might not be available in the mode. - -[You can find the full list of arguments here.](https://github.com/hlky/stable-diffusion/blob/d667ff52a36b4e79526f01555bfbf85428f334ce/scripts/webui.py) - -### FAQ - -You can find fixes to common issues [in the wiki page.](https://github.com/AbdBarho/stable-diffusion-webui-docker/wiki/Main) - -# Disclaimer - -The authors of this project are not responsible for any content generated using this interface. - -This license of this software forbids you from sharing any content that violates any laws, produce any harm to a person, disseminate any personal information that would be meant for harm, spread misinformation and target vulnerable groups. For the full list of restrictions please read [the license](./LICENSE). - -# Thanks - -Special thanks to everyone behind these awesome projects, without them, none of this would have been possible: - -- [hlky/stable-diffusion-webui](https://github.com/hlky/stable-diffusion-webui) -- [AUTOMATIC1111/stable-diffusion-webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui) -- [CompVis/stable-diffusion](https://github.com/CompVis/stable-diffusion) +# Stable Diffusion WebUI Docker + +Run Stable Diffusion on your machine with a nice UI without any hassle! + +This repository provides the [WebUI](https://github.com/hlky/stable-diffusion-webui) as a docker image for easy setup and deployment. Please note that the WebUI is experimental and evolving quickly, so expect some bugs. + +## Features + +- Interactive UI with many features, and more on the way! +- Support for 6GB GPU cards. +- GFPGAN for face reconstruction, RealESRGAN for super-sampling. +- Experimental: + - [Textual Inversion](https://github.com/hlky/sd-enable-textual-inversion) + - Latent Diffusion Super Resolution + - GoBig + - GoLatent +- many more! + +## Setup + +Make sure you have an **up to date** version of docker installed. Download this repo and run: + +``` +docker compose build +``` + +you can let it build in the background while you download the different models + +- [Stable Diffusion v1.4 (4GB)](https://www.googleapis.com/storage/v1/b/aai-blog-files/o/sd-v1-4.ckpt?alt=media), rename to `model.ckpt` +- (Optional) [GFPGANv1.3.pth (333MB)](https://github.com/TencentARC/GFPGAN/releases/download/v1.3.0/GFPGANv1.3.pth). +- (Optional) [RealESRGAN_x4plus.pth (64MB)](https://github.com/xinntao/Real-ESRGAN/releases/download/v0.1.0/RealESRGAN_x4plus.pth) and [RealESRGAN_x4plus_anime_6B.pth (18MB)](https://github.com/xinntao/Real-ESRGAN/releases/download/v0.2.2.4/RealESRGAN_x4plus_anime_6B.pth). +- (Optional) [LDSR (2GB)](https://heibox.uni-heidelberg.de/f/578df07c8fc04ffbadf3/?dl=1) and [its configuration](https://heibox.uni-heidelberg.de/f/31a76b13ea27482981b4/?dl=1), rename to `LDSR.ckpt` and `LDSR.yaml` respectively. + + +Put all of the downloaded files in the `models` folder, it should look something like this: + +``` +models/ +├── model.ckpt +├── GFPGANv1.3.pth +├── RealESRGAN_x4plus.pth +├── RealESRGAN_x4plus_anime_6B.pth +├── LDSR.ckpt +└── LDSR.yaml +``` + +## Run + +After the build is done, you can run the app with: + +``` +docker compose up --build +``` + +Will start the app on http://localhost:7860/ + +Note: the first start will take sometime as some other models will be downloaded, these will be cached in the `cache` folder, so next runs are faster. + +## Config + +in the `docker-compose.yml` you can change the `CLI_ARGS` variable, which contains the arguments that will be passed to the WebUI. By default: `--extra-models-cpu --optimized-turbo` are given, which allow you to use this model on a 6GB GPU. However, some features might not be available in the mode. + +[You can find the full list of arguments here.](https://github.com/hlky/stable-diffusion/blob/d667ff52a36b4e79526f01555bfbf85428f334ce/scripts/webui.py) + +### FAQ + +You can find fixes to common issues [in the wiki page.](https://github.com/AbdBarho/stable-diffusion-webui-docker/wiki/Main) + +# Disclaimer + +The authors of this project are not responsible for any content generated using this interface. + +This license of this software forbids you from sharing any content that violates any laws, produce any harm to a person, disseminate any personal information that would be meant for harm, spread misinformation and target vulnerable groups. For the full list of restrictions please read [the license](./LICENSE). + +# Thanks + +Special thanks to everyone behind these awesome projects, without them, none of this would have been possible: + +- [hlky/stable-diffusion-webui](https://github.com/hlky/stable-diffusion-webui) +- [AUTOMATIC1111/stable-diffusion-webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui) +- [CompVis/stable-diffusion](https://github.com/CompVis/stable-diffusion)