Self-Host n8n with TrueFoundry

n8n is a powerful, open-source workflow automation platform that lets you create complex workflows using a visual, node-based interface. While n8n offers a cloud version, the ability to self-host n8n gives you complete control over your data, costs, and instance performance.

With TrueFoundry's deployment platform, you can easily self-host n8n in your own infrastructure without getting lost in complex Kubernetes configurations. This guide will walk you through the entire process to get your n8n self-hosted instance running, from setting up storage to deploying the application.

Prerequisites for Deploying n8n

Before you begin, ensure you have the following set up. These are essential for a smooth deployment experience.

1. TrueFoundry Account & Cluster: You need an active TrueFoundry account connected to your Kubernetes cluster. If you haven't done this yet, follow our account setup guide.
2. TrueFoundry CLI: The TrueFoundry Command Line Interface (CLI) is required to deploy from your terminal. Install and configure it using our CLI setup guide.
3. Workspace: All deployments in TrueFoundry happen within a workspace. Create a new workspace or identify the target workspace you wish to deploy n8n into. You can learn more about workspaces in our key concepts documentation.

Step 1: Create a Persistent Volume for n8n

Any n8n self-hosted instance requires persistent storage to save your workflows, credentials, and execution data. If the instance restarts, this volume ensures that all your data is safe. You can create this volume using either the TrueFoundry UI or our Python SDK.

Option A: Using the TrueFoundry UI

For a no-code approach, you can create the required volume directly through our web interface. Follow the detailed steps in our volume creation guide.

Option B: Using Python Deployment

For a code-based, repeatable setup, you can define the volume in a Python script.

1. Create a file named volume_deploy.py.
2. Add the following code. Remember to replace the placeholder values for storage_class and workspace_fqn.

import logging
from truefoundry.deploy import (
    DynamicVolumeConfig,
    Volume,
)

logging.basicConfig(level=logging.INFO)

# Define the persistent volume for n8n data
volume = Volume(
    name="n8n-volume",
    # Replace with your cluster's storage class size
    config=DynamicVolumeConfig(storage_class="efs-sc", size=2),
    workspace_fqn="<your-workspace-fqn>", # Paste your Workspace FQN here
)

# Deploy the volume to your workspace
volume.deploy(workspace_fqn="<your-workspace-fqn>", wait=False)

3. Run the script from your terminal:

python volume_deploy.py

Step 2: Deploy the n8n Service

With the storage volume ready, you can now deploy the n8n application itself. This service will run the n8n docker container and connect it to the volume you created.

1. Create a new file named service_deploy.py.
2. Paste the following code. You will need to replace the placeholders for host, volume_fqn, and workspace_fqn.

import logging
from truefoundry.deploy import (
    Image,
    VolumeMount,
    Service,
    Port,
)

logging.basicConfig(level=logging.INFO)

service = Service(
    name="n8n-svc",
    image=Image(image_uri="docker.n8n.io/n8nio/n8n"),
    ports=[
        Port(
            port=5678,
            protocol="TCP",
            expose=True,
            app_protocol="http",
            host="<your-host-name>", # e.g., n8n.your-company.com
        )
    ],
    env={}, # Add license keys or other env vars here
    mounts=[
        VolumeMount(
            mount_path="/home/node/.n8n",
            volume_fqn="<your-volume-fqn>", # Paste the FQN of the volume from Step 1
        )
    ],
    workspace_fqn="<your-workspace-fqn>", # Paste your Workspace FQN here
)

service.deploy(workspace_fqn="<your-workspace-fqn>", wait=False)

Configuration Notes:

• host: This is the public URL where you will access n8n. Find your available host domain by following our ports and domains guide.
• volume_fqn: This is the Fully Qualified Name of the volume you created in Step 1. You can find this on the volume's page in the TrueFoundry dashboard.
• workspace_fqn: The FQN of the workspace where you want to deploy the service.

3. Run the script to deploy the n8n service:

python service_deploy.py

Step 3: Access Your n8n Instance

Once the deployment is complete, navigate to the host URL you configured in the service_deploy.py file. You will be greeted by the n8n setup screen.

You can now:

• Create powerful workflow automations.
• Connect to hundreds of different services and APIs.
• Build complex data processing pipelines.
• Set up scheduled tasks and triggers for your jobs.

Your n8n instance is now fully operational and running on your own infrastructure with persistent storage, ensuring your workflows and credentials are preserved across any restarts.

Unlocking n8n Enterprise Features

This guide deploys the community edition of n8n. If you have an enterprise license, you can unlock additional features by adding your license key to the env dictionary in the service_deploy.py file.

You can find more details on environment variables in the official n8n documentation.

Troubleshooting

If you run into issues, here are a few things to check first:

• Invalid Storage Class: Ensure the storage_class you specified in volume_deploy.py is available and compatible with your cluster.
• Incorrect FQN: Double-check that the workspace_fqn and volume_fqn values are correct and do not contain typos.
• Deployment Logs: If a deployment fails, check the service logs in the TrueFoundry dashboard for detailed error messages.

Conclusion

Congratulations! You have successfully learned how to self-host n8n using TrueFoundry. This n8n self-hosted setup not only gives you complete control over your workflows and data but also provides a scalable and robust foundation for all your automation needs.