nodes/Mattabyte-ComfyUI-SecureApiCall
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Mattabyte
2025-01-28 14:20:45 +10:00
parent 96f0adc0c6
commit a2e605a39f
1 changed files with 12 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+12 -5
View File
@@ -10,15 +10,22 @@ Send a JSON message to the specified URL. Supports basic api key authentication.
## A Note on Security
This package is designed to be used in a secure environment.
It is not recommended to use this package in a public environment.
99.99% of the time, you should use the prefix '$ENV.<Some_Variable_Name>' to access the environment variables for the api_url and api_auth fields.
99.99% of the time, you should use the prefix:
```
$ENV.<Some_Variable_Name>
```
to access the environment variables for the api_url and api_auth fields.
This keeps your secrets out of the metadata of the output.
**IF YOU DO NOT ADD THE --disable-metadata FLAG TO COMFYUI, THIS _WILL_ SPILL SECRETS IN THE METADATA OF THE OUTPUT.**
**You must ensure that the metadata is not attached to _any_ outputs, as some nodes will not respect the --disable-metadata flag and will attach their own metadata.**
**IF YOU DO NOT USE ENVIRONMENT VARIABLES, THIS _WILL_ SPILL SECRETS IN THE METADATA.**
This package is designed to be used in a secure environment. It is not recommended to use this package in a public environment.
Make sure to add the --disable-metadata flag to your comfyui command, to prevent the metadata from being attached outputs -- but be aware that some nodes will not respect this flag and will attach their own metadata.
You must ensure that the metadata is not attached to _any_ outputs, as some nodes will not respect
the --disable-metadata flag and will attach their own metadata.
In the event that you need to use the metadata, you absolutely must use the prefix '$ENV.<Some_Variable_Name>' in any fields you want to keep secret.