Showing the first 18000 characters. Load the complete file to read the remainder.
# n8n Docs
## Get started
- [n8n Docs](https://docs.n8n.io/welcome.md): Get set up on n8n, build your first workflow, and find inspiration for what to automate.
- [Choose how to use n8n](https://docs.n8n.io/choose-how-to-use-n8n.md): Choose between n8n Cloud and self-hosting, and learn about licenses and plans.
- [Build your first workflow](https://docs.n8n.io/build-your-first-workflow.md): Create your first workflow in n8n and learn some key concepts.
- [Learning paths](https://docs.n8n.io/learning-paths.md): Interactive courses to learn n8n through hands-on exercises, quizzes, and real workflow building.
- [Key concept glossary](https://docs.n8n.io/key-concept-glossary.md): Definitions of the terms n8n uses for workflows, agents, AI, and hosting, with links to the pages that explain each concept.
## Deploy
- [Deploy](https://docs.n8n.io/deploy/readme.md): Deploy n8n on n8n Cloud or self-host it, and find guides for installing, configuring, and maintaining your instance.
- [Use n8n Cloud](https://docs.n8n.io/deploy/use-n8n-cloud.md): Manage your n8n Cloud trial, plan, and instance, including the n8n Cloud console and updates.
- [Try free then choose a plan](https://docs.n8n.io/deploy/use-n8n-cloud/start-your-free-trial.md): Start a free n8n Cloud trial, then compare the Starter, Pro, and Enterprise plans to choose the right one.
- [Use the Cloud console](https://docs.n8n.io/deploy/use-n8n-cloud/use-the-cloud-console.md): How to open and find your way around the n8n Cloud console, where instance owners manage their n8n Cloud instance, plan, and credits.
- [Update your version](https://docs.n8n.io/deploy/use-n8n-cloud/update-your-version.md): How to update your n8n version on Cloud.
- [Configure Cloud](https://docs.n8n.io/deploy/use-n8n-cloud/configure-cloud.md)
- [Set your timezone](https://docs.n8n.io/deploy/use-n8n-cloud/configure-cloud/set-your-timezone.md): How to set your timezone on n8n Cloud.
- [Find your IP addresses](https://docs.n8n.io/deploy/use-n8n-cloud/configure-cloud/find-your-ip-addresses.md)
- [Manage your data](https://docs.n8n.io/deploy/use-n8n-cloud/configure-cloud/manage-your-data.md): How to manage your data on n8n Cloud.
- [Change instance ownership or username](https://docs.n8n.io/deploy/use-n8n-cloud/configure-cloud/change-instance-ownership-or-username.md)
- [Understand concurrency](https://docs.n8n.io/deploy/use-n8n-cloud/understand-concurrency.md)
- [Gateway credits](https://docs.n8n.io/deploy/use-n8n-cloud/gateway-credits.md): Use Gateway credits to run AI models and third-party services in your n8n workflows without provider accounts or API keys.
- [Top up Gateway credits](https://docs.n8n.io/deploy/use-n8n-cloud/gateway-credits/top-up-gateway-credits.md): Add credit to your Gateway credits balance manually or with auto top-up in the n8n Cloud console.
- [Track Gateway credit spend](https://docs.n8n.io/deploy/use-n8n-cloud/gateway-credits/track-gateway-credit-spend.md): Monitor your Gateway credits balance, spend by model or workflow, and top-up history in the n8n Cloud console.
- [Assistant credits](https://docs.n8n.io/deploy/use-n8n-cloud/assistant-credits.md): Understand Assistant credits: the monthly allowance included in your n8n Cloud plan, extra credits, and how n8n bills your n8n Assistant usage.
- [Top up Assistant credits](https://docs.n8n.io/deploy/use-n8n-cloud/assistant-credits/top-up-assistant-credits.md): Buy extra Assistant credits manually or with auto top-up in the n8n Cloud console, so you can keep using n8n Assistant after your monthly allowance runs out.
- [Track Assistant credit spend](https://docs.n8n.io/deploy/use-n8n-cloud/assistant-credits/track-assistant-credit-spend.md): Monitor your Assistant credit balance, spend, top users, and top-up history in the n8n Cloud console and the n8n Assistant panel.
- [Download workflows](https://docs.n8n.io/deploy/use-n8n-cloud/download-workflows.md): How to download workflows from an n8n Cloud backup in the n8n Cloud console.
- [Host n8n](https://docs.n8n.io/deploy/host-n8n.md): Access n8n hosting documentation and guides for setting up and managing self-hosted n8n instances.
- [Install options](https://docs.n8n.io/deploy/host-n8n/install-options.md): Compare ways to install self-hosted n8n, including one-line setup, Docker, Docker Compose, npm, and cloud providers.
- [One-line setup](https://docs.n8n.io/deploy/host-n8n/install-options/one-line-setup.md): Install n8n from the command line using a one-line setup.
- [Install using Docker Compose](https://docs.n8n.io/deploy/host-n8n/install-options/install-using-docker-compose.md): Build a Docker Compose setup for self-hosted n8n, including the sandbox stack for n8n Assistant.
- [Install with npm](https://docs.n8n.io/deploy/host-n8n/install-options/install-with-npm.md)
- [Install with Docker](https://docs.n8n.io/deploy/host-n8n/install-options/install-with-docker.md)
- [Use a cloud provider](https://docs.n8n.io/deploy/host-n8n/install-options/use-a-cloud-provider.md): Deploy self-hosted n8n to a cloud provider, including DigitalOcean, AWS, Azure, and Google Cloud.
- [Deploy to Digital Ocean](https://docs.n8n.io/deploy/host-n8n/install-options/use-a-cloud-provider/deploy-to-digital-ocean.md)
- [Deploy to Heroku](https://docs.n8n.io/deploy/host-n8n/install-options/use-a-cloud-provider/deploy-to-heroku.md)
- [Deploy to Hetzner](https://docs.n8n.io/deploy/host-n8n/install-options/use-a-cloud-provider/deploy-to-hetzner.md)
- [Deploy to AWS](https://docs.n8n.io/deploy/host-n8n/install-options/use-a-cloud-provider/deploy-to-aws.md)
- [Deploy to Azure](https://docs.n8n.io/deploy/host-n8n/install-options/use-a-cloud-provider/deploy-to-azure.md)
- [Deploy to Google Cloud Run](https://docs.n8n.io/deploy/host-n8n/install-options/use-a-cloud-provider/deploy-to-google-cloud-run.md)
- [Deploy to Google Kubernetes](https://docs.n8n.io/deploy/host-n8n/install-options/use-a-cloud-provider/deploy-to-google-kubernetes.md)
- [Deploy to OpenShift Local (CRC)](https://docs.n8n.io/deploy/host-n8n/install-options/use-a-cloud-provider/deploy-to-openshift-local-crc.md)
- [Use Docker Compose](https://docs.n8n.io/deploy/host-n8n/install-options/use-a-cloud-provider/use-docker-compose.md): Install and run n8n using Docker Compose
- [Configure n8n](https://docs.n8n.io/deploy/host-n8n/configure-n8n.md): Configure a self-hosted n8n instance, including database, security, scaling, and license settings.
- [Basic configuration](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration.md): How to set environment variables for n8n.
- [Use environment variables](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables.md): An overview of configuration environment variables for self-hosted n8n.
- [Ask n8n AI](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/ai-assistant.md): Environment variables to configure Ask n8n AI.
- [Binary data](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/binary-data.md): Customize binary data storage modes and paths with environment variables for your self-hosted n8n instance.
- [Credentials](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/credentials.md): Manage default credentials and override them through environment variables your self-hosted n8n instance.
- [Database](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/database.md): Set up and configure databases with environment variables for your self-hosted n8n instance.
- [Deployment](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/deployment.md): Configure deployment options and application accessibility with environment variables for your self-hosted n8n instance.
- [Endpoints](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/endpoints.md): Customize the application's API and webhook endpoints with environment variables for your self-hosted n8n instance.
- [Executions](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/executions.md): Environment variables to configure settings related to workflow executions.
- [Expression engine](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/expression-engine.md): Choose the expression engines for the n8n backend and editor, and configure the sandbox pool for your self-hosted n8n instance.
- [External data storage](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/external-data-storage.md): Environment variables to configure external data storage for your self-hosted n8n instance.
- [External hooks](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/external-hooks.md): Environment variables to integrate external hooks into your self-hosted n8n instance.
- [External secrets](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/external-secrets.md): Configure the update interval and the connect and refresh timeouts for external secrets in a self-hosted n8n instance.
- [Insights](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/insights.md): Configure insights metrics collection with environment variables for your self-hosted n8n instance.
- [Logs](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/logs.md): Environment variables to configure logging and diagnostic data.
- [License](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/license.md): Environment variables to configure license settings in n8n, including options to hide the usage page, manage license activation and auto-renewal settings, and specify the server URL for license retrie
- [Nodes](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/nodes.md): Environment variables to configure nodes management and node-specific limits in self-hosted n8n.
- [OpenTelemetry](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/opentelemetry.md): Configure OpenTelemetry tracing with environment variables for your self-hosted n8n instance.
- [Queue mode](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/queue-mode.md): Environment variables to configure queue mode on your self-hosted n8n instance.
- [Scheduler](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/scheduler.md): Environment variables to configure the durable scheduler for your self-hosted n8n instance.
- [Security](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/security.md): Configure authentication and environment variable access in self-hosted n8n instance.
- [Source control](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/source-control.md): Environment variable to set the default SSH key type for source control setup.
- [SSO](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/sso.md): Configure single sign-on for self-hosted n8n using environment variables.
- [SSRF protection](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/ssrf-protection.md): Configure SSRF protection for your self-hosted n8n instance.
- [Task runners](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/task-runners.md): Environment variables to confgure task runners your self-hosted n8n instance.
- [Timezone and localization](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/timezone-and-localization.md): Set the timezone and default language locale for self-hosted n8n instance.
- [User management and 2FA](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/user-management-and-2fa.md): Environment variables to set up user management and emails.
- [Workflows](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/workflows.md): Environment variables to configure workflows in n8n, including default naming, onboarding flow preferences, tag management, and caller policy settings.
- [Workflow history](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/use-environment-variables/workflow-history.md): Environment variables to configure workflow history in n8n.
- [Configuration examples](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/configuration-examples.md): An overview containing different configuration examples.
- [Isolate n8n](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/configuration-examples/isolate-n8n.md): Prevent your n8n instance from connecting with n8n's servers.
- [Configure the Base URL](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/configuration-examples/configure-the-base-url.md): Configure the Base URL environment variable to define the front end's access path to the back end's REST API for n8n.
- [Configure custom SSL certificate authorities](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/configuration-examples/configure-custom-ssl-certificate-authorities.md): Customize the n8n container to work with self signed certificates when connecting to services.
- [Set a custom encryption key](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/configuration-examples/set-a-custom-encryption-key.md): Set a custom encryption key for n8n to securely encrypt credentials.
- [Configure workflow timeouts](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/configuration-examples/configure-workflow-timeouts.md): Set execution timeouts to determine how long workflows can run.
- [Specify custom nodes location](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/configuration-examples/specify-custom-nodes-location.md): Add folders and specify paths for your custom nodes.
- [Enable modules in Code node](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/configuration-examples/enable-modules-in-code-node.md): Allow the use of both built-in and external modules within the Code node.
- [Set the timezone](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/configuration-examples/set-the-timezone.md): Change the default timezone for your self-hosted n8n instance.
- [Specify user folder path](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/configuration-examples/specify-user-folder-path.md): Specify location of the folder that stores user-specific data.
- [Configure webhook URLs with reverse proxy](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/configuration-examples/configure-webhook-urls-with-reverse-proxy.md): Customize n8n webhook URLs for compatibility with reverse proxy setups.
- [Enable Prometheus metrics](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/configuration-examples/enable-prometheus-metrics.md): Enable Prometheus metrics endpoint.
- [Pre-configure Microsoft OAuth credentials](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/configuration-examples/pre-configure-microsoft-oauth-credentials.md): Use credential overwrites to pre-configure Microsoft OAuth2 credentials in n8n so users can connect without their own app registration.
- [Configure a custom workflow templates library](https://docs.n8n.io/deploy/host-n8n/configure-n8n/basic-configuration/configuration-examples/configure-a-custom-workflow-templates-library.md): Set up a custom workflow template library for your self-hosted n8n instance.
- [Choose n8n's database](https://docs.n8n.io/deploy/host-n8n/configure-n8n/choose-n8ns-database.md)
- [External hooks](https://docs.n8n.io/deploy/host-n8n/configure-n8n/external-hooks.md): Use external hooks to execute custom code whenever n8n runs a specific operation.
- [Use the command line](https://docs.n8n.io/deploy/host-n8n/configure-n8n/use-the-command-line.md): Commands available in the Server CLI, the built-in n8n command-line interface.
- [User management](https://docs.n8n.io/deploy/host-n8n/configure-n8n/user-management.md): Configure self-hosted n8n for user management
- [Change instance owner email](https://docs.n8n.io/deploy/host-n8n/configure-n8n/change-instance-owner-email.md): Change the owner email address for a self-hosted n8n instance using the UI or environment variables.
- [Manage settings using environment variables](https://docs.n8n.io/deploy/host-n8n/configure-n8n/manage-settings-using-environment-variables.md): Configure a self-hosted n8n instance owner, SSO, security policy, log streaming, MCP, and community packages from environment variables.
- [Set up task runners](https://docs.n8n.io/deploy/host-n8n/configure-n8n/set-up-task-runners.md): How to configure task runners to execute tasks using internal or external runner processes.
- [Durable scheduler](https://docs.n8n.io/deploy/host-n8n/configure-n8n/durable-scheduler.md): How the durable scheduler runs time-based workflows from a database-backed queue for your self-hosted n8n instance.
- [System tasks](https://docs.n8n.io/deploy/host-n8n/configure-n8n/system-tasks.md): How n8n runs its internal maintenance tasks, and the Prometheus metrics they expose on your self-hosted instance.
- [Set up n8n Assistant](https://docs.n8n.io/deploy/host-n8n/configure-n8n/set-up-n8n-assistant.md): Set up n8n Assistant on self-hosted n8n using environment variables.
- [Deploy n8n in
Measured from the saved file
Linked document
UTF-8 text size
282.7 KB289469 bytes
Token count
70055o200k_base encoding
Markdown links
13721372 distinct URLs
Fenced code blocks
01403 lines in the file
Size measures the captured UTF-8 text, not compressed transfer size. Tokens are counted with a named tokenizer; other models can count differently. Neither measure establishes context compatibility or answer quality.
Project H1
n8n Docs
Context architecture
How the content is divided
10 H2 sections organize 1372 parsed Markdown links. 1372 links point to .md or .markdown paths; 0 link occurrences use another hostname. Linked destinations have not been recursively validated.
H2 section
Links
UTF-8 bytes
Tokens
Get startedLine 3
5
786
206
DeployLine 11
128
23875
6206
BuildLine 142
137
21054
5238
NodesLine 282
962
225235
53635
ConnectLine 1247
76
8308
2191
AdministerLine 1326
44
7443
1808
ContributeLine 1373
6
855
240
Privacy and securityLine 1382
3
364
93
ChangelogLine 1388
9
1155
345
n8n Community licenseLine 1400
2
238
57
Link counts exclude parsed fenced and inline code and resolve relative destinations against the final endpoint. Section sizes cover the text below each H2 until the next H2.
Embedded material
Code, installation and API examples
Fenced blocks
0 closed
Declared languages
No fenced blocks detected
Package-install commands
0 detected in fenced or inline code
Authentication examples
0 fenced lines match API-key, Authorization, Bearer, OAuth or access-token patterns
HTTP request examples
0 fenced lines match request-method patterns
Authentication links
2 links have authentication-related labels
Embedded example text and links to further documentation are counted separately. A code block does not establish that a sample runs or that an authentication flow succeeds.
Publisher prioritization
The Optional section
No H2 section named “Optional” was detected in this file.
The community proposal uses Optional by convention for secondary links that can be skipped for a shorter context. This label does not establish that everything outside it is critical, or that the material inside it is deprecated.
Machine-readable routes
MCP references and configuration text
MCP-related text was detected in the captured file. 11 links have MCP-related labels or paths. 0 fenced lines match mcpServers, mcp_servers or an mcp add command.
A verified text response establishes a companion at the checked URL. It does not prove the bundle contains all product documentation, that generation is automated, or that it fits an assistant’s context window.
Change evidence
What can be said about freshness
This capture establishes a baseline. Update frequency cannot be determined from one observation.
Linked release and migration material
10 links have release, changelog, deprecation or migration terms in their labels or paths. These provide places to investigate product changes separately.
File changes can reveal documentation edits or navigation changes. They do not by themselves measure product release velocity, accuracy, agent adoption or AI visibility.
Counts use a deterministic parser, not a spec-compliance grade. Unusual Markdown and indented code can fall outside its recognized patterns. See the llms.txt proposal and tokenizer implementation.