Skip to content

Reference preview #3020

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _snippets/code/tournament-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
If you have issues with expressions in 1.9.0:

* Please report the issue on the [forums](https://community.n8n.io/){:target=_blank .external-link}.
* Self-hosted users can switch back to RiotTmpl: set `N8N_EXPRESSION_EVALUATOR` to `tmpl`. Refer to [Environment variables](/hosting/configuration/environment-variables/index.md) for more information on configuring self-hosted n8n.
* Self-hosted users can switch back to RiotTmpl: set `N8N_EXPRESSION_EVALUATOR` to `tmpl`. Refer to [Environment variables](/hosting/configuration/environment-variables/overview.md) for more information on configuring self-hosted n8n.
///
2 changes: 1 addition & 1 deletion _snippets/privacy-security/gdpr-self-hosted.md
Original file line number Diff line number Diff line change
@@ -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/overview.md) for more information.
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
* Learn more about [configuring](/hosting/configuration/environment-variables/index.md) and [scaling](/hosting/scaling/overview.md) n8n.
* Learn more about [configuring](/hosting/configuration/environment-variables/overview.md) and [scaling](/hosting/scaling/overview.md) n8n.
* Or explore using n8n: try the [Quickstarts](/try-it-out/index.md).
16 changes: 15 additions & 1 deletion docs/_extra/css/extra.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
@font-face {
font-family: "Lexend";
src: url("./Lexend-VariableFont_wght.ttf");
}
@font-face {
font-family: "Moderat-Regular-Web";
src: url("./Moderat-Regular-Web/Moderat-Regular.woff");
Expand Down Expand Up @@ -29,7 +33,7 @@


/* https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/?h=font#additional-fonts */
--md-text-font: "Moderat-Regular-Web";
--md-text-font: "Lexend";
/* https://squidfunk.github.io/mkdocs-material/reference/admonitions/#custom-admonitions */
--md-admonition-icon--details: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>');
}
Expand Down Expand Up @@ -466,3 +470,13 @@
.bottom-link .footer-link {
color: #20b69e;
}

/*.md-nav__item--section.md-nav__item--active > .md-nav__link {
*/
#__nav_1_label,#__nav_2_label,#__nav_3_label,#__nav_4_label,#__nav_5_label {
color: rgb(144, 146, 152);
font-weight: 600;
font-size: 16px;
letter-spacing: 3px;
text-transform: uppercase;
}
Binary file added docs/_images/try-it-out/cloud.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/try-it-out/templates.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/try-it-out/tutorial-date.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/try-it-out/tutorial-expression.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/try-it-out/tutorial-first.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions docs/_redirects
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
### THESE REDIRECTS ARE HANDLED BY NETLIFY, SEE DOC FOR DETAILS ###
### https://docs.netlify.com/routing/redirects/redirect-options/ ###


## tutorials refresh

/try-it-out/longer-introduction/ /try-it-out/tutorial-first-workflow/

## DOC-994
/privacy-security/security/ https://n8n.io/legal/#security

Expand Down
193 changes: 193 additions & 0 deletions docs/_workflows/try-it-out/quickstart/tutorial.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,193 @@
{
"name": "Tutorial-workflow",
"nodes": [
{
"parameters": {
"rule": {
"interval": [
{
"field": "weeks",
"triggerAtDay": [
1
],
"triggerAtHour": 9
}
]
}
},
"type": "n8n-nodes-base.scheduleTrigger",
"typeVersion": 1.2,
"position": [
-680,
100
],
"id": "ef14445c-2f5f-4c78-96c8-66732feb7a8f",
"name": "Schedule Trigger"
},
{
"parameters": {
"resource": "donkiSolarFlare",
"additionalFields": {
"startDate": "={{ $today.minus(7, 'days') }}"
}
},
"type": "n8n-nodes-base.nasa",
"typeVersion": 1,
"position": [
-460,
100
],
"id": "52c58b93-c780-4aff-a216-d67b28195a45",
"name": "NASA",
"credentials": {
"nasaApi": {
"id": "sSVnxV9AcBmBOYn8",
"name": "NASA account"
}
}
},
{
"parameters": {
"conditions": {
"options": {
"caseSensitive": true,
"leftValue": "",
"typeValidation": "strict",
"version": 2
},
"conditions": [
{
"id": "2f469c8e-12b3-4ee5-95fc-ff81508d0b43",
"leftValue": "={{ $json.classType }}",
"rightValue": "C",
"operator": {
"type": "string",
"operation": "contains"
}
}
],
"combinator": "and"
},
"options": {}
},
"type": "n8n-nodes-base.if",
"typeVersion": 2.2,
"position": [
-240,
100
],
"id": "b54e3289-9ebb-451f-8bac-87edeeeced13",
"name": "If"
},
{
"parameters": {
"resource": "request",
"operation": "send",
"binId": "1741914338605-0907339996192",
"binContent": "=There was a solar flare of class {{$json[\"classType\"]}}",
"requestOptions": {}
},
"type": "n8n-nodes-base.postBin",
"typeVersion": 1,
"position": [
-20,
0
],
"id": "a8b602b6-17b1-4274-8d33-73344b6bb8fb",
"name": "PostBin(true)"
},
{
"parameters": {
"resource": "request",
"operation": "send",
"binId": "1741914338605-0907339996192",
"binContent": "=There was a solar flare of class {{$json[\"classType\"]}}",
"requestOptions": {}
},
"type": "n8n-nodes-base.postBin",
"typeVersion": 1,
"position": [
-20,
200
],
"id": "09c2c7a4-c229-430d-a5b0-8d7491515d9f",
"name": "PostBin(false)"
},
{
"parameters": {
"content": "## Setup required\n\nYou need to create a NASA account and create credentials, and create a bin with Postbin and enter the ID - see [the documentation](https://docs.n8n.io/try-it-out/longer-introduction/)",
"height": 120,
"width": 600
},
"type": "n8n-nodes-base.stickyNote",
"typeVersion": 1,
"position": [
-720,
-60
],
"id": "08e0b8f9-c90e-4c9c-a663-01aca805b9be",
"name": "Sticky Note"
}
],
"pinData": {},
"connections": {
"Schedule Trigger": {
"main": [
[
{
"node": "NASA",
"type": "main",
"index": 0
}
]
]
},
"NASA": {
"main": [
[
{
"node": "If",
"type": "main",
"index": 0
}
]
]
},
"If": {
"main": [
[
{
"node": "PostBin(true)",
"type": "main",
"index": 0
}
],
[
{
"node": "PostBin(false)",
"type": "main",
"index": 0
}
]
]
}
},
"active": false,
"settings": {
"executionOrder": "v1"
},
"versionId": "37de4877-e4f6-4b9a-b6f0-9b7e7aea0163",
"meta": {
"templateCredsSetupCompleted": true,
"instanceId": "cb484ba7b742928a2048bf8829668bed5b5ad9787579adea888f05980292a4a7"
},
"id": "DPzMzTIyDrYohiw4",
"tags": [
{
"createdAt": "2021-06-25T07:47:07.640Z",
"updatedAt": "2021-06-25T07:47:07.640Z",
"id": "1",
"name": "docs"
}
]
}
File renamed without changes.
78 changes: 56 additions & 22 deletions docs/choose-n8n.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,41 +6,75 @@ 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 is 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

## Licenses
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.

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.
**Great for:** people who want automations but don't want to maintain a server, small businesses, casual users.

For a detailed explanation of the license, refer to [Sustainable Use License](/sustainable-use-license.md).
[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

## Free versions
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.

n8n offers the following free options:
**Great for:** mission critical workflows, larger teams, ultimate control and observability.

* A free trial of Cloud
* A free self-hosted community edition for self-hosted users
[Find out more about enterprise features »][enterprise]

## Paid versions
## Embed

n8n has two paid versions:
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.

* 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.
## Feature comparison

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.
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 mins | 40 mins | 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) 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).

[see website]: https://n8n.io/pricing/
[hosting]: /hosting/index.md
[enterprise]: https://n8n.io/enterprise/
4 changes: 2 additions & 2 deletions docs/code/builtin/n8n-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/overview.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: |
Expand All @@ -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/overview.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`. |
Expand Down
Loading