Deployment Overview of ComfyUI on Server¶

Prerequisites and Basic Requirements¶

• Operating System: Debian-based Linux distribution.

• Privileges: Root access is required to install system packages, modify hosts, and manage systemd services.

• Ports: The application listens internally on port 8188. External access is routed via port 443 through a reverse proxy.

• Domain: The deployment utilizes the hostkey.in domain zone.

FQDN of the Final Panel¶

The final accessible address for the ComfyUI panel is: comfyuiServer ID.hostkey.in:443

Note: Replace Server ID with the specific identifier assigned to the host instance.

File and Directory Structure¶

The following directory structure is established during the deployment:

Application Installation Process¶

The installation process involves the following steps:

1. System Update: APT packages are updated and upgraded.

2. Repository Clone: The ComfyUI source code is cloned to /root/ComfyUI from https://github.com/comfyanonymous/ComfyUI.git.

3. Dependency Installation:

   • Python pip (python3-pip) is installed via APT.

   • PyTorch is installed using pip with the CUDA 12.6 index URL:

     /usr/bin/pip install torch torchvision torchaudio --extra-index-url https://download.pytorch.org/whl/cu126
     

   • Application requirements are installed from the local requirements.txt:

     /usr/bin/pip install -r requirements.txt
     

4. Hosts Configuration: The IP address 5.180.174.199 is added to /etc/hosts as an alias for huggingface.co to optimize model downloads.

5. Model Deployment:

   • A check is performed for the existence of the Flux model at /root/ComfyUI/models/checkpoints/flux1-dev-fp8.safetensors.

   • If missing or incomplete, the model is downloaded from https://huggingface.co/Comfy-Org/flux1-dev/resolve/main/flux1-dev-fp8.safetensors with resume capability.

6. Workflow Setup:

   • The directory /root/ComfyUI/user/default/workflows is created with permissions 0755.

   • A workflow configuration file flux1-dev-fp8.json is deployed to this directory.

7. Configuration: The file /root/ComfyUI/user/default/comfy.settings.json is configured.

8. Service Creation: The systemd service unit comfyui.service is created in /etc/systemd/system/.

9. Service Activation: The service is enabled and started immediately.

Access Rights and Security¶

• Firewall: External traffic is handled by the Nginx container which manages port 443. Direct access to port 8188 is restricted to internal use unless explicitly configured otherwise.

• Users: The ComfyUI service runs with root privileges as defined in the systemd unit file.

• Restrictions: Access to the Hugging Face repository is routed through a modified /etc/hosts entry to ensure reliable connectivity for model downloads.

Docker Containers and Their Deployment¶

The deployment utilizes Docker for the reverse proxy and SSL management.

1. Docker Installation: The Docker engine is installed and configured on the host.

2. Proxy Configuration:

   • A directory /root/nginx is created with root ownership.

   • A compose.yml file is generated in /root/nginx/.

3. Container Launch: The docker compose up -d command is executed in the /root/nginx directory to start the services.

Docker Service Details¶

The compose.yml defines the following service:

• Service Name: nginx

• Image: jonasal/nginx-certbot:latest

• Restart Policy: unless-stopped

• Network Mode: host

• Environment:

  • CERTBOT_EMAIL: Set to [email protected]

• Volumes:

  • nginx_secrets mounted to /etc/letsencrypt (SSL certificates).

  • /data/nginx/user_conf.d mounted to /etc/nginx/user_conf.d (Nginx configs).

• Dependencies: Relies on the docker-managed-install and docker-certbot-proxy roles for environment setup.

Proxy Servers¶

A reverse proxy is configured using the jonasal/nginx-certbot Docker image to handle HTTPS traffic and SSL certificate management.

• Nginx: Acts as the reverse proxy, routing external requests from port 443 to the internal ComfyUI port 8188.

• Certbot: Integrated within the Docker container to automatically obtain and renew SSL certificates via Let's Encrypt.

• SSL Certificates: Stored in the external volume nginx_secrets mounted at /etc/letsencrypt.

• Configuration: Custom Nginx configurations are stored in /data/nginx/user_conf.d and loaded by the container.

Permission Settings¶

The following permissions are set on the deployed files and directories:

Location of Configuration Files and Data¶

• Application Source: /root/ComfyUI

• User Workflows: /root/ComfyUI/user/default/workflows

• Application Settings: /root/ComfyUI/user/default/comfy.settings.json

• Systemd Service: /etc/systemd/system/comfyui.service

• Proxy Compose File: /root/nginx/compose.yml

• Proxy Environment: /data/nginx/nginx-certbot.env

• Hosts Entry: /etc/hosts (contains 5.180.174.199 huggingface.co)

Available Ports for Connection¶

The deployment exposes the following ports:

Starting, Stopping, and Updating¶

The ComfyUI application is managed as a systemd service. Use the following commands:

• Start the Service:

  systemctl start comfyui
  

• Stop the Service:

  systemctl stop comfyui
  

• Restart the Service:

  systemctl restart comfyui
  

• Enable on Boot:

  systemctl enable comfyui
  

• Check Status:

  systemctl status comfyui
  

For the Nginx proxy container, management is handled via Docker Compose within the /root/nginx directory:

• Start/Restart Containers:

  cd /root/nginx
  docker compose up -d