n8n Docker Immich API Backend Deployment Workflow

This n8n workflow provides a robust and flexible framework for deploying a Dockerized Immich API backend. It acts as a central control point, allowing you to trigger deployments, apply conditional logic, and execute SSH commands on a remote server, all while providing clear feedback.

What it does

This workflow is designed to streamline the deployment process for the Immich API backend. Here's a step-by-step breakdown:

1. Receives Webhook Trigger: The workflow starts by listening for incoming HTTP POST requests via a Webhook. This acts as the trigger for the entire deployment process.
2. Initial Field Editing: Upon receiving the webhook, the workflow uses an "Edit Fields (Set)" node. While the specific fields being edited are not defined in the provided JSON, this node typically allows for modifying, adding, or removing data from the incoming webhook payload, preparing it for subsequent steps.
3. Conditional Logic (If): A crucial "If" node introduces conditional branching. This node likely evaluates a condition based on the incoming data (e.g., a specific parameter in the webhook payload) to determine the next course of action.
   • True Branch: If the condition evaluates to true, the workflow proceeds to a "Switch" node.
   • False Branch: If the condition evaluates to false, the workflow responds directly to the webhook.
4. Further Conditional Logic (Switch): The "Switch" node, connected to the "True" branch of the "If" node, provides more granular conditional routing. It can evaluate multiple conditions against the incoming data, directing the workflow to different paths based on the outcome.
5. SSH Command Execution: One of the potential paths from the "Switch" node leads to an "SSH" node. This node is configured to connect to a remote server and execute commands. This is where the actual Docker deployment commands for the Immich API backend would be run (e.g., docker pull, docker run, docker-compose up).
6. Code Execution: Another potential path from the "Switch" node leads to a "Code" node. This node allows for custom JavaScript execution within the workflow. This could be used for advanced data manipulation, logging, or preparing data for other services.
7. Respond to Webhook: Regardless of the path taken, the workflow eventually converges back to a "Respond to Webhook" node. This node sends a response back to the original caller of the webhook, indicating the status or outcome of the deployment process.
8. Sticky Notes for Documentation: Throughout the workflow, "Sticky Note" nodes are used. These are purely for documentation purposes within the n8n editor, providing explanations or context for different parts of the workflow.

Prerequisites/Requirements

To use this workflow, you will need:

• n8n Instance: A running n8n instance (self-hosted or cloud).
• Webhook Trigger: An external system capable of sending HTTP POST requests to the n8n webhook URL.
• SSH Credentials: Access to a remote server via SSH, including:
  • Hostname or IP address
  • Username
  • Authentication method (e.g., private key or password).
• Docker/Docker Compose: The remote server must have Docker and Docker Compose installed to deploy the Immich API backend.
• Immich API Backend Configuration: Knowledge of the necessary Docker commands or Docker Compose files for the Immich API backend deployment.

Setup/Usage

1. Import the Workflow:
   • Copy the provided JSON content.
   • In your n8n instance, go to "Workflows" and click "New".
   • Click the three dots next to "New Workflow" and select "Import from JSON".
   • Paste the JSON content and click "Import".
2. Configure the Webhook:
   • Locate the "Webhook" trigger node.
   • Note the "Webhook URL". This is the endpoint your external system will call to trigger the workflow.
3. Configure SSH Credentials:
   • Locate the "SSH" node.
   • Click on the node and configure your SSH credentials (hostname, username, authentication method, etc.). Ensure the n8n instance has network access to the target SSH server.
   • Update the "Command" field with the specific Docker commands required to deploy your Immich API backend. This could involve docker pull, docker run, or docker-compose up commands, depending on your setup.
4. Configure Conditional Logic (If & Switch):
   • Review the "If" and "Switch" nodes.
   • Define the conditions based on your specific requirements. For example, you might check for a deploy_type or environment parameter in the incoming webhook data to decide which deployment script to run.
5. Configure "Code" Node (Optional):
   • If you intend to use the "Code" node, update the JavaScript code to perform any custom logic, data transformation, or logging as needed for your deployment process.
6. Activate the Workflow:
   • Once configured, activate the workflow by toggling the "Active" switch in the top right corner of the n8n editor.
7. Trigger the Workflow:
   • Send an HTTP POST request to the Webhook URL you obtained in step 2. Include any necessary data in the request body that your "If" and "Switch" nodes are configured to evaluate.

This workflow provides a flexible foundation. You can expand it further by adding notifications (e.g., Slack, email) for deployment status, error handling, or integrating with other services.