Upload 2 files
Browse files- Data/Backends.fds +40 -0
- Data/Settings.fds +606 -0
Data/Backends.fds
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
0:
|
| 2 |
+
type: comfyui_selfstart
|
| 3 |
+
title: ComfyUI Self-Starting
|
| 4 |
+
enabled: true
|
| 5 |
+
settings:
|
| 6 |
+
#The location of the 'main.py' file. Can be an absolute or relative path, but must end with 'main.py'.
|
| 7 |
+
#If you used the installer, this should be 'dlbackend/comfy/ComfyUI/main.py'.
|
| 8 |
+
StartScript: dlbackend/ComfyUI/main.py
|
| 9 |
+
#Any arguments to include in the launch script.
|
| 10 |
+
ExtraArgs: \x
|
| 11 |
+
#If unchecked, the system will automatically add some relevant arguments to the comfy launch. If checked, automatic args (other than port) won't be added.
|
| 12 |
+
DisableInternalArgs: false
|
| 13 |
+
#Whether the Comfy backend should automatically update itself during launch.
|
| 14 |
+
#You can update every launch, never update automatically, or force-update (bypasses some common git issues).
|
| 15 |
+
AutoUpdate: true
|
| 16 |
+
#Whether the Comfy backend should automatically update nodes within Swarm's managed nodes folder.
|
| 17 |
+
#You can update every launch, never update automatically, or force-update (bypasses some common git issues).
|
| 18 |
+
UpdateManagedNodes: true
|
| 19 |
+
#Which version of the ComfyUI frontend to enable.
|
| 20 |
+
#'Latest' uses the latest version available (including dev commits).
|
| 21 |
+
#'None' uses whatever is baked into ComfyUI itself.
|
| 22 |
+
#'Latest Swarm Validated' uses the latest version that Swarm has been tested and confirmed to work with.
|
| 23 |
+
#'Legacy' uses the pre-September-2024 legacy UI.
|
| 24 |
+
FrontendVersion: LatestSwarmValidated
|
| 25 |
+
#Whether Comfy should generate image previews. If disabled, previews will not be generated, and images won't show up until they're done.
|
| 26 |
+
#Regular enabled mode uses 'latent2rgb' which is nearly instant at the cost of a lower accuracy of the preview.
|
| 27 |
+
#The 'HD' enabled variant uses TAESD (Tiny Auto Encoder for Stable Diffusion), which uses a small VAE-like model to get more accurate previews, at the cost of slowing down generation to run this extra model each step.
|
| 28 |
+
#TAESD only works if architecture-specific compatible models are present (some are included by default).
|
| 29 |
+
EnablePreviews: true
|
| 30 |
+
#Which GPU to use, if multiple are available.
|
| 31 |
+
#Should be a single number, like '0'.
|
| 32 |
+
#You can use syntax like '0,1' to provide multiple GPUs to one backend (only applicable if you have custom nodes that can take advantage of this.)
|
| 33 |
+
GPU_ID: 0
|
| 34 |
+
#How many extra requests may queue up on this backend while one is processing.
|
| 35 |
+
#0 means one a single live gen, 1 means a live gen and an extra waiting.
|
| 36 |
+
#-1 means this is a UI-only instance that cannot do actual gens.
|
| 37 |
+
OverQueue: 1
|
| 38 |
+
#If checked, if the backend crashes it will automatically restart.
|
| 39 |
+
#If false, if the backend crashes it will sit in an errored state until manually restarted.
|
| 40 |
+
AutoRestart: true
|
Data/Settings.fds
ADDED
|
@@ -0,0 +1,606 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#Settings related to file paths.
|
| 2 |
+
Paths:
|
| 3 |
+
#Root path for model files. Use a full-formed path (starting with '/' or a Windows drive like 'C:') to use an absolute path.
|
| 4 |
+
#Defaults to 'Models'.
|
| 5 |
+
#Use a semicolon ';' to split multiple paths.
|
| 6 |
+
ModelRoot: Models
|
| 7 |
+
#0-based index of which ModelRoot entry to download models to.
|
| 8 |
+
#Defaults to 0 (the first entry).
|
| 9 |
+
#Naturally only is relevant if there's multiple model roots set.
|
| 10 |
+
DownloadToRootID: 0
|
| 11 |
+
#The model folder to use within 'ModelRoot'.
|
| 12 |
+
#Defaults to 'Stable-Diffusion'.
|
| 13 |
+
#'checkpoints' should be used for matching pre-existing ComfyUI model directories.
|
| 14 |
+
#Absolute paths work too (usually do not use an absolute path, use just a folder name).
|
| 15 |
+
#Use a semicolon ';' to split multiple paths.
|
| 16 |
+
SDModelFolder: Stable-Diffusion
|
| 17 |
+
#The LoRA (or related adapter type) model folder to use within 'ModelRoot'.
|
| 18 |
+
#Defaults to 'Lora'.
|
| 19 |
+
#Absolute paths work too (usually do not use an absolute path, use just a folder name).
|
| 20 |
+
#Use a semicolon ';' to split multiple paths.
|
| 21 |
+
SDLoraFolder: Lora
|
| 22 |
+
#The VAE (autoencoder) model folder to use within 'ModelRoot'.
|
| 23 |
+
#Defaults to 'VAE'.
|
| 24 |
+
#Absolute paths work too (usually do not use an absolute path, use just a folder name).
|
| 25 |
+
#Use a semicolon ';' to split multiple paths.
|
| 26 |
+
SDVAEFolder: VAE
|
| 27 |
+
#The Embedding (eg textual inversion) model folder to use within 'ModelRoot'.
|
| 28 |
+
#Defaults to 'Embeddings'.
|
| 29 |
+
#Absolute paths work too (usually do not use an absolute path, use just a folder name).
|
| 30 |
+
#Use a semicolon ';' to split multiple paths.
|
| 31 |
+
SDEmbeddingFolder: Embeddings
|
| 32 |
+
#The ControlNets model folder to use within 'ModelRoot'.
|
| 33 |
+
#Defaults to 'controlnet'.
|
| 34 |
+
#Absolute paths work too (usually do not use an absolute path, use just a folder name).
|
| 35 |
+
#Use a semicolon ';' to split multiple paths.
|
| 36 |
+
SDControlNetsFolder: controlnet;model_patches
|
| 37 |
+
#The CLIP (Text Encoder) model folder to use within 'ModelRoot'.
|
| 38 |
+
#Defaults to 'text_encoders;clip'.
|
| 39 |
+
#Absolute paths work too (usually do not use an absolute path, use just a folder name).
|
| 40 |
+
#Use a semicolon ';' to split multiple paths.
|
| 41 |
+
SDClipFolder: text_encoders;clip
|
| 42 |
+
#The CLIP Vision model folder to use within 'ModelRoot'.
|
| 43 |
+
#Defaults to 'clip_vision'.
|
| 44 |
+
#Absolute paths work too (usually do not use an absolute path, use just a folder name).
|
| 45 |
+
#Use a semicolon ';' to split multiple paths.
|
| 46 |
+
SDClipVisionFolder: clip_vision
|
| 47 |
+
#Root path for data (user configs, etc).
|
| 48 |
+
#Defaults to 'Data'
|
| 49 |
+
#Absolute paths work too.
|
| 50 |
+
DataPath: Data
|
| 51 |
+
#Root path for output files (images, etc).
|
| 52 |
+
#Defaults to 'Output'
|
| 53 |
+
#Absolute paths work too.
|
| 54 |
+
OutputPath: Output
|
| 55 |
+
#The folder for wildcard (.txt) files, under Data.
|
| 56 |
+
#Defaults to 'Wildcards'
|
| 57 |
+
#Absolute paths work too.
|
| 58 |
+
WildcardsFolder: Wildcards
|
| 59 |
+
#When true, output paths always have the username as a folder.
|
| 60 |
+
#When false, this will be skipped.
|
| 61 |
+
#Keep this on in multi-user environments.
|
| 62 |
+
AppendUserNameToOutputPath: true
|
| 63 |
+
#If true, when a user deletes an image, send it to the OS Recycle Bin instead of permanently deleting it.
|
| 64 |
+
#If false, image files are permanently deleted.
|
| 65 |
+
#Defaults to false.
|
| 66 |
+
RecycleDeletedImages: false
|
| 67 |
+
#If true, when a user deletes a model, send it to the OS Recycle Bin instead of permanently deleting it.
|
| 68 |
+
#If false, model files are permanently deleted.
|
| 69 |
+
#Defaults to false.
|
| 70 |
+
RecycleDeletedModels: false
|
| 71 |
+
#If true, when a user edits a model's metadata, clear all stray data (eg old images, jsons, etc.) even from other UIs.
|
| 72 |
+
#If false, only files controlled by Swarm will be altered.
|
| 73 |
+
#Defaults to false.
|
| 74 |
+
ClearStrayModelData: false
|
| 75 |
+
#If true, when a user edits a model's metadata, if there are multiple copies of that model in different folders, edit all copies.
|
| 76 |
+
#Be warned that if the models with the same name are different, the unique data maybe lost.
|
| 77 |
+
#This is only a relevant option for users with redundant storage (eg a local drive and a NAS).
|
| 78 |
+
#This also applies to deletes and renames.
|
| 79 |
+
#If false, only the file in the first folder will be edited.
|
| 80 |
+
#Defaults to false.
|
| 81 |
+
EditMetadataAcrossAllDups: false
|
| 82 |
+
#If true, always resave models after the downloader utility grabs them.
|
| 83 |
+
#This ensures metadata is fully properly set, but wastes some extra time on file processing.
|
| 84 |
+
#If false, the downloader will leave a stray json next to the model.
|
| 85 |
+
#Defaults to false.
|
| 86 |
+
DownloaderAlwaysResave: false
|
| 87 |
+
#Settings related to image/model metadata.
|
| 88 |
+
Metadata:
|
| 89 |
+
#If true, model metadata is tracked on a per-folder basis. This is better for example if you copy model folders to different machines, or have symlinks to different instances, or etc.
|
| 90 |
+
#If false, model metadata is tracked in the central data folder. This is better if you don't want stray files in your model folders, or if you have several Swarm instances running simultaneously.
|
| 91 |
+
ModelMetadataPerFolder: false
|
| 92 |
+
#If true, image metadata is tracked on a per-folder basis.
|
| 93 |
+
#If false, image metadata is tracked in the central data folder.
|
| 94 |
+
#This is better if you don't want stray files in your output folders, or if you have several Swarm instances running simultaneously over the same output folders.
|
| 95 |
+
ImageMetadataPerFolder: true
|
| 96 |
+
#If true, unrecognized XL-format models will be treated as SDXL 1.0.
|
| 97 |
+
#If false, unrecognized XL-format models will be treated as SDXL 0.9.
|
| 98 |
+
#The SDXL 1.0 specification requires ModelSpec architecture IDs, and any similar model lacking this ID is a 0.9 model,
|
| 99 |
+
#however, many custom XL model author have excluded this metadata.
|
| 100 |
+
#This means those models are technically SDXL 0.9 models, however it can be convenient to pretend they are 1.0 models instead.
|
| 101 |
+
#Note that enabling this will mislabel the official SDXL 0.9 model.
|
| 102 |
+
XLDefaultAsXL1: false
|
| 103 |
+
#If true, editing model metadata should write a '.swarm.json' file next to the model.
|
| 104 |
+
#If false, apply metadata to the model itself.
|
| 105 |
+
#Applying directly to the model is generally better, however the JSON file might be preferable if you have a very slow data drive, as it avoids rewriting the model content.
|
| 106 |
+
EditMetadataWriteJSON: false
|
| 107 |
+
#If true, image metadata will include a list of models with their hashes.
|
| 108 |
+
#This is useful for services like civitai to automatically link models.
|
| 109 |
+
#This will cause extra time to be taken when new hashes need to be loaded.
|
| 110 |
+
ImageMetadataIncludeModelHash: true
|
| 111 |
+
#How many kilobytes of blank spacer to include in model headers.
|
| 112 |
+
#This allows for future expansion of metadata without rewriting the entire model file.
|
| 113 |
+
#Defaults to 64 KiB.
|
| 114 |
+
#The average header length of a standard model is already between several hundred kilobytes to a few megabytes,
|
| 115 |
+
#so 64 KiB is not a major increase in space but is enough to fit major metadata changes including eg adding a small jpeg thumbnail.
|
| 116 |
+
ModelMetadataSpacerKilobytes: 64
|
| 117 |
+
#Settings related to networking and the webserver.
|
| 118 |
+
Network:
|
| 119 |
+
#Optionally set an external URL here, eg 'https://swarm.example.com'
|
| 120 |
+
#This is not used for any practical function,
|
| 121 |
+
#and only will be used for automatically displaying fully formed URLs in some special cases, such as when transmitting webhooks.
|
| 122 |
+
#If unset, an autogenerated value based on the Host and port will be used.
|
| 123 |
+
ExternalURL: \x
|
| 124 |
+
#What web host address to use. `localhost` means your PC only.
|
| 125 |
+
#Linux users may use `0.0.0.0` to mean accessible to anyone that can connect to your PC (ie LAN users, or the public if your firewall is open).
|
| 126 |
+
#Windows users may use `*` for that, though it may require additional Windows firewall configuration.
|
| 127 |
+
#Advanced server users may wish to manually specify a host bind address here.
|
| 128 |
+
Host: localhost
|
| 129 |
+
#What web port to use. Default is '7801'.
|
| 130 |
+
Port: 7801
|
| 131 |
+
#If true, if the port is already in use, the server will try to find another port to use instead.
|
| 132 |
+
#If false, the server will fail to start if the port is already in use.
|
| 133 |
+
PortCanChange: true
|
| 134 |
+
#Backends are automatically assigned unique ports. This value selects which port number to start the assignment from.
|
| 135 |
+
#Default is '7820'.
|
| 136 |
+
BackendStartingPort: 7820
|
| 137 |
+
#If enabled, backend starting port will be randomly offset at each restart.
|
| 138 |
+
#This is an obscure bug fix for 'stuck ports', where restarting and reusing the same backend port causes strange misbehaviors.
|
| 139 |
+
BackendPortRandomize: false
|
| 140 |
+
#If you wish to access your Swarm instance externally, set this to the path of a CloudFlared executable, and it will automatically be used.
|
| 141 |
+
#(Must restart to apply).
|
| 142 |
+
#The URL will be visible on the Server Info tab and/or terminal log.
|
| 143 |
+
#See documentation in <a target="_blank" href="{Utilities.RepoDocsRoot}Advanced Usage.md#accessing-swarmui-from-other-devices">the docs here</a>
|
| 144 |
+
CloudflaredPath: \x
|
| 145 |
+
#Any IPs that can bypass network-authorization requirements, as a comma-separated list.
|
| 146 |
+
#Defaults to '127.0.0.1' (localhost IPv4) and '::1' (localhost IPv6) and '::ffff:127.0.0.1' (IPv4 localhost forwarded through IPv6).
|
| 147 |
+
AuthBypassIPs: 127.0.0.1,::1,::ffff:127.0.0.1
|
| 148 |
+
#If set, connections will require an Authorization header.
|
| 149 |
+
#This is intended for if you're hosting your Swarm instance to a public IP and want to reduce the risks from it being exposed.
|
| 150 |
+
#Using a safe reverse proxy with actual authentication such as Apache2 is recommended instead.
|
| 151 |
+
#This is a simple equality check, and should be something like `Bearer some_passphrase_or_something_here`.
|
| 152 |
+
#Defaults to empty (no authorization required).
|
| 153 |
+
#If you accidentally lock yourself out, edit `Data/Settings.fds` to remove this setting and restart Swarm.
|
| 154 |
+
RequiredAuthorization: \x
|
| 155 |
+
#If true, special network forwarding logic will apply for developer modes.
|
| 156 |
+
#Notably, ComfyUI Frontend NPM Developer Mode requires significant special forwarding as it misroutes itself.
|
| 157 |
+
#Defaults to false.
|
| 158 |
+
EnableSpecialDevForwarding: false
|
| 159 |
+
#How long should browsers be told they can store cached copies of output images.
|
| 160 |
+
#Defaults to 30 seconds.
|
| 161 |
+
#Do not set less than 5-ish, temp-caching is important. Setting to a low value (like 5) can help if you often delete images and regenerate with the same filename.
|
| 162 |
+
#Some files (eg html/js for grids) in output always have a very low cache duration.
|
| 163 |
+
OutputCacheSeconds: 30
|
| 164 |
+
#Optional CORS header to set. If empty, no CORS header will be set.
|
| 165 |
+
#Defaults to empty.
|
| 166 |
+
AccessControlAllowOrigin: \x
|
| 167 |
+
#How many entries in an X-Forwarded-For header to trust.
|
| 168 |
+
#Defaults to 3.
|
| 169 |
+
#Set to 0 to not trust any forwarded-for.
|
| 170 |
+
MaxXForwardedFor: 3
|
| 171 |
+
#Maximum megabytes that can be sent as a single message from a client to the Swarm server.
|
| 172 |
+
#Set this lower to limit above, set this higher to allow very large file uploads.
|
| 173 |
+
#Server needs a restart for this to fully apply.
|
| 174 |
+
MaxNetworkRequestMegabytes: 200
|
| 175 |
+
#Settings related to Swarm server maintenance.
|
| 176 |
+
Maintenance:
|
| 177 |
+
#If true, Swarm will check if there's any updates available during startup. If false, it will not check for updates.
|
| 178 |
+
#Update check only runs a 'git fetch' from GitHub to get the list of git version tags, it does not transmit any telemetry nor does it actually apply the update.
|
| 179 |
+
#Defaults to true.
|
| 180 |
+
CheckForUpdates: true
|
| 181 |
+
#If true, Swarm will automatically download and apply any development version updates as soon as they're available.
|
| 182 |
+
#Defaults to false.
|
| 183 |
+
AutoPullDevUpdates: false
|
| 184 |
+
#If the server has been running more than this many hours, automatically restart.
|
| 185 |
+
#If set to 0, no automatic restart.
|
| 186 |
+
#Only restarts when the server is not processing any generation requests.
|
| 187 |
+
#Can use decimal values, but sub-hour durations are likely too fast and will cause issues.
|
| 188 |
+
#A value of eg 24 is reasonable, with AutoPullDevUpdates enabled, to keep an updated persistent server.
|
| 189 |
+
RestartAfterHours: 0
|
| 190 |
+
#Comma-separated list of numeric 24-hour time hours in which auto-restarting is allowed.
|
| 191 |
+
#If empty, hours are unrestricted.
|
| 192 |
+
#For example, '0,1,2,3' only allows auto-restarting from midnight up until before 4 am.
|
| 193 |
+
#Or, '22,23,0,1' allows 10pm-2am.
|
| 194 |
+
RestartHoursAllowed: \x
|
| 195 |
+
#Comma-separated list of numeric days-of-week in which auto-restarting is allowed. Sunday is 0, Saturday is 6.
|
| 196 |
+
#If empty, days are unrestricted.
|
| 197 |
+
#For example, '6,0' only allows auto-restarting from Sunday/Saturday.
|
| 198 |
+
RestartDayAllowed: \x
|
| 199 |
+
#If true, critical GPU errors (eg CUDA operation not permitted, or nvidia-smi crash) will cause SwarmUI to entirely restart itself.
|
| 200 |
+
#This primarily exists as a workaround for an nvidia-docker bug (docker randomly uses GPU, so do full restart to get the GPU back)
|
| 201 |
+
#but may be useful to other configs.
|
| 202 |
+
#If false, GPU errors will be logged and nothing further will happen.
|
| 203 |
+
RestartOnGpuCriticalError: false
|
| 204 |
+
#Number of minutes to silently wait for git operations to run.
|
| 205 |
+
#If this duration is reached, a warning is logged and 1 more minute is allowed.
|
| 206 |
+
#After that final minute runs out, the git process is backgrounded and ignored (it may still be running, but Swarm will stop waiting for it).
|
| 207 |
+
#Setting this timeout too low may cause still-running slow processes to glitch or conflict.
|
| 208 |
+
#Setting this timeout too high may cause Swarm to freeze up any time git doesn't properly shut down.
|
| 209 |
+
#For most users, the default (1 minute before warn, 1 minute extra) is more than enough, as git extremely rarely needs more than a minute to run.
|
| 210 |
+
GitTimeoutMinutes: 1
|
| 211 |
+
#How many weekly backups of the user database to keep.
|
| 212 |
+
#Default is 3.
|
| 213 |
+
#Set to 0 to disable backups.
|
| 214 |
+
#Backups are created weekly, in '(Data)/UsersBackups' named as (Year)_(Week).
|
| 215 |
+
UserDBBackups: 3
|
| 216 |
+
#Default settings for users (unless the user modifies them, if so permitted).
|
| 217 |
+
#(NOTE: Usually, don't edit this. Go to the 'User' tab to edit your User-Settings).
|
| 218 |
+
DefaultUser:
|
| 219 |
+
#Settings related to output path building.
|
| 220 |
+
OutPathBuilder:
|
| 221 |
+
#Builder for output file paths. Can use auto-filling placeholders like '[model]' for the model name, '[prompt]' for a snippet of prompt text, etc.
|
| 222 |
+
#Full details in <a target="_blank" href="https://github.com/mcmonkeyprojects/SwarmUI/blob/master/docs/User%20Settings.md#path-format">the docs here</a>
|
| 223 |
+
Format: raw/[year]-[month]-[day]/[hour][minute][request_time_inc]-[prompt]-[model]
|
| 224 |
+
#How long any one part can be.
|
| 225 |
+
#Default is 40 characters.
|
| 226 |
+
MaxLenPerPart: 40
|
| 227 |
+
#If true, when including model name (or loras or etc), the path will skip the folder (ie filename only).
|
| 228 |
+
ModelPathsSkipFolders: false
|
| 229 |
+
#Settings related to saved file format.
|
| 230 |
+
FileFormat:
|
| 231 |
+
#What format to save images in.
|
| 232 |
+
#Default is '.png', but '.jpg' is recommended to save some filespace.
|
| 233 |
+
ImageFormat: PNG
|
| 234 |
+
#Quality for JPEG and WEBP formats (1-100). Other formats are ignored.
|
| 235 |
+
#Default is 100, recommended 70-90.
|
| 236 |
+
ImageQuality: 100
|
| 237 |
+
#Whether to store metadata into saved images.
|
| 238 |
+
#Defaults enabled.
|
| 239 |
+
SaveMetadata: true
|
| 240 |
+
#If not set to 'false', encodes metadata into the pixels of the image itself.
|
| 241 |
+
#This can bypass services that strip normal metadata.
|
| 242 |
+
#'Alpha' uses the alpha channel. 'RGB' uses color channels.
|
| 243 |
+
#Alpha method Noticeably increases file size of PNG images, but not Webp.
|
| 244 |
+
#Webp and PNG are supported with the exception of lossy Webp with RGB stealth metadata.
|
| 245 |
+
#Currently SwarmUI cannot read stealth metadata.
|
| 246 |
+
StealthMetadata: false
|
| 247 |
+
#If set to non-0, adds DPI metadata to saved images.
|
| 248 |
+
#'72' is a good value for compatibility with some external software.
|
| 249 |
+
DPI: 0
|
| 250 |
+
#If enabled, a '.swarm.json' file will be saved alongside images with the image metadata easily viewable.
|
| 251 |
+
#This can work even if saving in the image is disabled. Defaults disabled.
|
| 252 |
+
SaveTextFileMetadata: false
|
| 253 |
+
#Images that are transient/temporary (not saved to file) generally are better off not being converted between image formats, or having metadata added.
|
| 254 |
+
#However, if you want to make the conversion and metadata apply anyway, you can enable this option.
|
| 255 |
+
#If you use 'Do Not Save' param frequently but manually save images, you may want this.
|
| 256 |
+
ReformatTransientImages: false
|
| 257 |
+
#Settings related to the user interface, entirely contained to the frontend.
|
| 258 |
+
UI:
|
| 259 |
+
#If enabled, you can hold ALT and press left/right arrows to move 'tags' in a prompt - that is, your currently selected comma-separated section will be moved left or right relative to other comma-separated sections.
|
| 260 |
+
TagMoveHotkeyEnabled: false
|
| 261 |
+
#If enabled, when pressing delete on an image, ask if you're sure before doing that (bypass by holding shift).
|
| 262 |
+
#If unchecked, there won't be any check.
|
| 263 |
+
#Defaults enabled.
|
| 264 |
+
CheckIfSureBeforeDelete: true
|
| 265 |
+
#Comma-separated list of fields to display in the preset Details view.
|
| 266 |
+
#Use 'name' for the preset name, 'path' for the full preset path, 'description' for the description, or 'params' for the param list.
|
| 267 |
+
#If unset, will act as 'path,description,params'
|
| 268 |
+
PresetListDetailsFields: \x
|
| 269 |
+
#If enabled, trigger phrases are copied with a trailing comma added.
|
| 270 |
+
#If disabled, trigger phrases are copied as-is without any trailing comma.
|
| 271 |
+
#This is useful when copying them to prompts.
|
| 272 |
+
CopyTriggerPhraseWithTrailingComma: false
|
| 273 |
+
#If true, when you interrupt generation, any incomplete generations will be removed from the batch view.
|
| 274 |
+
#If false, they will linger in the batch view with an X mark indicated they were started but not finished.
|
| 275 |
+
#In both cases, they will not save to file.
|
| 276 |
+
RemoveInterruptedGens: false
|
| 277 |
+
#Pipe-separated list of partial error message bodies.
|
| 278 |
+
#If an error message contains any of these, it will not show in the main error popup box.
|
| 279 |
+
#This is to hide intentionally-induced errors, or errors that pop up frequently but you don't want to be annoyed about.
|
| 280 |
+
#For example, set this to 'Generation session interrupted.|Some Other Error.' if you frequently externally interrupt your own gens.
|
| 281 |
+
HideErrorMessages: \x
|
| 282 |
+
#What to do when you delete an image that you are looking at in the UI:
|
| 283 |
+
#- Nothing: image view is closed / reset to empty
|
| 284 |
+
#- Next: move to the next image (right/down)
|
| 285 |
+
#- Previous: move to the previous image (left/up)
|
| 286 |
+
DeleteImageBehavior: next
|
| 287 |
+
#If enabled, shifting to next/previous image (eg with arrow keys) in history or batch view,
|
| 288 |
+
#cycles at the ends (jumps from the start to the end or vice versa).
|
| 289 |
+
#If disabled, shifting will simply stop at the ends.
|
| 290 |
+
#If 'only arrow keys', cycling happens when you press the arrow keys, but not other actions (eg deleting an image will not cycle).
|
| 291 |
+
ImageShiftingCycles: true
|
| 292 |
+
#If enabled, metadata will be hidden in the image Full View by default.
|
| 293 |
+
#If disabled, metadata will be shown by default.
|
| 294 |
+
#You zoom still zoom in or out to show or hide the metadata at any time as usual.
|
| 295 |
+
DefaultHideMetadataInFullview: false
|
| 296 |
+
#Settings related to the parsing of generation parameters.
|
| 297 |
+
ParamParsing:
|
| 298 |
+
#Whether LoRAs can be added to a generation multiple times.
|
| 299 |
+
#If false, the firstmost usage of a LoRA will be kept and others will be discarded.
|
| 300 |
+
AllowLoraStacking: true
|
| 301 |
+
#Whether your image output files save to server data drive or not.
|
| 302 |
+
#Disabling this can make some systems misbehave, and makes the Image History do nothing.
|
| 303 |
+
SaveFiles: true
|
| 304 |
+
#If enabled, folders will be discarded from starred image paths.
|
| 305 |
+
#If disabled, entire original image path will be replicated beneath the star folder.
|
| 306 |
+
StarNoFolders: false
|
| 307 |
+
#List of role IDs applied to this user. Defaults to owner (for local/accountless usage).
|
| 308 |
+
Roles:
|
| 309 |
+
- owner
|
| 310 |
+
#What theme to use. Default is 'modern_dark'.
|
| 311 |
+
Theme: modern_dark
|
| 312 |
+
#If true, images in the main center area will always grow to better fill the screen.
|
| 313 |
+
CenterImageAlwaysGrow: false
|
| 314 |
+
#If true, when 'Auto Swap To Images' is enabled, and you have FullView open, the FullView will also be swapped.
|
| 315 |
+
#If false, the FullView will not change.
|
| 316 |
+
AutoSwapImagesIncludesFullView: false
|
| 317 |
+
#A list of what buttons to include directly under images in the main prompt area of the Generate tab.
|
| 318 |
+
#Other buttons will be moved into the 'More' dropdown.
|
| 319 |
+
#This should be a comma separated list.
|
| 320 |
+
#The following options are available: "Use As Init", "Use As Image Prompt", "Edit Image", "Upscale 2x", "Star", "Reuse Parameters", "Open In Folder", "Delete", "Download" "View In History", "Refine Image"
|
| 321 |
+
#The default is blank, which currently implies 'Use As Init,Edit Image,Star,Reuse Parameters'
|
| 322 |
+
ButtonsUnderMainImages: \x
|
| 323 |
+
#How to format image metadata on the Generate tab when looking at an image.
|
| 324 |
+
#'below' means put the metadata below the image.
|
| 325 |
+
#'side' means put the image in a vertical column to the side.
|
| 326 |
+
#'auto' means switch to whichever fits better depending on the page width.
|
| 327 |
+
#Default is 'auto'.
|
| 328 |
+
ImageMetadataFormat: auto
|
| 329 |
+
#If enabled, batch size will be reset to 1 when parameters are loaded.
|
| 330 |
+
#This can prevent accidents that might thrash your GPU or cause compatibility issues, especially for example when importing a comfy workflow.
|
| 331 |
+
#You can still set the batch size at will in the GUI.
|
| 332 |
+
ResetBatchSizeToOne: false
|
| 333 |
+
#The format for parameter hints to display as.
|
| 334 |
+
#Default is 'BUTTON'.
|
| 335 |
+
HintFormat: BUTTON
|
| 336 |
+
#The delay, in seconds, for parameter hints when 'HOVER_DELAY' is selected.
|
| 337 |
+
HoverDelaySeconds: 0.5
|
| 338 |
+
#How many lines of text to display in the standard prompt box before cutting off to a scroll bar.
|
| 339 |
+
#Actual size in practice tends to be a few lines shorter due to browser and font variations.
|
| 340 |
+
#Default is 10.
|
| 341 |
+
MaxPromptLines: 10
|
| 342 |
+
#Options to override default VAEs with.
|
| 343 |
+
VAEs:
|
| 344 |
+
#What VAE to use with SDXL models by default. Use 'None' to use the one in the model.
|
| 345 |
+
DefaultSDXLVAE: None
|
| 346 |
+
#What VAE to use with SDv1 models by default. Use 'None' to use the one in the model.
|
| 347 |
+
DefaultSDv1VAE: None
|
| 348 |
+
#What VAE to use with SVD (Video) models by default. Use 'None' to use the one in the model. This should normally be an SDv1 VAE.
|
| 349 |
+
DefaultSVDVAE: None
|
| 350 |
+
#What VAE to use with Flux models by default.
|
| 351 |
+
DefaultFluxVAE: None
|
| 352 |
+
#What VAE to use with Flux2 models by default.
|
| 353 |
+
DefaultFlux2VAE: None
|
| 354 |
+
#What VAE to use with SD3 models by default.
|
| 355 |
+
DefaultSD3VAE: None
|
| 356 |
+
#What VAE to use with Mochi Text2Video models by default.
|
| 357 |
+
DefaultMochiVAE: None
|
| 358 |
+
#Set to a number above 1 to allow generations of multiple images to automatically generate square mini-grids when they're done.
|
| 359 |
+
MaxImagesInMiniGrid: 1
|
| 360 |
+
#How many images the history view should stop trying to load after.
|
| 361 |
+
MaxImagesInHistory: 1000
|
| 362 |
+
#How many images the history view should scan server-side before deciding the list is sufficient for sorting. Not relevant when sorting by filename.
|
| 363 |
+
MaxImagesScannedInHistory: 10000
|
| 364 |
+
#If true, the Image History view will cache small preview thumbnails of images.
|
| 365 |
+
#This should make things run faster. You can turn it off if you don't want that.
|
| 366 |
+
ImageHistoryUsePreviews: true
|
| 367 |
+
#When generating live previews (ie the turbo preview system, not normal generation previews after you've hit the Generate button),
|
| 368 |
+
#this is how many simultaneous generation requests can be waiting at one time.
|
| 369 |
+
MaxSimulPreviews: 1
|
| 370 |
+
#If true, hitting enter while in the prompt box starts generation.
|
| 371 |
+
#If false, hitting enter will insert a newline.
|
| 372 |
+
EnterKeyGenerates: true
|
| 373 |
+
#Delay, in seconds, between Generate Forever updates.
|
| 374 |
+
#If the delay hits and a generation is still waiting, it will be skipped.
|
| 375 |
+
#Default is 0.1 seconds.
|
| 376 |
+
GenerateForeverDelay: 0.1
|
| 377 |
+
#Number of generations that Generate Forever should always keep queued up when enabled.
|
| 378 |
+
#Useful when using multiple backends to keep them all busy.
|
| 379 |
+
GenerateForeverQueueSize: 1
|
| 380 |
+
#How long to remember your last parameters for, in hours, inside browser cookies.
|
| 381 |
+
#Default is 6 hours (long enough that you can close+reopen and get same params, but short enough that if you close for the day and come back you get a fresh UI).
|
| 382 |
+
ParameterMemoryDurationHours: 6
|
| 383 |
+
#What language to display the UI in.
|
| 384 |
+
#Default is 'en' (English).
|
| 385 |
+
Language: en
|
| 386 |
+
#Comma-separated list of parameters to exclude from 'Reuse Parameters'.
|
| 387 |
+
#For example, set 'model' to not copy the model, or 'model,refinermodel,videomodel' to really never copy any models.
|
| 388 |
+
ReuseParamExcludeList: wildcardseed
|
| 389 |
+
#Settings related to audio.
|
| 390 |
+
Audio:
|
| 391 |
+
#Optional audio file to play when a generation is completed.
|
| 392 |
+
#Supported file formats: .wav, .wave, .mp3, .aac, .ogg, .flac
|
| 393 |
+
#See <a target="_blank" href="https://github.com/mcmonkeyprojects/SwarmUI/blob/master/docs/Features/UISounds.md">docs/Features/UISounds</a> for info.
|
| 394 |
+
CompletionSound: \x
|
| 395 |
+
#If any sound effects are enabled, this is the volume they will play at.
|
| 396 |
+
#0 means silent, 1 means max volume, 0.5 means half volume.
|
| 397 |
+
Volume: 0.5
|
| 398 |
+
#Settings related to autocompletions.
|
| 399 |
+
AutoComplete:
|
| 400 |
+
#Optional source file for auto-completion texts (inside Data/Autocompletions).
|
| 401 |
+
#See <a target="_blank" href="https://github.com/mcmonkeyprojects/SwarmUI/blob/master/docs/Features/Autocompletions.md#word-lists">docs/Features/Autocompletions</a> for info.
|
| 402 |
+
Source: \x
|
| 403 |
+
#If true, the auto-completion will escape parentheses with backslashes to prevent parsing errors.
|
| 404 |
+
EscapeParens: true
|
| 405 |
+
#Optional suffix to append to autocompletes, eg ', ' to append commas.
|
| 406 |
+
Suffix: \x
|
| 407 |
+
#How to match and list results.
|
| 408 |
+
#'Contains' lists any match that contains your current text
|
| 409 |
+
#'StartsWith' only lists matches that start with your current text
|
| 410 |
+
#'Bucketed' shows StartsWith matches first, and Contains matches after.
|
| 411 |
+
MatchMode: Bucketed
|
| 412 |
+
#How to sort the results.
|
| 413 |
+
#'Active' sorts shortest tags first, then alphabetically after.
|
| 414 |
+
#'Alphabetical' sorts results alphabetically.
|
| 415 |
+
#'Frequency' sorts results by how popular the tag is (for tag CSVs).
|
| 416 |
+
#'None' uses whatever the source list's order is.
|
| 417 |
+
SortMode: Active
|
| 418 |
+
#If your completion list is booru tags, use this to optionally alter how spaces/underscores are handled.
|
| 419 |
+
#Select 'None' to just use what's in the file,
|
| 420 |
+
#'Spaces' to replace underscores to spaces,
|
| 421 |
+
#or 'Underscores' to replace spaces to underscores.
|
| 422 |
+
SpacingMode: None
|
| 423 |
+
#Settings related to backends.
|
| 424 |
+
Backends:
|
| 425 |
+
#How many times to retry initializing a backend before giving up. Default is 3.
|
| 426 |
+
MaxBackendInitAttempts: 3
|
| 427 |
+
#Safety check, the maximum duration all requests can be waiting for a backend before the system declares a backend handling failure.
|
| 428 |
+
#If you get backend timeout errors while intentionally running very long generations, increase this value.
|
| 429 |
+
MaxTimeoutMinutes: 120
|
| 430 |
+
#The maximum duration an individual request can be waiting on a backend to be available before giving up.
|
| 431 |
+
#Not to be confused with 'MaxTimeoutMinutes' which requires backends be unresponsive for that duration, this duration includes requests that are merely waiting because other requests are queued.
|
| 432 |
+
#Defaults to 60 * 24 * 7 = 1 week (ultra-long max queue duration).
|
| 433 |
+
PerRequestTimeoutMinutes: 10080
|
| 434 |
+
#The maximum number of pending requests to continue forcing orderly processing of.
|
| 435 |
+
#Over this limit, requests may start going out of order.
|
| 436 |
+
MaxRequestsForcedOrder: 20
|
| 437 |
+
#If true, max t2i simultaneous value is not limited by backend count.
|
| 438 |
+
#Ie, users may queue as many gens as they want directly to backends, with no overload prevention.
|
| 439 |
+
#This may be preferable on personal instances of Swarm to enforce stricter queue ordering.
|
| 440 |
+
#User role max t2i simultaneous value is still applied.
|
| 441 |
+
UnrestrictedMaxT2iSimultaneous: false
|
| 442 |
+
#How many minutes to wait after the last generation before automatically freeing up VRAM (to prevent issues with other programs).
|
| 443 |
+
#This has the downside of a small added bit of time to load back onto VRAM at next usage.
|
| 444 |
+
#Use a decimal number to free after seconds.
|
| 445 |
+
#Defaults to 10 minutes.
|
| 446 |
+
#Set to -1 to disable.
|
| 447 |
+
ClearVRAMAfterMinutes: 10
|
| 448 |
+
#How many minutes to wait after the last generation before automatically freeing up system RAM (to prevent issues with other programs).
|
| 449 |
+
#This has the downside of causing models to fully load from data drive at next usage.
|
| 450 |
+
#Use a decimal number to free after seconds.
|
| 451 |
+
#Defaults to 60 minutes (one hour).
|
| 452 |
+
#Set to -1 to disable.
|
| 453 |
+
ClearSystemRAMAfterMinutes: 60
|
| 454 |
+
#If true, any time you load the UI, trigger a server refresh.
|
| 455 |
+
#If false, only triggers a refresh if you restart Swarm or trigger a refresh manually from the Quick Tools menu.
|
| 456 |
+
#Defaults to true.
|
| 457 |
+
AlwaysRefreshOnLoad: true
|
| 458 |
+
#Preference for order of backend selection when loading a new model.
|
| 459 |
+
#'Last Used' will load the model on the last backend to load a model. This tends to distribute work between GPUs fairly.
|
| 460 |
+
#'First Free' will load the model on the first free backend. This tends to cause frequent model reloading on your first backend, and underuse of others.
|
| 461 |
+
#Defaults to Last Used.
|
| 462 |
+
ModelLoadOrderPreference: last_used
|
| 463 |
+
#If true, presume all backends can fast-load.
|
| 464 |
+
#For example, if you have multiple local comfy instances, allow them all to boot up at the same time.
|
| 465 |
+
AllBackendsLoadFast: false
|
| 466 |
+
#If this is set to 'true', hides the installer page. If 'false', the installer page will be shown.
|
| 467 |
+
IsInstalled: true
|
| 468 |
+
#The date that this instance was installed.
|
| 469 |
+
InstallDate: 2026-01-05
|
| 470 |
+
#The SwarmUI version that this instance was installed as.
|
| 471 |
+
InstallVersion: 0.9.7.4
|
| 472 |
+
#Ratelimit, in milliseconds, between Nvidia GPU status queries. Default is 1000 ms (1 second).
|
| 473 |
+
NvidiaQueryRateLimitMS: 1000
|
| 474 |
+
#How to launch the UI. If 'none', just quietly launch.
|
| 475 |
+
#If 'web', launch your web-browser to the page.
|
| 476 |
+
#If 'webinstall', launch web-browser to the install page.
|
| 477 |
+
#If 'electron', launch the UI in an electron window (NOT YET IMPLEMENTED).
|
| 478 |
+
LaunchMode: web
|
| 479 |
+
#If set true, some additional debugging data will be attached where relevant, such as in image metadata.
|
| 480 |
+
AddDebugData: false
|
| 481 |
+
#If set true, new/upcoming/experimental features will be visible.
|
| 482 |
+
#Enabling this will cause issues, do not expect a stable server.
|
| 483 |
+
#Do not report any bugs while this is enabled, and do not request new features related to experimental features.
|
| 484 |
+
ShowExperimentalFeatures: false
|
| 485 |
+
#Settings related to multi-user authorization.
|
| 486 |
+
UserAuthorization:
|
| 487 |
+
#If true, Swarm will require users to log in or use an API key to access the UI. If false, the UI will be open to anyone who can connect to it.
|
| 488 |
+
#Defaults to false.
|
| 489 |
+
#Make sure you know your own admin account login before enabling this!
|
| 490 |
+
AuthorizationRequired: false
|
| 491 |
+
#If true, a direct connection from localhost can bypass login requirements.
|
| 492 |
+
#If false, even local users will be required to login (they can just go manually edit the server settings file to toggle this though).
|
| 493 |
+
#Defaults to true.
|
| 494 |
+
AllowLocalhostBypass: true
|
| 495 |
+
#Title of this SwarmUI instance.
|
| 496 |
+
#Displayed eg in some page headers and logs.
|
| 497 |
+
#Keep it simple, avoid html text in here.
|
| 498 |
+
InstanceTitle: Local
|
| 499 |
+
#Message to add on the login page.
|
| 500 |
+
#You may use (basic!) HTML here.
|
| 501 |
+
#It is recommended to add contact information here, such as a Discord invite code or an email address.
|
| 502 |
+
LoginNotice: This is a local instance not yet configured for shared usage. If you're seeing this on the login screen, ask the server owner to fill it in on the Server Configuration page.
|
| 503 |
+
#Settings related to logging.
|
| 504 |
+
Logs:
|
| 505 |
+
#The minimum tier of logs that should be visible in the console and saved to file.
|
| 506 |
+
#Default is 'info'.
|
| 507 |
+
LogLevel: Info
|
| 508 |
+
#If true, logs will be saved to a file. If false, logs will be available in console and UI while running, but never saved to file.
|
| 509 |
+
#Defaults to false.
|
| 510 |
+
#Must restart Swarm to apply.
|
| 511 |
+
SaveLogToFile: false
|
| 512 |
+
#The path for where to store log file, parsed at time of program start, relative to the Data directory.
|
| 513 |
+
#Must restart Swarm to apply.
|
| 514 |
+
#Can use [year], [month], [month_name], [day], [day_name], [hour], [minute], [second], [pid].
|
| 515 |
+
LogsPath: Logs/[year]-[month]/[day]-[hour]-[minute].log
|
| 516 |
+
#How long (in minutes) the console may be idle for before the next message should have a full date/time stamp shown in it.
|
| 517 |
+
#This is for Swarm instances that are left open for long times, to make gaps in usage clearer.
|
| 518 |
+
#This will not show at all in Swarm is used consistently smaller than this duration.
|
| 519 |
+
#Set to 9999999 to disable this behavior.
|
| 520 |
+
#Defaults to 10 minutes.
|
| 521 |
+
RepeatTimestampAfterMinutes: 10
|
| 522 |
+
#Settings related to the User Interface.
|
| 523 |
+
UI:
|
| 524 |
+
#Optionally specify a (raw HTML) welcome message here. If specified, will override the automatic welcome messages.
|
| 525 |
+
OverrideWelcomeMessage: \x
|
| 526 |
+
#Optionally specify a (raw HTML) welcome message here. If specified, will be added to the standard welcome message.
|
| 527 |
+
ExtraWelcomeInfo: \x
|
| 528 |
+
#Animated previews make the image history nicer when you've generated videos, but may negatively impact performance.
|
| 529 |
+
#If having image history loaded with videos generated is negatively affecting your experience, disable this checkbox.
|
| 530 |
+
#After editing this setting, use the Reset All Metadata button in the Utilities tab.
|
| 531 |
+
AllowAnimatedPreviews: true
|
| 532 |
+
#Settings related to webhooks. See documentation in <a target="_blank" href="https://github.com/mcmonkeyprojects/SwarmUI/blob/master/docs/Features/Webhooks.md">the docs here</a>
|
| 533 |
+
WebHooks:
|
| 534 |
+
#Webhook to call (JSON POST) when queues are starting up from idle.
|
| 535 |
+
#Leave empty to disable any webhook.
|
| 536 |
+
#Call must return before the first generation starts.
|
| 537 |
+
QueueStartWebhook: \x
|
| 538 |
+
#If you want to send additional data with the queue start webhook, you can specify it here.
|
| 539 |
+
#This should be a JSON object, eg '{"key": "value"}'.
|
| 540 |
+
#If left blank, an empty JSON post (ie '{}') will be used.
|
| 541 |
+
QueueStartWebhookData: \x
|
| 542 |
+
#Webhook to call (JSON POST) when all queues are done and the server is going idle.
|
| 543 |
+
#Leave empty to disable any webhook.
|
| 544 |
+
#Call must return before queuing may restart.
|
| 545 |
+
QueueEndWebhook: \x
|
| 546 |
+
#If you want to send additional data with the queue end webhook, you can specify it here.
|
| 547 |
+
#This should be a JSON object, eg '{"key": "value"}'.
|
| 548 |
+
#If left blank, an empty JSON post (ie '{}') will be used.
|
| 549 |
+
QueueEndWebhookData: \x
|
| 550 |
+
#Webhook to call (JSON POST) after every generation.
|
| 551 |
+
#Leave empty to disable any webhook.
|
| 552 |
+
#Currently runs async, does not delay gen completion.
|
| 553 |
+
EveryGenWebhook: \x
|
| 554 |
+
#If you want to send additional data with the every-gen webhook, you can specify it here.
|
| 555 |
+
#This should be a JSON object, eg '{"key": "value"}'.
|
| 556 |
+
#If left blank, an empty JSON post (ie '{}') will be used.
|
| 557 |
+
#See <a target="_blank" href="https://github.com/mcmonkeyprojects/SwarmUI/blob/master/docs/Features/Webhooks.md">docs Features/Webhooks</a> for info about special tags you can include in the JSON.
|
| 558 |
+
EveryGenWebhookData: \x
|
| 559 |
+
#Webhook to call (JSON POST) after gens that set Swarm internal param 'Webook' as 'Manual' or 'Manual At End'.
|
| 560 |
+
#Leave empty to disable any webhook.
|
| 561 |
+
#Currently runs async, does not delay gen completion.
|
| 562 |
+
ManualGenWebhook: \x
|
| 563 |
+
#If you want to send additional data with the 'manual gen' webhook, you can specify it here.
|
| 564 |
+
#This should be a JSON object, eg '{"key": "value"}'.
|
| 565 |
+
#If left blank, an empty JSON post (ie '{}') will be used.
|
| 566 |
+
#See <a target="_blank" href="https://github.com/mcmonkeyprojects/SwarmUI/blob/master/docs/Features/Webhooks.md">docs Features/Webhooks</a> for info about special tags you can include in the JSON.
|
| 567 |
+
ManualGenWebhookData: \x
|
| 568 |
+
#Webhook to call (JSON POST) when the server is has started.
|
| 569 |
+
#Leave empty to disable any webhook.
|
| 570 |
+
ServerStartWebhook: \x
|
| 571 |
+
#If you want to send additional data with the 'server start' webhook, you can specify it here.
|
| 572 |
+
#This should be a JSON object, eg '{"key": "value"}'.
|
| 573 |
+
#If left blank, an empty JSON post (ie '{}') will be used.
|
| 574 |
+
ServerStartWebhookData: \x
|
| 575 |
+
#Webhook to call (JSON POST) when the server is about to shutdown.
|
| 576 |
+
#Leave empty to disable any webhook.
|
| 577 |
+
#Shutdown does not happen until the webhook completes.
|
| 578 |
+
ServerShutdownWebhook: \x
|
| 579 |
+
#If you want to send additional data with the 'server shutdown' webhook, you can specify it here.
|
| 580 |
+
#This should be a JSON object, eg '{"key": "value"}'.
|
| 581 |
+
#If left blank, an empty JSON post (ie '{}') will be used.
|
| 582 |
+
ServerShutdownWebhookData: \x
|
| 583 |
+
#How long to wait (in seconds) after all queues are done before sending the queue end webhook.
|
| 584 |
+
#This is useful to prevent rapid start+end calls.
|
| 585 |
+
QueueEndDelay: 1
|
| 586 |
+
#Settings related to server performance.
|
| 587 |
+
Performance:
|
| 588 |
+
#How likely an outdated image metadata entry is to be revalidated (ie have it's mtime checked against storage) each time an image's metadata is pulled.
|
| 589 |
+
#Default 0.05 means 5% chance.
|
| 590 |
+
#SSD users can safely set it higher. HDD users may be happier setting it to 0.
|
| 591 |
+
#Metadata is always loaded the first time an image is seen.
|
| 592 |
+
ImageDataValidationChance: 0.05
|
| 593 |
+
#Can be enabled to cache certain backend data.
|
| 594 |
+
#For example, with ComfyUI backends this will add an extended cache on the object_info data.
|
| 595 |
+
#Defaults to false.
|
| 596 |
+
DoBackendDataCache: false
|
| 597 |
+
#If true, Swarm may use GPU-specific optimizations.
|
| 598 |
+
#If false, Swarm will not try to optimize anything in a way specific to the GPU(s) you have.
|
| 599 |
+
#Some very minor quality changes may result.
|
| 600 |
+
#If you encounter errors that are solved by turning this off, please report that as a bug immediately.
|
| 601 |
+
#Defaults to 'true'. Should be left as 'true' in almost all circumstances.
|
| 602 |
+
AllowGpuSpecificOptimizations: true
|
| 603 |
+
#How many models can be loaded in a model list at once.
|
| 604 |
+
#Past this count, the list will simply be cut off.
|
| 605 |
+
#Use sub-folder organization to prevent issues.
|
| 606 |
+
ModelListSanityCap: 5000
|