From 13c72206d83eb430fb9ec98361bc5c3b00b4b835 Mon Sep 17 00:00:00 2001 From: psychedelicious <4822129+psychedelicious@users.noreply.github.com> Date: Tue, 19 Mar 2024 17:16:23 +1100 Subject: [PATCH] docs: update CONFIGURATION.md --- docs/features/CONFIGURATION.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/features/CONFIGURATION.md b/docs/features/CONFIGURATION.md index f608f80467..3f05c0cf9b 100644 --- a/docs/features/CONFIGURATION.md +++ b/docs/features/CONFIGURATION.md @@ -18,9 +18,6 @@ Settings sources are used in this order: - `invokeai.yaml` settings - Fallback: defaults -The most commonly changed settings are also accessible -graphically via the `invokeai-configure` script. - ### InvokeAI Root Directory On startup, InvokeAI searches for its "root" directory. This is the directory @@ -42,10 +39,9 @@ It has two sections - one for internal use and one for user settings: ```yaml # Internal metadata - do not edit: -meta: - schema_version: 4 +schema_version: 4 -# Put user settings here: +# Put user settings here - see https://invoke-ai.github.io/InvokeAI/features/CONFIGURATION/: host: 0.0.0.0 # serve the app on your local network models_dir: D:\invokeai\models # store models on an external drive precision: float16 # always use fp16 precision @@ -62,6 +58,12 @@ You can fix a broken `invokeai.yaml` by deleting it and running the configuration script again -- option [6] in the launcher, "Re-run the configure script". +#### Custom Config File Location + +You can use any config file with the `--config` CLI arg. Pass in the path to the `invokeai.yaml` file you want to use. + +Note that environment variables will trump any settings in the config file. + ### Environment Variables All settings may be set via environment variables by prefixing `INVOKEAI_` @@ -81,13 +83,10 @@ We suggest using `invokeai.yaml`, as it is more user-friendly. A subset of settings may be specified using CLI args: - `--root`: specify the root directory -- `--ignore_missing_core-models`: if set, do not check for models needed - to convert checkpoint/safetensor models to diffusers +- `--config`: override the default `invokeai.yaml` file location ### All Settings -The config is managed by the `InvokeAIAppConfig` class. The below docs are autogenerated from the class. - Following the table are additional explanations for certain settings.