update README and .env.example

This commit is contained in:
Sebastian Monroy
2025-08-11 13:52:32 +01:00
parent 2387d0e0ad
commit e5b165605a
2 changed files with 27 additions and 7 deletions
-7
View File
@@ -1,10 +1,3 @@
SQS_ENDPOINT_URL=http://localhost:9324
SQS_JOBS_TO_PROCESS_QUEUE_NAME="jobs_to_process"
AWS_ACCESS_KEY_ID=minioadmin
AWS_SECRET_ACCESS_KEY=...
AWS_DEFAULT_REGION=us-east-1
COMFYUI_API_URL=
# --- For media_stream.py (Output Node) ---
# Endpoint for the SQS service where completion messages are sent.
SQS_ENDPOINT_URL=http://localhost:9324
+27
View File
@@ -188,4 +188,31 @@ Uploads video files to a HuggingFace dataset.
| filename_prefix | STRING | Prefix for saved files |
**Notes**: Handles batch upload of multiple video files.
</details>
## 📡 Core Nilor Services
<details>
<summary><b>Worker Consumer Service</b></summary>
The `worker_consumer.py` script is a background service that runs on each ComfyUI worker. It is responsible for pulling jobs from the central ElasticMQ `jobs_to_process` queue and submitting them to its local ComfyUI instance for processing. This service is essential for the distributed architecture of the system.
**Key Responsibilities:**
- Continuously polls the `jobs_to_process` queue for new jobs using long polling.
- When a job is received, it extracts the workflow data and submits it to the local ComfyUI server.
- Deletes the job message from the queue upon successful submission to prevent reprocessing.
- If submission fails, the message remains on the queue to be picked up by another worker.
</details>
<details>
<summary><b>Environment Variables</b></summary>
The `nilor-nodes` require a `.env` file to be present in the `ComfyUI` directory to configure the connection to the core services (MinIO, ElasticMQ, and the Brain API). To set it up, create a file named `.env` in the root of your `ComfyUI` directory by copying the `.env.example` template.
**Instructions:**
1. Create a new file named `.env` in the `ComfyUI` directory.
2. Copy the contents of the `.env.example` file into your new `.env` file.
3. Replace the placeholder values with your actual credentials and endpoint URLs for your local or production environment.
</details>