From fc0f966ad2598c8e125602857d3140f4ffcf295a Mon Sep 17 00:00:00 2001 From: mauwii Date: Sun, 5 Feb 2023 03:03:27 +0100 Subject: [PATCH] fix docs --- docs/installation/040_INSTALL_DOCKER.md | 30 ++++++++++++------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/installation/040_INSTALL_DOCKER.md b/docs/installation/040_INSTALL_DOCKER.md index f3c24947d9..07e7f55e93 100644 --- a/docs/installation/040_INSTALL_DOCKER.md +++ b/docs/installation/040_INSTALL_DOCKER.md @@ -74,32 +74,32 @@ Some Suggestions of variables you may want to change besides the Token:
-| Environment-Variable | Default value | Description | -| ------------------------ | ------------------------------- | -------------------------------------------------------------------------------------------- | -| `HUGGING_FACE_HUB_TOKEN` | No default, but **required**! | This is the only **required** variable, without it you can't download the huggingface models | -| `REPOSITORY_NAME` | The Basename of the Repo folder | This name will used as the container repository/image name | -| `VOLUMENAME` | `${REPOSITORY_NAME,,}_data` | Name of the Docker Volume where model files will be stored | -| `ARCH` | arch of the build machine | can be changed if you want to build the image for another arch | -| `INVOKEAI_TAG` | latest | the Container Repository / Tag which will be used | -| `PIP_REQUIREMENTS` | `requirements-lin-cuda.txt` | the requirements file to use (from `environments-and-requirements`) | -| `CONTAINER_FLAVOR` | cuda | the flavor of the image, which can be changed if you build f.e. with amd requirements file. | -| `INVOKE_DOCKERFILE` | `Dockerfile` | the Dockerfile which should be built, handy for development | -| `CONTAINER_FLAVOR` | | the flavor of the image to built, available options are `cuda`, `rocm` and `cpu` | -| `PIP_EXTRA_INDEX_URL` | | if you want to use a custom pip-extra-index-url | +| Environment-Variable | Default value | Description | +| ----------------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `HUGGING_FACE_HUB_TOKEN` | No default, but **required**! | This is the only **required** variable, without it you can't download the huggingface models | +| `REPOSITORY_NAME` | The Basename of the Repo folder | This name will used as the container repository/image name | +| `VOLUMENAME` | `${REPOSITORY_NAME,,}_data` | Name of the Docker Volume where model files will be stored | +| `ARCH` | arch of the build machine | Can be changed if you want to build the image for another arch | +| `CONTAINER_REGISTRY` | ghcr.io | Name of the Container Registry to use for the full tag | +| `CONTAINER_REPOSITORY` | `$(whoami)/${REPOSITORY_NAME}` | Name of the Container Repository | +| `CONTAINER_FLAVOR` | `cuda` | The flavor of the image to built, available options are `cuda`, `rocm` and `cpu`. If you choose `rocm` or `cpu`, the extra-index-url will be selected automatically, unless you set one yourself. | +| `CONTAINER_TAG` | `${INVOKEAI_BRANCH##*/}-${CONTAINER_FLAVOR}` | The Container Repository / Tag which will be used | +| `INVOKE_DOCKERFILE` | `Dockerfile` | The Dockerfile which should be built, handy for development | +| `PIP_EXTRA_INDEX_URL` | | If you want to use a custom pip-extra-index-url |
#### Build the Image -I provided a build script, which is located in `docker/build.sh` but still needs -to be executed from the Repository root. +I provided a build script, which is located next to the Dockerfile in +`docker/build.sh`. It can be executed from repository root like this: ```bash ./docker/build.sh ``` The build Script not only builds the container, but also creates the docker -volume if not existing yet, or if empty it will just download the models. +volume if not existing yet. #### Run the Container