n8n templatesn8n templates

puq-docker-immich-deploy

This workflow is designed to automate the deployment and management of Docker-based Immich service instances, supporting operations such as starting, stopping, mounting, setting permissions, and retrieving logs for containers. Through API interfaces and SSH remote execution, users can flexibly manage the container lifecycle and achieve one-stop status monitoring and user management. Additionally, the built-in nginx proxy configuration feature ensures stable operation of the service in a reverse proxy environment, making it suitable for cloud service providers, system operations personnel, and enterprise IT teams, thereby enhancing operational efficiency and service delivery quality.

Workflow Diagram
puq-docker-immich-deploy Workflow diagram

Workflow Name

puq-docker-immich-deploy

Key Features and Highlights

This workflow is designed to automate the deployment and management of Docker-based Immich service instances. It integrates API interfaces, SSH remote execution, and Docker container management, supporting operations such as container start/stop, disk mount/unmount, permission settings, log retrieval, status monitoring, and user management. Through flexible command branching and parameter configuration, it enables full lifecycle management of the Immich service and its dependent containers. It also includes automatic generation and updating of nginx proxy configurations to ensure stable operation within a reverse proxy environment.

Core Problems Addressed

  • Automated deployment and management of Immich service containers, reducing manual operations and configuration errors.
  • Dynamic management of container storage mounts to ensure data persistence and isolation.
  • Unified API control for easy integration with systems like WHMCS/WISECP.
  • Centralized management of logs, status, permissions, and users to improve operational efficiency.
  • Secure command execution via SSH to guarantee safe and controllable operations.

Use Cases

  • Cloud service providers rapidly deploying Immich photo management services for customers.
  • Enterprises automating multi-tenant Immich instance management internally.
  • Integration with billing management platforms such as WHMCS/WISECP to automate Docker service provisioning, suspension, renewal, and other operations.
  • DevOps teams centrally monitoring and maintaining Immich container environments.

Main Workflow Steps

  1. Receive API Requests: Accept external command requests via webhook with authentication.
  2. Parameter Configuration: Set server domain, data storage directories, mount points, and other parameters based on request content.
  3. Command Parsing: Use conditional nodes to interpret operation commands (e.g., create, start, stop, mount disk).
  4. Execute SSH Commands: Remotely run corresponding shell scripts via SSH to perform Docker container operations and environment setup.
  5. Configuration Generation and Update:
    • Automatically generate docker-compose.yml for container orchestration.
    • Generate and update nginx proxy configuration files, applying access control lists (ACLs).
  6. Status and Log Collection: Retrieve container runtime status, performance metrics, and logs for feedback.
  7. User and Version Management: Query Immich application versions and user information, supporting password resets and other management functions.
  8. API Response: Return operation results in JSON format for caller consumption.

Involved Systems and Services

  • Docker: Containerized deployment of Immich and its dependencies (database, Redis, machine learning services).
  • SSH Remote Execution: Securely execute deployment and management commands on remote servers.
  • Webhook API: Receive external system requests (e.g., from WHMCS/WISECP) to enable automated control.
  • nginx Proxy: Reverse proxy configuration managing access control and request forwarding.
  • Immich Service: Open-source self-hosted photo management backend.
  • PostgreSQL Database: Stores Immich data.
  • Redis Cache: Provides high-speed caching support.

Target Users and Value Proposition

  • Cloud Service Providers: Automated deployment and management solution for Immich photo management services, enhancing customer delivery efficiency.
  • System Administrators: Simplify multi-instance Immich operations with API-driven batch management and monitoring.
  • Developers and Integrators: Facilitate integration of Immich container management into existing billing and customer management platforms.
  • Enterprise IT Teams: Quickly build private photo management platforms ensuring data security and service stability.
  • Technical Support Teams: Rapidly troubleshoot and resolve issues through log and status collection nodes.

This workflow delivers a comprehensive, efficient, and secure service management framework for automated deployment and operation of Immich in Docker environments. By leveraging API and SSH technologies, it significantly reduces manual effort while improving service delivery speed and quality.