From a2e605a39feeb26c81652a996b8dcf33276fe240 Mon Sep 17 00:00:00 2001 From: Mattabyte Date: Tue, 28 Jan 2025 14:20:45 +1000 Subject: [PATCH] update README --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 719d4db..5a3c313 100644 --- a/README.md +++ b/README.md @@ -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.' to access the environment variables for the api_url and api_auth fields. +99.99% of the time, you should use the prefix: + +``` +$ENV. +``` + +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.' in any fields you want to keep secret.