From 11fa71445814ac382f0ec481852bcc0d0cf6846f Mon Sep 17 00:00:00 2001 From: Thomas Mello Date: Thu, 6 Oct 2022 20:59:22 +0300 Subject: [PATCH] docs: add info about docker hub images (#1447) --- docs/3.docker-guide.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/3.docker-guide.md b/docs/3.docker-guide.md index 6f9d3b6..662b8d4 100644 --- a/docs/3.docker-guide.md +++ b/docs/3.docker-guide.md @@ -19,6 +19,34 @@ You should have received a copy of the GNU Affero General Public License along with this program. If not, see . --> +## Running prebuilt image + +The easiest way to run Stable Diffusion WebUI is to use the prebuilt image from Docker Hub. + +```bash +docker pull hlky/sd-webui:runpod +``` +This image has all the necessary models baked in. It is quite large but streamlines the process of managing the various models and simplifies the user experience. + +Alternatively you can pull: +```bash +docker pull hlky/sd-webui:latest +``` +This image includes the babrebones environment to run the Web UI. The models will be downloaded during the installation process. You will have to take care of the volume for the `sd/models` directory. + + +It is recommended that you run the `runpod` version. +You can run the image using the following command: +```bash +docker container run --rm -d -p 8501:8501 -e STREAMLIT_SERVER_HEADLESS=true -e "WEBUI_SCRIPT=webui_streamlit.py" -e "VALIDATE_MODELS=false" -v "${PWD}/outputs:/sd/outputs" --gpus all hlky/sd-webui:runpod +``` + +> Note: if you are running it on runpod it only supports one volume mount which is used for your outputs. + +> Note: if you are running it on your local machine the output directory will be created in the current directory from where you run this command. + +## Building the image + This Docker environment is intended to speed up development and testing of Stable Diffusion WebUI features. Use of a container image format allows for packaging and isolation of Stable Diffusion / WebUI's dependencies separate from the Host environment. You can use this Dockerfile to build a Docker image and run Stable Diffusion WebUI locally.