diff --git a/.vale.ini b/.vale.ini index 62c158bbf0d..4d7e654c89d 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,5 +1,5 @@ StylesPath = "styles" -MinAlertLevel = warning +MinAlertLevel = error Vocab = default [*.md] BasedOnStyles = from-write-good, n8n-styles, from-microsoft, Vale diff --git a/_doctools/filesize.sh b/_doctools/filesize.sh new file mode 100644 index 00000000000..bfa5408eeeb --- /dev/null +++ b/_doctools/filesize.sh @@ -0,0 +1,28 @@ +#!/bin/bash +# This is a simple script to work out the average file sizes in a directory. +# It is intended to keep track of the size of the built docs, so run on +# the _site directory after an mkdocs build. +# Check if a directory is provided, otherwise use the current directory +dir=${1:-.} + +# Find all files recursively and calculate total size and count +file_info=$(find "$dir" -type f -printf "%s\n" 2>/dev/null) + +total_size=0 +file_count=0 + +# Sum up sizes and count files +while read -r size; do + total_size=$((total_size + size)) + ((file_count++)) +done <<< "$file_info" + +# Calculate and display average file size +if [[ $file_count -eq 0 ]]; then + echo "No files found in the directory." +else + avg_size=$((total_size / file_count)) + echo "Total files: $file_count" + echo "Total size: $total_size bytes" + echo "Average file size: $avg_size bytes" +fi \ No newline at end of file diff --git a/_snippets/integrations/builtin/core-nodes/code-node.md b/_snippets/integrations/builtin/core-nodes/code-node.md index 3b7f72d6931..91e268833eb 100644 --- a/_snippets/integrations/builtin/core-nodes/code-node.md +++ b/_snippets/integrations/builtin/core-nodes/code-node.md @@ -1,20 +1,21 @@ Use the Code node to write custom JavaScript or Python and run it as a step in your workflow. /// note | Coding in n8n -This page gives usage information about the Code node. For more guidance on coding in n8n, refer to the [Code](/code/index.md) section. It includes: +This page gives usage information about the Code node. For more guidance on coding in n8n, refer to the following resources: * Reference documentation on [Built-in methods and variables](/code/builtin/overview.md) * Guidance on [Handling dates](/code/cookbook/luxon.md) and [Querying JSON](/code/cookbook/jmespath.md) -* A growing collection of examples in the [Cookbook](/code/cookbook/code-node/index.md) +* A collection of examples for the [Code node](/code/cookbook/code-node/index.md) /// /// note | Examples and templates -For usage examples and templates to help you get started, refer to n8n's [Code integrations](https://n8n.io/integrations/code/){:target=_blank .external-link} page. +For usage examples and templates to help you get started, refer to n8n's [Code integrations](https://n8n.io/integrations/code/) page. /// /// note | Function and Function Item nodes -The Code node replaces the Function and Function Item nodes from version 0.198.0. If you're using an older version of n8n, you can still view the [Function node documentation](https://github.com/n8n-io/n8n-docs/blob/67935ad2528e2e30d7984ea917e4af2910a096ec/docs/integrations/builtin/core-nodes/n8n-nodes-base.function.md){:target=_blank .external-link} and [Function Item node documentation](https://github.com/n8n-io/n8n-docs/blob/67935ad2528e2e30d7984ea917e4af2910a096ec/docs/integrations/builtin/core-nodes/n8n-nodes-base.functionItem.md){:target=_blank .external-link}. +The Code node replaces the Function and Function Item nodes from version 0.198.0. If you're using an older version of n8n, you can still view the [Function node documentation](https://github.com/n8n-io/n8n-docs/blob/67935ad2528e2e30d7984ea917e4af2910a096ec/docs/integrations/builtin/core-nodes/n8n-nodes-base.function.md) and [Function Item node documentation](https://github.com/n8n-io/n8n-docs/blob/67935ad2528e2e30d7984ea917e4af2910a096ec/docs/integrations/builtin/core-nodes/n8n-nodes-base.functionItem.md). /// + ## Usage How to use the Code node. @@ -43,8 +44,8 @@ If you self-host n8n, you can import and use built-in and external npm modules i If you use n8n Cloud, you can't import external npm modules. n8n makes two modules available for you: -* [crypto Node.js module](https://nodejs.org/docs/latest-v18.x/api/crypto.html){:target=_blank .external-link} -* [moment npm package](https://www.npmjs.com/package/moment){:target=_blank .external-link} +* [crypto Node.js module](https://nodejs.org/docs/latest-v18.x/api/crypto.html) +* [moment npm package](https://www.npmjs.com/package/moment) ### Built-in methods and variables @@ -58,7 +59,7 @@ The Code node editing environment supports time-saving and useful keyboard short ## Python -n8n added Python support in version 1.0. It doesn't include a Python executable. Instead, n8n provides Python support using [Pyodide](https://pyodide.org/en/stable/){:target=_blank .external-link}, which is a port of CPython to WebAssembly. This limits the available Python packages to the [Packages included with Pyodide](https://pyodide.org/en/stable/usage/packages-in-pyodide.html#packages-in-pyodide){:target=_blank .external-link}. n8n downloads the package automatically the first time you use it. +n8n added Python support in version 1.0. It doesn't include a Python executable. Instead, n8n provides Python support using [Pyodide](https://pyodide.org/en/stable/), which is a port of CPython to WebAssembly. This limits the available Python packages to the [Packages included with Pyodide](https://pyodide.org/en/stable/usage/packages-in-pyodide.html#packages-in-pyodide). n8n downloads the package automatically the first time you use it. /// note | Slower than JavaScript The Code node takes longer to process Python than JavaScript. This is due to the extra compilation steps. diff --git a/_snippets/integrations/builtin/core-nodes/data-transformation-actions/data-section-link.md b/_snippets/integrations/builtin/core-nodes/data-transformation-actions/data-section-link.md index 77cd54cfe06..5e551f24d4e 100644 --- a/_snippets/integrations/builtin/core-nodes/data-transformation-actions/data-section-link.md +++ b/_snippets/integrations/builtin/core-nodes/data-transformation-actions/data-section-link.md @@ -1 +1 @@ -Learn more about [data structure and data flow](/data/index.md) in n8n workflows. +Learn more about [data structure and data flow](/data/overview.md) in n8n workflows. diff --git a/_snippets/integrations/builtin/core-nodes/schedule/timezone-settings.md b/_snippets/integrations/builtin/core-nodes/schedule/timezone-settings.md index 996a3ff496b..36eacb4e603 100644 --- a/_snippets/integrations/builtin/core-nodes/schedule/timezone-settings.md +++ b/_snippets/integrations/builtin/core-nodes/schedule/timezone-settings.md @@ -2,5 +2,5 @@ The node relies on the timezone setting. n8n uses either: 1. The workflow timezone, if set. Refer to [Workflow settings](/workflows/settings.md) for more information. -2. The n8n instance timezone, if the workflow timezone isn't set. The default is `America/New York` for self-hosted instances. n8n Cloud tries to detect the instance owner's timezone when they sign up, falling back to GMT as the default. Self-hosted users can change the instance setting using [Environment variables](/hosting/configuration/environment-variables/timezone-localization.md). Cloud admins can change the instance timezone in the [Admin dashboard](/manage-cloud/set-cloud-timezone.md). +2. The n8n instance timezone, if the workflow timezone isn't set. The default is `America/New York` for self-hosted instances. n8n Cloud tries to detect the instance owner's timezone when they sign up, falling back to GMT as the default. Self-hosted users can change the instance setting using [Environment variables](/hosting/configuration/environment-variables.md#timezone-and-localization). Cloud admins can change the instance timezone in the [Admin dashboard](/manage-cloud/set-cloud-timezone.md). /// diff --git a/_snippets/privacy-security/gdpr-self-hosted.md b/_snippets/privacy-security/gdpr-self-hosted.md index dca19c0ab2a..303dec49109 100644 --- a/_snippets/privacy-security/gdpr-self-hosted.md +++ b/_snippets/privacy-security/gdpr-self-hosted.md @@ -1 +1 @@ -If you self-host n8n, you are responsible for deleting user data. If you need to delete data on behalf of one of your users, you can delete the respective execution. n8n recommends configuring n8n to prune execution data automatically every few days to avoid effortful GDPR request handling as much as possible. Configure this using the `EXECUTIONS_DATA_MAX_AGE` environment variable. Refer to [Environment variables](/hosting/configuration/environment-variables/index.md) for more information. +If you self-host n8n, you are responsible for deleting user data. If you need to delete data on behalf of one of your users, you can delete the respective execution. n8n recommends configuring n8n to prune execution data automatically every few days to avoid effortful GDPR request handling as much as possible. Configure this using the `EXECUTIONS_DATA_MAX_AGE` environment variable. Refer to [Environment variables](/hosting/configuration/environment-variables.md) for more information. diff --git a/_snippets/self-hosting/installation/server-setups-next-steps.md b/_snippets/self-hosting/installation/server-setups-next-steps.md index be57f84ed37..3c023c710f2 100644 --- a/_snippets/self-hosting/installation/server-setups-next-steps.md +++ b/_snippets/self-hosting/installation/server-setups-next-steps.md @@ -1,2 +1,2 @@ -* Learn more about [configuring](/hosting/configuration/environment-variables/index.md) and [scaling](/hosting/scaling/overview.md) n8n. -* Or explore using n8n: try the [Quickstarts](/try-it-out/index.md). +* Learn more about [configuring](/hosting/configuration/environment-variables.md) and [scaling](/hosting/scaling/overview.md) n8n. +* Or explore using n8n: try the [Tutorials](/tutorials/index.md). diff --git a/_snippets/workflows/dirty-nodes.md b/_snippets/workflows/dirty-nodes.md new file mode 100644 index 00000000000..43417565f13 --- /dev/null +++ b/_snippets/workflows/dirty-nodes.md @@ -0,0 +1,12 @@ +A 'dirty' node is simply one which has executed sucessfully in the past, but the resulting output is considered stale or unreliable. + +## How does a node get to be 'dirty' + +There are a number of ways that execution data can be flagged as stale: + + +## How to recognise 'dirty' node data + +In the canvas of the workflow editor, dirty notes can be identified by a different-colored border and a yellow triangle where previously it had a green 'tick' symbol. For example: + +![image of node displayed with yellow border]() \ No newline at end of file diff --git a/docs/1-0-migration-checklist.md b/docs/1-0-migration-checklist.md index 21cb512782c..5849b393324 100644 --- a/docs/1-0-migration-checklist.md +++ b/docs/1-0-migration-checklist.md @@ -15,7 +15,7 @@ The release of n8n 1.0 marks a milestone in n8n's journey to make n8n available ### Python support in the Code node -Although JavaScript remains the default language, you can now also select Python as an option in the [Code node](/code/code-node.md) and even make use of [many Python modules](https://pyodide.org/en/stable/usage/packages-in-pyodide.html#packages-in-pyodide){:target=_blank .external link}. Note that Python is unavailable in Code nodes added to a workflow before v1.0. +Although JavaScript remains the default language, you can now also select Python as an option in the [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md) and even make use of [many Python modules](https://pyodide.org/en/stable/usage/packages-in-pyodide.html#packages-in-pyodide){:target=_blank .external link}. Note that Python is unavailable in Code nodes added to a workflow before v1.0. [PR #4295](https://github.com/n8n-io/n8n/pull/4295){:target=_blank .external link}, [PR #6209](https://github.com/n8n-io/n8n/pull/6209){:target=_blank .external link} diff --git a/docs/_extra/css/extra.css b/docs/_extra/css/extra.css index 5c220676e34..25e2154dba9 100644 --- a/docs/_extra/css/extra.css +++ b/docs/_extra/css/extra.css @@ -466,3 +466,16 @@ .bottom-link .footer-link { color: #20b69e; } + +#__nav_1_label, +#__nav_2_label, +#__nav_3_label, +#__nav_4_label, +#__nav_5_label, +.md-nav--primary > .md-nav__list > .md-nav__item--active > .md-nav__container { + color: rgb(144, 146, 152); + font-weight: 600; + font-size: 16px; + letter-spacing: 3px; + text-transform: uppercase; +} diff --git a/docs/_images/try-it-out/cloud.png b/docs/_images/try-it-out/cloud.png new file mode 100644 index 00000000000..b25b796d643 Binary files /dev/null and b/docs/_images/try-it-out/cloud.png differ diff --git a/docs/_images/try-it-out/templates.png b/docs/_images/try-it-out/templates.png new file mode 100644 index 00000000000..2d8c2997929 Binary files /dev/null and b/docs/_images/try-it-out/templates.png differ diff --git a/docs/_images/workflows/executions/dirty-after.png b/docs/_images/workflows/executions/dirty-after.png new file mode 100644 index 00000000000..74070bff334 Binary files /dev/null and b/docs/_images/workflows/executions/dirty-after.png differ diff --git a/docs/_images/workflows/executions/dirty-before.png b/docs/_images/workflows/executions/dirty-before.png new file mode 100644 index 00000000000..bb27d61f43d Binary files /dev/null and b/docs/_images/workflows/executions/dirty-before.png differ diff --git a/docs/_images/workflows/executions/dirty-loop.png b/docs/_images/workflows/executions/dirty-loop.png new file mode 100644 index 00000000000..7c7d67bac86 Binary files /dev/null and b/docs/_images/workflows/executions/dirty-loop.png differ diff --git a/docs/_images/workflows/executions/dirty-node-canvas.png b/docs/_images/workflows/executions/dirty-node-canvas.png new file mode 100644 index 00000000000..79a2e3c2065 Binary files /dev/null and b/docs/_images/workflows/executions/dirty-node-canvas.png differ diff --git a/docs/_images/workflows/executions/dirty-node-editor.png b/docs/_images/workflows/executions/dirty-node-editor.png new file mode 100644 index 00000000000..b0283659b6d Binary files /dev/null and b/docs/_images/workflows/executions/dirty-node-editor.png differ diff --git a/docs/_images/workflows/executions/partial-test.png b/docs/_images/workflows/executions/partial-test.png new file mode 100644 index 00000000000..60a3d305522 Binary files /dev/null and b/docs/_images/workflows/executions/partial-test.png differ diff --git a/docs/_redirects b/docs/_redirects index 87c24b44af2..5ca07bac532 100644 --- a/docs/_redirects +++ b/docs/_redirects @@ -1,6 +1,39 @@ ### THESE REDIRECTS ARE HANDLED BY NETLIFY, SEE DOC FOR DETAILS ### ### https://docs.netlify.com/routing/redirects/redirect-options/ ### +## Redirects from docs reorg +/learning-path/ /tutorials/ +/code/ /using-n8n/ +/code/code-node/ /integrations/builtin/core-nodes/n8n-nodes-base.code/ +/code/cookbook/builtin/ /code/builtin/overview/ +/code/cookbook/http-node/ /code/cookbook/http-node/pagination/ +/courses/ /tutorials/ +/data/code/ /integrations/builtin/core-nodes/n8n-nodes-base.code/ +/hosting/community-edition-features/ /choosing-n8n/#feature-comparison +/hosting/community-edition-features/#registered-community-edition /choosing-n8n/#registered-community-edition-license +/hosting/configuration/environment-variables/binary-data/ /hosting/configuration/environment-variables/#binary-data +/hosting/configuration/environment-variables/credentials/ /hosting/configuration/environment-variables/#credentials +/hosting/configuration/environment-variables/database/ /hosting/configuration/environment-variables/#databases +/hosting/configuration/environment-variables/deployment/ /hosting/configuration/environment-variables/#deployment +/hosting/configuration/environment-variables/endpoints/ /hosting/configuration/environment-variables/#endpoints +/hosting/configuration/environment-variables/executions/ /hosting/configuration/environment-variables/#executions +/hosting/configuration/environment-variables/external-data-storage/ /hosting/configuration/environment-variables/#external-data-storage +/hosting/configuration/environment-variables/external-hooks/ /hosting/configuration/environment-variables/#external-hooks +/hosting/configuration/environment-variables/external-secrets/ /hosting/configuration/environment-variables/#external-secrets +/hosting/configuration/environment-variables/licenses/ /hosting/configuration/environment-variables/#licenses +/hosting/configuration/environment-variables/logs/ /hosting/configuration/environment-variables/#logs +/hosting/configuration/environment-variables/nodes/ /hosting/configuration/environment-variables/#nodes +/hosting/configuration/environment-variables/queue-mode/ /hosting/configuration/environment-variables/#queue-mode +/hosting/configuration/environment-variables/security/ /hosting/configuration/environment-variables/#security +/hosting/configuration/environment-variables/source-control/ /hosting/configuration/environment-variables/#source-control +/hosting/configuration/environment-variables/task-runners/ /hosting/configuration/environment-variables/#task-runners +/hosting/configuration/environment-variables/timezone-localization/ /hosting/configuration/environment-variables/#timezone-and-localization +/hosting/configuration/environment-variables/user-management-smtp-2fa/ /hosting/configuration/environment-variables/#user-management-smtp-and-two-factor-authentication +/hosting/configuration/environment-variables/workflows/ /hosting/configuration/environment-variables/#workflows +/integrations/builtin/trigger-nodes/ /integrations/builtin/app-nodes/ +/workflows/components/ /workflows/ +/hosting/installation/updating/ /hosting/ + ## Remove item lists (hidden for over a year) /integrations/builtin/core-nodes/n8n-nodes-base.itemlists/ /data/transforming-data/ diff --git a/docs/_workflows/try-it-out/quickstart/tutorial.json b/docs/_workflows/try-it-out/quickstart/tutorial.json index 743bd1d7cc9..c37428e3adb 100644 --- a/docs/_workflows/try-it-out/quickstart/tutorial.json +++ b/docs/_workflows/try-it-out/quickstart/tutorial.json @@ -190,4 +190,4 @@ "name": "docs" } ] -} \ No newline at end of file +} diff --git a/docs/advanced-ai/index.md b/docs/advanced-ai/index.md index 104b713bfbe..61ea092489e 100644 --- a/docs/advanced-ai/index.md +++ b/docs/advanced-ai/index.md @@ -53,7 +53,7 @@ Related documentation and tools. ### Node types -This feature uses [Cluster nodes](/integrations/builtin/cluster-nodes/index.md): groups of [root](/integrations/builtin/cluster-nodes/root-nodes/index.md) and [sub](/integrations/builtin/cluster-nodes/sub-nodes/index.md) nodes that work together. +This feature uses [Cluster nodes](/integrations/builtin/cluster-nodes/root-nodes/index.md): groups of [root](/integrations/builtin/cluster-nodes/root-nodes/index.md) and [sub](/integrations/builtin/cluster-nodes/sub-nodes/index.md) nodes that work together. --8<-- "_snippets/integrations/builtin/cluster-nodes/cluster-nodes-summary.md" diff --git a/docs/advanced-ai/intro-tutorial.md b/docs/advanced-ai/intro-tutorial.md index a5e3502ffd6..9cc1e62afff 100644 --- a/docs/advanced-ai/intro-tutorial.md +++ b/docs/advanced-ai/intro-tutorial.md @@ -16,7 +16,7 @@ Many people find it easier to take in new information in video format. This tuto ### What you will need -- **n8n**: For this tutorial we recommend using the [n8n cloud](/manage-cloud/overview.md) service - there is a free trial for new users! For a self hosted service, refer to the [installation pages](/hosting/installation/docker.md). +- **n8n**: For this tutorial we recommend using the [n8n cloud](/manage-cloud/index.md) service - there is a free trial for new users! For a self hosted service, refer to the [installation pages](/hosting/installation/docker.md). - **Credentials for a chat model**: This tutorial uses OpenAI, but you can easily use DeepSeek, Google Gemini, Groq, Azure, and others (see the [sub-nodes documentation](/integrations/builtin/cluster-nodes/sub-nodes/index.md) for more). ### What you will learn @@ -49,7 +49,7 @@ In n8n, the AI agent is represented as a node with some extra connections. | Scope | Generates language | Performs complex, real-world tasks | | Example | LLM generating a paragraph | An agent scheduling an appointment | -By incorporating the AI agent as a node, n8n can combine AI-driven steps with traditional programming for efficient, real-world workflows. For instance, simpler tasks, like validating an email address, do not require AI, whereas a complex tasks, like processing the _content_ of an email or dealing with multimodal inputs (e.g., images, audio), are excellent uses of an AI agent. +By incorporating the AI agent as a node, n8n can combine AI-driven steps with traditional programming for efficient, real-world workflows. For instance, simpler tasks, like validating an email address, don't require AI, whereas a complex tasks, like processing the _content_ of an email or dealing with multimodal inputs (for example images, audio), are excellent uses of an AI agent. ## 1. Create a new workflow @@ -97,7 +97,7 @@ AI agents require a chat model to be attached to process the incoming prompts. 1. Selecting the **OpenAI Chat model** from the list will attach it to the **AI Agent** node and open the node editor. One of the parameters which can be changed is the 'Model'. Note that for the basic OpenAI accounts, only the 'gpt-4o-mini' model is allowed. ??? explanation "Which chat model?" - As mentioned earlier, the LLM is the component which generates the text according to a prompt it is given. LLMs have to be created and trained, usually an intensive process. Different LLMS may have different capabilities or specialties, depending on the data they were trained with. + As mentioned earlier, the LLM is the component which generates the text according to a prompt it's given. LLMs have to be created and trained, usually an intensive process. Different LLMS may have different capabilities or specialties, depending on the data they were trained with. ## 5. Add credentials (if needed) @@ -128,7 +128,7 @@ Now that the node is connected to the **Chat Trigger** and a chat model, we can ??? explanation "Accessing the logs..." You can access the logs for the AI node even when you aren't using the chat interface. Open up the **AI Agent** node and click on the **Logs** tab in the right hand panel. - ![screenshot showing the Logs tab in the AIAgent](/_images/advanced-ai/ai-intro-logs.png) + ![screenshot showing the Logs tab in the AI Agent](/_images/advanced-ai/ai-intro-logs.png) ## 7. Changing the prompt @@ -147,7 +147,7 @@ The chat model is now giving us useful output, but there is something wrong with 1. Use the chat and tell the chat model your name, for example "Hi there, my name is Nick". -1. Wait for the response, then type the message "What's my name?". The AI will not be able to tell you, however apologetic it may seem. The reason for this is we are not saving the context. The AI Agent has no [memory](/glossary.md#ai-memory). +1. Wait for the response, then type the message "What's my name?". The AI won't be able to tell you, however apologetic it may seem. The reason for this is we aren't saving the context. The AI Agent has no [memory](/glossary.md#ai-memory). ![image showing a conversation illustrating the above](/_images/advanced-ai/ai-intro-memory.png) 1. In order to remember what has happened in the conversation, the AI Agent needs to preserve context. We can do this by adding memory to the **AI Agent** node. On the canvas click on the ![Add node icon](/_images/try-it-out/add-node-small.png){.off-glb} on the bottom of the **AI Agent** node labeled "Memory". @@ -164,7 +164,7 @@ Before we leave the workflow editor, remember to save the workflow or all your c ## Congratulations! -You have taken your first steps in building useful and effective workflows with AI. In this tutorial we have investigated the basic building blocks of an AI workflow, added an **AI Agent** and a chat model, and adjusted the prompt to get the kind of output we wanted. We also added memory so the chat could retain context between messages. +You've taken your first steps in building useful and effective workflows with AI. In this tutorial we've investigated the basic building blocks of an AI workflow, added an **AI Agent** and a chat model, and adjusted the prompt to get the kind of output we wanted. We also added memory so the chat could retain context between messages. [[ workflowDemo("file:////advanced-ai/tutorials/chat_complete.json") ]] diff --git a/docs/advanced-ai/langchain/langchain-n8n.md b/docs/advanced-ai/langchain/langchain-n8n.md index 34227eb87ee..b75eea41d22 100644 --- a/docs/advanced-ai/langchain/langchain-n8n.md +++ b/docs/advanced-ai/langchain/langchain-n8n.md @@ -9,7 +9,7 @@ description: How LangChain concepts map to n8n, and which n8n nodes to use. This page explains how LangChain concepts and features map to n8n nodes. -This page includes lists of the LangChain-focused nodes in n8n. You can use any n8n node in a workflow where you interact with LangChain, to link LangChain to other services. The LangChain features uses n8n's [Cluster nodes](/integrations/builtin/cluster-nodes/index.md). +This page includes lists of the LangChain-focused nodes in n8n. You can use any n8n node in a workflow where you interact with LangChain, to link LangChain to other services. The LangChain features uses n8n's [Cluster nodes](/integrations/builtin/cluster-nodes/root-nodes/index.md). /// note | n8n implements LangChain JS diff --git a/docs/api/index.md b/docs/api/overview.md similarity index 100% rename from docs/api/index.md rename to docs/api/overview.md diff --git a/docs/choose-n8n.md b/docs/choose-n8n.md index 386a127f753..6cec84918fc 100644 --- a/docs/choose-n8n.md +++ b/docs/choose-n8n.md @@ -6,41 +6,99 @@ contentType: overview # Choose your n8n -This section contains information on n8n's range of platforms, pricing plans, and licenses. +Our goal is to ensure that **everyone** can run n8n, in a way that matches their needs and their budget. -## Platforms +## Community edition (self-hosted) -There are different ways to set up n8n depending on how you intend to use it: +The code for n8n is free to use; in fact we make it easier for you by packaging it up nicely and making it easy to install with Docker. The features you miss out on are those which can only be delivered through n8n cloud, or are only of use to larger organisations. +Choosing this option does mean that you will need to host n8n somewhere - whether that's your laptop, home server or an instance on a public cloud. -* [n8n Cloud](/manage-cloud/overview.md): hosted solution, no need to install anything. -* [Self-host](/hosting/index.md): recommended method for production or customized use cases. - * [npm](/hosting/installation/npm.md) - * [Docker](/hosting/installation/docker.md) - * [Server setup guides](/hosting/installation/server-setups/index.md) for popular platforms -* [Embed](/embed/index.md): n8n Embed allows you to white label n8n and build it into your own product. Contact n8n on the [Embed website](https://n8n.io/embed/){:target=_blank .external-link} for pricing and support. +**Great for:** casual users, experimenting, node development. ---8<-- "_snippets/self-hosting/warning.md" +[Check out the hosting Guide for install instructions »][hosting] +## n8n Cloud Starter + +The entry-level hosted version of n8n makes it easier to use and maintain - n8n takes care of all the server-side aspects and you get to concentrate on creating and using workflows. It's also the best way to try out n8n and discover what you can make - there's a free trial so _everybody_ can see what n8n can do. + +**Great for:** people who want automations but don't want to maintain a server, small businesses, casual users. + +[Sign up for n8n Cloud here »](https://www.n8n.io/) + +## n8n Cloud Pro + +The Pro version of n8n Cloud adds extra capacity and features for people making more use of workflows and collaborating with others, as well as features to deal with running many workflows at scale. + +**Great for:** collaborating in teams, larger volumes of workflows, all the other benefits of the Cloud Starter level. + +[Sign up for n8n Cloud here »](https://www.n8n.io/) + +## Enterprise + +The Enterprise version of n8n is for people who rely on automation at scale, need enhanced support, have larger teams and more requirements for control and observability. Can be self-hosted or hosted by n8n. + +**Great for:** mission critical workflows, larger teams, ultimate control and observability. + +[Find out more about enterprise features »][enterprise] + +## Embed + +n8n Embed enables you to white label n8n and build it into your own product. Contact n8n on the [Embed website](https://n8n.io/embed/) for pricing and support. + +## Feature comparison + +This isn't an exhaustive comparison - for more details on the features available and current pricing, please see the main [n8n website][see website]. + + | Feature | Community Edition | Cloud Starter | Cloud Pro | Enterprise | + |-----------------------------|------------------------------------------------------|----------------------------------------------------------|----------------------------------------------------------|----------------------------------------------------------| + | **Workflow Executions** | Unlimited | 2.5k/month | 10k–50k+/month | Unlimited | + | **Active Workflows** | Unlimited | 5 | 15–50 | Unlimited | + | **Shared Projects** | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | 1 | 3 | Unlimited | + | **Max Execution Time** | Unlimited | 5 minutes | 40 minutes | Unlimited | + | **AI assistant** | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-check-circle-fill-24:{ style="color:#289b63" } | :octicons-check-circle-fill-24:{ style="color:#289b63" } | :octicons-check-circle-fill-24:{ style="color:#289b63" } | + | **Execution Log Retention** | 7 days | 7 days | 30 days | Unlimited | + | **Workflow History** | 1 day (with registration) | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | Up to 5 days | Up to 365 days | + | **Global Variables** | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-check-circle-fill-24:{ style="color:#289b63" } | :octicons-check-circle-fill-24:{ style="color:#289b63" } | + | **Multiple Environments** | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-check-circle-fill-24:{ style="color:#289b63" } | + | **Version Control** | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-check-circle-fill-24:{ style="color:#289b63" } | + | **SSO (SAML, LDAP)** | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-check-circle-fill-24:{ style="color:#289b63" } | + | **External Secret Store** | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-check-circle-fill-24:{ style="color:#289b63" } | + | **Log Streaming** | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-check-circle-fill-24:{ style="color:#289b63" } | + | **Scaling Options** | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-x-circle-fill-24:{ style="color:#2b0fof" } | :octicons-check-circle-fill-24:{ style="color:#289b63" } | + | **Support** | Community forum | Community forum | Community forum | Dedicated support with SLA | + | **Hosting** | Self-hosted | Hosted by n8n | Hosted by n8n | Self-hosted or hosted by n8n | + | **Pricing** | Free | [see website][] | [see website][] | [see website][] | ## Licenses -n8n's [Sustainable Use License](https://github.com/n8n-io/n8n/blob/master/LICENSE.md){:target=\_blank .external-link} and [n8n Enterprise License](https://github.com/n8n-io/n8n/blob/master/LICENSE_EE.md){:target=\_blank .external-link} are based on the [fair-code](https://faircode.io/) model. +n8n's [Sustainable Use License](https://github.com/n8n-io/n8n/blob/master/LICENSE.md) and [n8n Enterprise License](https://github.com/n8n-io/n8n/blob/master/LICENSE_EE.md) are based on the [fair-code](https://faircode.io/) model. For a detailed explanation of the license, refer to [Sustainable Use License](/sustainable-use-license.md). -## Free versions +### Registered Community edition license + +If you're using the community edition, you can unlock extra features by registering. You register with your email and receive a license key. + +Registering unlocks these features for the community edition: -n8n offers the following free options: +* [Folders](/release-notes.md#folders): Organize your workflows into tidy folders +* [Debug in editor](/workflows/executions/debug.md): Copy and [pin](/glossary.md#data-pinning-n8n) execution data when working on a workflow +* One day of [workflow history](/workflows/history.md): 24 hours of workflow history so you can revert back to previous workflow versions +* [Custom execution data](/workflows/executions/custom-executions-data.md): Save, find, and annotate execution metadata -* A free trial of Cloud -* A free self-hosted community edition for self-hosted users +To register a new community edition instance, select the option during your initial account creation. -## Paid versions +To register an existing community edition instance: -n8n has two paid versions: +1. Select the **three dots icon** ![three dots icon](/_images/common-icons/three-dots-horizontal.png){.off-glb} in the lower-left corner. +1. Select **Settings** and then **Usage and plan**. +1. Select **Unlock** to enter your email and then select **Send me a free license key**. +1. Check your email for the account you entered. -* n8n Cloud: choose from a range of paid plans to suit your usage and feature needs. -* Self-hosted: there are both free and paid versions of self-hosted. +Once you have a license key, activate it by clicking the button in the license email or by visiting **Options > Settings > Usage and plan** and selecting **Enter activation key**. -For details of the Cloud plans and contact details for Enterprise Self-hosted, refer to [Pricing](https://n8n.io/pricing/){:target=_blank .external-link} on the n8n website. +Once activated, your license won't expire. We may change the unlocked features in the future. This won't impact previously unlocked features. +[see website]: https://n8n.io/pricing/ +[hosting]: /hosting/installation/docker.md +[enterprise]: https://n8n.io/enterprise/ diff --git a/docs/code/builtin/n8n-metadata.md b/docs/code/builtin/n8n-metadata.md index e31d41e1cfb..3a25cc07e32 100644 --- a/docs/code/builtin/n8n-metadata.md +++ b/docs/code/builtin/n8n-metadata.md @@ -22,7 +22,7 @@ You can use Python in the Code node. It isn't available in expressions. === "JavaScript" | Method | Description | Available in Code node? | | ------ | ----------- | :-------------------------: | - | `$env` | Contains n8n instance configuration [environment variables](/hosting/configuration/environment-variables/index.md). | :white_check_mark: | + | `$env` | Contains n8n instance configuration [environment variables](/hosting/configuration/environment-variables.md). | :white_check_mark: | | `$execution.customData` | Set and get custom execution data. Refer to [Custom executions data](/workflows/executions/custom-executions-data.md) for more information. | :white_check_mark: | | `$execution.id` | The unique ID of the current workflow execution. | :white_check_mark: | | `$execution.mode` | Whether the execution was triggered automatically, or by manually running the workflow. Possible values are `test` and `production`. | :white_check_mark: | @@ -44,7 +44,7 @@ You can use Python in the Code node. It isn't available in expressions. === "Python" | Method | Description | | ------ | ----------- | - | `_env` | Contains n8n instance configuration [environment variables](/hosting/configuration/environment-variables/index.md). | + | `_env` | Contains n8n instance configuration [environment variables](/hosting/configuration/environment-variables.md). | | `_execution.customData` | Set and get custom execution data. Refer to [Custom executions data](/workflows/executions/custom-executions-data.md) for more information. | | `_execution.id` | The unique ID of the current workflow execution. | | `_execution.mode` | Whether the execution was triggered automatically, or by manually running the workflow. Possible values are `test` and `production`. | diff --git a/docs/code/builtin/overview.md b/docs/code/builtin/overview.md index b08afb85ed0..c4bbf80c1c3 100644 --- a/docs/code/builtin/overview.md +++ b/docs/code/builtin/overview.md @@ -4,7 +4,7 @@ description: n8n's built-in custom methods and variables. contentType: overview --- -# Built-in methods and variables +# Methods and variables n8n provides built-in methods and variables for working with data and accessing n8n data. This section provides a reference of available methods and variables for use in [expressions](/glossary.md#expression-n8n), with a short description. @@ -15,7 +15,7 @@ All data transformation functions are only available in the expressions editor. /// -The [Cookbook](/code/index.md) contains examples for some common tasks, including some [Code node only](/code/cookbook/code-node/index.md) functions. +The [using n8n](/using-n8n/index.md) section contains examples for some common tasks, including some [Code node only](/code/cookbook/code-node/index.md) functions and information on [working with expressions](/code/expressions.md). [[% import "_macros/section-toc.html" as sectionToc %]] diff --git a/docs/code/cookbook/builtin/all.md b/docs/code/cookbook/builtin/all.md index ddc219ba547..2994badd344 100644 --- a/docs/code/cookbook/builtin/all.md +++ b/docs/code/cookbook/builtin/all.md @@ -9,6 +9,7 @@ This gives access to all the items of the current or parent nodes. If you don't ## Getting items + === "JavaScript" ```js // Returns all the items of the given node and current run @@ -37,6 +38,7 @@ This gives access to all the items of the current or parent nodes. If you don't # Returns all items the node "IF" outputs (index: 1 which is Output "false" of run 0 which is the first run) allItems = _("IF").all(1, 0); ``` + ## Accessing item data diff --git a/docs/code/cookbook/builtin/get-workflow-static-data.md b/docs/code/cookbook/builtin/get-workflow-static-data.md index dd8b8226ee5..d678f31ba8c 100644 --- a/docs/code/cookbook/builtin/get-workflow-static-data.md +++ b/docs/code/cookbook/builtin/get-workflow-static-data.md @@ -28,6 +28,7 @@ same in the whole workflow. Every node in the workflow can access it. The node s Example with global data: + === "JavaScript" ```javascript // Get the global workflow static data @@ -60,7 +61,7 @@ Example with global data: Example with node data: === "JavaScript" - ```js + ```javascript // Get the static data of the node const nodeStaticData = $getWorkflowStaticData('node'); @@ -87,6 +88,7 @@ Example with node data: # Delete data delete nodeStaticData.lastExecution ``` + ## Templates and examples diff --git a/docs/code/cookbook/builtin/index.md b/docs/code/cookbook/builtin/index.md index d7228ef2271..8cd2077ed5e 100644 --- a/docs/code/cookbook/builtin/index.md +++ b/docs/code/cookbook/builtin/index.md @@ -15,4 +15,4 @@ n8n provides built-in methods and variables for working with data and accessing * [Built-in methods and variables reference](/code/builtin/overview.md) * [Expressions](/code/expressions.md) -* [Code node](/code/code-node.md) +* [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md) diff --git a/docs/code/cookbook/builtin/vars.md b/docs/code/cookbook/builtin/vars.md index 188e513d4c6..9d9186923c8 100644 --- a/docs/code/cookbook/builtin/vars.md +++ b/docs/code/cookbook/builtin/vars.md @@ -25,5 +25,5 @@ contentType: reference ``` /// note | `vars` and `env` -`vars` gives access to user-created variables. It's part of the [Environments](/source-control-environments/index.md) feature. `env` gives access to the [configuration environment variables](/hosting/configuration/environment-variables/index.md) for your n8n instance. +`vars` gives access to user-created variables. It's part of the [Environments](/source-control-environments/index.md) feature. `env` gives access to the [configuration environment variables](/hosting/configuration/environment-variables.md) for your n8n instance. /// diff --git a/docs/code/cookbook/code-node/console-log.md b/docs/code/cookbook/code-node/console-log.md index 2a61c5f5de9..9137b2768c5 100644 --- a/docs/code/cookbook/code-node/console-log.md +++ b/docs/code/cookbook/code-node/console-log.md @@ -55,7 +55,7 @@ for item in previousNodeData: print(itemDict) ``` -Refer to the Pyodide documentation on [JsProxy](https://pyodide.org/en/stable/usage/api/python-api/ffi.html#pyodide.ffi.JsProxy){:target=_blank .external-link} for more information on this class. +Refer to the Pyodide documentation on [JsProxy](https://pyodide.org/en/stable/usage/api/python-api/ffi.html#pyodide.ffi.JsProxy) for more information on this class. diff --git a/docs/code/cookbook/code-node/index.md b/docs/code/cookbook/code-node/index.md index e5d81da2f8b..389f7e9b4ea 100644 --- a/docs/code/cookbook/code-node/index.md +++ b/docs/code/cookbook/code-node/index.md @@ -15,4 +15,4 @@ This section contains examples and recipes for tasks you can do with the Code no ## Related resources * [Built-in methods and variables reference](/code/builtin/overview.md) -* [Code node](/code/code-node.md) +* [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md) diff --git a/docs/code/expressions.md b/docs/code/expressions.md index 4becb01b232..a2c5eb3296f 100644 --- a/docs/code/expressions.md +++ b/docs/code/expressions.md @@ -21,7 +21,7 @@ n8n additionally supports two libraries: - [JMESPath](https://jmespath.org/){:target=_blank .external-link}, for querying JSON. /// note | Data in n8n -When writing expressions, it's helpful to understand data structure and behavior in n8n. Refer to [Data](/data/index.md) for more information on working with data in your workflows. +When writing expressions, it's helpful to understand data structure and behavior in n8n. Refer to [Data](/data/overview.md) for more information on working with data in your workflows. /// ## Writing expressions @@ -74,7 +74,7 @@ This expression: ### Example: Writing longer JavaScript -An expression contains one line of JavaScript. This means you cannot do things like variable assignments or multiple standalone operations. +An expression contains one line of JavaScript. This means you can't do things like variable assignments or multiple standalone operations. To understand the limitations of JavaScript in expressions, and start thinking about workarounds, look at the following two pieces of code. Both code examples use the Luxon date and time library to find the time between two dates in months, and encloses the code in handlebar brackets, like an expression. diff --git a/docs/code/index.md b/docs/code/index.md index 181d44402e9..1ff61fe7241 100644 --- a/docs/code/index.md +++ b/docs/code/index.md @@ -17,7 +17,7 @@ There are two places in your workflows where you can use code: - __Expressions__ - Use [expressions](/glossary.md#expression-n8n) to transform [data](/data/index.md) in your nodes. You can use JavaScript in expressions, as well as n8n's [Built-in methods and variables](/code/builtin/overview.md) and [Data transformation functions](/code/builtin/data-transformation-functions/index.md). + Use [expressions](/glossary.md#expression-n8n) to transform [data](/data/overview.md) in your nodes. You can use JavaScript in expressions, as well as n8n's [Built-in methods and variables](/code/builtin/overview.md) and [Data transformation functions](/code/builtin/data-transformation-functions/index.md). [:octicons-arrow-right-24: Expressions](/code/expressions.md) @@ -64,7 +64,7 @@ n8n provides core nodes, which simplify adding key functionality such as API req n8n provides an API, where you can programmatically perform many of the same tasks as you can in the GUI. There's an [n8n API node](/integrations/builtin/core-nodes/n8n-nodes-base.n8n.md) to access the API in your workflows. - [:octicons-arrow-right-24: API](/api/index.md) + [:octicons-arrow-right-24: API](/api/overview.md) - __Self-host__ diff --git a/docs/courses/level-one/chapter-1.md b/docs/courses/level-one/chapter-1.md index dcbb8349ad3..2f2b52635d4 100644 --- a/docs/courses/level-one/chapter-1.md +++ b/docs/courses/level-one/chapter-1.md @@ -23,7 +23,7 @@ We recommend starting with [n8n Cloud](https://app.n8n.cloud/register), a hosted If n8n Cloud isn't a good option for you, you can [self-host with Docker](/hosting/installation/docker.md). This is an advanced option recommended only for technical users familiar with hosting services, Docker, and the command line. /// -For more details on the different ways to set up n8n, see our [platforms documentation](/choose-n8n.md#platforms). +For more details on the different ways to set up n8n, see our [choose a plan documentation](/choose-n8n.md). Once you have n8n running, open the Editor UI in a browser window. Log in to your n8n instance. Select **Overview** and then **Create Workflow** to view the main canvas. @@ -99,10 +99,10 @@ A node is an individual step in your workflow: one that either (a) loads, (b) pr Based on their function, n8n classifies nodes into four types: -- **App** or **Action Nodes** add, remove, and edit data; request and send external data; and trigger events in other systems. Refer to the [Action nodes library](/integrations/builtin/app-nodes/index.md) for a full list of these nodes. -- **Trigger Nodes** start a workflow and supply the initial data. Refer to the [Trigger nodes library](/integrations/builtin/trigger-nodes/index.md) for a list of trigger nodes. +- **App** or **Action Nodes** add, remove, and edit data; request and send external data; and trigger events in other systems. Refer to the [App nodes library](/integrations/builtin/app-nodes/index.md) for a full list of these nodes. +- **Trigger Nodes** start a workflow and supply the initial data. These are also included in the [App nodes library](/integrations/builtin/app-nodes/index.md). - **Core Nodes** can be trigger or app nodes. Whereas most nodes connect to a specific external service, core nodes provide functionality such as logic, scheduling, or generic API calls. Refer to the [Core Nodes library](/integrations/builtin/core-nodes/index.md) for a full list of core nodes. -- **Cluster Nodes** are node groups that work together to provide functionality in a workflow, primarily for AI workflows. Refer to [Cluster nodes](/integrations/builtin/cluster-nodes/index.md) for more information. +- **Cluster Nodes** are node groups that work together to provide functionality in a workflow, primarily for AI workflows. Refer to [Cluster nodes](/integrations/builtin/cluster-nodes/ai-nodes.md) for more information. /// note | Learn more Refer to [Node types](/integrations/builtin/node-types.md) for a more detailed explanation of all node types. diff --git a/docs/courses/level-one/chapter-5/chapter-5.5.md b/docs/courses/level-one/chapter-5/chapter-5.5.md index ec5c77475fa..bf0b8cdb7fe 100644 --- a/docs/courses/level-one/chapter-5/chapter-5.5.md +++ b/docs/courses/level-one/chapter-5/chapter-5.5.md @@ -75,7 +75,7 @@ With the Code node window open, configure these parameters: - **Language**: Select **JavaScript**. /// note | Using Python in code nodes - While we use JavaScript below, you can also use Python in the Code node. To learn more, refer to the [Code node](/code/code-node.md) documentation. + While we use JavaScript below, you can also use Python in the Code node. To learn more, refer to the [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md) documentation. /// - Copy the Code below and paste it into the **Code** box to replace the existing code: diff --git a/docs/courses/level-one/index.md b/docs/courses/level-one/index.md index e70f18ab31c..78fb3f8bbbf 100644 --- a/docs/courses/level-one/index.md +++ b/docs/courses/level-one/index.md @@ -41,7 +41,7 @@ You will build two workflows: ## What do I need to get started? -1. **n8n set up**: You can use [n8n Cloud](/manage-cloud/overview.md) (or the [self-hosted version](/hosting/installation/docker.md) if you have experience hosting services). +1. **n8n set up**: You can use [n8n Cloud](/manage-cloud/index.md) (or the [self-hosted version](/hosting/installation/docker.md) if you have experience hosting services). 2. **A course user ID**: [Sign up here](https://n8n-community.typeform.com/to/PDEMrevI) to get your unique ID and other credentials you will need in the course. 3. Basic knowledge of JavaScript and [APIs](https://n8n.io/blog/what-are-apis-how-to-use-them-with-no-code/) would be helpful, but isn't necessary. 4. An [account on the n8n community forum](https://community.n8n.io/) if you wish to receive a profile badge and avatar upon successful completion. diff --git a/docs/courses/level-two/chapter-1.md b/docs/courses/level-two/chapter-1.md index 9f38032f3ef..762c21d881e 100644 --- a/docs/courses/level-two/chapter-1.md +++ b/docs/courses/level-two/chapter-1.md @@ -171,7 +171,7 @@ The two most common operations for data transformation are: There are several ways to transform data for the purposes mentioned above: -- Use n8n's [data transformation nodes](/data/index.md#data-transformation-nodes). Use these nodes to modify the structure of incoming data that contain lists (arrays) without needing to use JavaScript code in the **Code node**: +- Use n8n's [data transformation nodes](/data/overview.md#data-transformation-nodes). Use these nodes to modify the structure of incoming data that contain lists (arrays) without needing to use JavaScript code in the **Code node**: - Use the [**Split Out node**](/integrations/builtin/core-nodes/n8n-nodes-base.splitout.md) to separate a single data item containing a list into multiple items. - Use the [**Aggregate node**](/integrations/builtin/core-nodes/n8n-nodes-base.aggregate.md) to take separate items, or portions of them, and group them together into individual items. - Use the **Code node** to write JavaScript functions to modify the data structure of incoming data using the **Run Once for All Items** mode: @@ -194,7 +194,8 @@ There are several ways to transform data for the purposes mentioned above: ]; ``` -These JavaScript examples assume your entire input is what you want to transform. As in the exercise above, you can also execute either operation on a specific field by identifying that in the items list, for example, if our workEmail example had multiple emails in a single field, we could run some code like this: +These JavaScript examples assume your entire input is what you want to transform. As in the exercise above, you can also execute either operation on a specific field by identifying that in the items list, for example, if our `workEmail` example had multiple emails in a single field, we could run some code like this: + ```javascript let items = $input.all(); return items[0].json.workEmail.map(item => { diff --git a/docs/courses/level-two/chapter-2.md b/docs/courses/level-two/chapter-2.md index 8a94a42551e..1bbf5417f5a 100644 --- a/docs/courses/level-two/chapter-2.md +++ b/docs/courses/level-two/chapter-2.md @@ -115,7 +115,7 @@ To begin: 2. Add the **Date & Time node** to Round Up the created Date from the datastore to End of Month. Output this to field new-date. Include all input fields. 3. Add the **If node** to check if that new rounded date is after `1960-01-01 00:00:00`. 4. Add the **Wait node** to the True output of that node and set it to wait for one minute. -5. Add the **Edit Fields (Set) node** to set a new field called outputValue to a String containing new-date. Include all input fields. +5. Add the **Edit Fields (Set) node** to set a new field called `outputValue` to a String containing new-date. Include all input fields. 6. Add the **Schedule Trigger node** at the beginning of the workflow to trigger it every 30 minutes. (You can keep the [Manual Trigger node](/integrations/builtin/core-nodes/n8n-nodes-base.manualworkflowtrigger.md) for testing!) ??? note "Show me the solution" diff --git a/docs/courses/level-two/index.md b/docs/courses/level-two/index.md index 62b057bdc0b..556c890837b 100644 --- a/docs/courses/level-two/index.md +++ b/docs/courses/level-two/index.md @@ -31,7 +31,7 @@ You will learn all this by completing short practical exercises after the theore To follow along this course (at a comfortable pace) you will need the following: -- **n8n set up**: You can use the [self-hosted version](/hosting/installation/npm.md) or [n8n Cloud](/manage-cloud/overview.md). +- **n8n set up**: You can use the [self-hosted version](/hosting/installation/npm.md) or [n8n Cloud](/manage-cloud/index.md). - **A user ID**: [Sign up here](https://n8n-community.typeform.com/to/HQoQ7nXg){:target="_blank" .external-link} to get your unique ID and other credentials you will need in the course. - **Basic n8n skills**: We strongly recommend taking the [Level 1 course](/courses/level-one/index.md) before this one. - **Basic JavaScript understanding** diff --git a/docs/credentials/add-edit-credentials.md b/docs/credentials/add-edit-credentials.md index d122f79cc4c..f912b1c64e7 100644 --- a/docs/credentials/add-edit-credentials.md +++ b/docs/credentials/add-edit-credentials.md @@ -22,7 +22,7 @@ Or: You can also create new credential in the credential drop down when editing a node on the workflow editor. -Once in the credential modal, enter the details required by your service. Refer to your service's page in the [credentials library](/integrations/builtin/credentials/index.md) for guidance. +Once in the credential modal, enter the details required by your service. Refer to your service's page in the [credentials library](/integrations/builtin/credentials/overview.md) for guidance. When you save a credential, n8n tests it to confirm it works. diff --git a/docs/credentials/index.md b/docs/credentials/index.md index 5048425a0ef..090dba41301 100644 --- a/docs/credentials/index.md +++ b/docs/credentials/index.md @@ -12,6 +12,6 @@ Access the credentials UI by opening the left menu and selecting **Credentials** * [Create and edit credentials](/credentials/add-edit-credentials.md). * Learn about [credential sharing](/credentials/credential-sharing.md). -* Find information on setting up credentials for your services in the [credentials library](/integrations/builtin/credentials/index.md). +* Find information on setting up credentials for your services in the [credentials library](/integrations/builtin/credentials/overview.md). diff --git a/docs/data/binary-data.md b/docs/data/binary-data.md index 3635534896c..9909f7fe27b 100644 --- a/docs/data/binary-data.md +++ b/docs/data/binary-data.md @@ -40,17 +40,17 @@ And nodes for performing common tasks: You can trigger a workflow based on changes to a local file using the [Local File trigger](/integrations/builtin/core-nodes/n8n-nodes-base.localfiletrigger.md). -To split or concatenate binary data items, use the [data transformation nodes](/data/index.md#data-transformation-nodes). +To split or concatenate binary data items, use the [data transformation nodes](/data/overview.md#data-transformation-nodes). ### Code -You can use the [Code node](/code/code-node.md) to manipulate binary data in your workflows. For example, [Get the binary data buffer](/code/cookbook/code-node/get-binary-data-buffer.md): get the binary data available in your workflow. +You can use the [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md) to manipulate binary data in your workflows. For example, [Get the binary data buffer](/code/cookbook/code-node/get-binary-data-buffer.md): get the binary data available in your workflow. ## Configure binary data mode when self-hosting -You can configure how your self-hosted n8n instance handles binary data using the [Binary data environment variables](/hosting/configuration/environment-variables/binary-data.md). This includes tasks such as setting the storage path and choosing how to store binary data. +You can configure how your self-hosted n8n instance handles binary data using the [Binary data environment variables](/hosting/configuration/environment-variables.md#binary-data). This includes tasks such as setting the storage path and choosing how to store binary data. Your configuration affects how well n8n scales: [Scaling | Binary data filesystem mode](/hosting/scaling/binary-data.md). -Reading and writing binary files can have security implications. If you want to disable reading and writing binary data, use the `NODES_EXCLUDE` environment variable. Refer to [Environment variables | Nodes](/hosting/configuration/environment-variables/nodes.md) for more information. +Reading and writing binary files can have security implications. If you want to disable reading and writing binary data, use the `NODES_EXCLUDE` environment variable. Refer to [Environment variables | Nodes](/hosting/configuration/environment-variables.md#nodes) for more information. diff --git a/docs/data/data-mapping/data-mapping-expressions.md b/docs/data/data-mapping/data-mapping-expressions.md index 599596217b9..e1b68087aa1 100644 --- a/docs/data/data-mapping/data-mapping-expressions.md +++ b/docs/data/data-mapping/data-mapping-expressions.md @@ -88,7 +88,7 @@ As a longer example, consider a scenario where the current node has the followin ] ``` -To extract the name, you'd normally use drag-and-drop [Data mapping](/data/data-mapping/index.md), but you could also write the following expression: +To extract the name, you'd normally use drag-and-drop [Data mapping](/data/data-mapping/data-mapping-ui.md), but you could also write the following expression: ```js {{$input.item.json.name}} diff --git a/docs/data/data-structure.md b/docs/data/data-structure.md index 45cb0bff768..1c45a7a2a6a 100644 --- a/docs/data/data-structure.md +++ b/docs/data/data-structure.md @@ -9,34 +9,38 @@ In n8n, all data passed between nodes is an array of objects. It has the followi ```json [ - { - // For most data: - // Wrap each item in another object, with the key 'json' - "json": { - // Example data - "apple": "beets", - "carrot": { - "dill": 1 - } - }, - // For binary data: - // Wrap each item in another object, with the key 'binary' - "binary": { - // Example data - "apple-picture": { - "data": "....", // Base64 encoded binary data (required) - "mimeType": "image/png", // Best practice to set if possible (optional) - "fileExtension": "png", // Best practice to set if possible (optional) - "fileName": "example.png", // Best practice to set if possible (optional) - } - } - }, + { + "json": { // (1)! + "apple": "beets", + "carrot": { + "dill": 1 + } + }, + "binary": { // (2)! + "apple-picture": { // (3)! + "data": "....", // (4)! + "mimeType": "image/png", // (5)! + "fileExtension": "png", // (6)! + "fileName": "example.png", // (7)! + } + } + }, + ... ] ``` +1. (required) n8n stores the actual data within a nested `json` key. This property is required, but can be set to anything from an empty object (like `{}`) to arrays and deeply nested data. The code node automatically wraps the data in a `json` object and parent array (`[]`) if it's missing. +2. (optional) Binary data of item. Most items in n8n don't contain binary data. +3. (required) Arbitrary key name for the binary data. +4. (required) Base64-encoded binary data. +5. (optional) Should set if possible. +6. (optional) Should set if possible. +7. (optional) Should set if possible. + /// note | Skipping the `json` key and array syntax -From 0.166.0 on, when using the Function node or Code node, n8n automatically adds the `json` key if it's missing. It also automatically wraps your items in an array (`[]`) if needed. This is only the case when using the Function or Code nodes. When building your own nodes, you must still make sure the node returns data with the `json` key. +From 0.166.0 on, when using the Code node, n8n automatically adds the `json` key if it's missing. It also automatically wraps your items in an array (`[]`) if needed. This is only the case when using the Code node. When building your own nodes, you must still make sure the node returns data with the `json` key. /// + ## Data item processing --8<-- "_snippets/flow-logic/data-flow-nodes.md" diff --git a/docs/data/index.md b/docs/data/overview.md similarity index 79% rename from docs/data/index.md rename to docs/data/overview.md index 3d0b4e7a3a2..d1349c4b222 100644 --- a/docs/data/index.md +++ b/docs/data/overview.md @@ -14,11 +14,7 @@ Data is the information that n8n nodes receive and process. For basic usage of n This section covers: * [Data structure](/data/data-structure.md) -* [Data flow within nodes](/data/data-flow-nodes.md) -* [Transforming data](/data/transforming-data.md) -* [Process data using code](/data/code.md) -* [Pinning](/data/data-pinning.md) and [editing](/data/data-editing.md) data during workflow development. -* [Data mapping](/data/data-mapping/index.md) and [Item linking](/data/data-mapping/data-item-linking/index.md): how data items link to each other. +* [Binary data](/data/binary-data.md) ## Related resources diff --git a/docs/embed/configuration.md b/docs/embed/configuration.md index 1e30238a742..f30357cee88 100644 --- a/docs/embed/configuration.md +++ b/docs/embed/configuration.md @@ -75,7 +75,7 @@ In this case, you can set parameters on the parent credentials (`googleOAuth2Api ## Environment variables -n8n has many [environment variables](/hosting/configuration/environment-variables/index.md) you can configure. Here are the most relevant environment variables for your hosted solution: +n8n has many [environment variables](/hosting/configuration/environment-variables.md) you can configure. Here are the most relevant environment variables for your hosted solution: | Variable | Type | Default | Description | | :------- | :--- | :------ | :---------- | diff --git a/docs/embed/prerequisites.md b/docs/embed/prerequisites.md index 65186f9389a..fd2977cd88f 100644 --- a/docs/embed/prerequisites.md +++ b/docs/embed/prerequisites.md @@ -41,4 +41,4 @@ For Postgres, the database must already exist on the DB-instance. The database u An n8n instance doesn't typically require large amounts of available memory. For example an n8n Cloud instance at idle requires ~100MB. It's the nature of your workflows and the data being processed that determines your memory requirements. -For example, while most nodes just pass data to the next node in the workflow, the [Code node](/code/code-node.md) creates a pre-processing and post-processing copy of the data. When dealing will large binary files, this can consume all available resources. +For example, while most nodes just pass data to the next node in the workflow, the [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md) creates a pre-processing and post-processing copy of the data. When dealing will large binary files, this can consume all available resources. diff --git a/docs/flow-logic/index.md b/docs/flow-logic/index.md index ced5901b45a..c86742dc368 100644 --- a/docs/flow-logic/index.md +++ b/docs/flow-logic/index.md @@ -17,7 +17,7 @@ This section covers: ## Related sections -You need some understanding of [Data](/data/index.md) in n8n, including [Data structure](/data/data-structure.md) and [Data flow within nodes](/data/data-flow-nodes.md). +You need some understanding of [Data](/data/overview.md) in n8n, including [Data structure](/data/data-structure.md) and [Data flow within nodes](/data/data-flow-nodes.md). When building your logic, you'll use n8n's [Core nodes](/integrations/builtin/core-nodes/index.md), including: diff --git a/docs/glossary.md b/docs/glossary.md index 74f10128942..d05e3104f78 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -49,6 +49,10 @@ In n8n, credentials store authentication information to connect with specific ap Data pinning allows you to temporarily freeze the output data of a node during workflow development. This allows you to develop workflows with predictable data without making repeated requests to external services. Production workflows ignore pinned data and request new data on each execution. +#### dirty node (n8n) + +A 'dirty' node is one which has executed successfully in the past, but the resulting output is now considered stale or unreliable. It is denoted on the canvas with a yellow outline and a triangle symbol. + #### editor (n8n) The n8n editor UI allows you to create and manage workflows. The main area is the canvas, where you can compose workflows by adding, configuring, and connecting nodes. The side and top panels allow you to access other areas of the UI like credentials, templates, variables, executions, and more. diff --git a/docs/hosting/community-edition-features.md b/docs/hosting/community-edition-features.md index dd59d9ab26e..c416ca27fe6 100644 --- a/docs/hosting/community-edition-features.md +++ b/docs/hosting/community-edition-features.md @@ -54,4 +54,4 @@ To register an existing community edition instance: Once you have a license key, activate it by clicking the button in the license email or by visiting **Options > Settings > Usage and plan** and selecting **Enter activation key**. -Once activated, your license will not expire. We may change the unlocked features in the future. This will not impact previously unlocked features. +Once activated, your license won't expire. We may change the unlocked features in the future. This won't impact previously unlocked features. diff --git a/docs/hosting/configuration/configuration-examples/base-url.md b/docs/hosting/configuration/configuration-examples/base-url.md index 466ccc1d28a..9d80ea6193a 100644 --- a/docs/hosting/configuration/configuration-examples/base-url.md +++ b/docs/hosting/configuration/configuration-examples/base-url.md @@ -16,4 +16,4 @@ You can configure the Base URL that the front end uses to connect to the back en ```bash export VUE_APP_URL_BASE_API=https://n8n.example.com/ ``` -Refer to [Environment variables reference](/hosting/configuration/environment-variables/deployment.md) for more information on this variable. +Refer to [Environment variables reference](/hosting/configuration/environment-variables.md#deployment) for more information on this variable. diff --git a/docs/hosting/configuration/configuration-examples/custom-nodes-location.md b/docs/hosting/configuration/configuration-examples/custom-nodes-location.md index 2677349d954..f17cca51167 100644 --- a/docs/hosting/configuration/configuration-examples/custom-nodes-location.md +++ b/docs/hosting/configuration/configuration-examples/custom-nodes-location.md @@ -15,4 +15,4 @@ You can define more folders with an environment variable: ```bash export N8N_CUSTOM_EXTENSIONS="/home/jim/n8n/custom-nodes;/data/n8n/nodes" ``` -Refer to [Environment variables reference](/hosting/configuration/environment-variables/nodes.md) for more information on this variable. +Refer to [Environment variables reference](/hosting/configuration/environment-variables.md#nodes) for more information on this variable. diff --git a/docs/hosting/configuration/configuration-examples/encryption-key.md b/docs/hosting/configuration/configuration-examples/encryption-key.md index 182dc74c1e1..fa0ef22b877 100644 --- a/docs/hosting/configuration/configuration-examples/encryption-key.md +++ b/docs/hosting/configuration/configuration-examples/encryption-key.md @@ -18,4 +18,4 @@ In [queue mode](/hosting/scaling/queue-mode.md), you must specify the encryption ```bash export N8N_ENCRYPTION_KEY= ``` -Refer to [Environment variables reference](/hosting/configuration/environment-variables/deployment.md) for more information on this variable. +Refer to [Environment variables reference](/hosting/configuration/environment-variables.md#deployment) for more information on this variable. diff --git a/docs/hosting/configuration/configuration-examples/execution-timeout.md b/docs/hosting/configuration/configuration-examples/execution-timeout.md index 024a1aa3a4b..3fc6ed5354b 100644 --- a/docs/hosting/configuration/configuration-examples/execution-timeout.md +++ b/docs/hosting/configuration/configuration-examples/execution-timeout.md @@ -20,4 +20,4 @@ You can also set maximum execution time (in seconds) for each workflow individua ```bash export EXECUTIONS_TIMEOUT_MAX=7200 ``` -Refer to [Environment variables reference](/hosting/configuration/environment-variables/executions.md) for more information on these variables. +Refer to [Environment variables reference](/hosting/configuration/environment-variables.md#executions) for more information on these variables. diff --git a/docs/hosting/configuration/configuration-examples/isolation.md b/docs/hosting/configuration/configuration-examples/isolation.md index 7c0e12728e8..5b5838d1d57 100644 --- a/docs/hosting/configuration/configuration-examples/isolation.md +++ b/docs/hosting/configuration/configuration-examples/isolation.md @@ -25,4 +25,4 @@ N8N_DIAGNOSTICS_CONFIG_FRONTEND= N8N_DIAGNOSTICS_CONFIG_BACKEND= ``` -Refer to [Environment variables reference](/hosting/configuration/environment-variables/deployment.md) for more information on these variables. +Refer to [Environment variables reference](/hosting/configuration/environment-variables.md#deployment) for more information on these variables. diff --git a/docs/hosting/configuration/configuration-examples/modules-in-code-node.md b/docs/hosting/configuration/configuration-examples/modules-in-code-node.md index 510ca1fc44e..baf4d16a918 100644 --- a/docs/hosting/configuration/configuration-examples/modules-in-code-node.md +++ b/docs/hosting/configuration/configuration-examples/modules-in-code-node.md @@ -25,4 +25,4 @@ export NODE_FUNCTION_ALLOW_BUILTIN=crypto,fs # Allow usage of external npm modules. export NODE_FUNCTION_ALLOW_EXTERNAL=moment,lodash ``` -Refer to [Environment variables reference](/hosting/configuration/environment-variables/nodes.md) for more information on these variables. +Refer to [Environment variables reference](/hosting/configuration/environment-variables.md#nodes) for more information on these variables. diff --git a/docs/hosting/configuration/configuration-examples/prometheus.md b/docs/hosting/configuration/configuration-examples/prometheus.md index a2c37a2dc04..a34fc4d0fef 100644 --- a/docs/hosting/configuration/configuration-examples/prometheus.md +++ b/docs/hosting/configuration/configuration-examples/prometheus.md @@ -15,13 +15,13 @@ The `/metrics` endpoint is disabled by default, but it's possible to enable it u export N8N_METRICS=true ``` -Refer to the respective [Environment Variables](/hosting/configuration/environment-variables/endpoints.md) (`N8N_METRICS_INCLUDE_*`) for configuring which metrics and labels should get exposed. +Refer to the respective [Environment Variables](/hosting/configuration/environment-variables.md#endpoints) (`N8N_METRICS_INCLUDE_*`) for configuring which metrics and labels should get exposed. Both `main` and `worker` instances are able to expose metrics. ## Queue metrics -To enable queue metrics, set the `N8N_METRICS_INCLUDE_QUEUE_METRICS` env var to `true`. You can adjust the refresh rate with `N8N_METRICS_QUEUE_METRICS_INTERVAL`. +To enable queue metrics, set the `N8N_METRICS_INCLUDE_QUEUE_METRICS` environment variable to `true`. You can adjust the refresh rate with `N8N_METRICS_QUEUE_METRICS_INTERVAL`. Queue metrics are only available for the `main` instance in single-main mode. diff --git a/docs/hosting/configuration/configuration-examples/time-zone.md b/docs/hosting/configuration/configuration-examples/time-zone.md index bfdf6479e58..a1ecfacd322 100644 --- a/docs/hosting/configuration/configuration-examples/time-zone.md +++ b/docs/hosting/configuration/configuration-examples/time-zone.md @@ -15,4 +15,4 @@ export GENERIC_TIMEZONE=Europe/Berlin You can find the name of your timezone [here](https://momentjs.com/timezone/){:target="_blank" .external-link}. -Refer to [Environment variables reference](/hosting/configuration/environment-variables/timezone-localization.md) for more information on this variable. +Refer to [Environment variables reference](/hosting/configuration/environment-variables.md#timezone-and-localization) for more information on this variable. diff --git a/docs/hosting/configuration/configuration-examples/user-folder.md b/docs/hosting/configuration/configuration-examples/user-folder.md index 23e760ecf8a..080dbf455fa 100644 --- a/docs/hosting/configuration/configuration-examples/user-folder.md +++ b/docs/hosting/configuration/configuration-examples/user-folder.md @@ -13,4 +13,4 @@ the ID of the tunnel (if used) in the subfolder `.n8n` of the user who started n ```bash export N8N_USER_FOLDER=/home/jim/n8n ``` -Refer to [Environment variables reference](/hosting/configuration/environment-variables/deployment.md) for more information on this variable. +Refer to [Environment variables reference](/hosting/configuration/environment-variables.md#deployment) for more information on this variable. diff --git a/docs/hosting/configuration/configuration-examples/webhook-url.md b/docs/hosting/configuration/configuration-examples/webhook-url.md index 683dd5ee5db..a657c880a8e 100644 --- a/docs/hosting/configuration/configuration-examples/webhook-url.md +++ b/docs/hosting/configuration/configuration-examples/webhook-url.md @@ -12,4 +12,4 @@ n8n creates the webhook URL by combining `N8N_PROTOCOL`, `N8N_HOST` and `N8N_POR ```bash export WEBHOOK_URL=https://n8n.example.com/ ``` -Refer to [Environment variables reference](/hosting/configuration/environment-variables/endpoints.md) for more information on this variable. +Refer to [Environment variables reference](/hosting/configuration/environment-variables.md#endpoints) for more information on this variable. diff --git a/docs/hosting/configuration/configuration-methods.md b/docs/hosting/configuration/configuration-methods.md index 69efe8f5730..49c986d4fad 100644 --- a/docs/hosting/configuration/configuration-methods.md +++ b/docs/hosting/configuration/configuration-methods.md @@ -7,7 +7,7 @@ contentType: howto # Configuration -You can change n8n's settings using environment variables. For a full list of available configurations see [Environment Variables](/hosting/configuration/environment-variables/index.md). +You can change n8n's settings using environment variables. For a full list of available configurations see [Environment Variables](/hosting/configuration/environment-variables.md). ## Set environment variables by command line @@ -69,7 +69,7 @@ Example file: ``` /// note | Formatting as JSON -You can't always work out the correct JSON from the [Environment variables reference](/hosting/configuration/environment-variables/index.md). For example, to set `N8N_METRICS` to `true`, you need to do: +You can't always work out the correct JSON from the [Environment variables reference](/hosting/configuration/environment-variables.md). For example, to set `N8N_METRICS` to `true`, you need to do: ```json { @@ -101,7 +101,7 @@ n8n: You can append `_FILE` to individual environment variables to provide their configuration in a separate file, enabling you to avoid passing sensitive details using environment variables. n8n loads the data from the file with the given name, making it possible to load data from [Docker-Secrets](https://docs.docker.com/engine/swarm/secrets/){:target=_blank .external-link} and [Kubernetes-Secrets](https://kubernetes.io/docs/concepts/configuration/secret/){:target=_blank .external-link}. -Refer to [Environment variables](/hosting/configuration/environment-variables/index.md) for details on each variable. +Refer to [Environment variables](/hosting/configuration/environment-variables.md) for details on each variable. While most environment variables can use the `_FILE` suffix, it's more beneficial for sensitive data such as [credentials](/glossary.md#credential-n8n) and database configuration. Here are some examples: diff --git a/docs/hosting/configuration/environment-variables.md b/docs/hosting/configuration/environment-variables.md new file mode 100644 index 00000000000..31afbd407b2 --- /dev/null +++ b/docs/hosting/configuration/environment-variables.md @@ -0,0 +1,449 @@ +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Environment Variables +description: An overview of configuration environment variables for self-hosted n8n. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# Environment variables + +This page lists of environment variables that you can use to change n8n's configuration settings when self-hosting n8n. + +/// note | File-based configuration +You can provide a [configuration file](/hosting/configuration/configuration-methods.md) for n8n. You can also append `_FILE` to certain variables to [provide their configuration in a separate file](/hosting/configuration/configuration-methods.md#keeping-sensitive-data-in-separate-files). +/// + +Environment variables are organized into the following sections: + +* [Binary data](#binary-data) +* [Credentials](#credentials) +* [Databases](#databases) + * [PostgreSQL](#postgresql) + * [SQLite](#sqlite) +* [Deployment](#deployment) +* [Endpoints](#endpoints) +* [Executions](#executions) +* [External data storage](#external-data-storage) +* [External hooks](#external-hooks) +* [External secrets](#external-secrets) +* [Licenses](#licenses) +* [Logs](#logs) + * [n8n logs](#n8n-logs) + * [Log streaming](#log-streaming) +* [Nodes](#nodes) +* [Queue mode](#queue-mode) + * [Multi-main setup](#multi-main-setup) +* [Security](#security) +* [Source control](#source-control) +* [Task runners](#task-runners) + * [n8n instance](#n8n-instance) + * [Task runner](#task-runner) + * [Task runner launcher](#task-runner-launcher) +* [Timezone and localization](#timezone-and-localization) +* [User management, SMTP, and two-factor authentication](#user-management-smtp-and-two-factor-authentication) +* [Workflows](#workflows) + +## Binary data + +By default, n8n uses memory to store binary data. Enterprise users can choose to use an external service instead. Refer to [External storage](/hosting/scaling/external-storage.md) for more information on using external storage for binary data. + + +| Variable | Type | Default | Description | +|:----------------------------------|:-------|:-----------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `N8N_AVAILABLE_BINARY_DATA_MODES` | String | `filesystem` | A comma separated list of available binary data modes. | +| `N8N_BINARY_DATA_STORAGE_PATH` | String | `N8N_USER_FOLDER/binaryData` | The path where n8n stores binary data. | +| `N8N_DEFAULT_BINARY_DATA_MODE` | String | `default` | The default binary data mode. `default` keeps binary data in memory. Set to `filesystem` to use the filesystem, or `s3` to AWS S3. Note that binary data pruning operates on the active binary data mode. For example, if your instance stored data in S3, and you later switched to filesystem mode, n8n only prunes binary data in the filesystem. This may change in future. | + + +## Credentials + +Enable credential overwrites using the following environment variables. Refer to [Credential overwrites](/embed/configuration.md#credential-overwrites) for details. + +| Variable | Type | Default | Description | +|:-----------------------------------------|:-------|:-----------------|:---------------------------------------| +| `CREDENTIALS_DEFAULT_NAME` | String | `My credentials` | The default name for credentials. | +| `CREDENTIALS_OVERWRITE_DATA`
/`_FILE` | * | - | Overwrites for credentials. | +| `CREDENTIALS_OVERWRITE_ENDPOINT` | String | - | The API endpoint to fetch credentials. | + + +## Databases + +By default, n8n uses SQLite. n8n also supports PostgreSQL. n8n [removed support for MySQL and MariaDB](/1-0-migration-checklist.md#mysql-and-mariadb) in v1.0. + +This section outlines environment variables to configure your chosen database for your self-hosted n8n instance. + +| Variable | Type | Default | Description | +|:----------------------|:----------------------------------------|:---------|:-------------------------------| +| `DB_TABLE_PREFIX` | * | - | Prefix to use for table names. | +| `DB_TYPE`
/`_FILE` | Enum string:
`sqlite`, `postgresdb` | `sqlite` | The database to use. | + +### PostgreSQL + +| Variable | Type | Default | Description | +|:----------------------------------------------------|:--------|:------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `DB_POSTGRESDB_CONNECTION_TIMEOUT`
/`_FILE` | Number | `20000` | Postgres connection timeout (ms). +| `DB_POSTGRESDB_DATABASE`
/`_FILE` | String | `n8n` | The name of the PostgreSQL database. | +| `DB_POSTGRESDB_HOST`
/`_FILE` | String | `localhost` | The PostgreSQL host. | +| `DB_POSTGRESDB_PASSWORD`
/`_FILE` | String | - | The PostgreSQL password. | +| `DB_POSTGRESDB_POOL_SIZE`
/`_FILE` | Number | `2` | Control how many parallel open Postgres connections n8n should have. Increasing it may help with resource utilization, but too many connections may degrade performance. | +| `DB_POSTGRESDB_PORT`
/`_FILE` | Number | `5432` | The PostgreSQL port. | +| `DB_POSTGRESDB_USER`
/`_FILE` | String | `postgres` | The PostgreSQL user. | +| `DB_POSTGRESDB_SCHEMA`
/`_FILE` | String | `public` | The PostgreSQL schema. | +| `DB_POSTGRESDB_SSL_CA`
/`_FILE` | String | - | The PostgreSQL SSL certificate authority. | +| `DB_POSTGRESDB_SSL_CERT`
/`_FILE` | String | - | The PostgreSQL SSL certificate. | +| `DB_POSTGRESDB_SSL_ENABLED`
/`_FILE` | Boolean | `false` | Whether to enable SSL. Automatically enabled if `DB_POSTGRESDB_SSL_CA`, `DB_POSTGRESDB_SSL_CERT` or `DB_POSTGRESDB_SSL_KEY` is defined. | +| `DB_POSTGRESDB_SSL_KEY`
/`_FILE` | String | - | The PostgreSQL SSL key. | +| `DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED`
/`_FILE` | Boolean | `true` | If n8n should reject unauthorized SSL connections (true) or not (false). | + +### SQLite + +| Variable | Type | Default | Description | +|:------------------------------|:--------|:--------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `DB_SQLITE_POOL_SIZE` | Number | `0` | Controls whether to open the SQLite file in [WAL mode](https://www.sqlite.org/wal.html) or [rollback journal mode](https://www.sqlite.org/lockingv3.html#rollback). Uses rollback journal mode when set to zero. When greater than zero, uses WAL mode with the value determining the number of parallel SQL read connections to configure. WAL mode is much more performant and reliable than the rollback journal mode. | +| `DB_SQLITE_VACUUM_ON_STARTUP` | Boolean | `false` | Runs [VACUUM](https://www.sqlite.org/lang_vacuum.html){:target="_blank" .external-link} operation on startup to rebuild the database. Reduces file size and optimizes indexes. This is a long running blocking operation and increases start-up time. | + + +## Deployment + +This section lists the deployment configuration options for your self-hosted n8n instance, including setting up access URLs, enabling templates, customizing encryption, and configuring server details. + +| Variable | Type | Default | Description | +|:-------------------------------------|:-----------------------------|:-----------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `N8N_CONFIG_FILES` | String | - | Use to provide the path to any JSON [configuration file](/hosting/configuration/configuration-methods.md). | +| `N8N_DEV_RELOAD` | Boolean | `false` | When working on the n8n source code, set this to `true` to automatically reload or restart the application when changes occur in the source code files. | +| `N8N_DIAGNOSTICS_CONFIG_BACKEND` | String | `1zPn7YoGC3ZXE9zLeTKLuQCB4F6;https://telemetry.n8n.io/v1/batch` | Telemetry configuration for the backend. | +| `N8N_DIAGNOSTICS_CONFIG_FRONTEND` | String | `1zPn9bgWPzlQc0p8Gj1uiK6DOTn;https://telemetry.n8n.io` | Telemetry configuration for the frontend. | +| `N8N_DIAGNOSTICS_ENABLED` | Boolean | `true` | Whether to share selected, anonymous [telemetry](/privacy-security/privacy.md) with n8n. Note that if you set this to `false`, you can't enable Ask AI in the Code node. | +| `N8N_DISABLE_UI` | Boolean | `false` | Set to `true` to disable the UI. | +| `N8N_EDITOR_BASE_URL` | String | - | Public URL where users can access the editor. Also used for emails sent from n8n and the redirect URL for SAML based authentication. | +| `N8N_ENCRYPTION_KEY` | String | Random key generated by n8n | Provide a custom key used to encrypt credentials in the n8n database. By default n8n generates a random key on first launch. | +| `N8N_GRACEFUL_SHUTDOWN_TIMEOUT` | Number | `30` | How long should the n8n process wait (in seconds) for components to shut down before exiting the process. | +| `N8N_HIRING_BANNER_ENABLED` | Boolean | `true` | Whether to show the n8n hiring banner in the console (true) or not (false). | +| `N8N_HOST` | String | `localhost` | Host name n8n runs on. | +| `N8N_LISTEN_ADDRESS` | String | `0.0.0.0` | The IP address n8n should listen on. | +| `N8N_PATH` | String | `/` | The path n8n deploys to. | +| `N8N_PERSONALIZATION_ENABLED` | Boolean | `true` | Whether to ask users personalisation questions and then customise n8n accordingly. | +| `N8N_PORT` | Number | `5678` | The HTTP port n8n runs on. | +| `N8N_PREVIEW_MODE` | Boolean | `false` | Set to `true` to run in preview mode. | +| `N8N_PROTOCOL` | Enum string: `http`, `https` | `http` | The protocol used to reach n8n. | +| `N8N_PROXY_HOPS` | Number | 0 | Number of reverse-proxies n8n is running behind. | +| `N8N_PUBLIC_API_DISABLED` | Boolean | `false` | Whether to disable the public API (true) or not (false). | +| `N8N_PUBLIC_API_ENDPOINT` | String | `api` | Path for the public API endpoints. | +| `N8N_PUBLIC_API_SWAGGERUI_DISABLED` | Boolean | `false` | Whether the Swagger UI (API playground) is disabled (true) or not (false). | +| `N8N_PUSH_BACKEND` | String | `websocket` | Choose whether the n8n backend uses server-sent events (`sse`) or WebSockets (`websocket`) to send changes to the UI. | +| `N8N_REINSTALL_MISSING_PACKAGES` | Boolean | `false` | If set to `true`, n8n will automatically attempt to reinstall any missing packages. | +| `N8N_SSL_CERT` | String | - | The SSL certificate for HTTPS protocol. | +| `N8N_SSL_KEY` | String | - | The SSL key for HTTPS protocol. | +| `N8N_TEMPLATES_ENABLED` | Boolean | `false` | Enables [workflow templates](/glossary.md#template-n8n) (true) or disable (false). | +| `N8N_TEMPLATES_HOST` | String | `https://api.n8n.io` | Change this if creating your own workflow template library. Note that to use your own workflow templates library, your API must provide the same endpoints and response structure as n8n's. Refer to [Workflow templates](/workflows/templates.md) for more information. | +| `N8N_TUNNEL_SUBDOMAIN` | String | - | Specifies the subdomain for the n8n tunnel. If not set, n8n generates a random subdomain. | +| `N8N_USER_FOLDER` | String | `user-folder` | Provide the path where n8n will create the `.n8n` folder. This directory stores user-specific data, such as database file and encryption key. | +| `N8N_VERSION_NOTIFICATIONS_ENABLED` | Boolean | `true` | When enabled, n8n sends notifications of new versions and security updates. | +| `N8N_VERSION_NOTIFICATIONS_ENDPOINT` | String | `https://api.n8n.io/versions/` | The endpoint to retrieve where version information. | +| `N8N_VERSION_NOTIFICATIONS_INFO_URL` | String | `https://docs.n8n.io/getting-started/installation/updating.html` | The URL displayed in the New Versions panel for more information. | +| `VUE_APP_URL_BASE_API` | String | `http://localhost:5678/` | Used when building the `n8n-editor-ui` package manually to set how the frontend can reach the backend API. Refer to [Configure the Base URL](/hosting/configuration/configuration-examples/base-url.md). | + + +## Endpoints + +This section lists environment variables for customizing endpoints in n8n. + +| Variable | Type | Default | Description | +|:------------------------------------------------|:--------|:------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `N8N_DISABLE_PRODUCTION_MAIN_PROCESS` | Boolean | `false` | Disable production webhooks from main process. This helps ensure no HTTP traffic load to main process when using webhook-specific processes. | +| `N8N_ENDPOINT_REST` | String | `rest` | The path used for REST endpoint. | +| `N8N_ENDPOINT_WEBHOOK` | String | `webhook` | The path used for webhook endpoint. | +| `N8N_ENDPOINT_WEBHOOK_TEST` | String | `webhook-test` | The path used for test-webhook endpoint. | +| `N8N_ENDPOINT_WEBHOOK_WAIT` | String | `webhook-waiting` | The path used for waiting-webhook endpoint. | +| `N8N_FORMDATA_FILE_SIZE_MAX` | Number | `200` | Max payload size for files in form-data webhook payloads in MiB. | +| `N8N_METRICS` | Boolean | `false` | Whether to enable the `/metrics` endpoint. | +| `N8N_METRICS_INCLUDE_API_ENDPOINTS` | Boolean | `false` | Whether to expose metrics for API endpoints. | +| `N8N_METRICS_INCLUDE_API_METHOD_LABEL` | Boolean | `false` | Whether to include a label for the HTTP method (GET, POST, ...) of API invocations. | +| `N8N_METRICS_INCLUDE_API_PATH_LABEL` | Boolean | `false` | Whether to include a label for the path of API invocations. | +| `N8N_METRICS_INCLUDE_API_STATUS_CODE_LABEL` | Boolean | `false` | Whether to include a label for the HTTP status code (200, 404, ...) of API invocations. | +| `N8N_METRICS_INCLUDE_CACHE_METRICS` | Boolean | false | Whether to include metrics (true) for cache hits and misses, or not include them (false). | +| `N8N_METRICS_INCLUDE_CREDENTIAL_TYPE_LABEL` | Boolean | `false` | Whether to include a label for the credential type on credential metrics. | +| `N8N_METRICS_INCLUDE_DEFAULT_METRICS` | Boolean | `true` | Whether to expose default system and node.js metrics. | +| `N8N_METRICS_INCLUDE_MESSAGE_EVENT_BUS_METRICS` | Boolean | `false` | Whether to include metrics (true) for events, or not include them (false). | +| `N8N_METRICS_INCLUDE_NODE_TYPE_LABEL` | Boolean | `false` | Whether to include a label for the node type on node metrics. | +| `N8N_METRICS_INCLUDE_QUEUE_METRICS` | Boolean | `false` | Whether to include metrics for jobs in scaling mode. Not supported in multi-main setup. | +| `N8N_METRICS_INCLUDE_WORKFLOW_ID_LABEL` | Boolean | `false` | Whether to include a label for the workflow ID on workflow metrics. | +| `N8N_METRICS_PREFIX` | String | `n8n_` | Optional prefix for n8n specific metrics names. | +| `N8N_METRICS_QUEUE_METRICS_INTERVAL` | Integer | `20` | How often (in seconds) to update queue metrics. | +| `N8N_PAYLOAD_SIZE_MAX` | Number | `16` | The maximum payload size in MiB. | +| `WEBHOOK_URL` | String | - | Used to manually provide the Webhook URL when running n8n behind a reverse proxy. See [here](/hosting/configuration/configuration-examples/webhook-url.md) for more details. | + + +## Executions + +This section lists environment variables to configure workflow execution settings. + +| Variable | Type | Default | Description | +|:---------------------------------------------|:--------------------------------|:----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `EXECUTIONS_DATA_HARD_DELETE_BUFFER` | Number | `1` | How old (hours) the finished execution data has to be to get hard-deleted. By default, this buffer excludes recent executions as the user may need them while building a workflow. | +| `EXECUTIONS_DATA_MAX_AGE` | Number | `336` | The execution age (in hours) before it's deleted. | +| `EXECUTIONS_DATA_PRUNE` | Boolean | `true` | Whether to delete data of past executions on a rolling basis. | +| `EXECUTIONS_DATA_PRUNE_HARD_DELETE_INTERVAL` | Number | `15` | How often (minutes) execution data should be hard-deleted. | +| `EXECUTIONS_DATA_PRUNE_SOFT_DELETE_INTERVAL` | Number | `60` | How often (minutes) execution data should be soft-deleted. | +| `EXECUTIONS_DATA_PRUNE_MAX_COUNT` | Number | `10000` | Maximum number of executions to keep in the database. 0 = no limit | +| `EXECUTIONS_DATA_SAVE_MANUAL_EXECUTIONS` | Boolean | `true` | Whether to save data of executions when started manually. | +| `EXECUTIONS_DATA_SAVE_ON_ERROR` | Enum string: `all`, `none` | `all` | Whether n8n saves execution data on error. | +| `EXECUTIONS_DATA_SAVE_ON_PROGRESS` | Boolean | `false` | Whether to save progress for each node executed (true) or not (false). | +| `EXECUTIONS_DATA_SAVE_ON_SUCCESS` | Enum string: `all`, `none` | `all` | Whether n8n saves execution data on success. | +| `EXECUTIONS_MODE` | Enum string: `regular`, `queue` | `regular` | Whether executions should run directly or using queue.

Refer to [Queue mode](/hosting/scaling/queue-mode.md) for more details. | +| `EXECUTIONS_TIMEOUT` | Number | `-1` | Sets a default timeout (in seconds) to all workflows after which n8n stops their execution. Users can override this for individual workflows up to the duration set in `EXECUTIONS_TIMEOUT_MAX`. Set `EXECUTIONS_TIMEOUT` to `-1` to disable. | +| `EXECUTIONS_TIMEOUT_MAX` | Number | `3600` | The maximum execution time (in seconds) that users can set for an individual workflow. | +| `N8N_CONCURRENCY_PRODUCTION_LIMIT` | Number | `-1` | Max production executions allowed to run concurrently, in both regular and scaling modes. `-1` to disable in regular mode. | + + +## External data storage + +Refer to [External storage](/hosting/scaling/external-storage.md) for more information on using external storage for binary data. + +| Variable | Type | Default | Description | +|:----------------------------------------|:-------|:--------|:----------------------------------------------------------------------------------------------------| +| `N8N_EXTERNAL_STORAGE_S3_ACCESS_KEY` | String | - | Access key in S3-compatible external storage | +| `N8N_EXTERNAL_STORAGE_S3_ACCESS_SECRET` | String | - | Access secret in S3-compatible external storage. | +| `N8N_EXTERNAL_STORAGE_S3_BUCKET_NAME` | String | - | Name of the n8n bucket in S3-compatible external storage. | +| `N8N_EXTERNAL_STORAGE_S3_BUCKET_REGION` | String | - | Region of the n8n bucket in S3-compatible external storage. For example, `us-east-1` | +| `N8N_EXTERNAL_STORAGE_S3_HOST` | String | - | Host of the n8n bucket in S3-compatible external storage. For example, `s3.us-east-1.amazonaws.com` | + + +## External hooks + +You can define external hooks that n8n executes whenever a specific operation runs. Refer to [Backend hooks](/embed/configuration.md#backend-hooks) for examples of available hooks and [Hook files](/embed/configuration.md#backend-hook-files) for information on file formatting. + +| Variable | Type | Description | +|:-------------------------------|:-------|:-----------------------------------------------------------------------------------------------------------| +| `EXTERNAL_FRONTEND_HOOKS_URLS` | String | URLs to files containing frontend external hooks. Provide multiple URLs as a colon-separated list ("`:`"). | +| `EXTERNAL_HOOK_FILES` | String | Files containing backend external hooks. Provide multiple files as a colon-separated list ("`:`"). | + + +## External secrets + +You can use an external secrets store to manage credentials for n8n. Refer to [External secrets](/external-secrets.md) for details. + +| Variable | Type | Default | Description | +|:---------------------------------------|:-------|:------------------|:----------------------------------------------------| +| `N8N_EXTERNAL_SECRETS_UPDATE_INTERVAL` | Number | `300` (5 minutes) | How often (in seconds) to check for secret updates. | + + +## Licenses + +To enable enterprise features, you need to add your enterprise license key. You can do this through the UI, or using environment variables. Refer to [Enterprise license key](/enterprise-key.md) for details. + +| Variable | Type | Default | Description | +|:---------------------------------|:--------|:-------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `http_proxy_license_server` | String | `http://user:pass@proxy:port` | Proxy server URL for HTTP requests to retrieve license. This variable name needs to be lowercase. | +| `https_proxy_license_server` | String | `https://user:pass@proxy:port` | Proxy server URL for HTTPS requests to retrieve license. This variable name needs to be lowercase. | +| `N8N_HIDE_USAGE_PAGE` | boolean | `false` | Hide the usage and plans page in the app. | +| `N8N_LICENSE_ACTIVATION_KEY` | String | `''` | Activation key to initialize license. Not applicable if the n8n instance was already activated. | +| `N8N_LICENSE_AUTO_RENEW_ENABLED` | Boolean | `true` | Enables (true) or disables (false) autorenewal for licenses.
If disabled, you need to manually renew the license every 10 days by navigating to **Settings** > **Usage and plan**, and pressing `F5`. Failure to renew the license will disable Enterprise features. | +| `N8N_LICENSE_AUTO_RENEW_OFFSET` | Number | `60 * 60 * 72` (72 hours) | Time in seconds before expiry a license should automatically renew. | +| `N8N_LICENSE_SERVER_URL` | String | `http://license.n8n.io/v1` | Server URL to retrieve license. | +| `N8N_LICENSE_TENANT_ID` | Number | `1` | Tenant ID associated with the license. Only set this variable if explicitly instructed by n8n. | + +## Logs + +This section lists environment variables to set up logging for debugging. Refer to [Logging in n8n](/hosting/logging-monitoring/logging.md) for details. + +### n8n logs + + +| Variable | Type | Default | Description | +|:--------------------------------|:---------------------------------------------------------------|:------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `CODE_ENABLE_STDOUT` | Boolean | `false` | Set to `true` to send Code node logs to process's stdout for debugging, monitoring, or logging purposes. | +| `DB_LOGGING_ENABLED` | Boolean | `false` | Whether to enable database-specific logging. | +| `DB_LOGGING_MAX_EXECUTION_TIME` | Number | `1000` | Maximum execution time (in milliseconds) before n8n logs a warning. Set to `0` to disable long running query warning. | +| `DB_LOGGING_OPTIONS` | Enum string: `query`, `error`, `schema`, `warn`, `info`, `log` | `error` | Database log output level. To enable all logging, specify `all`. Refer to [TypeORM logging options](https://orkhan.gitbook.io/typeorm/docs/logging#logging-options){:target=_blank .external-link} | +| `N8N_LOG_FILE_COUNT_MAX` | Number | `100` | Max number of log files to keep. | +| `N8N_LOG_FILE_LOCATION` | String | `/logs/n8n.log` | Log file location. Requires N8N_LOG_OUTPUT set to `file`. | +| `N8N_LOG_FILE_SIZE_MAX` | Number | `16` | Max size of each log file in MB. | +| `N8N_LOG_LEVEL` | Enum string: `info`, `warn`, `error`, `debug` | `info` | Log output level. Refer to [Log levels](/hosting/logging-monitoring/logging.md#log-levels) for details. | +| `N8N_LOG_OUTPUT` | Enum string: `console`, `file` | `console` | Where to output logs. Provide multiple values as a comma-separated list. | +| `NO_COLOR` | any | `undefined` | Set to any value to output logs without ANSI colors. For more information, see the [no-color.org website](https://no-color.org/){:target=_blank .external-link}. | + + +### Log streaming + +Refer to [Log streaming](/log-streaming.md) for more information on this feature. + +| Variable | Type | Default | Description | +|:-----------------------------------------|:--------|:--------------|:--------------------------------------------------------------------------------------------------------------------------------| +| `N8N_EVENTBUS_CHECKUNSENTINTERVAL` | Number | `0` | How often (in milliseconds) to check for unsent event messages. Can in rare cases send message twice. Set to `0` to disable it. | +| `N8N_EVENTBUS_LOGWRITER_KEEPLOGCOUNT` | Number | `3` | Number of event log files to keep. | +| `N8N_EVENTBUS_LOGWRITER_LOGBASENAME` | String | `n8nEventLog` | Basename of the event log file. | +| `N8N_EVENTBUS_LOGWRITER_MAXFILESIZEINKB` | Number | `10240` | Maximum size (in kilo-bytes) of an event log file before a new one starts. | +| `N8N_EVENTBUS_LOGWRITER_SYNCFILEACCESS` | Boolean | `false` | Whether all file access happens synchronously within the thread (true) or not (false). | + +## Nodes + +This section lists the environment variables configuration options for managing [nodes](/glossary.md#node-n8n) in n8n, including specifying which nodes to load or exclude, importing built-in or external modules in the Code node, and enabling community nodes. + +| Variable | Type | Default | Description | +|:----------------------------------|:-----------------|:------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `NODE_FUNCTION_ALLOW_BUILTIN` | String | - | Permit users to import specific built-in modules in the Code node. Use * to allow all. n8n disables importing modules by default. | +| `NODE_FUNCTION_ALLOW_EXTERNAL` | String | - | Permit users to import specific external modules (from `n8n/node_modules`) in the Code node. n8n disables importing modules by default. | +| `NODES_EXCLUDE` | Array of strings | - | Specify which nodes not to load. For example, to block nodes that can be a security risk if users aren't trustworthy: `NODES_EXCLUDE: "[\"n8n-nodes-base.executeCommand\", \"n8n-nodes-base.readWriteFile\"]"` | +| `NODES_INCLUDE` | Array of strings | - | Specify which nodes to load. | +| `NODES_ERROR_TRIGGER_TYPE` | String | `n8n-nodes-base.errorTrigger` | Specify which node type to use as Error Trigger. | +| `N8N_COMMUNITY_PACKAGES_ENABLED` | Boolean | `true` | Enables (true) or disables (false) community nodes. | +| `N8N_COMMUNITY_PACKAGES_REGISTRY` | String | `https://registry.npmjs.org` | NPM registry URL to pull community packages from (license required). | +| `N8N_CUSTOM_EXTENSIONS` | String | - | Specify the path to directories containing your custom nodes. | + + +## Queue mode + +You can run n8n in different modes depending on your needs. Queue mode provides the best scalability. Refer to [Queue mode](/hosting/scaling/queue-mode.md) for more information. + +| Variable | Type | Default | Description | +|:----------------------------------------|:--------|:------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `QUEUE_BULL_PREFIX` | String | - | Prefix to use for all queue keys. | +| `QUEUE_BULL_REDIS_CLUSTER_NODES` | String | - | Expects a comma-separated list of Redis Cluster nodes in the format `host:port`, for the Redis client to initially connect to. If running in queue mode (`EXECUTIONS_MODE = queue`), setting this variable will create a Redis Cluster client instead of a Redis client, and n8n will ignore `QUEUE_BULL_REDIS_HOST` and `QUEUE_BULL_REDIS_PORT`. | +| `QUEUE_BULL_REDIS_DUALSTACK` | Boolean | `false` | Enable dual-stack support (IPv4 and IPv6) on Redis connections. | +| `QUEUE_BULL_REDIS_DB` | Number | `0` | The Redis database used. | +| `QUEUE_BULL_REDIS_HOST` | String | `localhost` | The Redis host. | +| `QUEUE_BULL_REDIS_PASSWORD` | String | - | The Redis password. | +| `QUEUE_BULL_REDIS_PORT` | Number | `6379` | The Redis port used. | +| `QUEUE_BULL_REDIS_TIMEOUT_THRESHOLD` | Number | `10000` | The Redis timeout threshold (in ms). | +| `QUEUE_BULL_REDIS_TLS` | Boolean | `false` | Enable TLS on Redis connections. | +| `QUEUE_BULL_REDIS_USERNAME` | String | - | The Redis username (needs Redis version 6 or above). Don't define it for Redis < 6 compatibility | +| `QUEUE_WORKER_TIMEOUT` (**deprecated**) | Number | `30` | **Deprecated** Use `N8N_GRACEFUL_SHUTDOWN_TIMEOUT` instead.

How long should n8n wait (seconds) for running executions before exiting worker process on shutdown. | +| `QUEUE_HEALTH_CHECK_ACTIVE` | Boolean | `false` | Whether to enable health checks (true) or disable (false). | +| `QUEUE_HEALTH_CHECK_PORT` | Number | - | The port to serve health checks on. | +| `QUEUE_WORKER_LOCK_DURATION` | Number | `30000` | How long (in ms) is the lease period for a worker to work on a message. | +| `QUEUE_WORKER_LOCK_RENEW_TIME` | Number | `15000` | How frequently (in ms) should a worker renew the lease time. | +| `QUEUE_WORKER_MAX_STALLED_COUNT` | Number | `1` | Maximum amount of times a stalled job will be re-processed. | +| `QUEUE_WORKER_STALLED_INTERVAL` | Number | `30000` | How often should a worker check for stalled jobs (use 0 for never). | + +### Multi-main setup + +Refer to [Configuring multi-main setup](/hosting/scaling/queue-mode.md#configuring-multi-main-setup) for details. + +| Variable | Type | Default | Description | +|:--------------------------------------|:--------|:--------|:----------------------------------------------------------------------| +| `N8N_MULTI_MAIN_SETUP_ENABLED` | Boolean | `false` | Whether to enable multi-main setup for queue mode (license required). | +| `N8N_MULTI_MAIN_SETUP_CHECK_INTERVAL` | Number | `3` | Interval (in seconds) for leader check in multi-main setup. | +| `N8N_MULTI_MAIN_SETUP_KEY_TTL` | Number | `10` | Time to live (in seconds) for leader key in multi-main setup. | + + +## Security + + | Variable | Type | Default | Description | + |:---------------------------------------------|:-------------------------------------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `N8N_BLOCK_ENV_ACCESS_IN_NODE` | Boolean | `false` | Whether to allow users to access environment variables in expressions and the Code node (false) or not (true). | + | `N8N_BLOCK_FILE_ACCESS_TO_N8N_FILES` | Boolean | `true` | Set to `true` to block access to all files in the `.n8n` directory and user defined configuration files. | + | `N8N_RESTRICT_FILE_ACCESS_TO` | String | | Limits access to files in these directories. Provide multiple files as a colon-separated list ("`:`"). | + | `N8N_SAMESITE_COOKIE` | Enum string: `strict`, `lax`, `none` | `lax` | Controls cross-site cookie behavior ([learn more](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite)): | + | `N8N_SECURE_COOKIE` | Boolean | `true` | Ensures that cookies are only sent over HTTPS, enhancing security. | + | `N8N_SECURITY_AUDIT_DAYS_ABANDONED_WORKFLOW` | Number | 90 | Number of days to consider a workflow abandoned if it's not executed. | + + +## Source control + +n8n uses Git-based source control to support environments. Refer to [Source control and environments](/source-control-environments/setup.md) for more information on how to link a Git repository to an n8n instance and configure your source control. + +| Variable | Type | Default | Description | +|:-----------------------------------------|:-------|:----------|:---------------------------------------------------------------------------------------------------------------------| +| `N8N_SOURCECONTROL_DEFAULT_SSH_KEY_TYPE` | String | `ed25519` | Set to `rsa` to make RSA the default SSH key type for [Source control setup](/source-control-environments/setup.md). | + + +## Task runners + +[Task runners](/hosting/configuration/task-runners.md) execute code defined by the [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md). + +### n8n instance + +| Variable | Type | Default | Description | +|:------------------------------------|:------------------------------------|:----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `N8N_RUNNERS_AUTH_TOKEN` | String | Random string | Shared secret used by a task runner to authenticate to n8n. Required when using `external` mode. | +| `N8N_RUNNERS_BROKER_LISTEN_ADDRESS` | String | `127.0.0.1` | Address the task broker listens on. | +| `N8N_RUNNERS_BROKER_PORT` | Number | `5679` | Port the task broker listens on for task runner connections. | +| `N8N_RUNNERS_ENABLED` | Boolean | `false` | Are task runners enabled. | +| `N8N_RUNNERS_HEARTBEAT_INTERVAL` | Number | `30` | How often (in seconds) the runner must send a heartbeat to the broker, else the task aborts and the runner restarts. Must be greater than 0. | +| `N8N_RUNNERS_MAX_CONCURRENCY` | Number | `5` | The number of concurrent tasks a task runner can execute at a time. | +| `N8N_RUNNERS_MAX_OLD_SPACE_SIZE` | String | | The `--max-old-space-size` option to use for a task runner (in MB). By default, Node.js will set this based on available memory. | +| `N8N_RUNNERS_MAX_PAYLOAD` | Number | `1 073 741 824` | Maximum payload size in bytes for communication between a task broker and a task runner. | +| `N8N_RUNNERS_MODE` | Enum string: `internal`, `external` | `internal` | How to launch and run the task runner. `internal` means n8n will launch a task runner as child process. `external` means an external orchestrator will launch the task runner. | +| `N8N_RUNNERS_TASK_TIMEOUT` | Number | `60` | How long (in seconds) a task can take to complete before the task aborts and the runner restarts. Must be greater than 0. | + + +### Task runner launcher + +| Variable | Type | Default | Description | +|:-----------------------------------------|:----------------------------------------------|:------------------------|:-----------------------------------------------------------------------------------------| +| `N8N_RUNNERS_AUTH_TOKEN` | String | - | Shared secret used to authenticate to n8n. | +| `N8N_RUNNERS_AUTO_SHUTDOWN_TIMEOUT` | Number | `15` | The number of seconds to wait before shutting down an idle runner. | +| `N8N_RUNNERS_LAUNCHER_HEALTH_CHECK_PORT` | Number | `5680` | Port for the launcher's health check server. | +| `N8N_RUNNERS_LAUNCHER_LOG_LEVEL` | Enum string: `debug`, `info`, `warn`, `error` | `info` | Which log messages to show. | +| `N8N_RUNNERS_MAX_CONCURRENCY` | Number | `5` | The number of concurrent tasks a task runner can execute at a time. | +| `N8N_RUNNERS_MAX_PAYLOAD` | Number | `1 073 741 824` | Maximum payload size in bytes for communication between a task broker and a task runner. | +| `N8N_RUNNERS_TASK_BROKER_URI` | String | `http://127.0.0.1:5679` | The URI of the task broker server (n8n instance). | +| `NODE_OPTIONS` | String | - | [Options](https://nodejs.org/api/cli.html#node_optionsoptions) for Node.js. | + + +### Task runner + +| Variable | Type | Default | Description | +|:-----------------------------------------|:-------|:------------------------|:----------------------------------------------------------------------------------------------------------------------------------------| +| `GENERIC_TIMEZONE` | * | `America/New_York` | The [same default timezone as configured for the n8n instance](/hosting/configuration/environment-variables.md#timezone-and-localization). | +| `N8N_RUNNERS_AUTO_SHUTDOWN_TIMEOUT` | Number | `15` | The number of seconds to wait before shutting down an idle runner. | +| `N8N_RUNNERS_GRANT_TOKEN` | String | Random string | Token the runner uses to authenticate with the task broker. This is automatically provided by the launcher. | +| `N8N_RUNNERS_LAUNCHER_HEALTH_CHECK_PORT` | Number | `5680` | Port for the launcher's health check server. | +| `N8N_RUNNERS_MAX_CONCURRENCY` | Number | `5` | The number of concurrent tasks a task runner can execute at a time. | +| `N8N_RUNNERS_MAX_PAYLOAD` | Number | `1 073 741 824` | Maximum payload size in bytes for communication between a task broker and a task runner. | +| `N8N_RUNNERS_TASK_BROKER_URI` | String | `http://127.0.0.1:5679` | The URI of the task broker server (n8n instance). | +| `NODE_FUNCTION_ALLOW_BUILTIN` | String | - | Permit users to import specific built-in modules in the Code node. Use * to allow all. n8n disables importing modules by default. | +| `NODE_FUNCTION_ALLOW_EXTERNAL` | String | - | Permit users to import specific external modules (from `n8n/node_modules`) in the Code node. n8n disables importing modules by default. | + + +## Timezone and localization + +| Variable | Type | Default | Description | +|:---------------------|:-------|:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `GENERIC_TIMEZONE` | * | `America/New_York` | The n8n instance timezone. Important for schedule nodes (such as Cron). | +| `N8N_DEFAULT_LOCALE` | String | `en` | A locale identifier, compatible with the [Accept-Language header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language){:target="_blank" .external-link}. n8n doesn't support regional identifiers, such as `de-AT`. When running in a locale other than the default, n8n displays UI strings in the selected locale, and falls back to `en` for any untranslated strings. | + + +## User management SMTP and two-factor authentication + +Refer to [User management](/hosting/configuration/user-management-self-hosted.md) for more information on setting up user management and emails. + + +| Variable | Type | Default | Description | +|:------------------------------------------------|:--------|:--------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `N8N_EMAIL_MODE` | String | `smtp` | Enable emails. | +| `N8N_MFA_ENABLED` | Boolean | `true` | Whether to enable two-factor authentication (true) or disable (false). n8n ignores this if existing users have 2FA enabled. | +| `N8N_SMTP_HOST` | String | - | _your_SMTP_server_name_ | +| `N8N_SMTP_OAUTH_PRIVATE_KEY` | String | - | If using 2LO with a service account this is your private key | +| `N8N_SMTP_OAUTH_SERVICE_CLIENT` | String | - | If using 2LO with a service account this is your client ID | +| `N8N_SMTP_PASS` | String | - | _your_SMTP_password_ | +| `N8N_SMTP_PORT` | Number | - | _your_SMTP_server_port_ | +| `N8N_SMTP_SENDER` | String | - | Sender email address. You can optionally include the sender name. Example with name: _N8N ``_ | +| `N8N_SMTP_SSL` | Boolean | `true` | Whether to use SSL for SMTP (true) or not (false). | +| `N8N_SMTP_STARTTLS` | Boolean | `true` | Whether to use STARTTLS for SMTP (true) or not (false). | +| `N8N_SMTP_USER` | String | - | _your_SMTP_username_ | +| `N8N_UM_EMAIL_TEMPLATES_CREDENTIALS_SHARED` | String | - | Overrides the default HTML template for notifying users that a credential was shared. Provide the full path to the template. | +| `N8N_UM_EMAIL_TEMPLATES_INVITE` | String | - | Full path to your HTML email template. This overrides the default template for invite emails. | +| `N8N_UM_EMAIL_TEMPLATES_PWRESET` | String | - | Full path to your HTML email template. This overrides the default template for password reset emails. | +| `N8N_UM_EMAIL_TEMPLATES_WORKFLOW_SHARED` | String | - | Overrides the default HTML template for notifying users that a workflow was shared. Provide the full path to the template. | +| `N8N_USER_MANAGEMENT_JWT_DURATION_HOURS` | Number | 168 | Set an expiration date for the JWTs in hours. | +| `N8N_USER_MANAGEMENT_JWT_REFRESH_TIMEOUT_HOURS` | Number | 0 | How many hours before the JWT expires to automatically refresh it. 0 means 25% of `N8N_USER_MANAGEMENT_JWT_DURATION_HOURS`. -1 means it will never refresh, which forces users to log in again after the period defined in `N8N_USER_MANAGEMENT_JWT_DURATION_HOURS`. | +| `N8N_USER_MANAGEMENT_JWT_SECRET` | String | - | Set a specific JWT secret. By default, n8n generates one on start. | + + + +## Workflows + +| Variable | Type | Default | Description | +|:--------------------------------------------|:--------|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `N8N_ONBOARDING_FLOW_DISABLED` | Boolean | `false` | Whether to disable onboarding tips when creating a new workflow (true) or not (false). | +| `N8N_WORKFLOW_ACTIVATION_BATCH_SIZE` | Number | `1` | How many workflows to activate simultaneously during startup. +| `N8N_WORKFLOW_CALLER_POLICY_DEFAULT_OPTION` | String | `workflowsFromSameOwner` | Which workflows can call a workflow. Options are: `any`, `none`, `workflowsFromAList`, `workflowsFromSameOwner`. This feature requires [Workflow sharing](/workflows/sharing.md). | +| `N8N_WORKFLOW_TAGS_DISABLED` | Boolean | `false` | Whether to disable workflow tags (true) or enable tags (false). | +| `WORKFLOWS_DEFAULT_NAME` | String | `My workflow` | The default name used for new workflows. | diff --git a/docs/hosting/configuration/environment-variables/index.md b/docs/hosting/configuration/environment-variables/overview.md similarity index 100% rename from docs/hosting/configuration/environment-variables/index.md rename to docs/hosting/configuration/environment-variables/overview.md diff --git a/docs/hosting/configuration/supported-databases-settings.md b/docs/hosting/configuration/supported-databases-settings.md index 20f52107833..1f1a4f75bd0 100644 --- a/docs/hosting/configuration/supported-databases-settings.md +++ b/docs/hosting/configuration/supported-databases-settings.md @@ -13,6 +13,12 @@ The following environment variables get used by all databases: - `DB_TABLE_PREFIX` (default: -) - Prefix for table names +## SQLite + +This is the default database that gets used if nothing is defined. + +The database file is located at `~/.n8n/database.sqlite`. + ## PostgresDB To use PostgresDB as the database, you can provide the following environment variables: @@ -64,10 +70,3 @@ You can choose between these configurations: - Not declaring (default): Connect with `SSL=off` - Declaring only the CA and unauthorized flag: Connect with `SSL=on` and verify the server's signature - Declaring `_{CERT,KEY}` and the above: Use the certificate and key for client TLS authentication - -## SQLite - -This is the default database that gets used if nothing is defined. - -The database file is located at: -`~/.n8n/database.sqlite` diff --git a/docs/hosting/configuration/task-runners.md b/docs/hosting/configuration/task-runners.md index 9a1d345f18f..92d786922c1 100644 --- a/docs/hosting/configuration/task-runners.md +++ b/docs/hosting/configuration/task-runners.md @@ -56,7 +56,7 @@ You can configure n8n to use external task runners by setting the following envi | `N8N_RUNNERS_AUTH_TOKEN=` | A shared secret task runners use to connect to the broker. | | `N8N_RUNNERS_BROKER_LISTEN_ADDRESS=0.0.0.0` | By default, the task broker only listens to localhost. When using multiple containers (for example, with Docker Compose), it needs to be able to accept external connections. | -For full list of environment variables see [task runner environment variables](/hosting/configuration/environment-variables/task-runners.md). +For full list of environment variables see [task runner environment variables](/hosting/configuration/environment-variables.md#task-runners). ### Configuring task runners in external mode @@ -80,6 +80,6 @@ Set the following environment variables for the container, adjusted to fit your | `N8N_RUNNERS_TASK_BROKER_URI=localhost:5679` | The address of the task broker server within the n8n instance. | | `N8N_RUNNERS_AUTO_SHUTDOWN_TIMEOUT=15` | Number of seconds of inactivity to wait before shutting down the task runner process. The launcher will automatically start the runner again when there are new tasks to execute. Set to `0` to disable automatic shutdown. | | `NODE_OPTIONS=--max-old-space-size=` | The memory limit for the task runner Node.js process. This should be lower than the limit for container so that the runner runs out of memory before the container. That way, the launcher is able to monitor the runner. | -| `GENERIC_TIMEZONE` | The [same default timezone as configured for the n8n instance](/hosting/configuration/environment-variables/timezone-localization.md). | +| `GENERIC_TIMEZONE` | The [same default timezone as configured for the n8n instance](/hosting/configuration/environment-variables.md#timezone-and-localization). | -For full list of environment variables see [task runner environment variables](/hosting/configuration/environment-variables/task-runners.md). +For full list of environment variables see [task runner environment variables](/hosting/configuration/environment-variables.md#task-runners). diff --git a/docs/hosting/configuration/user-management-self-hosted.md b/docs/hosting/configuration/user-management-self-hosted.md index 78d778a581c..d4f40f83fc2 100644 --- a/docs/hosting/configuration/user-management-self-hosted.md +++ b/docs/hosting/configuration/user-management-self-hosted.md @@ -67,7 +67,7 @@ To set up SMTP with n8n, configure the SMTP environment variables for your n8n i If your n8n instance is already running, you need to restart it to enable the new SMTP settings. /// note | More configuration options -There are more configuration options available as environment variables. Refer to [Environment variables](/hosting/configuration/environment-variables/index.md) for a list. These include options to disable tags, workflow templates, and the personalization survey, if you don't want your users to see them. +There are more configuration options available as environment variables. Refer to [Environment variables](/hosting/configuration/environment-variables.md) for a list. These include options to disable tags, workflow templates, and the personalization survey, if you don't want your users to see them. /// /// note | New to SMTP? diff --git a/docs/hosting/index.md b/docs/hosting/index.md index e82642660cc..06053c99e0b 100644 --- a/docs/hosting/index.md +++ b/docs/hosting/index.md @@ -11,46 +11,6 @@ hide: This section provides guidance on setting up n8n for both the Enterprise and Community self-hosted editions. The Community edition is free, the Enterprise edition isn't. -See [Community edition features](/hosting/community-edition-features.md) for a list of available features. - -
- -- __Installation and server setups__ - - Install n8n on any platform using npm or Docker. Or follow our guides to popular hosting platforms. - - [:octicons-arrow-right-24: Docker installation guide](/hosting/installation/docker.md) - -- __Configuration__ - - Learn how to configure n8n with environment variables. - - [:octicons-arrow-right-24: Environment Variables](/hosting/configuration/environment-variables/index.md) - -- __Users and authentication__ - - Choose and set up user authentication for your n8n instance. - - [:octicons-arrow-right-24: Authentication](/hosting/configuration/user-management-self-hosted.md) - -- __Scaling__ - - Manage data, modes, and processes to keep n8n running smoothly at scale. - - [:octicons-arrow-right-24: Scaling](/hosting/scaling/queue-mode.md) - -- __Securing n8n__ - - Secure your n8n instance by setting up SSL, SSO, or 2FA or blocking or opting out of some data collection or features. - - [:octicons-arrow-right-24: Securing n8n guide](/hosting/securing/overview.md) - -- __Starter kits__ - - New to n8n or AI? Try our Self-hosted AI Starter Kit. Curated by n8n, it combines the self-hosted n8n platform with compatible AI products and components to get you started building self-hosted AI workflows. - - [:octicons-arrow-right-24: Starter kits](/hosting/starter-kits/ai-starter-kit.md) - -
+See [feature comparison](/choose-n8n.md#feature-comparison) for a list of available features. Visit the [Docker installation guide](/hosting/installation/docker.md) for information on installing n8n. --8<-- "_snippets/self-hosting/warning.md" diff --git a/docs/hosting/installation/docker.md b/docs/hosting/installation/docker.md index 7d2d955f353..db6b2482fe7 100644 --- a/docs/hosting/installation/docker.md +++ b/docs/hosting/installation/docker.md @@ -51,7 +51,7 @@ When using PostgreSQL, it's still important to persist the data stored in the `/ If n8n can't find the `/home/node/.n8n` directory on startup, it automatically creates one. In this case, all existing credentials that n8n saved with a different encryption key will no longer work. /// note | Keep in mind -While persisting the `/home/node/.n8n` directory with PostgreSQL is the recommended best practice, it's not explicitly required. You can provide the encryption key by passing the [`N8N_ENCRYPTION_KEY` environment variable](/hosting/configuration/environment-variables/deployment.md) when starting your Docker container. +While persisting the `/home/node/.n8n` directory with PostgreSQL is the recommended best practice, it's not explicitly required. You can provide the encryption key by passing the [`N8N_ENCRYPTION_KEY` environment variable](/hosting/configuration/environment-variables.md#deployment) when starting your Docker container. /// To use n8n with PostgreSQL, execute the following commands, replacing the placeholders (depicted within angled brackets, for example ``) with your actual values: @@ -77,7 +77,7 @@ You can find a complete `docker-compose` file for PostgreSQL in the [n8n hosting ## Setting timezone -To define the timezone n8n should use, you can set the [`GENERIC_TIMEZONE` environment variable](/hosting/configuration/environment-variables/timezone-localization.md). Schedule-oriented nodes, like the [Schedule Trigger node](/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/index.md) use this to determine the correct timezone. +To define the timezone n8n should use, you can set the [`GENERIC_TIMEZONE` environment variable](/hosting/configuration/environment-variables.md#timezone-and-localization). Schedule-oriented nodes, like the [Schedule Trigger node](/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/index.md) use this to determine the correct timezone. You can set the system timezone, which controls what some scripts and commands like `date` return, using the `TZ` environment variable. diff --git a/docs/hosting/installation/npm.md b/docs/hosting/installation/npm.md index 1d74109d860..f3641f79c29 100644 --- a/docs/hosting/installation/npm.md +++ b/docs/hosting/installation/npm.md @@ -5,7 +5,13 @@ contentType: tutorial # npm -npm is a quick way to get started with n8n on your local machine. You must have [Node.js](https://nodejs.org/en/){:target=_blank .external-link} installed. n8n requires Node.js 18 or above. +npm is a quick way to get started with n8n on your local machine. You must have [Node.js](https://nodejs.org/en/) installed. n8n requires Node.js 18 or above. + +/// warning | Recommended for development only +n8n recommends using [Docker](/hosting/installation/docker.md), [Docker Compose](/hosting/installation/server-setups/docker-compose.md), or other [container-based deployments](https://github.com/n8n-io/n8n-hosting) for most self-hosted deployments. These methods offer improved security, isolation from the host's packages and environment, straightforward version control and rollbacks, and more. Most users have fewer issues and an easier time debugging when deploying with these methods. + +Installing with npm is still necessary if you want to develop nodes or make changes to n8n itself. +/// --8<-- "_snippets/self-hosting/installation/latest-next-version.md" @@ -19,7 +25,7 @@ From the terminal, run: npx n8n ``` -This command will download everything that's needed to start n8n. You can then access n8n and start building workflows by opening [http://localhost:5678](http://localhost:5678){:target=_blank .external-link}. +This command will download everything that's needed to start n8n. You can then access n8n and start building workflows by opening [http://localhost:5678](http://localhost:5678). ## Install globally with npm @@ -52,7 +58,7 @@ n8n start ### Next steps -Try out n8n using the [Quickstarts](/try-it-out/index.md). +Try out n8n using the [Tutorials](/tutorials/index.md). ## Updating @@ -87,4 +93,4 @@ If the upgrade involved a database migration: ## Windows troubleshooting -If you are experiencing issues running n8n on Windows, make sure your Node.js environment is correctly set up. Follow Microsoft's guide to [Install NodeJS on Windows](https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows){:target=_blank .external-link}. +If you are experiencing issues running n8n on Windows, make sure your Node.js environment is correctly set up. Follow Microsoft's guide to [Install NodeJS on Windows](https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows). diff --git a/docs/hosting/installation/server-setups/aws.md b/docs/hosting/installation/server-setups/aws.md index 21f993c38bf..b026c7686bb 100644 --- a/docs/hosting/installation/server-setups/aws.md +++ b/docs/hosting/installation/server-setups/aws.md @@ -81,7 +81,7 @@ The `postgres-deployment.yaml` manifest then uses the values from this manifest ### Create a volume for file storage -While not essential for running n8n, using persistent volumes helps maintain files uploaded while using n8n and if you want to persist [manual n8n encryption keys](/hosting/configuration/environment-variables/deployment.md) between restarts, which saves a file containing the key into file storage during startup. +While not essential for running n8n, using persistent volumes helps maintain files uploaded while using n8n and if you want to persist [manual n8n encryption keys](/hosting/configuration/environment-variables.md#deployment) between restarts, which saves a file containing the key into file storage during startup. The `n8n-claim0-persistentvolumeclaim.yaml` manifest creates this, and the n8n Deployment mounts that claim in the `volumes` section of the `n8n-deployment.yaml` manifest. @@ -116,7 +116,7 @@ This defines a minimum of 250mb per container, a maximum of 500mb, and lets Kube You can configure n8n settings and behaviors using environment variables. -Create an `n8n-secret.yaml` file. Refer to [Environment variables](/hosting/configuration/environment-variables/index.md) for n8n environment variables details. +Create an `n8n-secret.yaml` file. Refer to [Environment variables](/hosting/configuration/environment-variables.md) for n8n environment variables details. ## Deployments diff --git a/docs/hosting/installation/server-setups/azure.md b/docs/hosting/installation/server-setups/azure.md index 3ffa3087c9a..1babf599140 100644 --- a/docs/hosting/installation/server-setups/azure.md +++ b/docs/hosting/installation/server-setups/azure.md @@ -79,7 +79,7 @@ The `postgres-deployment.yaml` manifest then uses the values from this manifest While not essential for running n8n, using persistent volumes is required for: * Using nodes that interact with files, such as the binary data node. -* If you want to persist [manual n8n encryption keys](/hosting/configuration/environment-variables/deployment.md) between restarts. This saves a file containing the key into file storage during startup. +* If you want to persist [manual n8n encryption keys](/hosting/configuration/environment-variables.md#deployment) between restarts. This saves a file containing the key into file storage during startup. The `n8n-claim0-persistentvolumeclaim.yaml` manifest creates this, and the n8n Deployment mounts that claim in the `volumes` section of the `n8n-deployment.yaml` manifest. @@ -114,7 +114,7 @@ This defines a minimum of 250mb per container, a maximum of 500mb, and lets Kube You can configure n8n settings and behaviors using environment variables. -Create an `n8n-secret.yaml` file. Refer to [Environment variables](/hosting/configuration/environment-variables/index.md) for n8n environment variables details. +Create an `n8n-secret.yaml` file. Refer to [Environment variables](/hosting/configuration/environment-variables.md) for n8n environment variables details. ## Deployments diff --git a/docs/hosting/installation/server-setups/digital-ocean.md b/docs/hosting/installation/server-setups/digital-ocean.md index c921dd15f3d..fd2c8aa0131 100644 --- a/docs/hosting/installation/server-setups/digital-ocean.md +++ b/docs/hosting/installation/server-setups/digital-ocean.md @@ -112,7 +112,7 @@ nano .env The file contains inline comments to help you know what to change. -Refer to [Environment variables](/hosting/configuration/environment-variables/index.md) for n8n environment variables details. +Refer to [Environment variables](/hosting/configuration/environment-variables.md) for n8n environment variables details. ## The Docker Compose file diff --git a/docs/hosting/installation/server-setups/google-cloud.md b/docs/hosting/installation/server-setups/google-cloud.md index a0580945fd5..34901f302a0 100644 --- a/docs/hosting/installation/server-setups/google-cloud.md +++ b/docs/hosting/installation/server-setups/google-cloud.md @@ -91,7 +91,7 @@ The `postgres-deployment.yaml` manifest then uses the values from this manifest While not essential for running n8n, using persistent volumes is required for: * Using nodes that interact with files, such as the binary data node. -* If you want to persist [manual n8n encryption keys](/hosting/configuration/environment-variables/deployment.md) between restarts. This saves a file containing the key into file storage during startup. +* If you want to persist [manual n8n encryption keys](/hosting/configuration/environment-variables.md#deployment) between restarts. This saves a file containing the key into file storage during startup. The `n8n-claim0-persistentvolumeclaim.yaml` manifest creates this, and the n8n Deployment mounts that claim in the `volumes` section of the `n8n-deployment.yaml` manifest. @@ -126,7 +126,7 @@ This defines a minimum of 250mb per container, a maximum of 500mb, and lets Kube You can configure n8n settings and behaviors using environment variables. -Create an `n8n-secret.yaml` file. Refer to [Environment variables](/hosting/configuration/environment-variables/index.md) for n8n environment variables details. +Create an `n8n-secret.yaml` file. Refer to [Environment variables](/hosting/configuration/environment-variables.md) for n8n environment variables details. ## Deployments diff --git a/docs/hosting/installation/server-setups/heroku.md b/docs/hosting/installation/server-setups/heroku.md index 8d0df4f16b1..95852956f80 100644 --- a/docs/hosting/installation/server-setups/heroku.md +++ b/docs/hosting/installation/server-setups/heroku.md @@ -31,7 +31,7 @@ Heroku pre-fills the configuration options defined in the `env` section of the ` You can change any of these values to suit your needs. You must change the following values: -- **N8N_ENCRYPTION_KEY**, which n8n uses to [encrypt user account details](/hosting/configuration/environment-variables/deployment.md) before saving to the database. +- **N8N_ENCRYPTION_KEY**, which n8n uses to [encrypt user account details](/hosting/configuration/environment-variables.md#deployment) before saving to the database. - **WEBHOOK_URL** should match the application name you create to ensure that webhooks have the correct URL. ### Deploy n8n diff --git a/docs/hosting/installation/server-setups/hetzner.md b/docs/hosting/installation/server-setups/hetzner.md index 52aa989e8b1..daff632aa4c 100644 --- a/docs/hosting/installation/server-setups/hetzner.md +++ b/docs/hosting/installation/server-setups/hetzner.md @@ -105,7 +105,7 @@ nano .env The file contains inline comments to help you know what to change. -Refer to [Environment variables](/hosting/configuration/environment-variables/index.md) for n8n environment variables details. +Refer to [Environment variables](/hosting/configuration/environment-variables.md) for n8n environment variables details. ## The Docker Compose file diff --git a/docs/hosting/installation/updating.md b/docs/hosting/installation/updating.md index 9de3f65ffce..6304fcb6bf2 100644 --- a/docs/hosting/installation/updating.md +++ b/docs/hosting/installation/updating.md @@ -20,5 +20,5 @@ Some tips when updating: For instructions on how to update, refer to the documentation for your installation method: -* [Installed with npm](/hosting/installation/npm.md) * [Installed with Docker](/hosting/installation/docker.md) +* [Installed with npm](/hosting/installation/npm.md) diff --git a/docs/hosting/logging-monitoring/logging.md b/docs/hosting/logging-monitoring/logging.md index 4ba0bbfabd8..2faf4f8b9c0 100644 --- a/docs/hosting/logging-monitoring/logging.md +++ b/docs/hosting/logging-monitoring/logging.md @@ -12,7 +12,7 @@ n8n Self-hosted Enterprise tier includes [Log streaming](/log-streaming.md), in /// ## Setup -To set up logging in n8n, you need to set the following environment variables (you can also set the values in the [configuration file](/hosting/configuration/environment-variables/index.md)) +To set up logging in n8n, you need to set the following environment variables (you can also set the values in the [configuration file](/hosting/configuration/environment-variables.md)) | Setting in the configuration file | Using environment variables | Description | |-----------------------------------|-----------------------------|-------------| diff --git a/docs/hosting/scaling/binary-data.md b/docs/hosting/scaling/binary-data.md index 0ee4826b2d9..78a9a7da60e 100644 --- a/docs/hosting/scaling/binary-data.md +++ b/docs/hosting/scaling/binary-data.md @@ -13,7 +13,7 @@ Binary data is any file-type data, such as image files or documents generated or When handling binary data, n8n keeps the data in memory by default. This can cause crashes when working with large files. -To avoid this, change the `N8N_DEFAULT_BINARY_DATA_MODE` [environment variable](/hosting/configuration/environment-variables/binary-data.md) to `filesystem`. This causes n8n to save data to disk, instead of using memory. +To avoid this, change the `N8N_DEFAULT_BINARY_DATA_MODE` [environment variable](/hosting/configuration/environment-variables.md#binary-data) to `filesystem`. This causes n8n to save data to disk, instead of using memory. If you're using queue mode, keep this to `default`. n8n doesn't support filesystem mode with queue mode. diff --git a/docs/hosting/scaling/execution-data.md b/docs/hosting/scaling/execution-data.md index e19ce035406..e609b7cb724 100644 --- a/docs/hosting/scaling/execution-data.md +++ b/docs/hosting/scaling/execution-data.md @@ -9,7 +9,7 @@ Depending on your executions settings and volume, your n8n database can grow in To avoid this, n8n recommends that you don't save unnecessary data, and enable pruning of old executions data. -To do this, configure the corresponding [environment variables](/hosting/configuration/environment-variables/executions.md). +To do this, configure the corresponding [environment variables](/hosting/configuration/environment-variables.md#executions). ## Reduce saved data @@ -94,7 +94,7 @@ n8n: ``` /// note | SQLite -If you run n8n using the default SQLite database, the disk space of any pruned data isn't automatically freed up but rather reused for future executions data. To free up this space configure the `DB_SQLITE_VACUUM_ON_STARTUP` [environment variable](/hosting/configuration/environment-variables/database.md#sqlite) or manually run the [VACUUM](https://www.sqlite.org/lang_vacuum.html){:target=_blank .external-link} operation. +If you run n8n using the default SQLite database, the disk space of any pruned data isn't automatically freed up but rather reused for future executions data. To free up this space configure the `DB_SQLITE_VACUUM_ON_STARTUP` [environment variable](/hosting/configuration/environment-variables.md#sqlite) or manually run the [VACUUM](https://www.sqlite.org/lang_vacuum.html){:target=_blank .external-link} operation. /// --8<-- "_snippets/self-hosting/scaling/binary-data-pruning.md" diff --git a/docs/hosting/scaling/memory-errors.md b/docs/hosting/scaling/memory-errors.md index 8d98e4ae08d..29a60b8e6d5 100644 --- a/docs/hosting/scaling/memory-errors.md +++ b/docs/hosting/scaling/memory-errors.md @@ -8,7 +8,7 @@ contentType: explanation n8n doesn't restrict the amount of data each node can fetch and process. While this gives you freedom, it can lead to errors when workflow executions require more memory than available. This page explains how to identify and avoid these errors. /// note | Only for self-hosted n8n -This page describes memory-related errors when [self-hosting n8n](/hosting/index.md). Visit [Cloud data management](/manage-cloud/cloud-data-management.md) to learn about memory limits for [n8n Cloud](/manage-cloud/overview.md). +This page describes memory-related errors when [self-hosting n8n](/hosting/index.md). Visit [Cloud data management](/manage-cloud/cloud-data-management.md) to learn about memory limits for [n8n Cloud](/manage-cloud/index.md). /// ## Identifying out of memory situations diff --git a/docs/hosting/scaling/queue-mode.md b/docs/hosting/scaling/queue-mode.md index d5c803e5f0f..9695de5a10c 100644 --- a/docs/hosting/scaling/queue-mode.md +++ b/docs/hosting/scaling/queue-mode.md @@ -39,7 +39,7 @@ Workers are n8n instances that do the actual work. They receive information from ### Set encryption key -n8n automatically generates an encryption key upon first startup. You can also provide your own custom key using [environment variable](/hosting/configuration/environment-variables/index.md) if desired. +n8n automatically generates an encryption key upon first startup. You can also provide your own custom key using [environment variable](/hosting/configuration/environment-variables.md) if desired. The encryption key of the main n8n instance must be shared with all worker and webhooks processor nodes to ensure these worker nodes are able to access credentials stored in the database. @@ -61,7 +61,7 @@ Set the environment variable `EXECUTIONS_MODE` to `queue` on the main instance a export EXECUTIONS_MODE=queue ``` -Alternatively, you can set `executions.mode` to `queue` in the [configuration file](/hosting/configuration/environment-variables/index.md). +Alternatively, you can set `executions.mode` to `queue` in the [configuration file](/hosting/configuration/environment-variables.md). ### Start Redis diff --git a/docs/hosting/securing/blocking-nodes.md b/docs/hosting/securing/blocking-nodes.md index 57ec14353cb..00d2440d977 100644 --- a/docs/hosting/securing/blocking-nodes.md +++ b/docs/hosting/securing/blocking-nodes.md @@ -34,6 +34,6 @@ The nodes that can pose security risks vary based on your use case and user prof ## Related resources -Refer to [Nodes environment variables](/hosting/configuration/environment-variables/nodes.md) for more information on this environment variable. +Refer to [Nodes environment variables](/hosting/configuration/environment-variables.md#nodes) for more information on this environment variable. Refer to [Configuration](/hosting/configuration/configuration-methods.md) for more information on setting environment variables. diff --git a/docs/hosting/securing/disable-public-api.md b/docs/hosting/securing/disable-public-api.md index a7f82eb7579..58fbe7e6bc3 100644 --- a/docs/hosting/securing/disable-public-api.md +++ b/docs/hosting/securing/disable-public-api.md @@ -7,11 +7,11 @@ contentType: howto # Disable the public REST API -The [n8n public REST API](/api/index.md) allows you to programmatically perform many of the same tasks as you can in the n8n GUI. +The [n8n public REST API](/api/overview.md) allows you to programmatically perform many of the same tasks as you can in the n8n GUI. If you don't plan on using this API, n8n recommends disabling it to improve the security of your n8n installation. -To disable the [public REST API](/api/index.md), set the `N8N_PUBLIC_API_DISABLED` environment variable to `true`, for example: +To disable the [public REST API](/api/overview.md), set the `N8N_PUBLIC_API_DISABLED` environment variable to `true`, for example: ```bash export N8N_PUBLIC_API_DISABLED=true @@ -27,6 +27,6 @@ export N8N_PUBLIC_API_SWAGGERUI_DISABLED=true ## Related resources -Refer to [Deployment environment variables](/hosting/configuration/environment-variables/deployment.md) for more information on these environment variables. +Refer to [Deployment environment variables](/hosting/configuration/environment-variables.md#deployment) for more information on these environment variables. Refer to [Configuration](/hosting/configuration/configuration-methods.md) for more information on setting environment variables. diff --git a/docs/hosting/securing/set-up-ssl.md b/docs/hosting/securing/set-up-ssl.md index c2c5f11b563..0d752e95d61 100644 --- a/docs/hosting/securing/set-up-ssl.md +++ b/docs/hosting/securing/set-up-ssl.md @@ -21,4 +21,4 @@ You can also choose to pass certificates into n8n directly. To do so, set the `N You'll need to make sure the certificate stays renewed and up to date. -Refer to [Deployment environment variables](/hosting/configuration/environment-variables/deployment.md) for more information on these variables and [Configuration](/hosting/configuration/configuration-methods.md) for more information on setting environment variables. +Refer to [Deployment environment variables](/hosting/configuration/environment-variables.md#deployment) for more information on these variables and [Configuration](/hosting/configuration/configuration-methods.md) for more information on setting environment variables. diff --git a/docs/hosting/securing/telemetry-opt-out.md b/docs/hosting/securing/telemetry-opt-out.md index 4409a9d06f0..f7424fc237c 100644 --- a/docs/hosting/securing/telemetry-opt-out.md +++ b/docs/hosting/securing/telemetry-opt-out.md @@ -43,6 +43,6 @@ If you want to fully prevent all communication with n8n's servers, refer to [Iso ## Related resources -Refer to [Deployment environment variables](/hosting/configuration/environment-variables/deployment.md) for more information on these environment variables. +Refer to [Deployment environment variables](/hosting/configuration/environment-variables.md#deployment) for more information on these environment variables. Refer to [Configuration](/hosting/configuration/configuration-methods.md) for more information on setting environment variables. diff --git a/docs/index.md b/docs/index.md index f4e5f1eb261..b84b598d732 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,45 +10,32 @@ hide: # Welcome to n8n Docs -This is the documentation for [n8n](https://n8n.io/){:target=_blank .external-link}, a [fair-code](https://faircode.io){:target=_blank .external-link} licensed workflow automation tool that combines AI capabilities with business process automation. +This is the documentation for [n8n](https://n8n.io/), a [fair-code](https://faircode.io) licensed workflow automation platform that uniquely combines AI capabilities with business process automation, giving technical teams the flexibility of code with the speed of no-code. -It covers everything from setup to usage and development. It's a work in progress and all [contributions](/help-community/contributing.md) are welcome. +[Get started with n8n here »](/try-it-out/getn8n.md){ .md-button } +## How to use this documentation -## Where to start +Our documentation arranges information by type, to make it easier to find what you are looking for, when you need it. -
+[**Getting Started**](/try-it-out/getn8n.md) details how to get up an running with n8n and takes you through setting up your first workflows, explaining key concepts along the way. -- __Quickstarts__ +[**Using n8n**](/using-n8n/index.md) has step-by-step instructions for all sorts of common tasks and operations. - Jump in with n8n's quickstart guides. +[**Reference**](/reference/index.md) is the section to browse when you want to find out more about node parameters, environment variables or other settings. Remember you can visit many of these pages directly through the user interface with the helpful links embedded in the editor. - [:octicons-arrow-right-24: Try it out](/try-it-out/index.md) +[**Tutorials and courses**](/tutorials/index.md). For structured learning or more hand-on learning of key topics, we've created two complete courses covering basic and advanced workflow generation. There's also a collection of targeted tutorials to guide you through discovering what n8n can do for you. -- __Choose the right n8n for you__ +[**Understanding n8n**](/understanding/index.md) is a section which covers higher-level concepts and deeper explanations of topics such as using AI in n8n. Expand your knowledge and get the most out of n8n. - Cloud, npm, self-host . . . +/// note | Visiting docs from the n8n editor +Most elements of the n8n user-interface include links to the relevant parts of the documentation. If you are ever looking for more details about a specific node for example, you will find a link to the relevant documentation in the top right of that node's edit panel. +/// - [:octicons-arrow-right-24: Options](/choose-n8n.md) +## Contributing +We welcome contributions from the community. Please see the [contributing guide](/help-community/contributing.md). -- __Explore integrations__ +## Licensing - Browse n8n's integrations library. - - [:octicons-arrow-right-24: Find your apps](/integrations/index.md) - -- __Build AI functionality__ - - n8n supports building AI functionality and tools. - - [:octicons-arrow-right-24: Advanced AI](/advanced-ai/index.md) -
- -## About n8n - -n8n (pronounced n-eight-n) helps you to connect any app with an API with any other, and manipulate its data with little or no code. - -* Customizable: highly flexible workflows and the option to build custom nodes. -* Convenient: use the npm or Docker to try out n8n, or the Cloud hosting option if you want us to handle the infrastructure. -* Privacy-focused: self-host n8n for privacy and security. +n8n's [Sustainable Use License](https://github.com/n8n-io/n8n/blob/master/LICENSE.md){:target=\_blank .external-link} and [n8n Enterprise License](https://github.com/n8n-io/n8n/blob/master/LICENSE_EE.md){:target=\_blank .external-link} are based on the [fair-code](https://faircode.io/) model. For more details, see the [license explanation](sustainable-use-license.md). diff --git a/docs/integrations/index.md b/docs/integrations/builtin-vs-community-vs-custom.md similarity index 93% rename from docs/integrations/index.md rename to docs/integrations/builtin-vs-community-vs-custom.md index 3d79f7cec45..4f783fa527e 100644 --- a/docs/integrations/index.md +++ b/docs/integrations/builtin-vs-community-vs-custom.md @@ -33,5 +33,5 @@ If you need to connect to a service where n8n doesn't have a node, or a credenti * If you want to create your own node, head over to the [Creating Nodes](/integrations/creating-nodes/overview.md) section. * Check out [Community nodes](/integrations/community-nodes/usage.md) to learn about installing and managing community-built nodes. -* If you'd like to learn more about the different nodes in n8n, their functionalities and example usage, check out n8n's node libraries: [Core nodes](/integrations/builtin/core-nodes/index.md), [Actions](/integrations/builtin/app-nodes/index.md), and [Triggers](/integrations/builtin/trigger-nodes/index.md). -* If you'd like to learn how to add the credentials for the different nodes, head over to the [Credentials](/integrations/builtin/credentials/index.md) section. +* If you'd like to learn more about the different nodes in n8n, their functionalities and example usage, check out n8n's node libraries: [Core nodes](/integrations/builtin/core-nodes/index.md) and [App nodes](/integrations/builtin/app-nodes/index.md). +* If you'd like to learn how to add the credentials for the different nodes, head over to the [Credentials](/integrations/builtin/credentials/overview.md) section. diff --git a/docs/integrations/builtin/app-nodes/index.md b/docs/integrations/builtin/app-nodes/index.md index 9809786c1e1..ef6d9b242d2 100644 --- a/docs/integrations/builtin/app-nodes/index.md +++ b/docs/integrations/builtin/app-nodes/index.md @@ -1,10 +1,13 @@ --- -title: Actions library +title: App nodes library #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 contentType: overview --- # Actions library -This section provides information about n8n's Actions. +This section provides information about n8n's App nodes. +App nodes integrate with specific external services and applications. The specific features differ from service to service, but some common examples include managing resources with [CRUD operations](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete), checking and updating statuses, sending and receiving messages, and converting data and documents. + +App nodes may be triggers or actions depending on whether they start workflows or not, and many App nodes implement both functions. diff --git a/docs/integrations/builtin/app-nodes/n8n-nodes-base.airtable/common-issues.md b/docs/integrations/builtin/app-nodes/n8n-nodes-base.airtable/common-issues.md index cba3b7539a3..b57cc3233c1 100644 --- a/docs/integrations/builtin/app-nodes/n8n-nodes-base.airtable/common-issues.md +++ b/docs/integrations/builtin/app-nodes/n8n-nodes-base.airtable/common-issues.md @@ -20,7 +20,7 @@ There was a problem loading the parameter options from server: "Forbidden - perh The error most often displays when the credential you're using doesn't have the scopes it requires on the resources you're attempting to manage. -Refer to the [Airtable credentials](/integrations/builtin/credentials/airtable.md) and [Airtables scopes documentation](https://airtable.com/developers/web/api/scopes) for more information. +Refer to the [Airtable credentials](/integrations/builtin/credentials/airtable.md) and [Airtable scopes documentation](https://airtable.com/developers/web/api/scopes) for more information. ## Service is receiving too many requests from you diff --git a/docs/integrations/builtin/app-nodes/n8n-nodes-base.clearbit.md b/docs/integrations/builtin/app-nodes/n8n-nodes-base.clearbit.md index 105e304ebfc..e5ee1cf9e77 100644 --- a/docs/integrations/builtin/app-nodes/n8n-nodes-base.clearbit.md +++ b/docs/integrations/builtin/app-nodes/n8n-nodes-base.clearbit.md @@ -18,7 +18,7 @@ Refer to [Clearbit credentials](/integrations/builtin/credentials/clearbit.md) f ## Operations * Company - * Auto-complete company names and retrieve logo and domain + * Autocomplete company names and retrieve logo and domain * Look up person and company data based on an email or domain * Person * Look up a person and company data based on an email or domain diff --git a/docs/integrations/builtin/app-nodes/n8n-nodes-base.freshservice.md b/docs/integrations/builtin/app-nodes/n8n-nodes-base.freshservice.md index cc0047e0aa9..90e38d955a3 100644 --- a/docs/integrations/builtin/app-nodes/n8n-nodes-base.freshservice.md +++ b/docs/integrations/builtin/app-nodes/n8n-nodes-base.freshservice.md @@ -84,7 +84,9 @@ Refer to [Freshservice credentials](/integrations/builtin/credentials/freshservi * Create a requester * Delete a requester * Retrieve a requester + * Retrieve all requesters + * Update a requester * Requester Group * Create a requester group diff --git a/docs/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/common-issues.md b/docs/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/common-issues.md index d15035fe8f8..120d31968b0 100644 --- a/docs/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/common-issues.md +++ b/docs/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/common-issues.md @@ -24,7 +24,7 @@ If using the OAuth authentication method, you may see an error indicating that y Most often, the actual cause of this issue is that the URLs don't match between Google's OAuth configuration and n8n. To avoid this, start by reviewing any links included in Google's error message. This will contain details about the exact error that occurred. -If you are self-hostin n8n, check the n8n configuration items used to construct external URLs. Verify that the [`N8N_EDITOR_BASE_URL`](/hosting/configuration/environment-variables/deployment.md) and [`WEBHOOK_URL`](/hosting/configuration/configuration-examples/webhook-url.md) environment variables use fully qualified domains. +If you are self-hostin n8n, check the n8n configuration items used to construct external URLs. Verify that the [`N8N_EDITOR_BASE_URL`](/hosting/configuration/environment-variables.md#deployment) and [`WEBHOOK_URL`](/hosting/configuration/configuration-examples/webhook-url.md) environment variables use fully qualified domains. ## Get recent files from Google Drive diff --git a/docs/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/sheet-operations.md b/docs/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/sheet-operations.md index 699a129fd61..a8501af1d28 100644 --- a/docs/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/sheet-operations.md +++ b/docs/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/sheet-operations.md @@ -183,7 +183,9 @@ Enter these parameters: - **Values (formatted)**: n8n displays the values as they appear in Google Sheets (for example, retaining commas or currency signs) by converting the data type from number to string. - **Formulas**: n8n returns the formula. It doesn't calculate the formula output. For example, if a cell B2 has the formula `=A2`, n8n returns B2's value as `=A2` (in text). Refer to [About date & time values | Google Sheets](https://developers.google.com/sheets/api/guides/formats#about_date_time_values){:target=_blank .external-link} for more information. - **Date Formatting**: Refer to [DateTimeRenderOption | Google Sheets](https://developers.google.com/sheets/api/reference/rest/v4/DateTimeRenderOption){:target=_blank .external-link} for more information. + - **Formatted Text** (default): As displayed in Google Sheets, which depends on the spreadsheet locale. For example `01/01/2024`. + - **Serial Number**: Number of days since December 30th 1899. - **When Filter Has Multiple Matches**: Set to **Return All Matches** to get multiple matches. By default only the first result gets returned. @@ -222,4 +224,4 @@ Enter these parameters: - **Header Row**: Specify the row index that contains the column headers. - **First Data Row**: Specify the row index where the actual data starts. -Refer to the [Method: spreadsheets.batchUpdate | Google Sheets](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/batchUpdate){:target=_blank .external-link} API documentation for more information. \ No newline at end of file +Refer to the [Method: spreadsheets.batchUpdate | Google Sheets](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/batchUpdate){:target=_blank .external-link} API documentation for more information. diff --git a/docs/integrations/builtin/app-nodes/n8n-nodes-base.notion/common-issues.md b/docs/integrations/builtin/app-nodes/n8n-nodes-base.notion/common-issues.md index 518647e2ae1..84f3b7c2322 100644 --- a/docs/integrations/builtin/app-nodes/n8n-nodes-base.notion/common-issues.md +++ b/docs/integrations/builtin/app-nodes/n8n-nodes-base.notion/common-issues.md @@ -40,7 +40,7 @@ Enable **Send Body**, set the **Body Content Type** to **JSON**, and set **Speci ## Create toggle heading -The Notion node allows you to create headings and toggles when adding blocks to **Page**, **Database Page**, or **Block** resources. Creating toggleable headings isn't yet supported by the Notion node itself. +The Notion node allows you to create headings and toggles when adding blocks to **Page**, **Database Page**, or **Block** resources. Creating toggle headings isn't yet supported by the Notion node itself. You can work around this be creating a regular heading and then modifying it to enable the [`is_toggleable` property](https://developers.notion.com/reference/block#headings): diff --git a/docs/integrations/builtin/cluster-nodes/index.md b/docs/integrations/builtin/cluster-nodes/ai-nodes.md similarity index 100% rename from docs/integrations/builtin/cluster-nodes/index.md rename to docs/integrations/builtin/cluster-nodes/ai-nodes.md diff --git a/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepgvector.md b/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepgvector.md index 128a58592a2..8d3af5e15c7 100644 --- a/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepgvector.md +++ b/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepgvector.md @@ -7,7 +7,7 @@ priority: medium # PGVector Vector Store node -PGVector is an extension of Postgresql. Use this node to interact with the PGVector tables in your Postgresql database. You can insert documents into a vector table, get documents from a vector table, retrieve documents to provide them to a retriever connected to a [chain](/glossary.md#ai-chain), or connect directly to an [agent](/glossary.md#ai-agent) as a [tool](/glossary.md#ai-tool). +PGVector is an extension of PostgreSQL. Use this node to interact with the PGVector tables in your PostgreSQL database. You can insert documents into a vector table, get documents from a vector table, retrieve documents to provide them to a retriever connected to a [chain](/glossary.md#ai-chain), or connect directly to an [agent](/glossary.md#ai-agent) as a [tool](/glossary.md#ai-tool). On this page, you'll find the node parameters for the PGVector node, and links to more resources. diff --git a/docs/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorybufferwindow/index.md b/docs/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorybufferwindow/index.md index 5254ab6d47a..336f55646be 100644 --- a/docs/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorybufferwindow/index.md +++ b/docs/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorybufferwindow/index.md @@ -32,7 +32,7 @@ Configure these parameters to configure the node: ## Related resources -Refer to [LangChain's Buffer Window Memory documentation](https://v03.api.js.langchain.com/classes/langchain.memory.BufferWindowMemory.html){:target=_blank .external-link} for more information about the service. +Refer to [LangChain's Buffer Window Memory documentation](https://v03.api.js.langchain.com/classes/langchain.memory.BufferWindowMemory.html) for more information about the service. --8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" diff --git a/docs/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrievermultiquery.md b/docs/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrievermultiquery.md index 1aa4f058778..f63240e6f61 100644 --- a/docs/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrievermultiquery.md +++ b/docs/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrievermultiquery.md @@ -25,7 +25,7 @@ On this page, you'll find the node parameters for the MultiQuery Retriever node, ## Related resources -Refer to [LangChain's retriever conceptual documentation](https://js.langchain.com/docs/concepts/retrievers){:target=_blank .external-link} and [LangChain's multiquery retriever API documentation](https://v03.api.js.langchain.com/classes/langchain.retrievers_multi_query.MultiQueryRetriever.html){:target=_blank .external-link} for more information about the service. +Refer to [LangChain's retriever conceptual documentation](https://js.langchain.com/docs/concepts/retrievers){:target=_blank .external-link} and [LangChain's MultiQuery retriever API documentation](https://v03.api.js.langchain.com/classes/langchain.retrievers_multi_query.MultiQueryRetriever.html){:target=_blank .external-link} for more information about the service. --8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" --8<-- "_glossary/ai-glossary.md" diff --git a/docs/integrations/builtin/core-nodes/index.md b/docs/integrations/builtin/core-nodes/index.md index 2f647d979e0..87c31cbe826 100644 --- a/docs/integrations/builtin/core-nodes/index.md +++ b/docs/integrations/builtin/core-nodes/index.md @@ -7,6 +7,4 @@ contentType: overview This section provides information about n8n's core [nodes](/glossary.md#node-n8n). - - - +Core nodes can be actions or triggers. Whereas most nodes connect to a specific external service, core nodes provide functionality such as logic, scheduling, or generic API calls. diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.aitransform.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.aitransform.md index fe3b1d63b9e..d35ba89a22e 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.aitransform.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.aitransform.md @@ -10,7 +10,7 @@ contentType: [integration, reference] Use the AI Transform node to generate code snippets based on your prompt. The AI is context-aware, understanding the workflow’s nodes and their data types. /// info | Feature availability -Available only on [Cloud plans](/manage-cloud/overview.md). +Available only on [Cloud plans](/manage-cloud/index.md). /// ## Node parameters diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.code/common-issues.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.code/common-issues.md index e80825c9484..1e69de8b743 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.code/common-issues.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.code/common-issues.md @@ -101,7 +101,7 @@ const express = require("express"); This error occurs if you try to use `require` in the Code node and n8n can't find the module. /// warning | Only for self-hosted -n8n doesn't support importing modules in the [Cloud](/manage-cloud/overview.md) version. +n8n doesn't support importing modules in the [Cloud](/manage-cloud/index.md) version. /// If you're [self-hosting](/hosting/index.md) n8n, follow these steps: diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.compression.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.compression.md index 2628a354efd..2ca96db9da6 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.compression.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.compression.md @@ -8,7 +8,9 @@ priority: medium # Compression + Use the Compression node to compress and decompress files. Supports Zip and Gzip formats. + ## Node parameters diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.crypto.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.crypto.md index 487fbb7ed44..e88cece7804 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.crypto.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.crypto.md @@ -50,7 +50,9 @@ Node parameters depend on the action you select. * **BASE64** * **HEX** + ### Hmac parameters + * **Binary File**: Turn this parameter on if the data you want to encrypt is from a binary file. * **Value**: If you turn off **Binary File**, enter the value you want to encrypt. diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.datetime.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.datetime.md index 64a016b984e..e6c50a8f07f 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.datetime.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.datetime.md @@ -182,7 +182,7 @@ This operation has one option: **Include Input Fields**. If you'd like to includ ## Related resources -The Date & Time node uses [Luxon](https://moment.github.io/luxon){:target=_blank .external-link}. You can also use Luxon in the [Code](/code/code-node.md) node and [expressions](/code/expressions.md). Refer to [Date and time with Luxon](/code/cookbook/luxon.md) for more information. +The Date & Time node uses [Luxon](https://moment.github.io/luxon){:target=_blank .external-link}. You can also use Luxon in the [Code](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md) node and [expressions](/code/expressions.md). Refer to [Date and time with Luxon](/code/cookbook/luxon.md) for more information. ### Supported date formats diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.filter.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.filter.md index 97d2a862be4..56d38c64306 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.filter.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.filter.md @@ -26,7 +26,7 @@ You can choose to keep items: * When they meet all conditions: Create two or more conditions and select **AND** in the dropdown between them. * When they meet any of the conditions: Create two or more conditions and select **OR** in the dropdown between them. -You can't create a mix of AND and OR rules. +You can't create a mix of `AND` and `OR` rules. ## Node options diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md index 869b4a48235..2af5318f8ad 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md @@ -88,7 +88,9 @@ If you need to send a body with your API request, turn this option on. Then select the **Body Content Type** that best matches the format for the body content you wish to send. + #### Form URLencoded + Use this option to send your body as `application/x-www-form-urlencoded`. diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.n8n.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.n8n.md index 7db87dc8667..d539d03ef62 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.n8n.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.n8n.md @@ -8,16 +8,16 @@ priority: medium # n8n -A node to integrate with n8n itself. This node allows you to consume the [n8n API](/api/index.md) in your workflows. +A node to integrate with n8n itself. This node allows you to consume the [n8n API](/api/overview.md) in your workflows. -Refer to the [n8n REST API documentation](/api/index.md) for more information on using the n8n API. Refer to [API endpoint reference](/api/api-reference.md) for working with the API endpoints directly. +Refer to the [n8n REST API documentation](/api/overview.md) for more information on using the n8n API. Refer to [API endpoint reference](/api/api-reference.md) for working with the API endpoints directly. /// note | Credentials You can find authentication information for this node in the [API authentication](/api/authentication.md) documentation. /// /// warning | SSL -This node doesn't support SSL. If your server requires an SSL connection, use the [HTTP Request node](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) to call the [n8n API](/api/index.md). +This node doesn't support SSL. If your server requires an SSL connection, use the [HTTP Request node](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) to call the [n8n API](/api/overview.md). The HTTP Request node has options to [provide the SSL certificate](/integrations/builtin/credentials/httprequest.md#provide-an-ssl-certificate). /// diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/common-issues.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/common-issues.md index ea058b2701e..c1d2fd96446 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/common-issues.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/common-issues.md @@ -16,8 +16,10 @@ This error occurs when you set **Trigger Interval** to **Custom (Cron)** and n8n To debug, check that the following: + * That your cron expression follows the syntax used in the [cron examples](/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/index.md#custom-cron-interval) * That your cron expression (after removing the [seconds column](/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/index.md#why-there-are-six-asterisks-in-the-cron-expression)) validates on [crontab guru](https://crontab.guru/) + ## Scheduled workflows run at the wrong time @@ -25,9 +27,9 @@ If the Schedule Trigger node runs at the wrong time, it may mean that you need t ### Adjust the timezone globally -If you're using [n8n Cloud](/manage-cloud/overview.md), follow the instructions on the [set the Cloud instance timezone](/manage-cloud/set-cloud-timezone.md) page to ensure that n8n executes in sync with your local time. +If you're using [n8n Cloud](/manage-cloud/index.md), follow the instructions on the [set the Cloud instance timezone](/manage-cloud/set-cloud-timezone.md) page to ensure that n8n executes in sync with your local time. -If you're [self hosting](/hosting/index.md), set your global timezone using the [`GENERIC_TIMEZONE` environment variable](/hosting/configuration/environment-variables/timezone-localization.md). +If you're [self hosting](/hosting/index.md), set your global timezone using the [`GENERIC_TIMEZONE` environment variable](/hosting/configuration/environment-variables.md#timezone-and-localization). ### Adjust the timezone for an individual workflow @@ -41,7 +43,7 @@ To set the timezone for an individual workflow: ### Variables not working as expected -While variables can be used in the scheduled trigger, their values only get evaluated when the workflow is activated. After activating the worfklow, you can alter a variable's value in the settings but it won't change how often the workflow runs. To work around this, you must stop and then re-activate the workflow to apply the updated variable value. +While variables can be used in the scheduled trigger, their values only get evaluated when the workflow is activated. After activating the workflow, you can alter a variable's value in the settings but it won't change how often the workflow runs. To work around this, you must stop and then re-activate the workflow to apply the updated variable value. ### Changing the trigger interval diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/index.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/index.md index 96695cf6c42..a5862cd2d1e 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/index.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/index.md @@ -81,7 +81,9 @@ For example, if you enter `3` **Months Between Triggers**, `28` **Trigger at Day Enter a custom cron **Expression** to set the schedule for the trigger. -To generate a Cron expression, you can use [crontab guru](https://crontab.guru){:target=_blank .external-link}. Paste the Cron expression that you generated using crontab guru in the **Expression** field in n8n. + +To generate a Cron expression, you can use [crontab guru](https://crontab.guru). Paste the Cron expression that you generated using the site in the **Expression** field in n8n. + #### Examples diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.sendemail.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.sendemail.md index 21c4627efd7..ad8000b43f0 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.sendemail.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.sendemail.md @@ -62,11 +62,11 @@ Enter the name of the binary properties that contain data to add as an attachmen ### CC Email -Enter an email address for the cc: field. +Enter an email address for the `cc:` field. ### BCC Email -Enter an email address for the bcc: field. +Enter an email address for the `bcc:` field. ### Ignore SSL Issues diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.set.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.set.md index c0bf4174463..e684bbbffda 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.set.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.set.md @@ -34,7 +34,7 @@ If you don't want to use expressions: You can do this for both the name and value of the field. -![A gif showing the drag and drop action, as well as changing a field to fixed](/_images/integrations/builtin/core-nodes/set/drag-drop-fixed-toggle.gif) +![A GIF showing the drag and drop action, as well as changing a field to fixed](/_images/integrations/builtin/core-nodes/set/drag-drop-fixed-toggle.gif) ### Keep Only Set Fields diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.splitinbatches.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.splitinbatches.md index 86722198198..c97c4c841f3 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.splitinbatches.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.splitinbatches.md @@ -53,7 +53,7 @@ When enabled, you can adjust the reset conditions by switching the parameter rep This workflow allows you to read an RSS feed from two different sources using the Loop Over Items node. You need the Loop Over Items node in the workflow as the RSS Feed Read node only processes the first item it receives. You can also find the [workflow](https://n8n.io/workflows/687-read-rss-feed-from-two-different-sources/){:target=_blank .external-link} on n8n.io. -The example walks through building the workflow, but assumes you are already familiar with n8n. To build your first workflow, including learning how to add nodes to a workflow, refer to [Try it out](/try-it-out/index.md). +The example walks through building the workflow, but assumes you are already familiar with n8n. To build your first workflow, including learning how to add nodes to a workflow, try the ["first workflow" tutorial](/try-it-out/tutorial-first-workflow.md). The final workflow looks like this: diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.webhook/common-issues.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.webhook/common-issues.md index 4ca3424e5ab..d1772431cb2 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.webhook/common-issues.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.webhook/common-issues.md @@ -98,4 +98,4 @@ Refer to [Workflow development](/integrations/builtin/core-nodes/n8n-nodes-base. If you're unable to connect from IPs in your IP Whitelist, check if you are running n8n behind a reverse proxy. -If so, set the `N8N_PROXY_HOPS` [environment variable](/hosting/configuration/environment-variables/index.md) to the number of reverse-proxies n8n is running behind. +If so, set the `N8N_PROXY_HOPS` [environment variable](/hosting/configuration/environment-variables.md) to the number of reverse-proxies n8n is running behind. diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.webhook/index.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.webhook/index.md index 5a13a04bdd7..85fc7f1625c 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.webhook/index.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.webhook/index.md @@ -55,7 +55,7 @@ The Webhook node supports standard [HTTP Request Methods](https://developer.mozi /// note | Webhook max payload The webhook maximum payload size is 16MB. - If you're self-hosting n8n, you can change this using the [endpoint environment variable](/hosting/configuration/environment-variables/endpoints.md) `N8N_PAYLOAD_SIZE_MAX`. + If you're self-hosting n8n, you can change this using the [endpoint environment variable](/hosting/configuration/environment-variables.md#endpoints) `N8N_PAYLOAD_SIZE_MAX`. /// ### Path diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/common-issues.md b/docs/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/common-issues.md index 27d18682ae5..ba75146aed5 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/common-issues.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/common-issues.md @@ -25,7 +25,7 @@ createChat({ }); ``` -The `metadata` field can contain arbitrary data that will appear in the Chat Trigger output alongside other output data. From there, you can query and process the data from downstream nodes as usual using n8n's [data processing features](/data/index.md). +The `metadata` field can contain arbitrary data that will appear in the Chat Trigger output alongside other output data. From there, you can query and process the data from downstream nodes as usual using n8n's [data processing features](/data/overview.md). ## Chat Trigger node doesn't fetch previous messages diff --git a/docs/integrations/builtin/credentials/bannerbear.md b/docs/integrations/builtin/credentials/bannerbear.md index c157d5fb178..653e0991491 100644 --- a/docs/integrations/builtin/credentials/bannerbear.md +++ b/docs/integrations/builtin/credentials/bannerbear.md @@ -13,7 +13,7 @@ You can use these credentials to authenticate the following nodes: ## Prerequisites -Create a [Bannerbear](https://www.BannerBear.com/){:target=_blank .external-link} account. +Create a [Bannerbear](https://www.bannerbear.com/){:target=_blank .external-link} account. ## Supported authentication methods diff --git a/docs/integrations/builtin/credentials/beeminder.md b/docs/integrations/builtin/credentials/beeminder.md index 7327addba97..a5c3455a05d 100644 --- a/docs/integrations/builtin/credentials/beeminder.md +++ b/docs/integrations/builtin/credentials/beeminder.md @@ -30,5 +30,5 @@ To configure this credential, you'll need: - A **User** name: Should match the user who the Auth Token is generated for. - A personal **Auth Token** for that user. Generate this using either method below: - In the GUI: From the [Apps & API](https://help.beeminder.com/article/110-apps-and-api#API-token){:target=_blank .external-link} option within **Account Settings** - - In the API: From hitting the [`auth_token` API endpoint](https://api.beeminder.com/#auth){:target=_blank .external-link} + - In the API: From hitting the [`auth_token` API endpoint](https://api.beeminder.com/#auth) diff --git a/docs/integrations/builtin/credentials/ghost.md b/docs/integrations/builtin/credentials/ghost.md index b70f51906f5..af1188a27d1 100644 --- a/docs/integrations/builtin/credentials/ghost.md +++ b/docs/integrations/builtin/credentials/ghost.md @@ -30,13 +30,13 @@ Refer to Ghost's [Admin API documentation](https://ghost.org/docs/admin-api/){:t To configure this credential, you'll need: -- The **URL** of your Ghost admin domain. Your [admin domain](https://ghost.org/docs/admin-api/#base-url){:target=_blank .external-link} can be different to your main domain and may include a subdirectory. All Ghost(Pro) blogs have a `*.ghost.io` domain as their admin domain and require https. +- The **URL** of your Ghost admin domain. Your [admin domain](https://ghost.org/docs/admin-api/#base-url){:target=_blank .external-link} can be different to your main domain and may include a subdirectory. All Ghost(Pro) blogs have a `*.ghost.io` domain as their admin domain and require HTTPS. - An **API Key**: To generate a new API key, create a new Custom Integration. Refer to the [Ghost Admin API Token Authentication Key documentation](https://ghost.org/docs/admin-api/#token-authentication){:target=_blank .external-link} for more detailed instructions. Copy the **Admin API Key** and use this as the **API Key** in the Ghost Admin n8n credential. ## Using Content API key To configure this credential, you'll need: -- The **URL** of your Ghost admin domain. Your [admin domain](https://ghost.org/docs/content-api/#url){:target=_blank .external-link} can be different to your main domain and may include a subdirectory. All Ghost(Pro) blogs have a `*.ghost.io` domain as their admin domain and require https. +- The **URL** of your Ghost admin domain. Your [admin domain](https://ghost.org/docs/content-api/#url){:target=_blank .external-link} can be different to your main domain and may include a subdirectory. All Ghost(Pro) blogs have a `*.ghost.io` domain as their admin domain and require HTTPS. - An **API Key**: To generate a new API key, create a new Custom Integration. Refer to the [Ghost Content API Key documentation](https://ghost.org/docs/content-api/#key){:target=_blank .external-link} for more detailed instructions. Copy the **Content API Key** and use this as the **API Key** in the Ghost Content n8n credential. diff --git a/docs/integrations/builtin/credentials/gitlab.md b/docs/integrations/builtin/credentials/gitlab.md index f4da0c23501..da31ef41419 100644 --- a/docs/integrations/builtin/credentials/gitlab.md +++ b/docs/integrations/builtin/credentials/gitlab.md @@ -37,7 +37,9 @@ To set up the credential: 4. Enter a **Name** for the token, like `n8n integration`. 5. Enter an **expiry date** for the token. If you don't enter an expiry date, GitLab automatically sets it to 365 days later than the current date. - The token expires on that expiry date at midnight UTC. + 6. Select the desired **Scopes**. For the [GitLab](/integrations/builtin/app-nodes/n8n-nodes-base.gitlab.md) node, use the `api` scope to easily grant access for all the node's functionality. Or refer to [Personal access token scopes](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#personal-access-token-scopes){:target=_blank .external-link} to select scopes for the functions you want to use. + 7. Select **Create personal access token**. 8. Copy the access token this creates and enter it in your n8n credential as the **Access Token**. 9. Enter the URL of your **GitLab Server** in your n8n credential. @@ -55,7 +57,9 @@ If you're [self-hosting](/hosting/index.md) n8n, you'll need a [GitLab](https:// 3. Select **Add new application**. 4. Enter a **Name** for your application, like `n8n integration`. 5. In n8n, copy the **OAuth Redirect URL**. Enter it as the GitLab **Redirect URI**. + 6. Select the desired **Scopes**. For the [GitLab](/integrations/builtin/app-nodes/n8n-nodes-base.gitlab.md) node, use the `api` scope to easily grant access for all the node's functionality. Or refer to [Personal access token scopes](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#personal-access-token-scopes){:target=_blank .external-link} to select scopes for the functions you want to use. + 6. Select **Save application**. 7. Copy the **Application ID** and enter it as the **Client ID** in your n8n credential. 8. Copy the **Secret** and enter it as the **Client Secret** in your n8n credential. diff --git a/docs/integrations/builtin/credentials/linear.md b/docs/integrations/builtin/credentials/linear.md index 8dd019df449..d104f722b13 100644 --- a/docs/integrations/builtin/credentials/linear.md +++ b/docs/integrations/builtin/credentials/linear.md @@ -38,7 +38,7 @@ To configure this credential, you'll need: - A **Client ID**: Generated when you create a new OAuth2 application. - A **Client Secret**: Generated when you create a new OAuth2 application. - Select the **Actor**: The actor defines how the OAuth2 application should create issues, comments and other changes. Options include: - - **User** (Linear's default): The application creates resources as the authorizing user. Use this option if you want each user to do their own authentication. + - **User** (the default in Linear): The application creates resources as the authorizing user. Use this option if you want each user to do their own authentication. - **Application**: The application creates resources as itself. Use this option if you have only one user (like an admin) authorizing the application. - To use this credential with the [Linear Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.lineartrigger.md) node, you must enable the **Include Admin Scope** toggle. diff --git a/docs/integrations/builtin/credentials/mailchimp.md b/docs/integrations/builtin/credentials/mailchimp.md index 60cfbd37fcc..fffe0d1e24a 100644 --- a/docs/integrations/builtin/credentials/mailchimp.md +++ b/docs/integrations/builtin/credentials/mailchimp.md @@ -43,5 +43,5 @@ If you need to configure OAuth2 from scratch, [register an application](https:// Mailchimp suggests using an API key if you're only accessing your own Mailchimp account's data: -> Use an API key if you're writing code that tightly couples _your_ application's data to _your_ Mailchimp account's data. If you ever need to access _someone else's_ Mailchimp account's data, you should be using OAuth 2 ([source](https://mailchimp.com/developer/marketing/guides/access-user-data-oauth-2/#when-not-to-use-oauth-2){:target=_blank .external-link}) +> Use an API key if you're writing code that tightly couples _your_ application's data to _your_ Mailchimp account's data. If you ever need to access _another person's_ Mailchimp account's data, you should be using OAuth 2 ([source](https://mailchimp.com/developer/marketing/guides/access-user-data-oauth-2/#when-not-to-use-oauth-2){:target=_blank .external-link}) diff --git a/docs/integrations/builtin/credentials/msg91.md b/docs/integrations/builtin/credentials/msg91.md index f5c3e3c0a33..ba37a64a756 100644 --- a/docs/integrations/builtin/credentials/msg91.md +++ b/docs/integrations/builtin/credentials/msg91.md @@ -33,7 +33,7 @@ To configure this credential, you'll need: MSG91 enables [IP Security](https://msg91.com/help/what-do-you-mean-by-api-security){:target=_blank .external-link} by default for authkeys. -For the n8n credentials to function with this setting enabled, add all the [n8n IP addresses](/manage-cloud/cloud-ip.md) as whitelisted IPs in MSG91. You can add them in one of two places, depending on your desired security level: +For the n8n credentials to function with this setting enabled, add all the [n8n IP addresses](/manage-cloud/cloud-ip.md) as whitelisted IP addresses in MSG91. You can add them in one of two places, depending on your desired security level: - To allow any/all authkeys in the account to work with n8n, add the n8n IP addresses in the **Company's whitelisted IPs** section of the **Authkey** page. - To allow only specific authkeys to work with n8n, add the n8n IP addresses in the **Whitelisted IPs** section of an authkey's details. diff --git a/docs/integrations/builtin/credentials/index.md b/docs/integrations/builtin/credentials/overview.md similarity index 70% rename from docs/integrations/builtin/credentials/index.md rename to docs/integrations/builtin/credentials/overview.md index c3b5d367ce4..41f4a3a23e0 100644 --- a/docs/integrations/builtin/credentials/index.md +++ b/docs/integrations/builtin/credentials/overview.md @@ -5,7 +5,7 @@ contentType: overview # Credentials library -This section contains step-by-step information about authenticating the different nodes in n8n. +This section contains information about authenticating to external services in n8n using credentials. To learn more about creating, managing, and sharing credentials, refer to [Manage credentials](/credentials/index.md). diff --git a/docs/integrations/builtin/credentials/pushbullet.md b/docs/integrations/builtin/credentials/pushbullet.md index 4617173ab5b..eb4a5a81b81 100644 --- a/docs/integrations/builtin/credentials/pushbullet.md +++ b/docs/integrations/builtin/credentials/pushbullet.md @@ -30,7 +30,7 @@ To configure this credential, you'll need: - A **Client ID**: Generated when you create a Pushbullet app, also known as an OAuth client. - A **Client Secret**: Generated when you create a Pushbullet app, also known as an OAuth client. -To generate the **Client ID** and **Client Secret**, go to the [create client](https://www.pushbullet.com/create-client) page. Copy the **OAuth Redirect URL** from n8n and add this as your **redirect_uri** for the app/client. Use the **client_id** and **client_secret** from the OAuth Client in your n8n credential. +To generate the **Client ID** and **Client Secret**, go to the [create client](https://www.pushbullet.com/create-client) page. Copy the **OAuth Redirect URL** from n8n and add this as your **redirect URI** for the app/client. Use the **Client ID** and **Client Secret** from the OAuth Client in your n8n credential. Refer to Pushbullet's [OAuth2 Guide](https://docs.pushbullet.com/#oauth2) for more information. diff --git a/docs/integrations/builtin/credentials/rocketchat.md b/docs/integrations/builtin/credentials/rocketchat.md index 24eb49e1511..4a87fa5645f 100644 --- a/docs/integrations/builtin/credentials/rocketchat.md +++ b/docs/integrations/builtin/credentials/rocketchat.md @@ -5,6 +5,7 @@ description: Documentation for Rocket.Chat credentials. Use these credentials to contentType: [integration, reference] --- + # Rocket.Chat credentials You can use these credentials to authenticate the following nodes: @@ -22,9 +23,7 @@ You can use these credentials to authenticate the following nodes: ## Related resources - -Refer to [Rocket.Chat's API documentation](https://developer.rocket.chat/reference/api/rest-api){:target=_blank .external-link} for more information about the service. - +Refer to [Rocket.Chat's API documentation](https://developer.rocket.chat/apidocs) for more information about the service. ## Using API access token @@ -34,5 +33,5 @@ To configure this credential, you'll need: - An **Auth Key**: Your personal access token. To generate an access token, go to your **avatar > Account > Personal Access Tokens**. Copy the token and add it as the n8n **Auth Key**. - Your Rocket.Chat **Domain**: Also known as your default URL or workspace URL. -Refer to [Personal Access Tokens](https://docs.rocket.chat/docs/manage-your-account-settings#personal-access-tokens){:target=_blank .external-link} for more information. +Refer to [Personal Access Tokens](https://docs.rocket.chat/docs/manage-your-account-settings#personal-access-tokens) for more information. diff --git a/docs/integrations/builtin/credentials/servicenow.md b/docs/integrations/builtin/credentials/servicenow.md index 0c03f3bb67b..e807b4c6dc2 100644 --- a/docs/integrations/builtin/credentials/servicenow.md +++ b/docs/integrations/builtin/credentials/servicenow.md @@ -30,7 +30,7 @@ To configure this credential, you'll need: - A **User** name: Enter your ServiceNow username. - A **Password**: Enter your ServiceNow password. -- A **Subdomain**: The subdomain for your servicenow instance is in your instance URL: `https://.service-now.com/`. For example, if the full URL is `https://dev99890.service-now.com`, then the subdomain is `dev99890`. +- A **Subdomain**: The subdomain for your ServiceNow instance is in your instance URL: `https://.service-now.com/`. For example, if the full URL is `https://dev99890.service-now.com`, then the subdomain is `dev99890`. ## Using OAuth2 @@ -38,7 +38,7 @@ To configure this credential, you'll need: - A **Client ID**: Generated once you register a new app. - A **Client Secret**: Generated once you register a new app. -- A **Subdomain**: The subdomain for your servicenow instance is in your instance URL: `https://.service-now.com/`. For example, if the full URL is `https://dev99890.service-now.com`, then the subdomain is `dev99890`. +- A **Subdomain**: The subdomain for your ServiceNow instance is in your instance URL: `https://.service-now.com/`. For example, if the full URL is `https://dev99890.service-now.com`, then the subdomain is `dev99890`. To generate your **Client ID** and **Client Secret**, register a new app in **System OAuth > Application Registry > New > Create an OAuth API endpoint for external clients**. Use these settings for your app: diff --git a/docs/integrations/builtin/credentials/yourls.md b/docs/integrations/builtin/credentials/yourls.md index cfd7df944ca..7731e50e0b4 100644 --- a/docs/integrations/builtin/credentials/yourls.md +++ b/docs/integrations/builtin/credentials/yourls.md @@ -21,7 +21,7 @@ Install [Yourls](https://github.com/YOURLS/YOURLS){:target=_blank .external-link ## Related resources -Refer to [Yourl's documentation](https://yourls.org/docs){:target=_blank .external-link} for more information about the service. +Refer to [Yourls' documentation](https://yourls.org/docs){:target=_blank .external-link} for more information about the service. ## Using API key diff --git a/docs/integrations/builtin/node-types.md b/docs/integrations/builtin/node-types.md index 2acb4dc615a..9141ff8d360 100644 --- a/docs/integrations/builtin/node-types.md +++ b/docs/integrations/builtin/node-types.md @@ -3,9 +3,9 @@ contentType: overview --- -# Built-in integrations +# Node types -This section contains the [node](/glossary.md#node-n8n) library: reference documentation for every built-in node in n8n, and their credentials. +This section contains the [node](/glossary.md#node-n8n) library: reference documentation for every built-in node in n8n. --8<-- "_snippets/integrations/builtin/node-operations.md" @@ -13,22 +13,28 @@ This section contains the [node](/glossary.md#node-n8n) library: reference docum Core nodes can be actions or [triggers](/glossary.md#trigger-node-n8n). Whereas most nodes connect to a specific external service, core nodes provide functionality such as logic, scheduling, or generic API calls. +## App nodes + +App nodes integrate with specific external services and applications. The specific features differ from service to service, but some common examples include managing resources with [CRUD operations](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete), checking and updating statuses, sending and receiving messages, and converting data and documents. + +App nodes may be triggers or actions depending on whether they start workflows or not, and many App nodes implement both functions. + ## Cluster nodes --8<-- "_snippets/integrations/builtin/cluster-nodes/cluster-nodes-summary.md" +## Community nodes + +n8n supports custom nodes built by the community. Refer to [Community nodes](/integrations/community-nodes/installation/index.md) for guidance on installing and using these nodes. + +For help building your own custom nodes, and publish them to [npm](https://www.npmjs.com/){:target=_blank .external-link}, refer to [Creating nodes](/integrations/creating-nodes/overview.md) for more information. + ## Credentials External services need a way to identify and authenticate users. This data can range from an API key over an email/password combination to a long multi-line private key. You can save these in n8n as [credentials](/glossary.md#credential-n8n). -Nodes in n8n can then request that credential information. As another layer of security, only node types with specific access rights can access the credentials. +While not nodes themselves, credentials are often required to correctly use nodes. Once saved, nodes in n8n can request that credential information. As another layer of security, only node types with specific access rights can access the credentials. To make sure that the data is secure, it gets saved to the database encrypted. n8n uses a random personal encryption key, which it automatically generates on the first run of n8n and then saved under `~/.n8n/config`. To learn more about creating, managing, and sharing credentials, refer to [Manage credentials](/credentials/index.md). - -## Community nodes - -n8n supports custom nodes built by the community. Refer to [Community nodes](/integrations/community-nodes/installation/index.md) for guidance on installing and using these nodes. - -For help building your own custom nodes, and publish them to [npm](https://www.npmjs.com/){:target=_blank .external-link}, refer to [Creating nodes](/integrations/creating-nodes/overview.md) for more information. diff --git a/docs/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md b/docs/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md index f09fc619a18..13e159450ed 100644 --- a/docs/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md +++ b/docs/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md @@ -24,17 +24,17 @@ For usage examples and templates to help you get started, refer to n8n's [Telegr - **Business Connection**: Trigger when the bot is connected to or disconnected from a business account, or a user edited an existing connection with the bot. - **Business Message**: Trigger on a new message from a connected business account. - **Callback Query**: Trigger on new incoming callback query. -- **Channel Post**: Trigger on new incoming channel post of any kind — including text, photo, sticker, and so on. +- **Channel Post**: Trigger on new incoming channel post of any kind—including text, photo, sticker, and so on. - **Chat Boost**: Trigger when a chat boost is added or changed. The bot must be an administrator in the chat to receive these updates. - **Chat Join Request**: Trigger when a request to join the chat is sent. The bot must have the `can_invite_users` administrator right in the chat to receive these updates. - **Chat Member**: Trigger when a chat member's status is updated. The bot must be an administrator in the chat. - **Chosen Inline Result**: Trigger when the result of an inline query chosen by a user is sent. Please see Telegram's API documentation on [feedback collection](https://core.telegram.org/bots/inline#collecting-feedback) for details on how to enable these updates for your bot. - **Deleted Business Messages**: Trigger when messages are deleted from a connected business account. - **Edited Business Message**: Trigger on new version of a message from a connected business account. -- **Edited Channel Post**: Trigger on new version of a channel post that is known to the bot is edited. -- **Edited Message**: Trigger on new version of a channel post that is known to the bot is edited. +- **Edited Channel Post**: Trigger on new version of a channel post that's known to the bot is edited. +- **Edited Message**: Trigger on new version of a channel post that's known to the bot is edited. - **Inline Query**: Trigger on new incoming inline query. -- **Message**: Trigger on new incoming message of any kind — text, photo, sticker, and so on. +- **Message**: Trigger on new incoming message of any kind—text, photo, sticker, and so on. - **Message Reaction**: Trigger when a reaction to a message is changed by a user. The bot must be an administrator in the chat. The update isn't received for reactions set by bots. - **Message Reaction Count**: Trigger when reactions to a message with anonymous reactions are changed. The bot must be an administrator in the chat. The updates are grouped and can be sent with delay up to a few minutes. - **My Chat Member**: Trigger when the bot's chat member status is updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user. diff --git a/docs/integrations/creating-nodes/build/node-development-environment.md b/docs/integrations/creating-nodes/build/node-development-environment.md index 6eea9d2b8a1..4671c28dc25 100644 --- a/docs/integrations/creating-nodes/build/node-development-environment.md +++ b/docs/integrations/creating-nodes/build/node-development-environment.md @@ -11,7 +11,7 @@ This document lists the essential dependencies for developing a node, as well as To build and test a node, you need: -* Node.js and npm. Minimum version Node 18.17.0. You can find instructions on how to install both using nvm (Node Version Manager) for Linux, Mac, and WSL (Windows Subsystem for Linux) [here](https://github.com/nvm-sh/nvm){:target=_blank class=.external-link}. For Windows users, refer to Microsoft's guide to [Install NodeJS on Windows](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows){:target=_blank class=.external-link}. +* Node.js and npm. Minimum version Node 18.17.0. You can find instructions on how to install both using `nvm` (Node Version Manager) for Linux, Mac, and WSL (Windows Subsystem for Linux) [here](https://github.com/nvm-sh/nvm){:target=_blank class=.external-link}. For Windows users, refer to Microsoft's guide to [Install NodeJS on Windows](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows){:target=_blank class=.external-link}. * A local instance of n8n. You can install n8n with `npm install n8n -g`, then follow the steps in [Run your node locally](/integrations/creating-nodes/test/run-node-locally.md) to test your node. You should also have [git](https://git-scm.com/){:target=_blank class=.external-link} installed. This allows you to clone and use the [n8n-node-starter](https://github.com/n8n-io/n8n-nodes-starter){:target=_blank class=.external-link}. diff --git a/docs/integrations/creating-nodes/build/reference/node-base-files/standard-parameters.md b/docs/integrations/creating-nodes/build/reference/node-base-files/standard-parameters.md index 05024999858..9a1cdbdb8d2 100644 --- a/docs/integrations/creating-nodes/build/reference/node-base-files/standard-parameters.md +++ b/docs/integrations/creating-nodes/build/reference/node-base-files/standard-parameters.md @@ -104,8 +104,10 @@ This parameter tells n8n the credential options. Each object defines an authenti The object must include: + * `name`: the credential name. Must match the `name` property in the credential file. For example, `name: 'asanaApi'` in [`Asana.node.ts`](https://github.com/n8n-io/n8n/blob/master/packages/nodes-base/nodes/Asana/Asana.node.ts){:target=_blank .external-class} links to `name = 'asanaApi'` in [`AsanaApi.credential.ts`](https://github.com/n8n-io/n8n/blob/master/packages/nodes-base/credentials/AsanaApi.credentials.ts){:target=_blank .external-class}. * `required`: Boolean. Specify whether authentication is required to use this node. + ## `requestDefaults` diff --git a/docs/integrations/creating-nodes/build/reference/ui-elements.md b/docs/integrations/creating-nodes/build/reference/ui-elements.md index 617a506d59e..1c43a9468c8 100644 --- a/docs/integrations/creating-nodes/build/reference/ui-elements.md +++ b/docs/integrations/creating-nodes/build/reference/ui-elements.md @@ -401,7 +401,7 @@ Use the drag and drop component when you want users to pre-fill name and value p You can see an example in n8n's [Edit Fields (Set) node](https://github.com/n8n-io/n8n/tree/0faeab1228e26d69a2a93bdb2f89523cca1e4036/packages/nodes-base/nodes/Set/v2){:target=_blank .external-link}: -![A gif showing the drag and drop action, as well as changing a field to fixed](/_images/integrations/builtin/core-nodes/set/drag-drop-fixed-toggle.gif) +![A GIF showing the drag and drop action, as well as changing a field to fixed](/_images/integrations/builtin/core-nodes/set/drag-drop-fixed-toggle.gif) ## Fixed collection diff --git a/docs/learning-path.md b/docs/learning-path.md index 25b9aa25c95..19d60d1b83c 100644 --- a/docs/learning-path.md +++ b/docs/learning-path.md @@ -20,11 +20,7 @@ If you don't have an account yet, sign up to a [free trial on n8n Cloud](https:/ ## Try it out -Start with the quickstart guides to help you get up and running with building basic workflows. - -- [A very quick quickstart](/try-it-out/quickstart.md) -- [A longer introduction](/try-it-out/tutorial-first-workflow.md) -- [Build an AI workflow in n8n](/advanced-ai/intro-tutorial.md) +Start with the [first workflow tutorial](/try-it-out/tutorial-first-workflow.md) to help you get up and running with building basic workflows. ## Structured Courses diff --git a/docs/log-streaming.md b/docs/log-streaming.md index 45cf32f091a..6ed9c8d954b 100644 --- a/docs/log-streaming.md +++ b/docs/log-streaming.md @@ -24,7 +24,7 @@ To use log streaming, you have to add a streaming destination. 6. Select **Save**. /// note | Self-hosted users -If you self-host n8n, you can configure additional log streaming behavior using [Environment variables](/hosting/configuration/environment-variables/logs.md#log-streaming). +If you self-host n8n, you can configure additional log streaming behavior using [Environment variables](/hosting/configuration/environment-variables.md#log-streaming). /// ## Events diff --git a/docs/manage-cloud/ai-assistant.md b/docs/manage-cloud/ai-assistant.md index 73cb3c106a2..19d3bc8c8a2 100644 --- a/docs/manage-cloud/ai-assistant.md +++ b/docs/manage-cloud/ai-assistant.md @@ -3,7 +3,7 @@ contentType: explanation --- -# AI Assistant +# AI assistant The n8n AI Assistant helps you build, debug, and optimize your workflows seamlessly. From answering questions about n8n to providing help with coding and [expressions](/glossary.md#expression-n8n), the AI Assistant can streamline your workflow-building process and support you as you navigate n8n's capabilities. @@ -15,7 +15,7 @@ The AI Assistant offers a range of tools to support you: - **Answer n8n questions**: Get instant answers to your n8n-related questions, whether they're about specific features or general functionality. - **Coding support**: Receive guidance on coding, including SQL and JSON, to optimize your nodes and data processing. - **Expression assistance**: Learn how to create and refine [expressions](/code/expressions.md) to get the most out of your workflows. -- **Credential setup tips**: Find out how to set up and manage node [credentials](/integrations/builtin/credentials/index.md) securely and efficiently. +- **Credential setup tips**: Find out how to set up and manage node [credentials](/integrations/builtin/credentials/overview.md) securely and efficiently. ## Tips for getting the most out of the Assistant diff --git a/docs/manage-cloud/cloud-ip.md b/docs/manage-cloud/cloud-ip.md index a5291250563..0f4da379216 100644 --- a/docs/manage-cloud/cloud-ip.md +++ b/docs/manage-cloud/cloud-ip.md @@ -6,7 +6,7 @@ contentType: reference # Cloud IP addresses /// warning | Cloud IP addresses change without warning -n8n can't guarantee static source IPs, as Cloud operates in a dynamic cloud provider environment and scales its infrastructure to meet demand. You should use strong authentication and secure transport protocols when connecting into and out of n8n. +n8n can't guarantee static source IP addresses, as Cloud operates in a dynamic cloud provider environment and scales its infrastructure to meet demand. You should use strong authentication and secure transport protocols when connecting into and out of n8n. /// Outbound traffic may appear to originate from any of: diff --git a/docs/manage-cloud/concurrency.md b/docs/manage-cloud/concurrency.md index 32ff2bf8e35..b1e32a6982e 100644 --- a/docs/manage-cloud/concurrency.md +++ b/docs/manage-cloud/concurrency.md @@ -29,7 +29,7 @@ You can view the number of active executions and your plan's concurrency limit a Some other details about concurrency to keep in mind: - Concurrency control applies only to production executions: those started from a webhook or trigger node. It doesn't apply to any other kinds, such as manual executions, sub-workflow executions, or error executions. -- [Test evaluations](/glossary.md#evaluation-n8n) do not count towards concurrency limits. Your test evaluation concurrency limit is equal to, but separate from, your plan's regular concurrency limit. +- [Test evaluations](/glossary.md#evaluation-n8n) don't count towards concurrency limits. Your test evaluation concurrency limit is equal to, but separate from, your plan's regular concurrency limit. - You can't retry queued executions. Cancelling or deleting a queued execution also removes it from the queue. - On instance startup, n8n resumes queued executions up to the concurrency limit and re-enqueues the rest. diff --git a/docs/manage-cloud/overview.md b/docs/manage-cloud/index.md similarity index 89% rename from docs/manage-cloud/overview.md rename to docs/manage-cloud/index.md index 6142cc48cba..5e2a04e2ff7 100644 --- a/docs/manage-cloud/overview.md +++ b/docs/manage-cloud/index.md @@ -14,7 +14,7 @@ n8n Cloud is n8n's hosted solution. It provides: - Managed OAuth for authentication - One-click upgrades to the newest n8n versions -[Sign up for n8n Cloud](https://www.n8n.io/){:target=_blank .external-link} +[Sign up for n8n Cloud](https://www.n8n.io/) /// note | Russia and Belarus n8n Cloud isn't available in Russia and Belarus. Refer to this blog post: [Update on n8n cloud accounts in Russia and Belarus](https://n8n.io/blog/update-on-n8n-cloud-accounts-in-russia-and-belarus/) for more information. diff --git a/docs/manage-cloud/update-cloud-version.md b/docs/manage-cloud/update-cloud-version.md index 99599cde762..d334f6f0cbf 100644 --- a/docs/manage-cloud/update-cloud-version.md +++ b/docs/manage-cloud/update-cloud-version.md @@ -27,6 +27,6 @@ Only instance owners can upgrade n8n Cloud versions. Contact your instance owner ## Automatic update -n8n automatically updates outdated Cloud instances. +n8n automatically updates outdated Cloud instances. If you don't update you instance for 120 days, n8n emails you to warn you to update. After a further 30 days, n8n automatically updates your instance. diff --git a/docs/placeholder.md b/docs/placeholder.md new file mode 100644 index 00000000000..1b39ec1b7fd --- /dev/null +++ b/docs/placeholder.md @@ -0,0 +1,17 @@ +--- +ContentType: empty +Title: "Placeholder page" +--- + +# Placeholder page + +Text paragraph for a page which doesn't currently exist. Maybe it will exist at some point, or maybe it will be redesigned out of the navigation, but for now, this is its place. + +``` mermaid +graph LR + A[Start] --> B{Error?}; + B -->|Yes| C[Hmm...]; + C --> D[Debug]; + D --> B; + B ---->|No| E[Yay!]; +``` \ No newline at end of file diff --git a/docs/privacy-security/privacy.md b/docs/privacy-security/privacy.md index d4679e428f2..3047ae57c52 100644 --- a/docs/privacy-security/privacy.md +++ b/docs/privacy-security/privacy.md @@ -82,7 +82,7 @@ n8n takes care to keep self-hosted data anonymous and avoids collecting sensitiv - DB_TYPE - N8N_VERSION_NOTIFICATIONS_ENABLED - N8N_DISABLE_PRODUCTION_MAIN_PROCESS - - [Execution variables](/hosting/configuration/environment-variables/executions.md) + - [Execution variables](/hosting/configuration/environment-variables.md#executions) - OS, RAM, and CPUs - Anonymous instance ID - IP address diff --git a/docs/privacy-security/what-you-can-do.md b/docs/privacy-security/what-you-can-do.md index 0cc7dad1d87..6d0d3775223 100644 --- a/docs/privacy-security/what-you-can-do.md +++ b/docs/privacy-security/what-you-can-do.md @@ -23,8 +23,8 @@ If you self-host n8n, there are additional steps you can take: * Ensure data is encrypted at rest by using encrypted partitions, or encryption at the hardware level, and ensuring n8n and its database is written to that location. * Run a [Security audit](/hosting/securing/security-audit.md). * Be aware of the [Risks](/integrations/community-nodes/risks.md) when installing community nodes, or choose to disable them. -* Make sure users can't import external modules in the Code node. Refer to [Environment variables | Nodes](https://docs.n8n.io/hosting/configuration/environment-variables/nodes) for more information. -* Choose to exclude certain nodes. For example, you can disable nodes like Execute Command or SSH. Refer to [Environment variables | Nodes](https://docs.n8n.io/hosting/configuration/environment-variables/nodes) for more information. +* Make sure users can't import external modules in the Code node. Refer to [Environment variables | Nodes](/hosting/configuration/environment-variables.md#nodes) for more information. +* Choose to exclude certain nodes. For example, you can disable nodes like Execute Command or SSH. Refer to [Environment variables | Nodes](/hosting/configuration/environment-variables.md#nodes) for more information. * For maximum privacy, you can [Isolate n8n](/hosting/configuration/configuration-examples/isolation.md). ### GDPR for self-hosted users diff --git a/docs/reference/index.md b/docs/reference/index.md new file mode 100644 index 00000000000..54ed39fe57e --- /dev/null +++ b/docs/reference/index.md @@ -0,0 +1,10 @@ +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +--- + +# Reference + +This section contains reference material for n8n. This includes information about nodes, credentials, working with data, built in methods and variables, the API and more. + +The n8n user interface links directly to many of the pages in this section, offering convenient access to context-specific information while using the application. diff --git a/docs/release-notes.md b/docs/release-notes.md index 2d25ee623ea..618a6b28b36 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -149,7 +149,7 @@ Create and manage folders within your personal space or within projects. You can
-Folders are available for all [registered](/hosting/community-edition-features.md#registered-community-edition) users so get started with decluttering your workspace now and look for more features (like drag and drop) to organize your instances soon. +Folders are available for all [registered](/choose-n8n.md#registered-community-edition-license) users so get started with decluttering your workspace now and look for more features (like drag and drop) to organize your instances soon. ### Enhancements to Form Trigger Node @@ -918,7 +918,7 @@ The Task runner comes in two modes: - Internal mode (default): Perfect for getting started, automatically managing task runners as child processes - External mode: For advanced hosting scenarios requiring maximum isolation and security -Currently, this feature is opt-in and can be enabled using [environment variables](/hosting/configuration/environment-variables/task-runners.md). Once stable, it will become the default execution method for Code nodes. +Currently, this feature is opt-in and can be enabled using [environment variables](/hosting/configuration/environment-variables.md#task-runners). Once stable, it will become the default execution method for Code nodes. To start using Task runners today, [check out the docs](/hosting/configuration/task-runners.md). @@ -1433,11 +1433,11 @@ This release contains new features, node enhancements and bug fixes. #### Queue metrics for workers -You can now [expose and consume metrics from your workers](https://docs.n8n.io/hosting/configuration/configuration-examples/prometheus/). The worker instances have the same metrics available as the main instance(s) and can be configured with [environment variables](/hosting/configuration/environment-variables/endpoints.md). +You can now [expose and consume metrics from your workers](https://docs.n8n.io/hosting/configuration/configuration-examples/prometheus/). The worker instances have the same metrics available as the main instance(s) and can be configured with [environment variables](/hosting/configuration/environment-variables.md#endpoints). -You can now customize the maximum file size when uploading files within forms to webhooks. The [environment variable to set](/hosting/configuration/environment-variables/endpoints.md) for this is `N8N_FORMDATA_FILE_SIZE_MAX`. The default setting is 200MiB. +You can now customize the maximum file size when uploading files within forms to webhooks. The [environment variable to set](/hosting/configuration/environment-variables.md#endpoints) for this is `N8N_FORMDATA_FILE_SIZE_MAX`. The default setting is 200MiB. ### Node updates Enhanced nodes: @@ -1691,7 +1691,7 @@ We now also prevent npm downloading community packages from a compromised npm re #### New node: AI Transform -This release adds the [AI Transform node](/integrations/builtin/core-nodes/n8n-nodes-base.aitransform.md). Use the AI Transform node to generate code snippets based on your prompt. The AI is context-aware, understanding the workflow’s nodes and their data types. The node is only available on [Cloud plans](/manage-cloud/overview.md). +This release adds the [AI Transform node](/integrations/builtin/core-nodes/n8n-nodes-base.aitransform.md). Use the AI Transform node to generate code snippets based on your prompt. The AI is context-aware, understanding the workflow’s nodes and their data types. The node is only available on [Cloud plans](/manage-cloud/index.md). @@ -1739,7 +1739,7 @@ View the [commits](https://github.com/n8n-io/n8n/compare/n8n@1.53.1...n8n@1.54.0 This release contains new features, node enhancements, bug fixes and updates to our API. ### API update -Our [public REST API](/api/index.md) now supports additional operations: +Our [public REST API](/api/overview.md) now supports additional operations: - Create, delete, and edit roles for users - Create, read, update and delete projects @@ -1814,7 +1814,7 @@ Enhanced nodes: - [Shopify](/integrations/builtin/app-nodes/n8n-nodes-base.shopify.md) ### API update -Our [public REST API](/api/index.md) now supports additional operations: +Our [public REST API](/api/overview.md) now supports additional operations: - Create, read, and delete for variables - Filtering workflows by project @@ -2341,7 +2341,7 @@ You can now ask AI to help create API requests in the HTTP Request node: 1. Enter the **Service** and **Request** you want to use. For example, to use the NASA API to get their picture of the day, enter `NASA` in **Service** and `get picture of the day` in **Request**. 1. Check the parameters: the AI tries to fill them out, but you may still need to adjust or correct the configuration. -Self-hosted users need to [enable AI features and provide their own API keys](/hosting/configuration/environment-variables/index.md) +Self-hosted users need to [enable AI features and provide their own API keys](/hosting/configuration/environment-variables.md) @@ -2874,7 +2874,7 @@ This release includes a new version of the [OpenAI node](/integrations/builtin/a Other highlights: * Support for AI events in [log streaming](/log-streaming.md). -* Added support for workflow tags in the [public API](/api/index.md). +* Added support for workflow tags in the [public API](/api/overview.md). ### Contributors @@ -3687,7 +3687,7 @@ Read more: * This is a beta release, and not yet available in the main product. Follow the instructions in [Access LangChain in n8n](/advanced-ai/langchain/overview.md) to try it out. Self-hosted and Cloud options are available. * Learn how LangChain concepts map to n8n nodes in [LangChain concepts in n8n](/advanced-ai/langchain/langchain-n8n.md). -* Browse n8n's new [Cluster nodes](/integrations/builtin/cluster-nodes/index.md). This is a new set of node types that allows for multiple nodes to work together to configure each other. +* Browse n8n's new [Cluster nodes](/integrations/builtin/cluster-nodes/ai-nodes.md). This is a new set of node types that allows for multiple nodes to work together to configure each other. ## n8n@1.9.0 @@ -4117,7 +4117,7 @@ For full details, refer to the [n8n v1.0 migration guide](/1-0-migration-checkli #### Python support -Although JavaScript remains the default language, you can now also select Python as an option in the [Code node](/code/code-node.md) and even make use of [many Python modules](https://pyodide.org/en/stable/usage/packages-in-pyodide.html#packages-in-pyodide){:target=_blank .external link}. Note that Python is unavailable in Code nodes added to a workflow before v1.0. +Although JavaScript remains the default language, you can now also select Python as an option in the [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md) and even make use of [many Python modules](https://pyodide.org/en/stable/usage/packages-in-pyodide.html#packages-in-pyodide){:target=_blank .external link}. Note that Python is unavailable in Code nodes added to a workflow before v1.0. diff --git a/docs/release-notes/0-x.md b/docs/release-notes/0-x.md index d5e36bdb07a..0a447c142ab 100644 --- a/docs/release-notes/0-x.md +++ b/docs/release-notes/0-x.md @@ -1474,7 +1474,7 @@ This release contains enhancements to the Item Lists node, and bug fixes. ### New features -This release adds experimental support for more Prometheus metrics. Self-hosting users can configure Prometheus using [environment variables](/hosting/configuration/environment-variables/index.md). +This release adds experimental support for more Prometheus metrics. Self-hosting users can configure Prometheus using [environment variables](/hosting/configuration/environment-variables.md). ### Node enhancements @@ -2548,7 +2548,7 @@ Introducing improved support for item linking (paired items). Item linking is a #### Overhauled built-in variables -n8n's [built-in methods and variables](/code/index.md) have been overhauled, introducing new variables, and providing greater consistency in behavior and naming. +n8n's [built-in methods and variables](/code/builtin/overview.md) have been overhauled, introducing new variables, and providing greater consistency in behavior and naming. @@ -3427,7 +3427,7 @@ This release introduces the public API. #### The n8n public API -This release introduces the n8n public REST API. Using n8n's public API, you can programmatically perform many of the same tasks as you can in the GUI. The API includes a built-in Swagger UI playground. Refer to the [API documentation](/api/index.md){:target=_blank} for more information. +This release introduces the n8n public REST API. Using n8n's public API, you can programmatically perform many of the same tasks as you can in the GUI. The API includes a built-in Swagger UI playground. Refer to the [API documentation](/api/overview.md){:target=_blank} for more information. @@ -5973,7 +5973,7 @@ For a comprehensive list of changes, check out the [commits](https://github.com/ - Spotify: Added Create a Playlist operation to Playlist resource and Get New Releases to the Album resource - Bug fixes - Airtable: Fixed a bug with updating and deleting records -- Added the functionality to expose metrics to Prometheus. Read more about that [here](/hosting/configuration/environment-variables/index.md) +- Added the functionality to expose metrics to Prometheus. Read more about that [here](/hosting/configuration/environment-variables.md) - Updated fallback values to match the value type - Added the functionality to display debugging information for pending workflows on exit - Fixed an issue with queue mode for the executions that shouldn't be saved diff --git a/docs/source-control-environments/create-environments.md b/docs/source-control-environments/create-environments.md index db741df6052..af57163d51b 100644 --- a/docs/source-control-environments/create-environments.md +++ b/docs/source-control-environments/create-environments.md @@ -107,7 +107,7 @@ Your work is now in GitHub. If you're using a multi-branch setup, it's on the de ### Optional: Use a GitHub Action to automate pulls -If you want to avoid logging in to your production instance to pull, you can use a [GitHub Action](https://docs.github.com/en/actions/creating-actions/about-custom-actions){:target=_blank .external-link} and the [n8n API](/api/index.md) to automatically pull every time you push new work to your production or main branch. +If you want to avoid logging in to your production instance to pull, you can use a [GitHub Action](https://docs.github.com/en/actions/creating-actions/about-custom-actions){:target=_blank .external-link} and the [n8n API](/api/overview.md) to automatically pull every time you push new work to your production or main branch. --8<-- "_snippets/source-control-environments/github-action.md" diff --git a/docs/try-it-out/getn8n.md b/docs/try-it-out/getn8n.md new file mode 100644 index 00000000000..7d6edf6ac2f --- /dev/null +++ b/docs/try-it-out/getn8n.md @@ -0,0 +1,23 @@ +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +--- + +# Get n8n + +It couldn't be simpler to get started with n8n - we recommend you sign up for a free trial of [**n8n cloud**](https://www.n8n.io/), our cloud-hosted solution - it's a convenient, fast way to get started with everything you need to try out n8n and make some amazingly useful workflows with minimum effort. + +![Screenshot of n8n cloud](/_images/try-it-out/cloud.png){: style="height:250px"; border="0px"} + +**n8n Cloud** has the following advantages: + +- No technical set up or maintenance for your n8n instance +- Continual uptime monitoring +- Managed OAuth for authentication +- One-click upgrades to the newest n8n versions + +[Sign up for n8n Cloud here »](https://app.n8n.cloud/register){ .md-button } + +## Other options + +n8n is committed to providing a free-to-use **Community Edition** of n8n which you can self-host on your own equipment or public clouds. For more details of this or the other options available, see the [Choose your plan page](/choose-n8n.md). \ No newline at end of file diff --git a/docs/try-it-out/going-further.md b/docs/try-it-out/going-further.md new file mode 100644 index 00000000000..ea70fa8157e --- /dev/null +++ b/docs/try-it-out/going-further.md @@ -0,0 +1,56 @@ +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: A suggested learning path to get started with n8n through tutorials, courses, and step-by-step guides. +contentType: overview +--- +# Going further + +Now you've [got n8n running][] and built your [first workflow][], what's next? Here are some suggestions on how to continue your journey: + +## Join the community! + +n8n has an active community where you can get and offer help. Connect, share, and learn with other n8n users: + +- [Ask questions](https://community.n8n.io/t/readme-welcome-to-the-n8n-community/44381) and [make feature requests](https://community.n8n.io/c/feature-requests) in the Community Forum. +- [Report bugs](https://github.com/n8n-io/n8n/issues) and [contribute](https://github.com/n8n-io/n8n/blob/master/CONTRIBUTING.md) on GitHub. + +## Build from one of over 1500 templates + +Particularly when you're starting out, whatever you need an n8n workflow for has probably be done before. n8n templates are the distilled wisdom of our community, giving you the building blocks to experiment, tweak and tune your own workflows or quickly automate a common task. They're also a great way to learn. + +![Screenshot of n8n templates](/_images/try-it-out/templates.png){ align=right : style="height:250px"; border="0px"} + +[Browse or search the templates »](https://n8n.io/workflows/) + +When you open a template, you will be prompted to supply any required credentials the workflow needs, making it even easier to get up and running. Most templates also include helpful notes for customizing the workflow. + +## Follow our structured courses + +Everyone has a different learning style, so we've developed two sets of structured learning courses to follow: + +### Video courses + +Learn key concepts and n8n features, while building examples as you go. + +- The [Beginner](https://www.youtube.com/playlist?list=PLlET0GsrLUL59YbxstZE71WszP3pVnZfI){:target=_blank .external-link} course covers the basics of n8n. +- The [Advanced](https://www.youtube.com/playlist?list=PLlET0GsrLUL5bxmx5c1H1Ms_OtOPYZIEG){:target=_blank .external-link} course covers more complex workflows, more technical nodes, and enterprise features + + + + +### Text courses + +Build more complex workflows while learning key concepts along the way. Earn a badge and an avatar in your community profile. + +- [Level 1: Beginner Course](/courses/level-one/index.md) +- [Level 2: Intermediate Course](/courses/level-two/index.md) + +## Keep up to date + +- Follow new features and bug fixes in the [Release Notes](/release-notes.md) +- Follow n8n online: [Twitter/X](https://twitter.com/n8n_io), [Discord](https://discord.com/invite/vWwMVThRta), [LinkedIn](https://www.linkedin.com/company/n8n/), [YouTube](https://www.youtube.com/@n8n-io) + + + +[got n8n running]: /try-it-out/getn8n.md +[first workflow]: /try-it-out/tutorial-first-workflow.md diff --git a/docs/try-it-out/index.md b/docs/try-it-out/index.md deleted file mode 100644 index ee53150a179..00000000000 --- a/docs/try-it-out/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 -description: The n8n quickstarts. -contentType: overview ---- - -# Try it out - -The best way to learn n8n is by using our tutorials to get familiar with the user interface and the many different types of nodes and integrations available. Here is a selection of material to get you started: - -- Looking for a quick introduction? Check out the ["First Workflow" tutorial](/try-it-out/tutorial-first-workflow.md). -- Interested in what you could do with AI? Find out [how to build an AI chat agent with n8n](/advanced-ai/intro-tutorial.md). -- Prefer to work through extensive examples? Maybe the [courses](/courses/index.md) are for you. diff --git a/docs/try-it-out/quickstart.md b/docs/try-it-out/quickstart.md deleted file mode 100644 index f10820f83e1..00000000000 --- a/docs/try-it-out/quickstart.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 -description: A quick example to try out n8n. -contentType: tutorial ---- - -# The very quick quickstart - -This quickstart gets you started using n8n as quickly as possible. Its allows you to try out the UI and introduces two key features: [workflow templates](/glossary.md#template-n8n) and [expressions](/glossary.md#expression-n8n). It doesn't include detailed explanations or explore concepts in-depth. - -In this tutorial, you will: - -* Load a [workflow](/glossary.md#workflow-n8n) from the workflow templates library -* Add a node and configure it using expressions -* Run your first workflow - -## Step one: Sign up for n8n - -This quickstart uses [n8n Cloud](/manage-cloud/overview.md). A free trial is available for new users. If you haven't already done so, [sign up](https://app.n8n.cloud/register) for an account now. - -## Step two: Open a workflow template - -n8n provides a quickstart template using training nodes. You can use this to work with fake data and avoid setting up [credentials](/glossary.md#credential-n8n). - -1. Go to [Templates | Very quick quickstart](https://n8n.io/workflows/1700-very-quick-quickstart/). -1. Select **Use workflow** to view the options for using the template. -1. Select **Import template to cloud workspace** to load the template into your Cloud instance. - -This workflow: - -1. Gets example data from the [Customer Datastore](/integrations/builtin/app-nodes/n8n-nodes-base.n8ntrainingcustomerdatastore.md) node. -2. Uses the [Edit Fields](/integrations/builtin/core-nodes/n8n-nodes-base.set.md) node to extract only the desired data and assigns that data to variables. In this example, you map the customer name, ID, and description. - -The individual pieces in an n8n workflow are called [nodes](/glossary.md#node-n8n). Double click a node to explore its settings and how it processes data. - -## Step three: Run the workflow - -Select **Test Workflow**. This runs the workflow, loading the data from the Customer Datastore node, then transforming it with Edit Fields. You need this data available in the workflow so that you can work with it in the next step. - -## Step four: Add a node - -Add a third node to message each customer and tell them their description. Use the Customer Messenger node to send a message to fake recipients. - -1. Select the **Add node** ![Add node icon](/_images/try-it-out/add-node-small.png){.off-glb} connector on the Edit Fields node. -2. Search for **Customer Messenger**. n8n shows a list of nodes that match the search. -3. Select **Customer Messenger (n8n training)** to add the node to the [canvas](/glossary.md#canvas-n8n). n8n opens the node automatically. -4. Use [expressions](/code/expressions.md) to map in the **Customer ID** and create the **Message**: - 1. In the **INPUT** panel select the **Schema** tab. - 2. Drag **Edit Fields1** > **customer_id** into the **Customer ID** field in the node settings. - 2. Hover over **Message**. Select the **Expression** tab, then select the expand button ![Add node icon](/_images/common-icons/open-expression-editor.png){.off-glb} to open the full expressions editor. - 3. Copy this expression into the editor: - ``` - Hi {{ $json.customer_name }}. Your description is: {{ $json.customer_description }} - ``` -5. Close the expressions editor, then close the **Customer Messenger** node by clicking outside the node or selecting **Back to canvas**. -6. Select **Test Workflow**. n8n runs the workflow. - -The complete workflow should look like this: - -[[ workflowDemo("file:///try-it-out/quickstart/very-quick-quickstart-workflow.json") ]] - - -## Next steps - -* Read n8n's [longer try it out tutorial](/try-it-out/tutorial-first-workflow.md) for a more complex workflow, and an introduction to more features and n8n concepts. -* Take the [text courses](/courses/index.md) or [video courses](/video-courses.md). - - diff --git a/docs/try-it-out/tutorial-first-workflow.md b/docs/try-it-out/tutorial-first-workflow.md index 7be2964d7ca..df6de218f73 100644 --- a/docs/try-it-out/tutorial-first-workflow.md +++ b/docs/try-it-out/tutorial-first-workflow.md @@ -18,7 +18,7 @@ This guide will show you how to construct a [workflow](/glossary.md#workflow-n8n !["Screenshot of the completed workflow"](/_images/try-it-out/tutorial-first.png) -This quickstart uses [n8n Cloud](/manage-cloud/overview.md), which is recommended for new users. A free trial is available - if you haven't already done so, [sign up](https://app.n8n.cloud/register) for an account now. +This quickstart uses [n8n Cloud](/manage-cloud/index.md), which is recommended for new users. A free trial is available - if you haven't already done so, [sign up](https://app.n8n.cloud/register) for an account now. ## Step one: Create a new workflow @@ -120,7 +120,7 @@ The last step of the workflow is to send the two reports about solar flares. For 1. Copy the bin ID. It looks similar to `1651063625300-2016451240051`. 1. In n8n, paste your Postbin ID into **Bin ID**. 1. Now, configure the data to send to Postbin. Next to **Bin Content**, select the **Expression** tab (you will need to mouse-over the **Bin Content** for the tab to appear), then select the expand button ![Add node icon](/_images/common-icons/open-expression-editor.png){.off-glb} to open the full expressions editor. -1. You can now click and drag the correct field from the If Node output into the expressions editor to automatically create a reference for this label. In this case the input we want is 'classType'. +1. You can now click and drag the correct field from the If Node output into the expressions editor to automatically create a reference for this label. In this case the input we want is `classType`. 1. Once dropped into the expressions editor it will transform into this reference: `{{$json["classType"]}}`. Add a message to it, so that the full expression is: ```js @@ -164,5 +164,5 @@ There are plenty of things you could add to this (perhaps add some more credenti ## Next steps - Interested in what you could do with AI? Find out [how to build an AI chat agent with n8n](/advanced-ai/intro-tutorial.md). -- Take n8n's [text courses](/courses/index.md) or [video courses](/video-courses.md). +- Take n8n's [tutorials](/tutorials/index.md) or [video courses](/video-courses.md). - Explore more examples in [workflow templates](https://n8n.io/workflows/){:target=_blank .external-link}. diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md new file mode 100644 index 00000000000..cd8d22bdfb9 --- /dev/null +++ b/docs/tutorials/index.md @@ -0,0 +1,12 @@ +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: n8n tutorials and courses +description: Guided examples and structured courses help you learn how to create n8n workflow automations +contentType: overview +--- + +# Tutorials and courses + +The Tutorials and Structured Courses section is designed to help users of all skill levels learn more about n8n, from beginners taking their first steps in automation to advanced users looking to build more complex, scalable workflows. Tutorials provide guided examples for real-world automation scenarios, helping users understand how to use n8n’s nodes, integrations, and features effectively. Each tutorial focuses on demonstrating and explaining aspects of n8n and imparting practical experience that can be applied immediately. + +The structured courses offer a more in-depth learning path, guiding users through progressively advanced topics in a logical sequence. These courses cover everything from setting up n8n and building basic workflows to deploying self-hosted instances, working with APIs, and implementing advanced logic within automations. Whether you prefer to follow bite-sized tutorials or engage in a full learning journey, this section provides the knowledge and resources needed to become proficient in n8n and leverage automation effectively in your projects or business. diff --git a/docs/tutorials/tutorial-first-workflow.md b/docs/tutorials/tutorial-first-workflow.md new file mode 100644 index 00000000000..b92010c91d0 --- /dev/null +++ b/docs/tutorials/tutorial-first-workflow.md @@ -0,0 +1,168 @@ +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Create your first workflow in n8n and learn some key concepts. +contentType: tutorial +--- + +# Your first workflow + +This guide will show you how to construct a [workflow](/glossary.md#workflow-n8n) in n8n, explaining key concepts along the way. You will: + +* Create a workflow from scratch. +* Understand key concepts and skills, including: + * Starting workflows with trigger nodes + * Configuring [credentials](/glossary.md#credential-n8n) + * Processing data + * Representing logic in an n8n workflow + * Using [expressions](/glossary.md#expression-n8n) + +!["Screenshot of the completed workflow"](/_images/try-it-out/tutorial-first.png) + +This quickstart uses [n8n Cloud](/manage-cloud/index.md), which is recommended for new users. A free trial is available - if you haven't already done so, [sign up](https://app.n8n.cloud/register) for an account now. + +## Step one: Create a new workflow + +When you open n8n, you'll see either: + +* A window with a welcome message and two large buttons: Choose "Start from Scratch" to create a new workflow. +* The **Workflows** list on the **Overview** page. Select the ![universal create resource icon](/_images/common-icons/universal-resource-button.png){.off-glb} **button** to create a new workflow. + +## Step two: Add a trigger node + +n8n provides two ways to start a workflow: + +* Manually, by selecting **Test Workflow**. +* Automatically, using a trigger node as the first node. The trigger node runs the workflow in response to an external event, or based on your settings. + +For this tutorial, we'll use the [Schedule trigger](/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/index.md). This allows you to run the workflow on a schedule: + +1. Select **Add first step**. +1. Search for **Schedule**. n8n shows a list of nodes that match the search. +1. Select **Schedule Trigger** to add the node to the canvas. n8n opens the node. +1. For **Trigger Interval**, select **Weeks**. +1. For **Weeks Between Triggers**, enter `1`. +1. Enter a time and day. For this example, select **Monday** in **Trigger on Weekdays**, select **9am** in **Trigger at Hour**, and enter `0` in **Trigger at Minute**. +1. Close the node details view to return to the canvas. + +## Step three: Add the NASA node and set up credentials + +The [NASA node](/integrations/builtin/app-nodes/n8n-nodes-base.nasa.md) interacts with NASA's [public APIs](https://api.nasa.gov/){:target=_blank .external-link} to fetch useful data. We will use the real-time data from the API to find solar events. + +??? explanation "Credentials" + Credentials are private pieces of information issued by apps and services to authenticate you as a user and allow you to connect and share information between the app or service and the n8n node. The type of information required varies depending on the app/service concerned. You should be careful about sharing or revealing the credentials outside of n8n. + +1. Select the **Add node** ![Add node icon](/_images/try-it-out/add-node-small.png){.off-glb} connector on the Schedule Trigger node. +1. Search for **NASA**. n8n shows a list of nodes that match the search. +1. Select **NASA** to view a list of operations. +1. Search for and select **Get a DONKI solar flare**. This operation returns a report about recent solar flares. When you select the operation, n8n adds the node to the canvas and opens it. +1. To access the NASA APIs, you need to set up credentials: + 1. Select the **Credential for NASA API** dropdown. + 1. Select **- Create New -**. n8n opens the credentials view. + 1. Go to [NASA APIs](https://api.nasa.gov/){:target=_blank .external-link} and fill out the form from the **Generate API Key** link. The NASA site generates the key and emails it to the address you entered. + 1. Check your email account for the API key. Copy the key, and paste it into **API Key** in n8n. + 1. Select **Save**. + 1. Close the credentials screen. n8n returns to the node. The new credentials should be automatically selected in **Credential for NASA API**. + +1. By default, DONKI Solar Flare provides data for the past 30 days. To limit it to just the last week, use **Additional Fields**: + 1. Select **Add field**. + 1. Select **Start date**. + 1. To get a report starting from a week ago, you can use an expression: next to **Start date**, select the **Expression** tab, then select the expand button ![Add node icon](/_images/common-icons/open-expression-editor.png){.off-glb} to open the full expressions editor. + 1. In the **Expression** field, enter the following expression: + ```js + {{ $today.minus(7, 'days') }} + ``` + This generates a date in the correct format, seven days before the current date. + + ![image showing the expression above generating a date](/_images/try-it-out/tutorial-date.png) + + ??? explanation "Date and time formats in n8n..." + n8n uses Luxon to work with date and time, and also provides two variables for convenience: `$now` and `$today`. For more information, refer to [Expressions > Luxon](/code/cookbook/luxon.md). + +1. Close the **Edit Expression** modal to return to the NASA node. +1. You can now check that the node is working and returning the expected date: select **Test step** to run the node manually. n8n calls the NASA API and displays details of solar flares in the past seven days in the **OUTPUT** section. +1. Close the NASA node to return to the workflow canvas. + +## Step four: Add logic with the If node + +n8n supports complex logic in workflows. In this tutorial we will use the [If node](/integrations/builtin/core-nodes/n8n-nodes-base.if.md) to create two branches that each generate a report from the NASA data. Solar flares have five possible classifications; we will add logic that sends a report with the lower classifications to one output, and the higher classifications to another. + +Add the If node: + +1. Select the **Add node** ![Add node icon](/_images/try-it-out/add-node-small.png){.off-glb} connector on the NASA node. +1. Search for **If**. n8n shows a list of nodes that match the search. +1. Select **If** to add the node to the canvas. n8n opens the node. +1. You need to check the value of the `classType` property in the NASA data. To do this: + 1. Drag `classType` into **Value 1**. + + /// note | Make sure you ran the NASA node in the previous section + If you didn't follow the step in the previous section to run the NASA node, you won't see any data to work with in this step. + /// + + 1. Change the comparison operation to **String > Contains**. + 1. In **Value 2**, enter **X**. This is the highest classification of solar flare. In the next step, you will create two reports: one for X class solar flares, and one for all the smaller solar flares. +1. You can now check that the node is working and returning the expected date: select **Test step** to run the node manually. n8n tests the data against the condition, and shows which results match true or false in the **OUTPUT** panel. + + /// note | Weeks without large solar flares + In this tutorial, you are working with live data. If you find there aren't any X class solar flares when you run the workflow, try replacing **X** in **Value 2** with either **A**, **B**, **C**, or **M**. + /// + +1. Once you are happy the node will return some events, you can close the node to return to the canvas. + +## Step five: Output data from your workflow + +The last step of the workflow is to send the two reports about solar flares. For this example, you'll send data to [Postbin](https://www.toptal.com/developers/postbin/){:target=_blank .external-link}. Postbin is a service that receives data and displays it on a temporary web page. + +1. On the If node, select the **Add node** ![Add node icon](/_images/try-it-out/add-node-small.png){.off-glb} connector labeled **true**. +1. Search for **PostBin**. n8n shows a list of nodes that match the search. +1. Select **PostBin**. +1. Select **Send a request**. n8n adds the node to the canvas and opens it. +1. Go to [Postbin](https://www.toptal.com/developers/postbin/){:target=_blank .external-link} and select **Create Bin**. Leave the tab open so you can come back to it when testing the workflow. +1. Copy the bin ID. It looks similar to `1651063625300-2016451240051`. +1. In n8n, paste your Postbin ID into **Bin ID**. +1. Now, configure the data to send to Postbin. Next to **Bin Content**, select the **Expression** tab (you will need to mouse-over the **Bin Content** for the tab to appear), then select the expand button ![Add node icon](/_images/common-icons/open-expression-editor.png){.off-glb} to open the full expressions editor. +1. You can now click and drag the correct field from the If Node output into the expressions editor to automatically create a reference for this label. In this case the input we want is `classType`. +1. Once dropped into the expressions editor it will transform into this reference: `{{$json["classType"]}}`. Add a message to it, so that the full expression is: + + ```js + There was a solar flare of class {{$json["classType"]}} + ``` + + ![image showing the expression above generating output](/_images/try-it-out/tutorial-expression.png) + +1. Close the expressions editor to return to the node. +1. Close the Postbin node to return to the canvas. +1. Add another Postbin node, to handle the **false** output path from the If node: + 1. Hover over the Postbin node, then select **Node context menu** ![Node context menu icon](/_images/common-icons/node-context-menu.png){.off-glb} > **Duplicate node** to duplicate the first Postbin node. + 1. Drag the **false** connector from the If node to the left side of the new Postbin node. + +## Step six: Test the workflow + +1. You can now test the entire workflow. Select **Test Workflow**. n8n runs the workflow, showing each stage in progress. +1. Go back to your Postbin bin. Refresh the page to see the output. +1. If you want to use this workflow (in other words, if you want it to run once a week automatically), you need to activate it by selecting the **Active** toggle. + +/// note | Time limit +Postbin's bins exist for 30 minutes after creation. You may need to create a new bin and update the ID in the Postbin nodes, if you exceed this time limit. +/// + + +## Congratulations + +You now have a fully functioning workflow that does something useful! It should look something like this: + +[[ workflowDemo("file:///try-it-out/quickstart/tutorial.json") ]] + +Along the way you have discovered: + +- How to find the nodes you want and join them together +- How to use expressions to manipulate data +- How to create credentials and attach them to nodes +- How to use logic in your workflows + +There are plenty of things you could add to this (perhaps add some more credentials and a node to send you an email of the results), or maybe you have a specific project in mind. Whatever your next steps, the resources linked below should help. + +## Next steps + +- Interested in what you could do with AI? Find out [how to build an AI chat agent with n8n](/advanced-ai/intro-tutorial.md). +- Take n8n's [tutorials](/tutorials/index.md) or [video courses](/video-courses.md). +- Explore more examples in [workflow templates](https://n8n.io/workflows/){:target=_blank .external-link}. diff --git a/docs/understanding/credentials.md b/docs/understanding/credentials.md new file mode 100644 index 00000000000..81b13bf0bf8 --- /dev/null +++ b/docs/understanding/credentials.md @@ -0,0 +1,21 @@ +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: "Credentials" +description: n8n credentials explanation. +contentType: overview +--- + +An n8n credential is a secure way to store authentication details needed to connect to external services. Instead of entering authentication details directly inside the workflow, users create and manage credentials separately, attaching them to the relevant nodes as needed. This improves security, reusability, and maintainability, as the created credentials can be used across multiple workflows. + +## Types of Credential + +The specifics of each credential depend on the service being authenticated to. Some common types are: + +- Basic Authentication: Uses a username and password to authenticate requests. +- API Key: Used when a service requires an API key for access. +- OAuth: Common for services like Google, Slack, and GitHub, where users authenticate via OAuth and n8n stores the access token. +- Header Auth: For some APIs and webhooks, authentication uses similar tokens but formatted into request headers. + +Credentials are managed in the n8n credential manager, where they can be added, edited, or deleted without modifying workflows. This approach improves security by keeping sensitive data encrypted and separate from workflow logic, making automation more scalable and secure. + +For more on how to use and manage credentials in n8n, see the [Using n8n documentation](/credentials/index.md). diff --git a/docs/understanding/executions.md b/docs/understanding/executions.md new file mode 100644 index 00000000000..dc12b15c4f6 --- /dev/null +++ b/docs/understanding/executions.md @@ -0,0 +1,143 @@ +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: "Executions" +description: n8n executions explanation. +contentType: explanation +--- + +# Executions + +In n8n, the term "execution" refers to the process of carrying out the instructions in a workflow. Executions can be triggered manually, by a schedule, via incoming webhooks, or through other internal and external events. n8n maintains a full record of node inputs, outputs, and any errors encountered, which can be viewed in the execution history for debugging or auditing. + +## Production executions + - Triggers + +## Manual Executions + +Instead of being triggered by an external event (like a webhook, schedule, or application node), a manual execution occurs when a user selects “Test Workflow” while editing in the [canvas](/glossary/#canvas-n8n){ data-preview }, and the workflow runs using either predefined test data or real inputs configured in the nodes. + +Manual executions are an essential part of creating, editing, testing and debugging workflows. + +### Partial executions + +Partial executions are manual executions that only run a subset of your workflow nodes. Running only part of the workflow has a number of advantages when actively editing or troubleshooting: + +**Faster Debugging**: You don’t need to re-run the entire workflow from the beginning. You can test just the section you're working on, saving time. + +**Retaining outputs**: You can reuse previous node outputs or test with a known input, reducing variability and focusing on the logic you’re debugging. + +**Avoid repeating unwanted actions**: For example, sending messages, accessing external websites. + +To perform a partial execution, either select the 'test step' icon above the node or open its detail view, and select 'Test step'. This executes the specific node and any preceding nodes required to fill in its input data. You can also temporarily deactivate specific nodes in the workflow chain to avoid interacting with those services while building. +
+ !["image showing a test step icon"](/_images/workflows/executions/partial-test.png){ width="400" } +
Start a partial execution direct from the canvas.
+
+During a partial execution, n8n follows the path from the initial trigger and moves forward along the path of nodes until it finds one which is either un-executed, has an error, or is labeled as dirty (see [next section](#dirty-nodes)). The workflow execution is then started from that node using existing data. + +For errors encountered when running partial executions, see the [troubleshooting section](#resolving-manual-execution-errors). + +### Dirty nodes + +A 'dirty' node is simply one which has executed successfully in the past, but the resulting output is considered stale or unreliable. It is labeled in this way for information purposes, since if the node were executed again, the output may be different. It is also potentially the point at which a [partial execution](#partial-executions) starts from. + +#### How to recognize 'dirty' node data + +In the canvas of the workflow editor, dirty notes can be identified by a different-colored border and a yellow triangle where previously it had a green 'tick' symbol. For example: + +!["Image of node displayed with yellow border"](/_images/workflows/executions/dirty-node-canvas.png) + +In the node editor view, the output panel will also display the yellow triangle on the output panel. Hovering the mouse over the triangle will show a tooltip with more explanation about why the data is considered stale. + +!["Image of node displayed with yellow border"](/_images/workflows/executions/dirty-node-editor.png) + +#### How does a node get to be 'dirty'? + +There are a number of ways that execution data can be flagged as stale, depending on changes you have made. For example: + +- Inserting or deleting a node: labels the first node that follows the inserted node. +- Modifying node parameters: labels the node being modified. +- Adding a connector: labels the destination node of the new connector. +- Deactivating a node: labels the first node that follows the deactivated node. + +??? explanation "List of other ways a node can become dirty..." + - Unpinning a node: labels the node that was unpinned. + - Modifying pinned data: labels the node that comes after the pinned data. + - If any of the above actions occur inside a loop, also labels the first node of the loop. + + For sub-nodes, also label any executed parent nodes (up to and including the root) when: + + - Editing an executed sub-node + - Adding a new sub-node + - Disconnecting or deleting a sub-node + - Deactivating a sub-node + - Activating a sub-node + +
+ +- When deleting a node connected in a workflow... + + !["Image of node displayed with yellow border"](/_images/workflows/executions/dirty-before.png) + +- ...the next node in the sequence becomes dirty + + !["Image of node displayed with yellow border"](/_images/workflows/executions/dirty-after.png) + +
+ +In the case of a loop (using the [Loop over Items][] node), when any node within the loop is dirty, the initial node of the loop is also considered dirty: + +!["Image of node displayed with yellow border"](/_images/workflows/executions/dirty-loop.png) + +#### Resolving dirty nodes + +The 'dirty' status of a node can be cleared by executing the node again. This can be done by manually triggering the whole workflow, or by running a partial execution (as described in the [preceding section](#partial-executions)) by running 'test step' on the individual node or any node which follows it. + + +## Execution Flow + - Execution order + - Logic and branching + - Loops + - Sub-workflows + +## Execution logs +### Execution history +### Execution Status and Lifecycle + - Queued + - Running + - Completed + - Failed + - Canceled +### Inspecting node data +### Debugging failures + +## Queuing executions + - Execution modes + - Workers + - Execution timeout and retries + +## Best Practices + - Design tips + - Performance + +## Troubleshooting executions +### Interpreting stack traces +### Monitoring and alerts +### Common issues + +#### Resolving manual execution errors + +Error messages for a workflow are displayed in the bottom right corner of the editor window. + +??? "Connect a trigger to run this node" + This error message appears when you try to perform a partial execution without connecting the workflow to a trigger. Manual executions use the same execution logic as production executions when possible. Part of this includes requiring a trigger node to determine from what point the workflow logic should execute. + +??? "Please execute the whole workflow, rather than just the node. (Existing execution data is too large.)" + This error can appear when performing partial executions on workflows with large numbers of branches. Partial executions involve sending data and workflow logic to the n8n backend in a way that isn't required for full executions. This error occurs when your workflow exceeds the maximum size allowed for these messages. + To work around this, consider using the [limit node][] to limit node output while running partial executions. Once the workflow is running as intended, you can deactivate or delete the limit node before re-activating production execution. + + + +[Loop over Items]: /integrations/builtin/core-nodes/n8n-nodes-base.splitinbatches.md +[pinning data]: /data/data-pinning.md +[limit node]: /integrations/builtin/core-nodes/n8n-nodes-base.limit.md \ No newline at end of file diff --git a/docs/understanding/index.md b/docs/understanding/index.md new file mode 100644 index 00000000000..90e808077cd --- /dev/null +++ b/docs/understanding/index.md @@ -0,0 +1,9 @@ +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: "Understanding n8n" +description: A deeper dive into how n8n works. +contentType: overview +--- + +This section of the documentation covers the key concepts of n8n, as well as some deeper discussion on how it operates. If you have a specific goal, the [using n8n section](/using-n8n/index.md) has goal-oriented guides which will quickly take you through steps to achieve them. +The explanation section is for a deeper understanding of the hows and whys of n8n. diff --git a/docs/understanding/nodes.md b/docs/understanding/nodes.md new file mode 100644 index 00000000000..cf0f5c4bd26 --- /dev/null +++ b/docs/understanding/nodes.md @@ -0,0 +1,7 @@ +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: "nodes" +description: n8n nodes explanation. +contentType: overview +--- + diff --git a/docs/understanding/self-hosting.md b/docs/understanding/self-hosting.md new file mode 100644 index 00000000000..29fe57fc782 --- /dev/null +++ b/docs/understanding/self-hosting.md @@ -0,0 +1,13 @@ +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: "Self-hosted n8n" +description: Why might you want to run n8n on your own servers? +contentType: explanation +--- + +Self-hosting is an option for users using the community edition license or enterprise customers of n8n. For this set-up, the user needs to provide the resources for n8n to run - a computer, either as a physical device on a network or a remote instance in a public cloud. + +This actually enables a lot of flexibility in terms of how your run n8n and what you use it for. For community edition users it enables a degree of flexibility not available on the cloud-hosted version, and of course as you are using your own resources rather than paying for a hosted account so there could be a cost saving. +For enterprise users the advantages are more direct control over how n8n is run, how it's secured and what resources it has access to. + +There are also some caveats though. Self-hosting n8n is only really recommended for people who have the skills, knowledge and experience of running web-based services. Although n8n is actually quite easy to install on your laptop, a home server or a cloud instance, it will be up to the user to configure, maintain and manage the resources that n8n uses. We do have plenty of guides and material to help though. Check out the [install documentation](/hosting/installation/docker.md) for how to get started. diff --git a/docs/understanding/workflows.md b/docs/understanding/workflows.md new file mode 100644 index 00000000000..c533b037c51 --- /dev/null +++ b/docs/understanding/workflows.md @@ -0,0 +1,18 @@ +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: "workflows" +description: n8n workflows explanation. +contentType: explanation +--- + +In n8n, a workflow is simply a sequence of steps, each of which represents some operation which fetches, stores, evaluates or processes data. These steps are represented by n8n **nodes**, which can represent various operations like retrieving information from services, manipulating data, or sending notifications. + +!["Screenshot of the completed workflow"](/_images/try-it-out/tutorial-first.png) + +For guides on how to create, manage, share and use workflows, please see the [using n8n documentation](/workflows/index.md). + +## More about workflows + +This section explains in a little more detail the different elements and operations of a workflow + +When you [create a new workflow], the first thing you need to decide is what is going to activate it. All workflows require a node from which they start. In n8n this is known as a "trigger node". This is a special node (it even has a distinguishing icon '⚡︎' and a slightly different shape) which acts as the starting point for the workflow. Every workflow diff --git a/docs/user-management/best-practices.md b/docs/user-management/best-practices.md index 0498c1170b9..86806980850 100644 --- a/docs/user-management/best-practices.md +++ b/docs/user-management/best-practices.md @@ -26,5 +26,5 @@ If you run n8n behind a reverse proxy, set the following environment variables s * `N8N_PROTOCOL` * `N8N_EDITOR_BASE_URL` -More information on these variables is available in [Environment variables](/hosting/configuration/environment-variables/index.md). +More information on these variables is available in [Environment variables](/hosting/configuration/environment-variables.md). diff --git a/docs/user-management/saml/okta.md b/docs/user-management/saml/okta.md index 17c1b5eccc5..0764122332e 100644 --- a/docs/user-management/saml/okta.md +++ b/docs/user-management/saml/okta.md @@ -5,7 +5,7 @@ description: Use Okta Workforce Identity with n8n. contentType: tutorial --- -# Okta Workforce Identity SAML setup +# Set up SAML with Okta Workforce Identity Set up SAML SSO in n8n with Okta. @@ -38,10 +38,10 @@ Read the [Set up SAML](/user-management/saml/setup.md) guide first. | **Name** | **Name format** | **Value** | | -------- | --------------- | --------- | - | http://schemas.xmlsoap.org/ws/2005/05/identity/claims/firstname | URI Reference | user.firstName | - | http://schemas.xmlsoap.org/ws/2005/05/identity/claims/lastname | URI Reference | user.lastName | - | http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn | URI Reference | user.login | - | http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress | URI Reference | user.email | + | `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/firstname` | URI Reference | user.firstName | + | `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/lastname` | URI Reference | user.lastName | + | `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn` | URI Reference | user.login | + | `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` | URI Reference | user.email | 1. Select **Next**. Okta may prompt you to complete a marketing form, or may take you directly to your new n8n Okta app. 1. Assign the n8n app to people: diff --git a/docs/using-n8n/index.md b/docs/using-n8n/index.md new file mode 100644 index 00000000000..df1ad79610a --- /dev/null +++ b/docs/using-n8n/index.md @@ -0,0 +1,10 @@ +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +--- + +# Using n8n + +This section contains step-by-step instructions for common tasks and operations in n8n. This includes configuring n8n instances, using workflows, nodes, and credentials, working with data and expressions, and more. + +Many of the topics in this section link to supporting material in the [understanding n8n](/understanding/index.md) and [reference](/reference/index.md) sections. Check out those resources for more context around the features used, and for details about specific parameters and options. diff --git a/docs/workflows/components/nodes.md b/docs/workflows/components/nodes.md index 42e47317bce..834d3c2b74f 100644 --- a/docs/workflows/components/nodes.md +++ b/docs/workflows/components/nodes.md @@ -4,7 +4,7 @@ description: A node is an entry point for retrieving data, a function to process contentType: howto --- -# Nodes +# Manage nodes [Nodes](/glossary.md#node-n8n) are the key building blocks of a [workflow](/glossary.md#workflow-n8n). They perform a range of actions, including: diff --git a/docs/workflows/create.md b/docs/workflows/create.md index 0fb3b1fa711..e7730f80524 100644 --- a/docs/workflows/create.md +++ b/docs/workflows/create.md @@ -20,7 +20,7 @@ Or: 2. If you're doing this from the **Overview** page, you'll create the workflow inside your personal space. If you're doing this from inside a project, you'll create the workflow inside that specific project. 3. Get started by adding a trigger node: select **Add first step...** -If it's your first time building a workflow, you may want to use the [quickstart guides](/try-it-out/index.md) to quickly try out n8n features. +If it's your first time building a workflow, you may want to use the [tutorial](/try-it-out/tutorial-first-workflow.md) to quickly try out n8n features. ## Run workflows manually diff --git a/docs/workflows/executions/manual-partial-and-production-executions.md b/docs/workflows/executions/manual-partial-and-production-executions.md index 2058277634e..2212618c515 100644 --- a/docs/workflows/executions/manual-partial-and-production-executions.md +++ b/docs/workflows/executions/manual-partial-and-production-executions.md @@ -11,7 +11,7 @@ There are some important differences in how n8n executes workflows manually (by ## Manual executions -Manual executions allow you to run workflows directly from the [canvas](/glossary.md#canvas-n8n) to test your workflow logic. These executions are "ad-hoc" — they run only when you manually select the **Test workflow** button. +Manual executions allow you to run workflows directly from the [canvas](/glossary.md#canvas-n8n) to test your workflow logic. These executions are "ad-hoc"—they run only when you manually select the **Test workflow** button. Manual executions make building workflows easier by allowing you to iteratively test as you go, following the flow logic and seeing data transformations. You can test conditional branching, data formatting changes, and loop behavior by providing different input items and modifying node options. diff --git a/docs/workflows/index.md b/docs/workflows/index.md index e3d9245566d..5d5cad37cd9 100644 --- a/docs/workflows/index.md +++ b/docs/workflows/index.md @@ -11,8 +11,7 @@ A [workflow](/glossary.md#workflow-n8n) is a collection of nodes connected toget * [Create](/workflows/create.md) a workflow. * Use [Workflow templates](/workflows/templates.md) to help you get started. -* Learn about the key [components](/workflows/components/index.md) of an automation in n8n. * Debug using the [Executions](/workflows/executions/index.md) list. * [Share](/workflows/sharing.md) workflows between users. -If it's your first time building a workflow, you may want to use the [quickstart guides](/try-it-out/index.md) to quickly try out n8n features. +If it's your first time building a workflow, you may want to use the [tutorial](/try-it-out/tutorial-first-workflow.md) to quickly try out n8n features. diff --git a/docs/workflows/tags.md b/docs/workflows/tags.md index b33c8664884..485c8e8ffd7 100644 --- a/docs/workflows/tags.md +++ b/docs/workflows/tags.md @@ -37,6 +37,8 @@ You can edit existing tags. Instance owners can delete tags. 2. Hover over the tag you want to change. 3. Select **Edit** ![Add node icon](/_images/common-icons/edit.png){.off-glb} to rename it, or **Delete** ![Add node icon](/_images/common-icons/delete.png){.off-glb} to delete it. + /// warning | Global tags Tags are global. If you edit or delete a tag, this affects all users of your n8n instance. /// + diff --git a/lychee.toml b/lychee.toml index 149ab957212..2a9d959f568 100644 --- a/lychee.toml +++ b/lychee.toml @@ -121,6 +121,7 @@ exclude = [ '^https://support\.onfleet\.com/hc/en-us/.*', '^https://help\.shopify\.com/.*', '^https://www\.goto\.com/.*', + '^https://(developer|docs)\.rocket\.chat/.*', # Added to avoid too many CDN redirects ] # Exclude these filesystem paths from getting checked. diff --git a/nav.yml b/nav.yml index efd974b39b6..0119a1e6fbf 100644 --- a/nav.yml +++ b/nav.yml @@ -1,80 +1,87 @@ nav: - - Using n8n: + - Getting started: - Welcome: index.md - - Getting started: - - Learning path: learning-path.md - - Choose your n8n: choose-n8n.md - - Quickstarts: - - try-it-out/index.md - - A very quick quickstart: try-it-out/quickstart.md - - A longer introduction: try-it-out/tutorial-first-workflow.md - - Video courses: video-courses.md - - Text courses: - - courses/index.md - - Level one: - - courses/level-one/index.md - - Navigating the editor UI: courses/level-one/chapter-1.md - - Building a mini-workflow: courses/level-one/chapter-2.md - - Automating a (real-world) use case: courses/level-one/chapter-3.md - - Designing the workflow: courses/level-one/chapter-4.md - - Building the workflow: - - Getting data from the data warehouse: courses/level-one/chapter-5/chapter-5.1.md - - Inserting data into airtable: courses/level-one/chapter-5/chapter-5.2.md - - Filtering orders: courses/level-one/chapter-5/chapter-5.3.md - - Setting values for processing orders: courses/level-one/chapter-5/chapter-5.4.md - - Calculating booked orders: courses/level-one/chapter-5/chapter-5.5.md - - Notifying the team: courses/level-one/chapter-5/chapter-5.6.md - - Scheduling the workflow: courses/level-one/chapter-5/chapter-5.7.md - - Activating and examining the workflow: courses/level-one/chapter-5/chapter-5.8.md - - Exporting and importing workflows: courses/level-one/chapter-6.md - - Test your knowledge: courses/level-one/chapter-7.md - - Level two: - - courses/level-two/index.md - - Understanding the data structure: courses/level-two/chapter-1.md - - Processing different data types: courses/level-two/chapter-2.md - - Merging and splitting data: courses/level-two/chapter-3.md - - Dealing with errors in workflows: courses/level-two/chapter-4.md - - Automating a business workflow: - - Use case: courses/level-two/chapter-5/chapter-5.0.md - - Workflow 1: courses/level-two/chapter-5/chapter-5.1.md - - Workflow 2: courses/level-two/chapter-5/chapter-5.2.md - - Workflow 3: courses/level-two/chapter-5/chapter-5.3.md - - Test your knowledge: courses/level-two/chapter-6.md - - Using the app: - - Understand workflows: - - workflows/index.md - - Create and run: workflows/create.md - - Components: - - workflows/components/index.md - - Nodes: workflows/components/nodes.md - - Connections: workflows/components/connections.md - - Sticky Notes: workflows/components/sticky-notes.md - - Executions: - - workflows/executions/index.md - - Manual, partial, and production executions: workflows/executions/manual-partial-and-production-executions.md - - Workflow-level executions: workflows/executions/single-workflow-executions.md - - All executions: workflows/executions/all-executions.md - - Custom executions data: workflows/executions/custom-executions-data.md - - Debug executions: workflows/executions/debug.md - - Tags: workflows/tags.md - - Export and import: workflows/export-import.md - - Templates: workflows/templates.md - - Sharing: workflows/sharing.md - - Settings: workflows/settings.md - - Workflow history: workflows/history.md - - Workflow ID: workflows/workflow-id.md - - Manage credentials: - - credentials/index.md - - Create and edit: credentials/add-edit-credentials.md - - Credential sharing: credentials/credential-sharing.md + - Hello World: + - Get n8n: try-it-out/getn8n.md + - Your first workflow: try-it-out/tutorial-first-workflow.md + - Going further: try-it-out/going-further.md + - Choose your n8n: + - Choose a plan: choose-n8n.md + - Install n8n: + - Docker: hosting/installation/docker.md + - Docker Compose: hosting/installation/server-setups/docker-compose.md + - Install n8n embed: embed/prerequisites.md + - Server setups: + - hosting/installation/server-setups/index.md + - Digital Ocean: hosting/installation/server-setups/digital-ocean.md + - Heroku: hosting/installation/server-setups/heroku.md + - Hetzner: hosting/installation/server-setups/hetzner.md + - Amazon Web Services: hosting/installation/server-setups/aws.md + - Azure: hosting/installation/server-setups/azure.md + - Google Cloud: hosting/installation/server-setups/google-cloud.md + - Help and community: + - Where to get help: help-community/help.md + - Contributing: help-community/contributing.md + - Using n8n: + - using-n8n/index.md + - Configuration: + - n8n Cloud: + - manage-cloud/index.md + - Access the Cloud admin dashboard: manage-cloud/cloud-admin-dashboard.md + - Update your n8n Cloud version: manage-cloud/update-cloud-version.md + - Set the timezone: manage-cloud/set-cloud-timezone.md + - Cloud data management: manage-cloud/cloud-data-management.md + - Change ownership or username: manage-cloud/change-ownership-or-username.md + - Self-hosted n8n: + - hosting/index.md + - Configuration methods: hosting/configuration/configuration-methods.md + - Configuration examples: + - hosting/configuration/configuration-examples/index.md + - Isolate n8n: hosting/configuration/configuration-examples/isolation.md + - Configure the Base URL: hosting/configuration/configuration-examples/base-url.md + - Configure custom SSL certificate authorities: hosting/configuration/configuration-examples/custom-certificate-authority.md + - Set a custom encryption key: hosting/configuration/configuration-examples/encryption-key.md + - Configure workflow timeouts: hosting/configuration/configuration-examples/execution-timeout.md + - Specify custom nodes location: hosting/configuration/configuration-examples/custom-nodes-location.md + - Enable modules in Code node: hosting/configuration/configuration-examples/modules-in-code-node.md + - Set the timezone: hosting/configuration/configuration-examples/time-zone.md + - Specify user folder path: hosting/configuration/configuration-examples/user-folder.md + - Configure webhook URLs with reverse proxy: hosting/configuration/configuration-examples/webhook-url.md + - Enable Prometheus metrics: hosting/configuration/configuration-examples/prometheus.md + - Task runners: hosting/configuration/task-runners.md + - User management: hosting/configuration/user-management-self-hosted.md + - Logging and monitoring: + - Logging: hosting/logging-monitoring/logging.md + - Monitoring: hosting/logging-monitoring/monitoring.md + - Scaling and performance: + - Overview: hosting/scaling/overview.md + - Configuring queue mode: hosting/scaling/queue-mode.md + - Execution data: hosting/scaling/execution-data.md + - Binary data: hosting/scaling/binary-data.md + - External storage for binary data: hosting/scaling/external-storage.md + - Securing n8n: + - Overview: hosting/securing/overview.md + - Set up SSL: hosting/securing/set-up-ssl.md + - Set up SSO: hosting/securing/set-up-sso.md + - Security audit: hosting/securing/security-audit.md + - Disable the API: hosting/securing/disable-public-api.md + - Opt out of data collection: hosting/securing/telemetry-opt-out.md + - Blocking nodes: hosting/securing/blocking-nodes.md + - Hardening task runners: hosting/securing/hardening-task-runners.md + - n8n Embed: + - embed/index.md + - Deployment: embed/deployment.md + - Manage configuration: embed/configuration.md + - Workflow management: embed/managing-workflows.md + - Workflows templates: embed/workflow-templates.md + - White labelling: embed/white-labelling.md + - Paid Cloud features (enterprise + Cloud): - Manage users and access: - user-management/index.md - Cloud setup: user-management/cloud-setup.md - Manage users: user-management/manage-users.md - - Account types: user-management/account-types.md - Role-based access control: - user-management/rbac/index.md - - Role types: user-management/rbac/role-types.md - Projects: user-management/rbac/projects.md - Best practices: user-management/best-practices.md - 2FA: user-management/two-factor-auth.md @@ -82,91 +89,256 @@ nav: - SAML: - user-management/saml/index.md - Set up SAML: user-management/saml/setup.md - - Okta Workforce Identity SAML setup: user-management/saml/okta.md - - Troubleshooting: user-management/saml/troubleshooting.md - Manage users with SAML: user-management/saml/managing.md - - Keyboard shortcuts: keyboard-shortcuts.md - - Key concepts: - - Flow logic: - - flow-logic/index.md - - Splitting with conditionals: flow-logic/splitting.md - - Merging data: flow-logic/merging.md - - Looping: flow-logic/looping.md - - Waiting: flow-logic/waiting.md - - Sub-workflows: flow-logic/subworkflows.md - - Error handling: flow-logic/error-handling.md - - Execution order in multi-branch workflows: flow-logic/execution-order.md - - Data: - - data/index.md - - Data structure: data/data-structure.md - - Data flow within nodes: data/data-flow-nodes.md - - Transforming data: data/transforming-data.md - - Process data using code: data/code.md - - Data mapping: - - data/data-mapping/index.md - - Data mapping in the UI: data/data-mapping/data-mapping-ui.md - - Data mapping in the expressions editor: data/data-mapping/data-mapping-expressions.md - - Data item linking: - - data/data-mapping/data-item-linking/index.md - - Item linking concepts: data/data-mapping/data-item-linking/item-linking-concepts.md - - Item linking in the Code node: data/data-mapping/data-item-linking/item-linking-code-node.md - - Item linking errors: data/data-mapping/data-item-linking/item-linking-errors.md - - Item linking for node creators: data/data-mapping/data-item-linking/item-linking-node-building.md - - Data pinning: data/data-pinning.md - - Data editing: data/data-editing.md - - Data filtering: data/data-filtering.md - - Data mocking: data/data-mocking.md - - Binary data: data/binary-data.md - - Schema preview: data/schema-preview.md - - Glossary: glossary.md - - n8n Cloud: - - Overview: manage-cloud/overview.md - - Access the Cloud admin dashboard: manage-cloud/cloud-admin-dashboard.md - - Update your n8n Cloud version: manage-cloud/update-cloud-version.md - - Set the timezone: manage-cloud/set-cloud-timezone.md - - Cloud IP addresses: manage-cloud/cloud-ip.md - - Cloud data management: manage-cloud/cloud-data-management.md - - Change ownership or username: manage-cloud/change-ownership-or-username.md - - Concurrency: manage-cloud/concurrency.md - - AI Assistant: manage-cloud/ai-assistant.md - - Enterprise features: + - Set up SAML with Okta Workforce Identity: user-management/saml/okta.md + - Troubleshooting: user-management/saml/troubleshooting.md - Source control and environments: - source-control-environments/index.md - - Understand: - - source-control-environments/understand/index.md - - Environments: source-control-environments/understand/environments.md - - Git in n8n: source-control-environments/understand/git.md - - Branch patterns: source-control-environments/understand/patterns.md - Set up: source-control-environments/setup.md - Using: - source-control-environments/using/index.md - Push and pull: source-control-environments/using/push-pull.md - Copy work between environments: source-control-environments/using/copy-work.md - Manage variables: source-control-environments/using/manage-variables.md - - "Tutorial: Create environments with source control": source-control-environments/create-environments.md - External secrets: external-secrets.md - Log streaming: log-streaming.md - Enterprise license key: enterprise-key.md - - Releases: - - Release notes: - - 1.x: release-notes.md - - 0.x: release-notes/0-x.md - - v1.0 migration guide: 1-0-migration-checklist.md - - Help and community: - - Where to get help: help-community/help.md - - Contributing: help-community/contributing.md - - Licenses and privacy: - - Privacy and security: - - privacy-security/index.md - - Privacy: privacy-security/privacy.md - - Security: https://n8n.io/legal/#security - - Incident response: privacy-security/incident-response.md - - What you can do: privacy-security/what-you-can-do.md - - Sustainable use license: sustainable-use-license.md - - Integrations: - - integrations/index.md - - Built-in nodes: + - Using workflows: + - workflows/index.md + - Create: workflows/create.md + - Share: workflows/sharing.md + - Connections: workflows/components/connections.md + - Sticky notes: workflows/components/sticky-notes.md + - Tags: workflows/tags.md + - Export and import: workflows/export-import.md + - Workflow settings: workflows/settings.md + - Workflow history: workflows/history.md + - Workflow templates: workflows/templates.md + - Workflow ID: workflows/workflow-id.md + - Create custom variables: code/variables.md + - Manage executions: + - workflows/executions/index.md + - Manual, partial, and production executions: workflows/executions/manual-partial-and-production-executions.md + - Workflow-level executions: workflows/executions/single-workflow-executions.md + - All executions: workflows/executions/all-executions.md + - Custom executions data: workflows/executions/custom-executions-data.md + - Debug executions: workflows/executions/debug.md + - Working with nodes: + - Manage nodes: workflows/components/nodes.md + - Flow control nodes: + - flow-logic/index.md + - Splitting with conditionals: flow-logic/splitting.md + - Merging data: flow-logic/merging.md + - Looping: flow-logic/looping.md + - Waiting: flow-logic/waiting.md + - Sub-workflows: flow-logic/subworkflows.md + - Error handling: flow-logic/error-handling.md + - Code node: + - code/cookbook/code-node/index.md + - Get number of items returned by last node: code/cookbook/code-node/number-items-last-node.md + - Get the binary data buffer: code/cookbook/code-node/get-binary-data-buffer.md + - Output to the browser console: code/cookbook/code-node/console-log.md + - HTTP Request node pagination: code/cookbook/http-node/pagination.md + - Handle rate limits: integrations/builtin/rate-limits.md + - Using community nodes: + - Installation and management: + - integrations/community-nodes/installation/index.md + - GUI installation: integrations/community-nodes/installation/gui-install.md + - Manual installation: integrations/community-nodes/installation/manual-install.md + - Using community nodes: integrations/community-nodes/usage.md + - Building community nodes: integrations/community-nodes/build-community-nodes.md + - Troubleshooting: integrations/community-nodes/troubleshooting.md + - Using credentials: + - credentials/index.md + - Create and edit: credentials/add-edit-credentials.md + - Credential sharing: credentials/credential-sharing.md + - Working with data: + - Data pinning: data/data-pinning.md + - Data editing: data/data-editing.md + - Data filtering: data/data-filtering.md + - Data mocking: data/data-mocking.md + - Schema preview: data/schema-preview.md + - Data mapping: + - data/data-mapping/index.md + - Data mapping in the UI: data/data-mapping/data-mapping-ui.md + - Data mapping in the expressions editor: data/data-mapping/data-mapping-expressions.md + - Item linking: + - data/data-mapping/data-item-linking/index.md + - Item linking in the Code node: data/data-mapping/data-item-linking/item-linking-code-node.md + - Item linking for node creators: data/data-mapping/data-item-linking/item-linking-node-building.md + - Retrieve linked items from earlier in the workflow: code/cookbook/builtin/itemmatching.md + - Item linking errors: data/data-mapping/data-item-linking/item-linking-errors.md + - Handling dates: code/cookbook/luxon.md + - Querying JSON: code/cookbook/jmespath.md + - Using expressions: + - Expressions: code/expressions.md + - code/cookbook/expressions/index.md + - Check incoming data: code/cookbook/expressions/check-incoming-data.md + - Common issues: code/cookbook/expressions/common-issues.md + - Using AI: + - AI Starter Kit: hosting/starter-kits/ai-starter-kit.md + - Set a human fallback for AI workflows: advanced-ai/examples/human-fallback.md + - Use LangSmith with n8n: advanced-ai/langchain/langsmith.md + - Call an API to fetch data: advanced-ai/examples/api-workflow-tool.md + - Use Google Sheets as a data source: advanced-ai/examples/data-google-sheets.md + - Populate a Pinecone vector database from a website: advanced-ai/examples/vector-store-website.md + - API: + - Authentication: api/authentication.md + - Pagination: api/pagination.md + - Using the API playground: api/using-api-playground.md + - Creating nodes: + - Install n8n with npm: hosting/installation/npm.md + - Set up your development environment: integrations/creating-nodes/build/node-development-environment.md + - Versioning: integrations/creating-nodes/build/reference/node-versioning.md + - Item linking: integrations/creating-nodes/build/reference/paired-items.md + - Test your node: + - integrations/creating-nodes/test/index.md + - Run your node locally: integrations/creating-nodes/test/run-node-locally.md + - Node linter: integrations/creating-nodes/test/node-linter.md + - Troubleshooting: integrations/creating-nodes/test/troubleshooting-node-development.md + - Deploy your node: + - integrations/creating-nodes/deploy/index.md + - Submit community nodes: integrations/creating-nodes/deploy/submit-community-nodes.md + - Install private nodes: integrations/creating-nodes/deploy/install-private-nodes.md + - Tutorials and courses: + - tutorials/index.md + - Your first workflow: tutorials/tutorial-first-workflow.md + - Build an AI workflow in n8n: advanced-ai/intro-tutorial.md + - AI examples: + - Let AI specify tool parameters: advanced-ai/examples/using-the-fromai-function.md + - Text courses: + - Level one: + - courses/level-one/index.md + - Navigating the editor UI: courses/level-one/chapter-1.md + - Building a mini-workflow: courses/level-one/chapter-2.md + - Automating a (real-world) use case: courses/level-one/chapter-3.md + - Designing the workflow: courses/level-one/chapter-4.md + - Building the workflow: + - Getting data from the data warehouse: courses/level-one/chapter-5/chapter-5.1.md + - Inserting data into airtable: courses/level-one/chapter-5/chapter-5.2.md + - Filtering orders: courses/level-one/chapter-5/chapter-5.3.md + - Setting values for processing orders: courses/level-one/chapter-5/chapter-5.4.md + - Calculating booked orders: courses/level-one/chapter-5/chapter-5.5.md + - Notifying the team: courses/level-one/chapter-5/chapter-5.6.md + - Scheduling the workflow: courses/level-one/chapter-5/chapter-5.7.md + - Activating and examining the workflow: courses/level-one/chapter-5/chapter-5.8.md + - Exporting and importing workflows: courses/level-one/chapter-6.md + - Test your knowledge: courses/level-one/chapter-7.md + - Level two: + - courses/level-two/index.md + - Understanding the data structure: courses/level-two/chapter-1.md + - Processing different data types: courses/level-two/chapter-2.md + - Merging and splitting data: courses/level-two/chapter-3.md + - Dealing with errors in workflows: courses/level-two/chapter-4.md + - Automating a business workflow: + - Use case: courses/level-two/chapter-5/chapter-5.0.md + - Workflow 1: courses/level-two/chapter-5/chapter-5.1.md + - Workflow 2: courses/level-two/chapter-5/chapter-5.2.md + - Workflow 3: courses/level-two/chapter-5/chapter-5.3.md + - Test your knowledge: courses/level-two/chapter-6.md + - Using nodes: + - Custom API actions for existing nodes: integrations/custom-operations.md + - Video courses: video-courses.md + - Creating nodes: + - integrations/creating-nodes/overview.md + - Plan your node: + - integrations/creating-nodes/plan/index.md + - Choose a node type: integrations/creating-nodes/plan/node-types.md + - Choose a node building style: integrations/creating-nodes/plan/choose-node-method.md + - Node UI design: integrations/creating-nodes/plan/node-ui-design.md + - Choose node file structure: integrations/creating-nodes/build/reference/node-file-structure.md + - Build your node: + - integrations/creating-nodes/build/index.md + - "Tutorial: Build a declarative-style node": integrations/creating-nodes/build/declarative-style-node.md + - "Tutorial: Build a programmatic-style node": integrations/creating-nodes/build/programmatic-style-node.md + - Reference: + - integrations/creating-nodes/build/reference/index.md + - Node UI elements: integrations/creating-nodes/build/reference/ui-elements.md + - Code standards: integrations/creating-nodes/build/reference/code-standards.md + - File structure: integrations/creating-nodes/build/reference/node-file-structure.md + - Base files: + - integrations/creating-nodes/build/reference/node-base-files/index.md + - Structure: integrations/creating-nodes/build/reference/node-base-files/structure.md + - Standard parameters: integrations/creating-nodes/build/reference/node-base-files/standard-parameters.md + - Declarative-style parameters: integrations/creating-nodes/build/reference/node-base-files/declarative-style-parameters.md + - Programmatic-style parameters: integrations/creating-nodes/build/reference/node-base-files/programmatic-style-parameters.md + - Programmatic-style execute method: integrations/creating-nodes/build/reference/node-base-files/programmatic-style-execute-method.md + - Codex files: integrations/creating-nodes/build/reference/node-codex-files.md + - Credentials files: integrations/creating-nodes/build/reference/credentials-files.md + - HTTP request helpers: integrations/creating-nodes/build/reference/http-helpers.md + - Enterprise: + - Create environments with source control: source-control-environments/create-environments.md + - Understanding n8n: + - understanding/index.md + - Workflows: + - Learn about workflows: understanding/workflows.md + - Executions: understanding/executions.md +#Workflow settings - Tags - Workflow history - Export/import - Workflow ID + - Nodes: + - Builtin vs community vs custom nodes: integrations/builtin-vs-community-vs-custom.md - Node types: integrations/builtin/node-types.md +# - Trigger nodes: placeholder.md +# - App nodes: placeholder.md + - Execution order in multi-branch workflows: flow-logic/execution-order.md + - Data transformation nodes: data/transforming-data.md + - AI nodes: integrations/builtin/cluster-nodes/ai-nodes.md +# - Human in the loop nodes: placeholder.md + - Community nodes: + - Risks: integrations/community-nodes/risks.md + - Blocklist: integrations/community-nodes/blocklist.md +# - Execution: understanding/executions.md +# - Pinning and mocking +# - Debugging executions + - Credentials: + - What are credentials?: understanding/credentials.md + - Data mapping and transformation: + - Data structure: data/data-structure.md + - Data item linking: data/data-mapping/data-item-linking/item-linking-concepts.md + - Transforming data: data/transforming-data.md + - Data flow within nodes: data/data-flow-nodes.md +# - Expressions overview +# - Code in n8n +# - Handling dates +# - Query JSON with JMESPath + - AI: + - advanced-ai/index.md + - AI concepts: + - advanced-ai/examples/introduction.md + - What is a chain?: advanced-ai/examples/understand-chains.md + - What is an agent?: advanced-ai/examples/understand-agents.md + - Agents vs chains example: advanced-ai/examples/agent-chain-comparison.md + - What is memory?: advanced-ai/examples/understand-memory.md + - What is a tool?: advanced-ai/examples/understand-tools.md + - What is a vector database?: advanced-ai/examples/understand-vector-databases.md + - AI coding: code/ai-code.md + - LangChain in n8n: + - advanced-ai/langchain/overview.md + - Langchain concepts in n8n: advanced-ai/langchain/langchain-n8n.md + - LangChain learning resources: advanced-ai/langchain/langchain-learning-resources.md + - Cloud: + - Concurrency: manage-cloud/concurrency.md + - AI assistant: manage-cloud/ai-assistant.md + - Performance and benchmarking: hosting/scaling/performance-benchmarking.md + - Concurrency control: hosting/scaling/concurrency-control.md + - Memory-related errors: hosting/scaling/memory-errors.md + - Self-hosted: + - Why self host?: understanding/self-hosting.md + - Enterprise: + - Source control: source-control-environments/understand/index.md + - Environments: source-control-environments/understand/environments.md + - Git in n8n: source-control-environments/understand/git.md + - Branch patterns: source-control-environments/understand/patterns.md + - Reference: + - reference/index.md + - n8n CLI commands: hosting/cli-commands.md + - Keyboard shortcuts: keyboard-shortcuts.md + - Cloud IP addresses: manage-cloud/cloud-ip.md + - Glossary: glossary.md + - Configuration: + - Environment variables: hosting/configuration/environment-variables.md + - Supported databases and settings: hosting/configuration/supported-databases-settings.md + - Built-in nodes: + - integrations/builtin/node-types.md - Core nodes: - integrations/builtin/core-nodes/index.md - Activation Trigger: integrations/builtin/core-nodes/n8n-nodes-base.activationtrigger.md @@ -245,21 +417,28 @@ nav: - Common issues: integrations/builtin/core-nodes/n8n-nodes-base.webhook/common-issues.md - Workflow Trigger: integrations/builtin/core-nodes/n8n-nodes-base.workflowtrigger.md - integrations/builtin/core-nodes/n8n-nodes-base.xml.md - - Actions: + - App nodes: - integrations/builtin/app-nodes/index.md - Action Network: integrations/builtin/app-nodes/n8n-nodes-base.actionnetwork.md - ActiveCampaign: integrations/builtin/app-nodes/n8n-nodes-base.activecampaign.md + - ActiveCampaign Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.activecampaigntrigger.md + - Acuity Scheduling Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.acuityschedulingtrigger.md - Adalo: integrations/builtin/app-nodes/n8n-nodes-base.adalo.md - Affinity: integrations/builtin/app-nodes/n8n-nodes-base.affinity.md + - Affinity Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.affinitytrigger.md - Agile CRM: integrations/builtin/app-nodes/n8n-nodes-base.agilecrm.md - Airtable: - Airtable: integrations/builtin/app-nodes/n8n-nodes-base.airtable/index.md - Common issues: integrations/builtin/app-nodes/n8n-nodes-base.airtable/common-issues.md + - Airtable Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.airtabletrigger.md - AMQP Sender: integrations/builtin/app-nodes/n8n-nodes-base.amqp.md + - AMQP Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.amqptrigger.md - APITemplate.io: integrations/builtin/app-nodes/n8n-nodes-base.apitemplateio.md - Asana: integrations/builtin/app-nodes/n8n-nodes-base.asana.md + - Asana Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.asanatrigger.md - Automizy: integrations/builtin/app-nodes/n8n-nodes-base.automizy.md - Autopilot: integrations/builtin/app-nodes/n8n-nodes-base.autopilot.md + - Autopilot Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.autopilottrigger.md - AWS Certificate Manager: integrations/builtin/app-nodes/n8n-nodes-base.awscertificatemanager.md - AWS Comprehend: integrations/builtin/app-nodes/n8n-nodes-base.awscomprehend.md - AWS DynamoDB: integrations/builtin/app-nodes/n8n-nodes-base.awsdynamodb.md @@ -269,6 +448,7 @@ nav: - AWS S3: integrations/builtin/app-nodes/n8n-nodes-base.awss3.md - AWS SES: integrations/builtin/app-nodes/n8n-nodes-base.awsses.md - AWS SNS: integrations/builtin/app-nodes/n8n-nodes-base.awssns.md + - AWS SNS Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.awssnstrigger.md - AWS SQS: integrations/builtin/app-nodes/n8n-nodes-base.awssqs.md - AWS Textract: integrations/builtin/app-nodes/n8n-nodes-base.awstextract.md - AWS Transcribe: integrations/builtin/app-nodes/n8n-nodes-base.awstranscribe.md @@ -277,29 +457,40 @@ nav: - Bannerbear: integrations/builtin/app-nodes/n8n-nodes-base.bannerbear.md - Baserow: integrations/builtin/app-nodes/n8n-nodes-base.baserow.md - Beeminder: integrations/builtin/app-nodes/n8n-nodes-base.beeminder.md + - Bitbucket Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.bitbuckettrigger.md - Bitly: integrations/builtin/app-nodes/n8n-nodes-base.bitly.md - Bitwarden: integrations/builtin/app-nodes/n8n-nodes-base.bitwarden.md - Box: integrations/builtin/app-nodes/n8n-nodes-base.box.md + - Box Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.boxtrigger.md - Brandfetch: integrations/builtin/app-nodes/n8n-nodes-base.brandfetch.md - Brevo: integrations/builtin/app-nodes/n8n-nodes-base.brevo.md + - Brevo Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.brevotrigger.md - Bubble: integrations/builtin/app-nodes/n8n-nodes-base.bubble.md + - Cal Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.caltrigger.md + - Calendly Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.calendlytrigger.md - Chargebee: integrations/builtin/app-nodes/n8n-nodes-base.chargebee.md + - Chargebee Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.chargebeetrigger.md - CircleCI: integrations/builtin/app-nodes/n8n-nodes-base.circleci.md - - Webex by Cisco: integrations/builtin/app-nodes/n8n-nodes-base.ciscowebex.md - Clearbit: integrations/builtin/app-nodes/n8n-nodes-base.clearbit.md - ClickUp: integrations/builtin/app-nodes/n8n-nodes-base.clickup.md + - ClickUp Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.clickuptrigger.md - Clockify: integrations/builtin/app-nodes/n8n-nodes-base.clockify.md + - Clockify Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.clockifytrigger.md - Cloudflare: integrations/builtin/app-nodes/n8n-nodes-base.cloudflare.md - Cockpit: integrations/builtin/app-nodes/n8n-nodes-base.cockpit.md - Coda: integrations/builtin/app-nodes/n8n-nodes-base.coda.md - CoinGecko: integrations/builtin/app-nodes/n8n-nodes-base.coingecko.md - Contentful: integrations/builtin/app-nodes/n8n-nodes-base.contentful.md - ConvertKit: integrations/builtin/app-nodes/n8n-nodes-base.convertkit.md + - ConvertKit Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.convertkittrigger.md - Copper: integrations/builtin/app-nodes/n8n-nodes-base.copper.md + - Copper Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.coppertrigger.md - Cortex: integrations/builtin/app-nodes/n8n-nodes-base.cortex.md - CrateDB: integrations/builtin/app-nodes/n8n-nodes-base.cratedb.md - crowd.dev: integrations/builtin/app-nodes/n8n-nodes-base.crowddev.md + - crowd.dev Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.crowddevtrigger.md - Customer.io: integrations/builtin/app-nodes/n8n-nodes-base.customerio.md + - Customer.io Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.customeriotrigger.md - DeepL: integrations/builtin/app-nodes/n8n-nodes-base.deepl.md - Demio: integrations/builtin/app-nodes/n8n-nodes-base.demio.md - DHL: integrations/builtin/app-nodes/n8n-nodes-base.dhl.md @@ -315,17 +506,40 @@ nav: - Elasticsearch: integrations/builtin/app-nodes/n8n-nodes-base.elasticsearch.md - Elastic Security: integrations/builtin/app-nodes/n8n-nodes-base.elasticsecurity.md - Emelia: integrations/builtin/app-nodes/n8n-nodes-base.emelia.md + - Emelia Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.emeliatrigger.md + - Eventbrite Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.eventbritetrigger.md - ERPNext: integrations/builtin/app-nodes/n8n-nodes-base.erpnext.md - Facebook Graph API: integrations/builtin/app-nodes/n8n-nodes-base.facebookgraphapi.md + - Facebook Lead Ads Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.facebookleadadstrigger.md + - Facebook Trigger: + - Facebook Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/index.md + - Ad Account: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/ad-account.md + - Application: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/application.md + - Certificate Transparency: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/certificate-transparency.md + - Group: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/group.md + - Instagram: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/instagram.md + - Link: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/link.md + - Page: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/page.md + - Permissions: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/permissions.md + - User: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/user.md + - WhatsApp Business Account: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/whatsapp.md + - Workplace Security: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/workplace-security.md + - Figma Trigger (Beta): integrations/builtin/trigger-nodes/n8n-nodes-base.figmatrigger.md - FileMaker: integrations/builtin/app-nodes/n8n-nodes-base.filemaker.md - Flow: integrations/builtin/app-nodes/n8n-nodes-base.flow.md + - Flow Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.flowtrigger.md + - Form.io Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.formiotrigger.md + - Formstack Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.formstacktrigger.md - Freshdesk: integrations/builtin/app-nodes/n8n-nodes-base.freshdesk.md - Freshservice: integrations/builtin/app-nodes/n8n-nodes-base.freshservice.md - Freshworks CRM: integrations/builtin/app-nodes/n8n-nodes-base.freshworkscrm.md - GetResponse: integrations/builtin/app-nodes/n8n-nodes-base.getresponse.md + - GetResponse Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.getresponsetrigger.md - Ghost: integrations/builtin/app-nodes/n8n-nodes-base.ghost.md - GitHub: integrations/builtin/app-nodes/n8n-nodes-base.github.md + - GitHub Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.githubtrigger.md - GitLab: integrations/builtin/app-nodes/n8n-nodes-base.gitlab.md + - GitLab Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.gitlabtrigger.md - Gmail: - Gmail: integrations/builtin/app-nodes/n8n-nodes-base.gmail/index.md - Draft operations: integrations/builtin/app-nodes/n8n-nodes-base.gmail/draft-operations.md @@ -333,16 +547,22 @@ nav: - Message operations: integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations.md - Thread operations: integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations.md - Common issues: integrations/builtin/app-nodes/n8n-nodes-base.gmail/common-issues.md + - Gmail Trigger: + - integrations/builtin/trigger-nodes/n8n-nodes-base.gmailtrigger/index.md + - Poll Mode options: integrations/builtin/trigger-nodes/n8n-nodes-base.gmailtrigger/poll-mode-options.md + - Common issues: integrations/builtin/trigger-nodes/n8n-nodes-base.gmailtrigger/common-issues.md - Gong: integrations/builtin/app-nodes/n8n-nodes-base.gong.md - Google Ads: integrations/builtin/app-nodes/n8n-nodes-base.googleads.md - Google Analytics: integrations/builtin/app-nodes/n8n-nodes-base.googleanalytics.md - Google BigQuery: integrations/builtin/app-nodes/n8n-nodes-base.googlebigquery.md - Google Books: integrations/builtin/app-nodes/n8n-nodes-base.googlebooks.md - Google Business Profile: integrations/builtin/app-nodes/n8n-nodes-base.googlebusinessprofile.md + - Google Business Profile Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.googlebusinessprofiletrigger.md - Google Calendar: - Google Calendar: integrations/builtin/app-nodes/n8n-nodes-base.googlecalendar/index.md - Calendar operations: integrations/builtin/app-nodes/n8n-nodes-base.googlecalendar/calendar-operations.md - Event operations: integrations/builtin/app-nodes/n8n-nodes-base.googlecalendar/event-operations.md + - Google Calendar Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.googlecalendartrigger.md - Google Chat: integrations/builtin/app-nodes/n8n-nodes-base.googlechat.md - Google Cloud Firestore: integrations/builtin/app-nodes/n8n-nodes-base.googlecloudfirestore.md - Google Cloud Natural Language: integrations/builtin/app-nodes/n8n-nodes-base.googlecloudnaturallanguage.md @@ -357,12 +577,18 @@ nav: - Folder operations: integrations/builtin/app-nodes/n8n-nodes-base.googledrive/folder-operations.md - Shared drive operations: integrations/builtin/app-nodes/n8n-nodes-base.googledrive/shared-drive-operations.md - Common issues: integrations/builtin/app-nodes/n8n-nodes-base.googledrive/common-issues.md + - Google Drive Trigger: + - Google Drive Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.googledrivetrigger/index.md + - Common issues: integrations/builtin/trigger-nodes/n8n-nodes-base.googledrivetrigger/common-issues.md - Google Perspective: integrations/builtin/app-nodes/n8n-nodes-base.googleperspective.md - Google Sheets: - Google Sheets: integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/index.md - Document operations: integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/document-operations.md - Sheet within Document operations: integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/sheet-operations.md - Common issues: integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/common-issues.md + - Google Sheets Trigger: + - Google Sheets Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.googlesheetstrigger/index.md + - Common issues: integrations/builtin/trigger-nodes/n8n-nodes-base.googlesheetstrigger/common-issues.md - Google Slides: integrations/builtin/app-nodes/n8n-nodes-base.googleslides.md - Google Tasks: integrations/builtin/app-nodes/n8n-nodes-base.googletasks.md - Google Translate: integrations/builtin/app-nodes/n8n-nodes-base.googletranslate.md @@ -371,41 +597,57 @@ nav: - GoToWebinar: integrations/builtin/app-nodes/n8n-nodes-base.gotowebinar.md - Grafana: integrations/builtin/app-nodes/n8n-nodes-base.grafana.md - Grist: integrations/builtin/app-nodes/n8n-nodes-base.grist.md + - Gumroad Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.gumroadtrigger.md - Hacker News: integrations/builtin/app-nodes/n8n-nodes-base.hackernews.md - HaloPSA: integrations/builtin/app-nodes/n8n-nodes-base.halopsa.md - Harvest: integrations/builtin/app-nodes/n8n-nodes-base.harvest.md - Help Scout: integrations/builtin/app-nodes/n8n-nodes-base.helpscout.md + - Help Scout Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.helpscouttrigger.md - HighLevel: integrations/builtin/app-nodes/n8n-nodes-base.highlevel.md - Home Assistant: integrations/builtin/app-nodes/n8n-nodes-base.homeassistant.md - HubSpot: integrations/builtin/app-nodes/n8n-nodes-base.hubspot.md + - Hubspot Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.hubspottrigger.md - Humantic AI: integrations/builtin/app-nodes/n8n-nodes-base.humanticai.md - Hunter: integrations/builtin/app-nodes/n8n-nodes-base.hunter.md - Intercom: integrations/builtin/app-nodes/n8n-nodes-base.intercom.md - Invoice Ninja: integrations/builtin/app-nodes/n8n-nodes-base.invoiceninja.md + - Invoice Ninja Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.invoiceninjatrigger.md - Iterable: integrations/builtin/app-nodes/n8n-nodes-base.iterable.md - Jenkins: integrations/builtin/app-nodes/n8n-nodes-base.jenkins.md - Jira Software: integrations/builtin/app-nodes/n8n-nodes-base.jira.md + - Jira Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.jiratrigger.md + - JotForm Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.jotformtrigger.md - Kafka: integrations/builtin/app-nodes/n8n-nodes-base.kafka.md + - Kafka Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.kafkatrigger.md - Keap: integrations/builtin/app-nodes/n8n-nodes-base.keap.md + - Keap Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.keaptrigger.md - Kitemaker: integrations/builtin/app-nodes/n8n-nodes-base.kitemaker.md - KoboToolbox: integrations/builtin/app-nodes/n8n-nodes-base.kobotoolbox.md + - KoboToolbox Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.kobotoolboxtrigger.md - Lemlist: integrations/builtin/app-nodes/n8n-nodes-base.lemlist.md + - Lemlist Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.lemlisttrigger.md - Line: integrations/builtin/app-nodes/n8n-nodes-base.line.md - Linear: integrations/builtin/app-nodes/n8n-nodes-base.linear.md + - Linear Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.lineartrigger.md - LingvaNex: integrations/builtin/app-nodes/n8n-nodes-base.lingvanex.md - LinkedIn: integrations/builtin/app-nodes/n8n-nodes-base.linkedin.md - LoneScale: integrations/builtin/app-nodes/n8n-nodes-base.lonescale.md + - LoneScale Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.lonescaletrigger.md - Magento 2: integrations/builtin/app-nodes/n8n-nodes-base.magento2.md - Mailcheck: integrations/builtin/app-nodes/n8n-nodes-base.mailcheck.md - Mailchimp: integrations/builtin/app-nodes/n8n-nodes-base.mailchimp.md + - Mailchimp Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.mailchimptrigger.md - MailerLite: integrations/builtin/app-nodes/n8n-nodes-base.mailerlite.md + - MailerLite Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.mailerlitetrigger.md - Mailgun: integrations/builtin/app-nodes/n8n-nodes-base.mailgun.md - Mailjet: integrations/builtin/app-nodes/n8n-nodes-base.mailjet.md + - Mailjet Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.mailjettrigger.md - Mandrill: integrations/builtin/app-nodes/n8n-nodes-base.mandrill.md - marketstack: integrations/builtin/app-nodes/n8n-nodes-base.marketstack.md - Matrix: integrations/builtin/app-nodes/n8n-nodes-base.matrix.md - Mattermost: integrations/builtin/app-nodes/n8n-nodes-base.mattermost.md - Mautic: integrations/builtin/app-nodes/n8n-nodes-base.mautic.md + - Mautic Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.mautictrigger.md - Medium: integrations/builtin/app-nodes/n8n-nodes-base.medium.md - MessageBird: integrations/builtin/app-nodes/n8n-nodes-base.messagebird.md - Metabase: integrations/builtin/app-nodes/n8n-nodes-base.metabase.md @@ -414,7 +656,9 @@ nav: - Microsoft Excel 365: integrations/builtin/app-nodes/n8n-nodes-base.microsoftexcel.md - Microsoft Graph Security: integrations/builtin/app-nodes/n8n-nodes-base.microsoftgraphsecurity.md - Microsoft OneDrive: integrations/builtin/app-nodes/n8n-nodes-base.microsoftonedrive.md + - Microsoft OneDrive Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.microsoftonedrivetrigger.md - Microsoft Outlook: integrations/builtin/app-nodes/n8n-nodes-base.microsoftoutlook.md + - Microsoft Outlook Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.microsoftoutlooktrigger.md - Microsoft SQL: integrations/builtin/app-nodes/n8n-nodes-base.microsoftsql.md - Microsoft Teams: integrations/builtin/app-nodes/n8n-nodes-base.microsoftteams.md - Microsoft To Do: integrations/builtin/app-nodes/n8n-nodes-base.microsofttodo.md @@ -425,6 +669,7 @@ nav: - MongoDB: integrations/builtin/app-nodes/n8n-nodes-base.mongodb.md - Monica CRM: integrations/builtin/app-nodes/n8n-nodes-base.monicacrm.md - MQTT: integrations/builtin/app-nodes/n8n-nodes-base.mqtt.md + - MQTT Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.mqtttrigger.md - MSG91: integrations/builtin/app-nodes/n8n-nodes-base.msg91.md - MySQL: - MySQL: integrations/builtin/app-nodes/n8n-nodes-base.mysql/index.md @@ -433,17 +678,20 @@ nav: - Customer Messenger (n8n Training): integrations/builtin/app-nodes/n8n-nodes-base.n8ntrainingcustomermessenger.md - NASA: integrations/builtin/app-nodes/n8n-nodes-base.nasa.md - Netlify: integrations/builtin/app-nodes/n8n-nodes-base.netlify.md + - Netlify Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.netlifytrigger.md - Netscaler ADC: integrations/builtin/app-nodes/n8n-nodes-base.netscaleradc.md - Nextcloud: integrations/builtin/app-nodes/n8n-nodes-base.nextcloud.md - NocoDB: integrations/builtin/app-nodes/n8n-nodes-base.nocodb.md - Notion: - Notion: integrations/builtin/app-nodes/n8n-nodes-base.notion/index.md - Common issues: integrations/builtin/app-nodes/n8n-nodes-base.notion/common-issues.md + - Notion Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.notiontrigger.md - npm: integrations/builtin/app-nodes/n8n-nodes-base.npm.md - Odoo: integrations/builtin/app-nodes/n8n-nodes-base.odoo.md - Okta: integrations/builtin/app-nodes/n8n-nodes-base.okta.md - One Simple API: integrations/builtin/app-nodes/n8n-nodes-base.onesimpleapi.md - Onfleet: integrations/builtin/app-nodes/n8n-nodes-base.onfleet.md + - Onfleet Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.onfleettrigger.md - OpenAI: - OpenAI: integrations/builtin/app-nodes/n8n-nodes-langchain.openai/index.md - Assistant operations: integrations/builtin/app-nodes/n8n-nodes-langchain.openai/assistant-operations.md @@ -458,34 +706,43 @@ nav: - Paddle: integrations/builtin/app-nodes/n8n-nodes-base.paddle.md - PagerDuty: integrations/builtin/app-nodes/n8n-nodes-base.pagerduty.md - PayPal: integrations/builtin/app-nodes/n8n-nodes-base.paypal.md + - PayPal Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.paypaltrigger.md - Peekalink: integrations/builtin/app-nodes/n8n-nodes-base.peekalink.md - PhantomBuster: integrations/builtin/app-nodes/n8n-nodes-base.phantombuster.md - Philips Hue: integrations/builtin/app-nodes/n8n-nodes-base.philipshue.md - Pipedrive: integrations/builtin/app-nodes/n8n-nodes-base.pipedrive.md + - Pipedrive Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.pipedrivetrigger.md - Plivo: integrations/builtin/app-nodes/n8n-nodes-base.plivo.md - PostBin: integrations/builtin/app-nodes/n8n-nodes-base.postbin.md - Postgres: - Postgres: integrations/builtin/app-nodes/n8n-nodes-base.postgres/index.md - Common issues: integrations/builtin/app-nodes/n8n-nodes-base.postgres/common-issues.md + - Postgres Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.postgrestrigger.md - PostHog: integrations/builtin/app-nodes/n8n-nodes-base.posthog.md + - Postmark Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.postmarktrigger.md - ProfitWell: integrations/builtin/app-nodes/n8n-nodes-base.profitwell.md - Pushbullet: integrations/builtin/app-nodes/n8n-nodes-base.pushbullet.md - Pushcut: integrations/builtin/app-nodes/n8n-nodes-base.pushcut.md + - Pushcut Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.pushcuttrigger.md - Pushover: integrations/builtin/app-nodes/n8n-nodes-base.pushover.md - QuestDB: integrations/builtin/app-nodes/n8n-nodes-base.questdb.md - Quick Base: integrations/builtin/app-nodes/n8n-nodes-base.quickbase.md - QuickBooks Online: integrations/builtin/app-nodes/n8n-nodes-base.quickbooks.md - QuickChart: integrations/builtin/app-nodes/n8n-nodes-base.quickchart.md - RabbitMQ: integrations/builtin/app-nodes/n8n-nodes-base.rabbitmq.md + - RabbitMQ Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.rabbitmqtrigger.md - Raindrop: integrations/builtin/app-nodes/n8n-nodes-base.raindrop.md - Reddit: integrations/builtin/app-nodes/n8n-nodes-base.reddit.md - Redis: integrations/builtin/app-nodes/n8n-nodes-base.redis.md + - Redis Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.redistrigger.md - Rocket.Chat: integrations/builtin/app-nodes/n8n-nodes-base.rocketchat.md - Rundeck: integrations/builtin/app-nodes/n8n-nodes-base.rundeck.md - S3: integrations/builtin/app-nodes/n8n-nodes-base.s3.md - Salesforce: integrations/builtin/app-nodes/n8n-nodes-base.salesforce.md + - Salesforce Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.salesforcetrigger.md - Salesmate: integrations/builtin/app-nodes/n8n-nodes-base.salesmate.md - SeaTable: integrations/builtin/app-nodes/n8n-nodes-base.seatable.md + - SeaTable Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.seatabletrigger.md - SecurityScorecard: integrations/builtin/app-nodes/n8n-nodes-base.securityscorecard.md - Segment: integrations/builtin/app-nodes/n8n-nodes-base.segment.md - SendGrid: integrations/builtin/app-nodes/n8n-nodes-base.sendgrid.md @@ -494,8 +751,10 @@ nav: - ServiceNow: integrations/builtin/app-nodes/n8n-nodes-base.servicenow.md - seven: integrations/builtin/app-nodes/n8n-nodes-base.sms77.md - Shopify: integrations/builtin/app-nodes/n8n-nodes-base.shopify.md + - Shopify Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.shopifytrigger.md - SIGNL4: integrations/builtin/app-nodes/n8n-nodes-base.signl4.md - Slack: integrations/builtin/app-nodes/n8n-nodes-base.slack.md + - Slack Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.slacktrigger.md - Snowflake: integrations/builtin/app-nodes/n8n-nodes-base.snowflake.md - Splunk: integrations/builtin/app-nodes/n8n-nodes-base.splunk.md - Spontit: integrations/builtin/app-nodes/n8n-nodes-base.spontit.md @@ -504,12 +763,16 @@ nav: - Storyblok: integrations/builtin/app-nodes/n8n-nodes-base.storyblok.md - Strapi: integrations/builtin/app-nodes/n8n-nodes-base.strapi.md - Strava: integrations/builtin/app-nodes/n8n-nodes-base.strava.md + - Strava Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.stravatrigger.md - Stripe: integrations/builtin/app-nodes/n8n-nodes-base.stripe.md + - Stripe Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.stripetrigger.md - Supabase: - Supabase: integrations/builtin/app-nodes/n8n-nodes-base.supabase/index.md - Common issues: integrations/builtin/app-nodes/n8n-nodes-base.supabase/common-issues.md + - SurveyMonkey Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.surveymonkeytrigger.md - SyncroMSP: integrations/builtin/app-nodes/n8n-nodes-base.syncromsp.md - Taiga: integrations/builtin/app-nodes/n8n-nodes-base.taiga.md + - Taiga Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.taigatrigger.md - Tapfiliate: integrations/builtin/app-nodes/n8n-nodes-base.tapfiliate.md - Telegram: - integrations/builtin/app-nodes/n8n-nodes-base.telegram/index.md @@ -518,155 +781,61 @@ nav: - File operations: integrations/builtin/app-nodes/n8n-nodes-base.telegram/file-operations.md - Message operations: integrations/builtin/app-nodes/n8n-nodes-base.telegram/message-operations.md - Common issues: integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md + - Telegram Trigger: + - Telegram Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md + - Common issues: integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/common-issues.md - TheHive: integrations/builtin/app-nodes/n8n-nodes-base.thehive.md + - TheHive Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.thehivetrigger.md - TheHive 5: integrations/builtin/app-nodes/n8n-nodes-base.thehive5.md + - TheHive 5 Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.thehive5trigger.md - TimescaleDB: integrations/builtin/app-nodes/n8n-nodes-base.timescaledb.md - Todoist: integrations/builtin/app-nodes/n8n-nodes-base.todoist.md + - Toggl Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.toggltrigger.md - Travis CI: integrations/builtin/app-nodes/n8n-nodes-base.travisci.md - Trello: integrations/builtin/app-nodes/n8n-nodes-base.trello.md + - Trello Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.trellotrigger.md - Twake: integrations/builtin/app-nodes/n8n-nodes-base.twake.md - Twilio: integrations/builtin/app-nodes/n8n-nodes-base.twilio.md + - Twilio Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.twiliotrigger.md - Twist: integrations/builtin/app-nodes/n8n-nodes-base.twist.md + - Typeform Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.typeformtrigger.md - Unleashed Software: integrations/builtin/app-nodes/n8n-nodes-base.unleashedsoftware.md - UpLead: integrations/builtin/app-nodes/n8n-nodes-base.uplead.md - uProc: integrations/builtin/app-nodes/n8n-nodes-base.uproc.md - UptimeRobot: integrations/builtin/app-nodes/n8n-nodes-base.uptimerobot.md - urlscan.io: integrations/builtin/app-nodes/n8n-nodes-base.urlscanio.md - Venafi TLS Protect Cloud: integrations/builtin/app-nodes/n8n-nodes-base.venafitlsprotectcloud.md + - Venafi TLS Protect Cloud Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.venafitlsprotectcloudtrigger.md - Venafi TLS Protect Datacenter: integrations/builtin/app-nodes/n8n-nodes-base.venafitlsprotectdatacenter.md - Vero: integrations/builtin/app-nodes/n8n-nodes-base.vero.md - Vonage: integrations/builtin/app-nodes/n8n-nodes-base.vonage.md + - Webex by Cisco: integrations/builtin/app-nodes/n8n-nodes-base.ciscowebex.md + - Webex by Cisco Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.ciscowebextrigger.md - Webflow: integrations/builtin/app-nodes/n8n-nodes-base.webflow.md + - Webflow Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.webflowtrigger.md - Wekan: integrations/builtin/app-nodes/n8n-nodes-base.wekan.md - WhatsApp Business Cloud: - WhatsApp Business Cloud: integrations/builtin/app-nodes/n8n-nodes-base.whatsapp/index.md - Common issues: integrations/builtin/app-nodes/n8n-nodes-base.whatsapp/common-issues.md + - WhatsApp Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.whatsapptrigger.md - Wise: integrations/builtin/app-nodes/n8n-nodes-base.wise.md + - Wise Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.wisetrigger.md - WooCommerce: integrations/builtin/app-nodes/n8n-nodes-base.woocommerce.md + - WooCommerce Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.woocommercetrigger.md - WordPress: integrations/builtin/app-nodes/n8n-nodes-base.wordpress.md + - Workable Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.workabletrigger.md + - Wufoo Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.wufootrigger.md - X (Formerly Twitter): integrations/builtin/app-nodes/n8n-nodes-base.twitter.md - Xero: integrations/builtin/app-nodes/n8n-nodes-base.xero.md - Yourls: integrations/builtin/app-nodes/n8n-nodes-base.yourls.md - YouTube: integrations/builtin/app-nodes/n8n-nodes-base.youtube.md - Zammad: integrations/builtin/app-nodes/n8n-nodes-base.zammad.md - Zendesk: integrations/builtin/app-nodes/n8n-nodes-base.zendesk.md + - Zendesk Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.zendesktrigger.md - Zoho CRM: integrations/builtin/app-nodes/n8n-nodes-base.zohocrm.md - Zoom: integrations/builtin/app-nodes/n8n-nodes-base.zoom.md - Zulip: integrations/builtin/app-nodes/n8n-nodes-base.zulip.md - - Triggers: - - integrations/builtin/trigger-nodes/index.md - - ActiveCampaign Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.activecampaigntrigger.md - - Acuity Scheduling Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.acuityschedulingtrigger.md - - Affinity Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.affinitytrigger.md - - Airtable Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.airtabletrigger.md - - AMQP Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.amqptrigger.md - - Asana Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.asanatrigger.md - - Autopilot Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.autopilottrigger.md - - AWS SNS Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.awssnstrigger.md - - Bitbucket Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.bitbuckettrigger.md - - Box Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.boxtrigger.md - - Brevo Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.brevotrigger.md - - Calendly Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.calendlytrigger.md - - Cal Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.caltrigger.md - - Chargebee Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.chargebeetrigger.md - - ClickUp Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.clickuptrigger.md - - Clockify Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.clockifytrigger.md - - ConvertKit Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.convertkittrigger.md - - Copper Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.coppertrigger.md - - crowd.dev Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.crowddevtrigger.md - - Customer.io Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.customeriotrigger.md - - Emelia Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.emeliatrigger.md - - Eventbrite Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.eventbritetrigger.md - - Facebook Lead Ads Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.facebookleadadstrigger.md - - Facebook Trigger: - - Facebook Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/index.md - - Ad Account: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/ad-account.md - - Application: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/application.md - - Certificate Transparency: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/certificate-transparency.md - - Group: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/group.md - - Instagram: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/instagram.md - - Link: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/link.md - - Page: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/page.md - - Permissions: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/permissions.md - - User: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/user.md - - WhatsApp Business Account: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/whatsapp.md - - Workplace Security: integrations/builtin/trigger-nodes/n8n-nodes-base.facebooktrigger/workplace-security.md - - Figma Trigger (Beta): integrations/builtin/trigger-nodes/n8n-nodes-base.figmatrigger.md - - Flow Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.flowtrigger.md - - Form.io Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.formiotrigger.md - - Formstack Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.formstacktrigger.md - - GetResponse Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.getresponsetrigger.md - - GitHub Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.githubtrigger.md - - GitLab Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.gitlabtrigger.md - - Gmail Trigger: - - integrations/builtin/trigger-nodes/n8n-nodes-base.gmailtrigger/index.md - - Poll Mode options: integrations/builtin/trigger-nodes/n8n-nodes-base.gmailtrigger/poll-mode-options.md - - Common issues: integrations/builtin/trigger-nodes/n8n-nodes-base.gmailtrigger/common-issues.md - - Google Calendar Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.googlecalendartrigger.md - - Google Drive Trigger: - - Google Drive Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.googledrivetrigger/index.md - - Common issues: integrations/builtin/trigger-nodes/n8n-nodes-base.googledrivetrigger/common-issues.md - - Google Business Profile Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.googlebusinessprofiletrigger.md - - Google Sheets Trigger: - - Google Sheets Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.googlesheetstrigger/index.md - - Common issues: integrations/builtin/trigger-nodes/n8n-nodes-base.googlesheetstrigger/common-issues.md - - Gumroad Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.gumroadtrigger.md - - Help Scout Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.helpscouttrigger.md - - Hubspot Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.hubspottrigger.md - - Invoice Ninja Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.invoiceninjatrigger.md - - Jira Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.jiratrigger.md - - JotForm Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.jotformtrigger.md - - Kafka Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.kafkatrigger.md - - Keap Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.keaptrigger.md - - KoboToolbox Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.kobotoolboxtrigger.md - - Lemlist Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.lemlisttrigger.md - - Linear Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.lineartrigger.md - - LoneScale Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.lonescaletrigger.md - - Mailchimp Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.mailchimptrigger.md - - MailerLite Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.mailerlitetrigger.md - - Mailjet Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.mailjettrigger.md - - Mautic Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.mautictrigger.md - - Microsoft OneDrive Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.microsoftonedrivetrigger.md - - Microsoft Outlook Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.microsoftoutlooktrigger.md - - MQTT Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.mqtttrigger.md - - Netlify Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.netlifytrigger.md - - Notion Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.notiontrigger.md - - Onfleet Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.onfleettrigger.md - - PayPal Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.paypaltrigger.md - - Pipedrive Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.pipedrivetrigger.md - - Postgres Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.postgrestrigger.md - - Postmark Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.postmarktrigger.md - - Pushcut Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.pushcuttrigger.md - - RabbitMQ Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.rabbitmqtrigger.md - - Redis Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.redistrigger.md - - Salesforce Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.salesforcetrigger.md - - SeaTable Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.seatabletrigger.md - - Shopify Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.shopifytrigger.md - - Slack Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.slacktrigger.md - - Strava Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.stravatrigger.md - - Stripe Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.stripetrigger.md - - SurveyMonkey Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.surveymonkeytrigger.md - - Taiga Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.taigatrigger.md - - Telegram Trigger: - - Telegram Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md - - Common issues: integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/common-issues.md - - TheHive 5 Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.thehive5trigger.md - - TheHive Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.thehivetrigger.md - - Toggl Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.toggltrigger.md - - Trello Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.trellotrigger.md - - Twilio Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.twiliotrigger.md - - Typeform Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.typeformtrigger.md - - Venafi TLS Protect Cloud Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.venafitlsprotectcloudtrigger.md - - Webex by Cisco Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.ciscowebextrigger.md - - Webflow Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.webflowtrigger.md - - WhatsApp Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.whatsapptrigger.md - - Wise Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.wisetrigger.md - - WooCommerce Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.woocommercetrigger.md - - Workable Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.workabletrigger.md - - Wufoo Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.wufootrigger.md - - Zendesk Trigger: integrations/builtin/trigger-nodes/n8n-nodes-base.zendesktrigger.md - Cluster nodes: - - integrations/builtin/cluster-nodes/index.md - Root nodes: - integrations/builtin/cluster-nodes/root-nodes/index.md - AI Agent: @@ -756,8 +925,9 @@ nav: - Wikipedia: integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolwikipedia.md - Wolfram|Alpha: integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolwolframalpha.md - Custom n8n Workflow Tool: integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow.md - - Credentials: - - integrations/builtin/credentials/index.md + - Credentials: + - Overview: integrations/builtin/credentials/overview.md + - Built-in credentials: - integrations/builtin/credentials/actionnetwork.md - integrations/builtin/credentials/activecampaign.md - integrations/builtin/credentials/acuityscheduling.md @@ -1065,222 +1235,91 @@ nav: - integrations/builtin/credentials/zoom.md - integrations/builtin/credentials/zscalerzia.md - integrations/builtin/credentials/zulip.md - - Custom API actions for existing nodes: integrations/custom-operations.md - - Handle rate limits: integrations/builtin/rate-limits.md - - Community nodes: - - Installation and management: - - integrations/community-nodes/installation/index.md - - GUI installation: integrations/community-nodes/installation/gui-install.md - - Manual installation: integrations/community-nodes/installation/manual-install.md - - Risks: integrations/community-nodes/risks.md - - Blocklist: integrations/community-nodes/blocklist.md - - Using community nodes: integrations/community-nodes/usage.md - - Troubleshooting: integrations/community-nodes/troubleshooting.md - - Building community nodes: integrations/community-nodes/build-community-nodes.md - - Creating nodes: - - Overview: integrations/creating-nodes/overview.md - - Plan your node: - - integrations/creating-nodes/plan/index.md - - Choose a node type: integrations/creating-nodes/plan/node-types.md - - Choose a node building style: integrations/creating-nodes/plan/choose-node-method.md - - Node UI design: integrations/creating-nodes/plan/node-ui-design.md - - Choose node file structure: integrations/creating-nodes/build/reference/node-file-structure.md - - Build your node: - - integrations/creating-nodes/build/index.md - - Set up your development environment: integrations/creating-nodes/build/node-development-environment.md - - "Tutorial: Build a declarative-style node": integrations/creating-nodes/build/declarative-style-node.md - - "Tutorial: Build a programmatic-style node": integrations/creating-nodes/build/programmatic-style-node.md - - Reference: - - integrations/creating-nodes/build/reference/index.md - - Node UI elements: integrations/creating-nodes/build/reference/ui-elements.md - - Code standards: integrations/creating-nodes/build/reference/code-standards.md - - Versioning: integrations/creating-nodes/build/reference/node-versioning.md - - File structure: integrations/creating-nodes/build/reference/node-file-structure.md - - Base files: - - integrations/creating-nodes/build/reference/node-base-files/index.md - - Structure: integrations/creating-nodes/build/reference/node-base-files/structure.md - - Standard parameters: integrations/creating-nodes/build/reference/node-base-files/standard-parameters.md - - Declarative-style parameters: integrations/creating-nodes/build/reference/node-base-files/declarative-style-parameters.md - - Programmatic-style parameters: integrations/creating-nodes/build/reference/node-base-files/programmatic-style-parameters.md - - Programmatic-style execute method: integrations/creating-nodes/build/reference/node-base-files/programmatic-style-execute-method.md - - Codex files: integrations/creating-nodes/build/reference/node-codex-files.md - - Credentials files: integrations/creating-nodes/build/reference/credentials-files.md - - HTTP request helpers: integrations/creating-nodes/build/reference/http-helpers.md - - Item linking: integrations/creating-nodes/build/reference/paired-items.md - - Test your node: - - integrations/creating-nodes/test/index.md - - Run your node locally: integrations/creating-nodes/test/run-node-locally.md - - Node linter: integrations/creating-nodes/test/node-linter.md - - Troubleshooting: integrations/creating-nodes/test/troubleshooting-node-development.md - - Deploy your node: - - integrations/creating-nodes/deploy/index.md - - Submit community nodes: integrations/creating-nodes/deploy/submit-community-nodes.md - - Install private nodes: integrations/creating-nodes/deploy/install-private-nodes.md - - Hosting n8n: - - Overview: hosting/index.md - - Community vs Enterprise: hosting/community-edition-features.md - - Installation: - - npm: hosting/installation/npm.md - - Docker: hosting/installation/docker.md - - Server setups: - - hosting/installation/server-setups/index.md - - Digital Ocean: hosting/installation/server-setups/digital-ocean.md - - Heroku: hosting/installation/server-setups/heroku.md - - Hetzner: hosting/installation/server-setups/hetzner.md - - Amazon Web Services: hosting/installation/server-setups/aws.md - - Azure: hosting/installation/server-setups/azure.md - - Google Cloud: hosting/installation/server-setups/google-cloud.md - - Docker Compose: hosting/installation/server-setups/docker-compose.md - - Updating: hosting/installation/updating.md - - Configuration: - - Environment variables: - - Environment variables overview : hosting/configuration/environment-variables/index.md - - Binary data: hosting/configuration/environment-variables/binary-data.md - - Credentials: hosting/configuration/environment-variables/credentials.md - - Database: hosting/configuration/environment-variables/database.md - - Deployment: hosting/configuration/environment-variables/deployment.md - - Endpoints: hosting/configuration/environment-variables/endpoints.md - - Executions: hosting/configuration/environment-variables/executions.md - - External data storage: hosting/configuration/environment-variables/external-data-storage.md - - External hooks: hosting/configuration/environment-variables/external-hooks.md - - External secrets: hosting/configuration/environment-variables/external-secrets.md - - Logs: hosting/configuration/environment-variables/logs.md - - License: hosting/configuration/environment-variables/licenses.md - - Nodes: hosting/configuration/environment-variables/nodes.md - - Queue mode: hosting/configuration/environment-variables/queue-mode.md - - Security: hosting/configuration/environment-variables/security.md - - Source control: hosting/configuration/environment-variables/source-control.md - - Task runners: hosting/configuration/environment-variables/task-runners.md - - Timezone and localization: hosting/configuration/environment-variables/timezone-localization.md - - User management and 2FA: hosting/configuration/environment-variables/user-management-smtp-2fa.md - - Workflows: hosting/configuration/environment-variables/workflows.md - - Configuration methods: hosting/configuration/configuration-methods.md - - Configuration examples: - - hosting/configuration/configuration-examples/index.md - - Isolate n8n: hosting/configuration/configuration-examples/isolation.md - - Configure the Base URL: hosting/configuration/configuration-examples/base-url.md - - Configure custom SSL certificate authorities: hosting/configuration/configuration-examples/custom-certificate-authority.md - - Set a custom encryption key: hosting/configuration/configuration-examples/encryption-key.md - - Configure workflow timeouts: hosting/configuration/configuration-examples/execution-timeout.md - - Specify custom nodes location: hosting/configuration/configuration-examples/custom-nodes-location.md - - Enable modules in Code node: hosting/configuration/configuration-examples/modules-in-code-node.md - - Set the timezone: hosting/configuration/configuration-examples/time-zone.md - - Specify user folder path: hosting/configuration/configuration-examples/user-folder.md - - Configure webhook URLs with reverse proxy: hosting/configuration/configuration-examples/webhook-url.md - - Enable Prometheus metrics: hosting/configuration/configuration-examples/prometheus.md - - Supported databases and settings: hosting/configuration/supported-databases-settings.md - - Task runners: hosting/configuration/task-runners.md - - User management: hosting/configuration/user-management-self-hosted.md - - Logging and monitoring: - - Logging: hosting/logging-monitoring/logging.md - - Monitoring: hosting/logging-monitoring/monitoring.md - - Security audit: hosting/securing/security-audit.md - - Scaling and performance: - - Overview: hosting/scaling/overview.md - - Performance and benchmarking: hosting/scaling/performance-benchmarking.md - - Configuring queue mode: hosting/scaling/queue-mode.md - - Concurrency control: hosting/scaling/concurrency-control.md - - Execution data: hosting/scaling/execution-data.md - - Binary data: hosting/scaling/binary-data.md - - External storage for binary data: hosting/scaling/external-storage.md - - Memory-related errors: hosting/scaling/memory-errors.md - - Securing n8n: - - Overview: hosting/securing/overview.md - - Set up SSL: hosting/securing/set-up-ssl.md - - Set up SSO: hosting/securing/set-up-sso.md - - Security audit: hosting/securing/security-audit.md - - Disable the API: hosting/securing/disable-public-api.md - - Opt out of data collection: hosting/securing/telemetry-opt-out.md - - Blocking nodes: hosting/securing/blocking-nodes.md - - Hardening task runners: hosting/securing/hardening-task-runners.md - - Starter Kits: - - AI Starter Kit: hosting/starter-kits/ai-starter-kit.md + - User management: + - Account types: user-management/account-types.md + - Role types: user-management/rbac/role-types.md - Architecture: - Overview: hosting/architecture/overview.md - Database structure: hosting/architecture/database-structure.md - - Using the CLI: - - CLI commands: hosting/cli-commands.md - - Code in n8n: - - code/index.md - - Expressions: code/expressions.md - - Using the Code node: code/code-node.md - - AI coding: code/ai-code.md - - Built in methods and variables: - - Overview: code/builtin/overview.md - - Current node input: code/builtin/current-node-input.md - - Output of other nodes: code/builtin/output-other-nodes.md - - Date and time: code/builtin/date-time.md - - JMESPath: code/builtin/jmespath.md - - HTTP node: code/builtin/http-node-variables.md - - LangChain Code node: code/builtin/langchain-methods.md - - n8n metadata: code/builtin/n8n-metadata.md - - Convenience methods: code/builtin/convenience.md - - Data transformation functions: - - code/builtin/data-transformation-functions/index.md - - Arrays: code/builtin/data-transformation-functions/arrays.md - - Booleans: code/builtin/data-transformation-functions/booleans.md - - Dates: code/builtin/data-transformation-functions/dates.md - - Numbers: code/builtin/data-transformation-functions/numbers.md - - Objects: code/builtin/data-transformation-functions/objects.md - - Strings: code/builtin/data-transformation-functions/strings.md - - Custom variables: - - Create custom variables: code/variables.md - - Cookbook: - - Handling dates: code/cookbook/luxon.md - - Query JSON with JMESPath: code/cookbook/jmespath.md - - Built-in methods and variables examples: - - code/cookbook/builtin/index.md - - execution: code/cookbook/builtin/execution.md - - getWorkflowStaticData: code/cookbook/builtin/get-workflow-static-data.md - - Retrieve linked items from earlier in the workflow: code/cookbook/builtin/itemmatching.md - - (node-name).all: code/cookbook/builtin/all.md - - vars: code/cookbook/builtin/vars.md - - Expressions: - - code/cookbook/expressions/index.md - - Check incoming data: code/cookbook/expressions/check-incoming-data.md - - Common issues: code/cookbook/expressions/common-issues.md - - Code node: - - code/cookbook/code-node/index.md - - Get number of items returned by last node: code/cookbook/code-node/number-items-last-node.md - - Get the binary data buffer: code/cookbook/code-node/get-binary-data-buffer.md - - Output to the browser console: code/cookbook/code-node/console-log.md - - HTTP Request node: - - code/cookbook/http-node/index.md - - Pagination: code/cookbook/http-node/pagination.md - - Advanced AI: - - advanced-ai/index.md - - "Tutorial: Build an AI workflow in n8n": advanced-ai/intro-tutorial.md - - LangChain in n8n: - - Overview: advanced-ai/langchain/overview.md - - Langchain concepts in n8n: advanced-ai/langchain/langchain-n8n.md - - LangChain learning resources: advanced-ai/langchain/langchain-learning-resources.md - - Use LangSmith with n8n: advanced-ai/langchain/langsmith.md - - Examples and concepts: - - Introduction: advanced-ai/examples/introduction.md - - What is a chain?: advanced-ai/examples/understand-chains.md - - What is an agent?: advanced-ai/examples/understand-agents.md - - Agents vs chains example: advanced-ai/examples/agent-chain-comparison.md - - What is memory?: advanced-ai/examples/understand-memory.md - - What is a tool?: advanced-ai/examples/understand-tools.md - - Use Google Sheets as a data source: advanced-ai/examples/data-google-sheets.md - - Call an API to fetch data: advanced-ai/examples/api-workflow-tool.md - - Set a human fallback for AI workflows: advanced-ai/examples/human-fallback.md - - Let AI specify tool parameters: advanced-ai/examples/using-the-fromai-function.md - - What is a vector database?: advanced-ai/examples/understand-vector-databases.md - - Populate a Pinecone vector database from a website: advanced-ai/examples/vector-store-website.md - - API: - - api/index.md - - Authentication: api/authentication.md - - Pagination: api/pagination.md - - Using the API playground: api/using-api-playground.md + - Data: + - Overview: data/overview.md + - Data structure: data/data-structure.md + - Binary data: data/binary-data.md + - Methods and variables: + - Overview: code/builtin/overview.md + - Current node input: code/builtin/current-node-input.md + - Output of other nodes: code/builtin/output-other-nodes.md + - Date and time: code/builtin/date-time.md + - JMESPath: code/builtin/jmespath.md + - HTTP node: code/builtin/http-node-variables.md + - LangChain Code node: code/builtin/langchain-methods.md + - n8n metadata: code/builtin/n8n-metadata.md + - Convenience methods: code/builtin/convenience.md + - Data transformation functions: + - code/builtin/data-transformation-functions/index.md + - Arrays: code/builtin/data-transformation-functions/arrays.md + - Booleans: code/builtin/data-transformation-functions/booleans.md + - Dates: code/builtin/data-transformation-functions/dates.md + - Numbers: code/builtin/data-transformation-functions/numbers.md + - Objects: code/builtin/data-transformation-functions/objects.md + - Strings: code/builtin/data-transformation-functions/strings.md + - Examples: + - execution: code/cookbook/builtin/execution.md + - getWorkflowStaticData: code/cookbook/builtin/get-workflow-static-data.md + - (node-name).all: code/cookbook/builtin/all.md + - vars: code/cookbook/builtin/vars.md + - API: + - Overview: api/overview.md - API reference: api/api-reference.md - - Embed: - - embed/index.md - - Prerequisites: embed/prerequisites.md - - Deployment: embed/deployment.md - - Configuration: embed/configuration.md - - Workflow management: embed/managing-workflows.md - - Workflows templates: embed/workflow-templates.md - - White labelling: embed/white-labelling.md + - Releases: + - Release notes: + - 1.x: release-notes.md + - 0.x: release-notes/0-x.md + - v1.0 migration guide: 1-0-migration-checklist.md + - Licenses and privacy: + - Privacy and security: + - privacy-security/index.md + - Privacy: privacy-security/privacy.md + - Security: https://n8n.io/legal/#security + - Incident response: privacy-security/incident-response.md + - What you can do: privacy-security/what-you-can-do.md + - Sustainable use license: sustainable-use-license.md + # - Feature tests: # - Main features: docs-site-feature-tests/index.md +exclude_docs: | + /learning-path.md + /placeholder.md + /code/index.md + /code/code-node.md + /code/cookbook/builtin/index.md + /code/cookbook/http-node/index.md + /courses/index.md + /data/code.md + /hosting/community-edition-features.md + /hosting/configuration/environment-variables/binary-data.md + /hosting/configuration/environment-variables/credentials.md + /hosting/configuration/environment-variables/database.md + /hosting/configuration/environment-variables/deployment.md + /hosting/configuration/environment-variables/endpoints.md + /hosting/configuration/environment-variables/executions.md + /hosting/configuration/environment-variables/external-data-storage.md + /hosting/configuration/environment-variables/external-hooks.md + /hosting/configuration/environment-variables/external-secrets.md + /hosting/configuration/environment-variables/licenses.md + /hosting/configuration/environment-variables/logs.md + /hosting/configuration/environment-variables/nodes.md + /hosting/configuration/environment-variables/overview.md + /hosting/configuration/environment-variables/queue-mode.md + /hosting/configuration/environment-variables/security.md + /hosting/configuration/environment-variables/source-control.md + /hosting/configuration/environment-variables/task-runners.md + /hosting/configuration/environment-variables/timezone-localization.md + /hosting/configuration/environment-variables/user-management-smtp-2fa.md + /hosting/configuration/environment-variables/workflows.md + /integrations/builtin/trigger-nodes/index.md + /workflows/components/index.md + /understanding/nodes.md + /hosting/installation/updating.md + + #not_in_nav: | diff --git a/styles/config/vocabularies/default/accept.txt b/styles/config/vocabularies/default/accept.txt index c4594061c0e..495f90f1bb7 100644 --- a/styles/config/vocabularies/default/accept.txt +++ b/styles/config/vocabularies/default/accept.txt @@ -1,6 +1,6 @@ ABCorp Adalo -[Aa]ddon +[Aa]ddons? [Aa]gent [Aa]ggregate Airtable @@ -11,9 +11,11 @@ ARNs Asana Atlassian Authentik +[Aa]uthkeys? [Aa]uto-fixing +[Aa]utomations Automizy -[Aa]utorenew +[Aa]utorenew(al)? Axios Backblaze [Bb]ackend @@ -27,7 +29,7 @@ Bing Bitly Bitwarden blockquote -[Bb]oolean +[Bb]ooleans? [Bb]orderless bot Brandfetch @@ -36,11 +38,11 @@ buildpack [Bb]urstable Caddy Calendly -[Cc]allout +[Cc]allouts? Capterra cartesian Chargebee -[Cc]hatbot +[Cc]hatbots? Citrix Clearbit Clockify @@ -48,15 +50,19 @@ Codecademy commenters? Cohere Combinator +[Cc]onfig Contentful ConvertKit CPU CPython -CRM +CRMs? Cron [Cc]rypto +[Cc]ryptocurrenc(y|ies) +[Cc]ybersecurity Datadog Datastore +datetime [Dd]edupe [Dd]eduplication DeepL @@ -102,12 +108,13 @@ Homeserver [Hh]ostname HubSpot Humantic +iCalendar Imperva indexable invalid Infisical Intuit -IP +IPs? [Ii]terable Jira JMESPath @@ -123,6 +130,7 @@ Lenovo LLMs? Luhn Luxon +Magento [Mm]agnetopause Mailcheck Mailchimp @@ -141,10 +149,10 @@ Mindee [Mm]inimum Mocean Motorhead -[Mm]ultiple +[Mm]ultimodal n8n nanoids -namespace +[Nn]amespaces? NASA Netlify Netscaler @@ -155,6 +163,7 @@ Nodelinter npm NPM npx +[Nn]ullish OAuth Odoo Okta @@ -173,11 +182,12 @@ Pipedrive Pinecone Plivo Pluralsight +[Pp]ollers? Postbin Postgres PostHog [Pp]refilled -[Pp]repopulate +[Pp]repopulate[sd]? [Pp]roxying Pushbullet Pushcut @@ -189,6 +199,7 @@ Qualys Realtime Rekognition requester +reusability Rundeck Salesmate [Ss]andboxed @@ -199,6 +210,7 @@ Serp sheetId [Ss]hopify signup +Slackbots? Splunk Spontit Spotify @@ -209,10 +221,12 @@ Storyblok Strapi Strava strikethrough -[Ss]ubfolder -sublist -[Ss]ubreddit -[Ss]ubtask +[Ss]ubaccounts? +[Ss]ubfolders? +[Ss]ublists? +[Ss]ubreddits? +[Ss]ubtasks? +[Ss]ubtrees? Supabase [Ss]ysdig [Ss]yslog @@ -222,7 +236,7 @@ There are [Tt]imesheet Todoist Toggl -[Tt]ooltip +[Tt]ooltips? [Tt]ouchpad Traefik Trellix @@ -246,10 +260,12 @@ uProc URI URIs URL +[Vv]alidator +VCert Venafi VERO Vhost -VM +VMs? Vonage Vuex Wasabi's @@ -262,6 +278,7 @@ WordPress Wufoo Xata Xero +Yourls Zabbix Zammad Zapier @@ -269,3 +286,4 @@ Zendesk Zep Zoho Zscaler +Zulip