(docs) update
This commit is contained in:
kevin96666
@@ -27,54 +27,14 @@ cd ComfyUI-Manager && pip install -r requirements.txt
|
||||
cd SDFXBridgeForComfyUI && pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## Configuration
|
||||
## Configuration file
|
||||
|
||||
In the sdfx node directory, you will find a sample configuration file named `sdfx.config.example.json`. Rename this file to `sdfx.config.json` and customize the paths for various modules. Here is an example configuration:
|
||||
You will find a sample configuration file named `sdfx.config.example.json`.
|
||||
This file is not mandatory.
|
||||
If you want to us it, please rename it to `sdfx.config.json` and customize it.
|
||||
|
||||
```json
|
||||
{
|
||||
"args": {
|
||||
"disable-xformers": false,
|
||||
"preview-method": "taesd",
|
||||
"listen": "127.0.0.1",
|
||||
"enable-cors-header": false,
|
||||
"port": 8188
|
||||
},
|
||||
For detailed explainations on how this file works, please read the [doc](https://github.com/sdfxai/SDFXBridgeForComfyUI/blob/master/docs/sdfx_config.md)
|
||||
|
||||
"paths": {
|
||||
"media": {
|
||||
"gallery": "data/media/gallery",
|
||||
"input": "data/media/input",
|
||||
"output": "data/media/output",
|
||||
"workflows": "data/media/workflows",
|
||||
"templates": "data/media/templates",
|
||||
"temp": "data/media/temp"
|
||||
},
|
||||
|
||||
"models": {
|
||||
"checkpoints": ["data/models/checkpoints"],
|
||||
"clip": ["data/models/clip"]
|
||||
// ... (other model paths)
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
### Path Configuration
|
||||
|
||||
- Each path under `paths` (e.g., `media`, `models`) represents a category of resources.
|
||||
- Sub-keys (e.g., `gallery`, `checkpoints`) specify the specific resource paths.
|
||||
- Paths can be relative, absolute, or omitted based on user preferences.
|
||||
- If a path is relative, files will be read from the sdfx.config.json file's root.
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Users can place if they want the `sdfx.config.json` file anywhere on their computer. To make it work, ComfyUI should be launched with the `--sdfx-config-file` flag:
|
||||
|
||||
```bash
|
||||
python main.py --sdfx-config-file=/path/to/sdfx.config.json
|
||||
```
|
||||
Note: All relative paths configured in `sdfx.config.json` will be relative to the location of sdfx.config.json.
|
||||
## License
|
||||
|
||||
This project is licensed under the AGPL-3.0 license.
|
||||
|
||||
@@ -0,0 +1,83 @@
|
||||
# SDFX config Documentation
|
||||
|
||||
## Introduction
|
||||
This JSON configuration file contains settings and paths for the application.
|
||||
|
||||
**None of the parameters are mandatory**
|
||||
|
||||
## Global Parameters (`args`)
|
||||
This section details each global parameter along with its meaning and possible values.
|
||||
- `disable-xformers`: Boolean indicating whether xformers are disabled.
|
||||
- `preview-method`: Method used for previewing.
|
||||
- `listen`: IP address to listen for connections.
|
||||
- `enable-cors-header`: Boolean indicating whether CORS headers are enabled.
|
||||
- `port`: Port on which the service is listening.
|
||||
|
||||
For sdfx users using their own ComfyUI instance :
|
||||
|
||||
These parameters override the default flags passed to the main.py script upon launching ComfyUI.
|
||||
|
||||
```python main.py --disable-xformers --listen=127.0.0.1```
|
||||
|
||||
can be replaced with :
|
||||
|
||||
```python main.py --sdfx-config-file=/path/to/sdfx.config.json```
|
||||
|
||||
|
||||
## Paths (`paths`)
|
||||
This section describes the different paths used in the application.
|
||||
- `media`: Paths to media directories.
|
||||
- `gallery`: Directory for media galleries.
|
||||
- `input`: Directory for media input files.
|
||||
- `output`: Output directory for processed media.
|
||||
- `workflows`: Directory for media workflows.
|
||||
- `templates`: Directory for media templates.
|
||||
- `temp`: Temporary directory for media.
|
||||
- `models`: Paths to model directories.
|
||||
- `checkpoints`: Array of directories for model checkpoints.
|
||||
- `clip`: Array of directories for clip models.
|
||||
- `clip_vision`: Array of directories for clip vision models.
|
||||
- ...
|
||||
|
||||
|
||||
All the paths can be specified as either relative or absolute.
|
||||
|
||||
If a path is defined as relative, it will be resolved relative to the location of the `sdfx.config.json` file.
|
||||
|
||||
For example, if the configuration includes:
|
||||
|
||||
```json
|
||||
"checkpoints": [
|
||||
"data/models/checkpoints"
|
||||
]
|
||||
```
|
||||
and the absolute path of sdfx.config.json is `/x/y/sdfx.config.json`, the checkpoints will be searched for at :
|
||||
```/x/y/data/models/checkpoints```
|
||||
|
||||
## Usage Examples
|
||||
If you are already using ComfyUI extra_model_paths.yaml to configure the path of your models you don't need to redeclare it
|
||||
|
||||
So a minimalist configuration could be :
|
||||
|
||||
```json
|
||||
{
|
||||
"args": {
|
||||
"disable-xformers": true,
|
||||
"preview-method": "taesd",
|
||||
"listen": "127.0.0.1",
|
||||
"enable-cors-header": true,
|
||||
"port": 8188
|
||||
},
|
||||
|
||||
"paths": {
|
||||
"media": {
|
||||
"gallery": "data/media/gallery",
|
||||
"input": "data/media/input",
|
||||
"output": "data/media/output",
|
||||
"workflows": "data/media/workflows",
|
||||
"templates": "data/media/templates",
|
||||
"temp": "data/media/temp"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user