Skip to content

Commit 8ade7f6

Browse files
committed
docs: added config section
1 parent 99e116b commit 8ade7f6

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

.runpod/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,19 @@ This worker comes with the **FLUX.1-dev-fp8** (`flux1-dev-fp8.safetensors`) mode
3535

3636
Follow the [Customization Guide](https://github.com/runpod-workers/worker-comfyui/blob/main/docs/customization.md) to manually create your own custom worker by editing Dockerfiles and managing dependencies yourself.
3737

38+
## Configuration
39+
40+
For all available environment variables including Comfy.org API key, S3 upload, logging, and debugging options, see the [Configuration Guide](https://github.com/runpod-workers/worker-comfyui/blob/main/docs/configuration.md).
41+
3842
## Usage
3943

4044
The worker accepts the following input parameters:
4145

42-
| Parameter | Type | Default | Required | Description |
43-
| :--------- | :------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
44-
| `workflow` | `object` | `None` | **Yes** | The entire ComfyUI workflow in the API JSON format. See the main project [README.md](https://github.com/runpod-workers/worker-comfyui#how-to-get-the-workflow-from-comfyui) for instructions on how to export this from the ComfyUI interface. |
45-
| `images` | `array` | `[]` | No | An optional array of input images. Each image object should contain `name` (string, required, filename to reference in the workflow) and `image` (string, required, base64-encoded image data). |
46+
| Parameter | Type | Default | Required | Description |
47+
| :------------------ | :------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
48+
| `workflow` | `object` | `None` | **Yes** | The entire ComfyUI workflow in the API JSON format. See the main project [README.md](https://github.com/runpod-workers/worker-comfyui#how-to-get-the-workflow-from-comfyui) for instructions on how to export this from the ComfyUI interface. |
49+
| `images` | `array` | `[]` | No | An optional array of input images. Each image object should contain `name` (string, required, filename to reference in the workflow) and `image` (string, required, base64-encoded image data). |
50+
| `comfy_org_api_key` | `string` | `None` | No | Optional Comfy.org API key for ComfyUI API Nodes. Overrides the `COMFY_ORG_API_KEY` environment variable if set. |
4651

4752
> [!NOTE]
4853
> The `input.images` array has specific size constraints based on RunPod API limits (10MB for `/run`, 20MB for `/runsync`). See the main [README.md](https://github.com/runpod-workers/worker-comfyui#inputimages) for details.

0 commit comments

Comments
 (0)