feat(docker): update docker documentation

docker/.env.sample

@@ -1,13 +1,15 @@
 ## Make a copy of this file named `.env` and fill in the values below.
-## Any environment variables supported by InvokeAI can be specified here.
+## Any environment variables supported by InvokeAI can be specified here,
+## in addition to the examples below.
 
 # INVOKEAI_ROOT is the path to a path on the local filesystem where InvokeAI will store data.
 # Outputs will also be stored here by default.
 # This **must** be an absolute path.
 INVOKEAI_ROOT=
 
-HUGGINGFACE_TOKEN=
+# Get this value from your HuggingFace account settings page.
+# HUGGING_FACE_HUB_TOKEN=
 
-## optional variables specific to the docker setup
+## optional variables specific to the docker setup.
 # GPU_DRIVER=cuda
 # CONTAINER_UID=1000

docker/README.md

@@ -5,7 +5,7 @@ All commands are to be run from the `docker` directory: `cd docker`
 #### Linux
 
 1. Ensure builkit is enabled in the Docker daemon settings (`/etc/docker/daemon.json`)
-2. Install the `docker compose` plugin using your package manager, or follow a [tutorial](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-compose-on-ubuntu-22-04).
+2. Install the `docker compose` plugin using your package manager, or follow a [tutorial](https://docs.docker.com/compose/install/linux/#install-using-the-repository).
     - The deprecated `docker-compose` (hyphenated) CLI continues to work for now.
 3. Ensure docker daemon is able to access the GPU.
     - You may need to install [nvidia-container-toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html)
@@ -20,7 +20,6 @@ This is done via Docker Desktop preferences
 
 ## Quickstart
 
-
 1. Make a copy of `env.sample` and name it `.env` (`cp env.sample .env` (Mac/Linux) or `copy example.env .env` (Windows)). Make changes as necessary. Set `INVOKEAI_ROOT` to an absolute path to:
     a. the desired location of the InvokeAI runtime directory, or
     b. an existing, v3.0.0 compatible runtime directory.
@@ -42,20 +41,22 @@ The Docker daemon on the system must be already set up to use the GPU. In case o
 
 Check the `.env.sample` file. It contains some environment variables for running in Docker. Copy it, name it `.env`, and fill it in with your own values. Next time you run `docker compose up`, your custom values will be used.
 
-You can also set these values in `docker compose.yml` directly, but `.env` will help avoid conflicts when code is updated.
+You can also set these values in `docker-compose.yml` directly, but `.env` will help avoid conflicts when code is updated.
 
-Example (most values are optional):
+Example (values are optional, but setting `INVOKEAI_ROOT` is highly recommended):
 
-```
+```bash
 INVOKEAI_ROOT=/Volumes/WorkDrive/invokeai
 HUGGINGFACE_TOKEN=the_actual_token
 CONTAINER_UID=1000
 GPU_DRIVER=cuda
 ```
 
+Any environment variables supported by InvokeAI can be set here - please see the [Configuration docs](https://invoke-ai.github.io/InvokeAI/features/CONFIGURATION/) for further detail.
+
 ## Even Moar Customizing!
 
-See the `docker compose.yaml` file. The `command` instruction can be uncommented and used to run arbitrary startup commands. Some examples below.
+See the `docker-compose.yml` file. The `command` instruction can be uncommented and used to run arbitrary startup commands. Some examples below.
 
 ### Reconfigure the runtime directory
 
@@ -63,7 +64,7 @@ Can be used to download additional models from the supported model list
 
 In conjunction with `INVOKEAI_ROOT` can be also used to initialize a runtime directory
 
-```
+```yaml
 command:
   - invokeai-configure
   - --yes
@@ -71,7 +72,7 @@ command:
 
 Or install models:
 
-```
+```yaml
 command:
   - invokeai-model-install
-```
+```

docker/build.sh

@@ -5,7 +5,7 @@ build_args=""
 
 [[ -f ".env" ]] && build_args=$(awk '$1 ~ /\=[^$]/ {print "--build-arg " $0 " "}' .env)
 
-echo "docker-compose build args:"
+echo "docker compose build args:"
 echo $build_args
 
-docker-compose build $build_args
+docker compose build $build_args

docker/run.sh

@@ -1,8 +1,11 @@
 #!/usr/bin/env bash
 set -e
 
+# This script is provided for backwards compatibility with the old docker setup.
+# it doesn't do much aside from wrapping the usual docker compose CLI.
+
 SCRIPTDIR=$(dirname "${BASH_SOURCE[0]}")
 cd "$SCRIPTDIR" || exit 1
 
-docker-compose up --build -d
-docker-compose logs -f
+docker compose up --build -d
+docker compose logs -f