n8n (pronounced n-eight-n) helps you to interconnect every app with an API in the world with each other to share and manipulate its data without a single line of code. It is an easy to use, user-friendly and highly customizable service, which uses an intuitive user interface for you to design your unique workflows very fast. Hosted on your server and not based in the cloud, it keeps your sensible data very secure in your own trusted database.
To install, click the button below:
Or, follow these steps to get the add-on installed on your system:
Important: Make sure you've added this addon repository to your Home Assistant addon library: https://github.com/Rbillon59/hass-n8n
- Navigate in your Home Assistant frontend to Supervisor -> Add-on Store.
- Find the "hass-n8n" add-on and click it.
- Click on the "INSTALL" button.
timezone: Europe/Berlin
env_vars_list:
- "WEBHOOK_URL: <value here>"
- "EXTERNAL_URL: <value here>"
- "OTHER_ENVIRONMENT_VARIABLE_OF_YOUR_CHOICE: <value here>"
cmd_line_args: ""
unrestrict_file_writes: falseList of the n8n environment variables. You can add as many environment variables as you want to the list through the UI. The format is the following:
SOME_ENVIRONMENT_VARIABLE: some-value (the regular expression is ^[A-Z_0-9]+: .*$ )
All the available environment variables are available here : https://docs.n8n.io/hosting/environment-variables/environment-variables/
The command line to start n8n. If you want to use a custom command line, you can use this variable.
Allows n8n workflows to write files to the Home Assistant mapped directories /share and /media. Defaults to false.
n8n 1.x blocks file writes outside its allowed paths (for example with the Read/Write Files node), even when the OS permissions allow it. The documented workaround, setting the N8N_BLOCK_FILE_ACCESS_TO_N8N_FILES: "false" environment variable, does not work in this addon because n8n executes nodes in a task-runner subprocess that receives a stripped environment, so the override never reaches it.
When set to true, the addon patches n8n's internal file-system helper (isFilePathBlocked) at startup (idempotently) so that file writes are no longer blocked.
Note: enabling this removes one of n8n's file-access safety guards, so only enable it if you trust the workflows running in your n8n instance.
In n8n you can add external node modules by setting the NODE_FUNCTION_ALLOW_EXTERNAL environment variable with the list of npm packages you need.
For example, to install the lodash and the moment packages, in the UI, set the env_vars_list variable to:
NODE_FUNCTION_ALLOW_EXTERNAL: lodash,momentThe addon is presented via a Home Assistant Ingress for additional security.
This means that in addition to n8n's credentials, n8n can't be accessed without being authenticated with Home Assistant as well, even when accessing it remotely.
If you use Nabu Casa remote URL, the addon can't fetch your Nabu Casa remote URL programmatically, in that case, you need to set the EXTERNAL_URL environment variable to your Nabu Casa remote URL for things like OAuth2 credentials to work properly (setting the right redirect URLs).
If you are using a manual external URL, Ingress traffic is not relayed via this in a safe manner. In that case, you need to expose port 5678 of the container to a certain port (for instance, 5678) on Home Assistant, under the "Network" section of the configuration tab of the addon.
Webhooks, triggers and the n8n API can't go via an Ingress, since having Home Assistant authentication on top of it would break the webhook (they need to be publically accessible and unauthenticated).
For this reason, the addon exposes all webhook or API traffic on port 8081.
For the n8n API, webhooks and some webhook-based triggers to work properly, you need to open up a tunnel for port 8081 to the internet via the Cloudflared addon or something similar.
When done, set the WEBHOOK_URL environment variable to the URL of the tunnel.
If you want to, you can expose n8n without requiring to go through the Ingress. This is done in the "ports" section of the "configuration" tab of the addon, for port 5678. Note that you need to enable "hidden port bindings" for that port to show up. It is not exposed by default.
Just start the addon and head to the addon's web UI.
https://docs.n8n.io https://docs.n8n.io/getting-started/tutorials.html
This addon is published under the Apache 2 license. Original author of the addon's bundled software is n8n.
Got questions?
You can open an issue on GitHub.
Repository: https://github.com/Rbillon59/hass-n8n
This can happen depending on which browser you are using. To work around it, copy the URL of the popup window and paste it into a new tab in the main window. Then the authorization will complete.
If you forget your admin password, you can reset n8n’s user management using the n8n CLI.
This operation restores user management to its pre-setup state and removes all existing user accounts. Use this only if you can no longer access the admin account.
Official n8n documentation: https://docs.n8n.io/hosting/cli-commands/#user-management
- In the Configuration tab of the add-on, set the following value in the
cmd_line_argsfield:user-management:reset - Click Save, restart the add-on, and wait until the following message appears in the Log tab:
Successfully reset the database to default user state. - Once the reset is complete, go back to the Configuration tab and clear the
cmd_line_argsfield. - Click Save and restart the add-on again.
- You’re done! You will be redirected to the page allowing you to create a new admin user.