AI Image Frame Server

This project is a Flask-based web server designed to generate and display images from various AI models, primarily interacting with ComfyUI. It can be configured to automatically generate new images at scheduled times and provides a gallery to view the generated images.

Features

• Web Interface: A simple web interface to view generated images, manage favourites, and monitor job queues.
• Image Generation: Integrates with ComfyUI to generate images using SDXL, FLUX, and Qwen models based on given prompts.
• Prompt Generation: Automatic prompt generation using OpenWebUI or OpenRouter APIs with topic-based theming.
• Scheduled Generation: Automatically generates new images at a configurable time.
• Favourites System: Mark and manage favourite images.
• Job Queue Management: View and cancel running/pending image generation jobs.
• Thumbnail Generation: Automatic thumbnail creation for generated images.
• Prompt Logging: Maintains a log of recent prompts to avoid repetition.
• Settings Management: Web-based configuration editor for all settings.
• Docker Support: Comes with a Dockerfile and docker-compose.yml for easy setup and deployment.
• Configurable: Most options can be configured through a user_config.cfg file or web interface.
• Authentication: Optional password protection for image creation.
• Version Management: Uses bump-my-version for version tracking.

Prerequisites

• Python 3.11
• Docker (for containerized deployment)
• An instance of ComfyUI running and accessible from the server.

Installation and Setup

Manual Setup

1. Clone the repository:

   git clone <repository_url>
   cd ai_image_frame_server
   

2. Install dependencies:

   pip install -r requirements.txt
   

3. Configure the application:

   • The user_config.cfg file will be automatically created from user_config.cfg.sample on first run if it doesn't exist.
   • Edit user_config.cfg with your settings, or use the web-based settings page accessible by clicking the version number in the bottom right corner of the home page. See the Configuration section for more details.

4. Run the application:

   export SECRET_KEY='a_very_secret_key'
   python ai_frame_image_server.py
   

Docker Setup

1. Clone the repository:

   git clone <repository_url>
   cd ai_image_frame_server
   

2. Configure the application:

   • The user_config.cfg file will be automatically created from user_config.cfg.sample on first run if it doesn't exist.
   • Edit user_config.cfg with your settings, or use the web-based settings page accessible by clicking the version number in the bottom right corner of any page. The comfyui_url should be the address of your ComfyUI instance, accessible from within the Docker network (e.g., http://host.docker.internal:8188 or your server's IP).

3. Build and run with Docker Compose:

   docker-compose up --build
   

   The application will be available at http://localhost:8088.

Configuration

The application is configured via the user_config.cfg file.

Section	Key	Description	Default (from sample)
[frame]	reload_interval	How often the gallery page reloads in milliseconds.	30000
[frame]	auto_regen	Enable or disable automatic image generation (True/False).	True
[frame]	regen_time	The time to automatically generate a new image (HH:MM).	03:00
[frame]	port	The port the Flask application will run on.	5000
[frame]	create_requires_auth	Require a password to create images (True/False).	False
[frame]	password_for_auth	The password to use for image creation if authentication is enabled.	create
[comfyui]	comfyui_url	The URL of your ComfyUI instance.	http://comfyui
[comfyui]	models	A comma-separated list of models to use for generation.	zavychromaxl_v100.safetensors,ponyDiffusionV6XL_v6StartWithThisOne.safetensors
[comfyui]	output_dir	The directory to save generated images to.	./output/
[comfyui]	prompt	The prompt to use for generating a random prompt for stable diffusion.	"Generate a random detailed prompt for stable diffusion."
[comfyui]	width	The width of the generated image.	1568
[comfyui]	height	The height of the generated image.	672
[comfyui]	topics	A comma-separated list of topics to generate prompts from.
[comfyui]	secondary_topic	A secondary topic for prompt generation.
[comfyui]	flux	Enable FLUX models (True/False).	False
[comfyui]	qwen	Enable Qwen models (True/False).	False
[comfyui:flux]	models	A comma-separated list of FLUX models.	flux1-dev-Q4_0.gguf,flux1-schnell-Q4_0.gguf
[comfyui:qwen]	models	A comma-separated list of Qwen models.	qwen-image-Q4_K_S.gguf, qwen-image-Q2_K.gguf
[openwebui]	base_url	The base URL for OpenWebUI.	https://openwebui
[openwebui]	api_key	The API key for OpenWebUI.	sk-
[openwebui]	models	A comma-separated list of models for OpenWebUI.	llama3:latest,cogito:14b,gemma3:12b
[openrouter]	enabled	Enable OpenRouter integration (True/False).	False
[openrouter]	api_key	The API key for OpenRouter.
[openrouter]	models	A comma-separated list of models for OpenRouter.	mistralai/mistral-7b-instruct:free,google/gemma-7b-it:free,meta-llama/llama-3.1-8b-instruct:free
[openrouter]	list_all_free_models	List all free models (True/False).	False

Usage

• Gallery: Open your browser to http://<server_ip>:<port> to see the gallery of generated images.
• Create Image: Navigate to /create or /create_image to manually trigger image generation with various model options.
• Job Queue: Monitor and cancel running/pending jobs via the gallery interface.
• API Endpoints:
  • /api/queue - Get current job queue details (JSON)
  • /cancel - Cancel the current running job

Dependencies

• Flask
• comfy_api_simplified
• APScheduler
• Pillow
• tenacity
• nest_asyncio
• openai
• websockets
• bump-my-version
• openwebui-chat-client
• And others, see requirements.txt.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

This project is unlicensed.