mirror of
https://github.com/n8n-io/n8n-docs.git
synced 2026-03-27 09:28:43 +07:00
update theme and fix admonitions (#1644)
* update theme * fix tab issues * update readme * editor * revert tab change * change editor config back to 4 spaces for tabs * fix admons that broke when enforcing 4 spaces per tab * update README
This commit is contained in:
Deborah
@@ -4,6 +4,7 @@ root = true
|
||||
charset = utf-8
|
||||
indent_style = tab
|
||||
end_of_line = lf
|
||||
indent_size = 4
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = false
|
||||
|
||||
|
||||
@@ -13,6 +13,9 @@ This repository hosts the documentation for [n8n](https://n8n.io/), an extendabl
|
||||
* Pip
|
||||
* n8n recommends using a virtual environment when working with Python, such as [venv](https://docs.python.org/3/tutorial/venv.html).
|
||||
* Follow the [recommended configuration and auto-complete](https://squidfunk.github.io/mkdocs-material/creating-your-site/#minimal-configuration) guidance for the theme. This will help when working with the `mkdocs.yml` file.
|
||||
* The repo includes a `.editorconfig` file. Make sure your local editor settings **do not override** these settings. In particular:
|
||||
- Don't allow your editor to replace tabs with spaces. This can affect our code samples (which must retain tabs for people building nodes).
|
||||
- One tab must be equivalent to four spaces.
|
||||
|
||||
### Steps
|
||||
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
!!! info "Feature availability"
|
||||
Embed requires an embed license. For more information about when to use Embed, as well as costs and licensing processes, refer to [Embed](https://n8n.io/embed/){:target=_blank .external-link} on the n8n website.
|
||||
Embed requires an embed license. For more information about when to use Embed, as well as costs and licensing processes, refer to [Embed](https://n8n.io/embed/){:target=_blank .external-link} on the n8n website.
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
!!! note "Recommendation: don't push and pull to the same n8n instance"
|
||||
You can push work from an instance to a branch, and pull to the same instance. n8n doesn't recommend this. To reduce the risk of merge conflicts and overwriting work, try to create a process where work goes in one direction: either to Git, or from Git, but not both.
|
||||
You can push work from an instance to a branch, and pull to the same instance. n8n doesn't recommend this. To reduce the risk of merge conflicts and overwriting work, try to create a process where work goes in one direction: either to Git, or from Git, but not both.
|
||||
|
||||
@@ -14,7 +14,7 @@ n8n Cloud is n8n's hosted solution. In addition to all the features of n8n, it p
|
||||
[Sign up for n8n Cloud](https://www.n8n.cloud/){:target=_blank .external-link}
|
||||
|
||||
!!! note "Russia and Belarus"
|
||||
n8n Cloud is not available in Russia and Belarus. Refer to our 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.
|
||||
n8n Cloud is not available in Russia and Belarus. Refer to our 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.
|
||||
|
||||
## Update your Cloud version
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ contentType: reference
|
||||
A reference document listing built-in convenience functions to support data transformation in expressions for arrays.
|
||||
|
||||
!!! note "JavaScript in expressions"
|
||||
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
|
||||
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
|
||||
|
||||
[[% import "_macros/data-functions.html" as dataFunctions %]]
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ contentType: reference
|
||||
A reference document listing built-in convenience functions to support data transformation in expressions for dates.
|
||||
|
||||
!!! note "JavaScript in expressions"
|
||||
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
|
||||
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
|
||||
|
||||
[[% import "_macros/data-functions.html" as dataFunctions %]]
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ contentType: overview
|
||||
Data transformation functions are helper functions to make data transformation easier in expressions.
|
||||
|
||||
!!! note "JavaScript in expressions"
|
||||
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
|
||||
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
|
||||
|
||||
For a list of available functions, refer to the page for your data type:
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ contentType: reference
|
||||
A reference document listing built-in convenience functions to support data transformation in expressions for numbers.
|
||||
|
||||
!!! note "JavaScript in expressions"
|
||||
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
|
||||
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
|
||||
|
||||
[[% import "_macros/data-functions.html" as dataFunctions %]]
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ contentType: reference
|
||||
A reference document listing built-in convenience functions to support data transformation in expressions for objects.
|
||||
|
||||
!!! note "JavaScript in expressions"
|
||||
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
|
||||
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
|
||||
|
||||
[[% import "_macros/data-functions.html" as dataFunctions %]]
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ contentType: reference
|
||||
A reference document listing built-in convenience functions to support data transformation in expressions for strings.
|
||||
|
||||
!!! note "JavaScript in expressions"
|
||||
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
|
||||
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
|
||||
|
||||
[[% import "_macros/data-functions.html" as dataFunctions %]]
|
||||
|
||||
|
||||
@@ -8,9 +8,9 @@ contentType: overview
|
||||
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, with a short description.
|
||||
|
||||
!!! note "Availability in the expressions editor and the Code node"
|
||||
Some methods and variables aren't available in the Code node. These are noted in the documentation.
|
||||
Some methods and variables aren't available in the Code node. These are noted in the documentation.
|
||||
|
||||
All data transformation functions are only available in the expressions editor.
|
||||
All data transformation functions are only available in the expressions editor.
|
||||
|
||||
[[% import "_macros/section-toc.html" as sectionToc %]]
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ contentType: howto
|
||||
# Credential sharing
|
||||
|
||||
!!! info "Feature availability"
|
||||
Available on Pro and Enterprise Cloud plans, and Enterprise self-hosted plans.
|
||||
Available on Pro and Enterprise Cloud plans, and Enterprise self-hosted plans.
|
||||
|
||||
Credential sharing allows you to share a credential you created with other users in the same n8n workspace as you. The other users can then use the credential in their workflows. They can't access or edit the credential details.
|
||||
|
||||
|
||||
@@ -162,7 +162,7 @@ To find the address of the n8n service running on the instance:
|
||||
4. Select the **n8n** service and copy the **Load balancer URLs** value. Use this value suffixed with the n8n service port (5678) for DNS.
|
||||
|
||||
!!! note "Use HTTP"
|
||||
This guide uses HTTP connections for the services it defines, for example in `n8n-deployment.yaml`. However, if you click the **Load balancer URLs** value, EKS takes you to an "HTTPS" URL which results in an error. To solve this, when you open the n8n subdomain, make sure to use HTTP.
|
||||
This guide uses HTTP connections for the services it defines, for example in `n8n-deployment.yaml`. However, if you click the **Load balancer URLs** value, EKS takes you to an "HTTPS" URL which results in an error. To solve this, when you open the n8n subdomain, make sure to use HTTP.
|
||||
|
||||
## Delete resources
|
||||
|
||||
|
||||
@@ -21,10 +21,10 @@ This hosting guide shows you how to self-host n8n on a DigitalOcean droplet. It
|
||||
4. [Create a new Droplet](https://docs.digitalocean.com/products/droplets/how-to/create/){:target=_blank .external-link} using the [Docker image](https://marketplace.digitalocean.com/apps/docker){:target="_blank" .external-link} available on the **Marketplace** tab.
|
||||
|
||||
!!! note "Droplet resources"
|
||||
When creating the Droplet, DigitalOcean asks you to choose a plan. For most usage levels, a basic shared CPU plan is enough.
|
||||
When creating the Droplet, DigitalOcean asks you to choose a plan. For most usage levels, a basic shared CPU plan is enough.
|
||||
|
||||
!!! note "SSH or Password"
|
||||
DigitalOcean lets you choose between SSH and password-based authentication. SSH is more secure. The rest of this guide assumes you are using SSH.
|
||||
DigitalOcean lets you choose between SSH and password-based authentication. SSH is more secure. The rest of this guide assumes you are using SSH.
|
||||
|
||||
## Log in to your Droplet and create new user
|
||||
|
||||
|
||||
@@ -22,10 +22,10 @@ This hosting guide shows you how to self-host n8n on a Hetzner cloud server. It
|
||||
You can change most of the settings to suit your needs, but as this guide uses Docker to run the application, under the **Image** section, select "Docker CE" from the **APPS** tab.
|
||||
|
||||
!!! note "Type"
|
||||
When creating the server, Hetzner asks you to choose a plan. For most usage levels, the CPX11 type is enough.
|
||||
When creating the server, Hetzner asks you to choose a plan. For most usage levels, the CPX11 type is enough.
|
||||
|
||||
!!! note "SSH keys"
|
||||
Hetzner lets you choose between SSH and password-based authentication. SSH is more secure. The rest of this guide assumes you are using SSH.
|
||||
Hetzner lets you choose between SSH and password-based authentication. SSH is more secure. The rest of this guide assumes you are using SSH.
|
||||
|
||||
## Log in to your server
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ The HTML node provides operations to help you work with HTML in n8n.
|
||||
The HTML node replaces the HTML Extract node from version 0.213.0 onwards. If you're using an older version of n8n, you can still view the [HTML Extract node documentation](https://github.com/n8n-io/n8n-docs/blob/86fe33b681621e618e3adcab9a27e8605dbc23ad/docs/integrations/builtin/core-nodes/n8n-nodes-base.htmlextract.md){:target=_blank .external-link}.
|
||||
|
||||
!!! warning "Cross-site scripting"
|
||||
When using the HTML node to generate an HTML template you can introduce [XSS (cross-site scripting)](https://owasp.org/www-community/attacks/xss/){:target=_blank .external-link}. This is a security risk. Be careful with untrusted inputs.
|
||||
When using the HTML node to generate an HTML template you can introduce [XSS (cross-site scripting)](https://owasp.org/www-community/attacks/xss/){:target=_blank .external-link}. This is a security risk. Be careful with untrusted inputs.
|
||||
|
||||
## Operations
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ contentType: integration
|
||||
Use the Merge node to combine data from two streams, once data of both streams is available.
|
||||
|
||||
!!! note "Major changes in 0.194.0"
|
||||
This node was overhauled in n8n 0.194.0. This document reflects the latest version of the node. If you're using an older version of n8n, you can find the previous version of this document [here](https://github.com/n8n-io/n8n-docs/blob/4ff688642cc9ee7ca7d00987847bf4e4515da59d/docs/integrations/builtin/core-nodes/n8n-nodes-base.merge.md){:target=_blank .external-link}.
|
||||
This node was overhauled in n8n 0.194.0. This document reflects the latest version of the node. If you're using an older version of n8n, you can find the previous version of this document [here](https://github.com/n8n-io/n8n-docs/blob/4ff688642cc9ee7ca7d00987847bf4e4515da59d/docs/integrations/builtin/core-nodes/n8n-nodes-base.merge.md){:target=_blank .external-link}.
|
||||
|
||||
## Merge mode
|
||||
|
||||
|
||||
@@ -60,7 +60,7 @@ You can require authentication for any service calling your webhook URL.
|
||||
* [**Header Auth**](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization){:target=_blank .external-link}: a method of authentication where calls to the webhook URL must include the specified header parameter. For example, use this method when you want to authenticate using an API key or an access token.
|
||||
|
||||
!!! note Credential data can vary
|
||||
The **Credential Data** required for header auth credentials depends on the type used. For example, if you need to provide an `Authorization: Bearer <token>` header, the Credential Data `Name` will be `Authorization` and the `Value` will be `Bearer <token>`.
|
||||
The **Credential Data** required for header auth credentials depends on the type used. For example, if you need to provide an `Authorization: Bearer <token>` header, the Credential Data `Name` will be `Authorization` and the `Value` will be `Bearer <token>`.
|
||||
|
||||
|
||||
### HTTP Method
|
||||
|
||||
@@ -88,7 +88,7 @@ import { INodeType, INodeTypeDescription } from 'n8n-workflow';
|
||||
The node must export an interface that implements INodeType. This interface must include a `description` interface, which in turn contains the `properties` array.
|
||||
|
||||
!!! note "Class names and file names"
|
||||
Make sure the class name and the file name match. For example, given a class `NasaPics`, the filename must be `NasaPics.node.ts`.
|
||||
Make sure the class name and the file name match. For example, given a class `NasaPics`, the filename must be `NasaPics.node.ts`.
|
||||
|
||||
```typescript
|
||||
export class NasaPics implements INodeType {
|
||||
|
||||
@@ -102,7 +102,7 @@ import {
|
||||
The node must export an interface that implements `INodeType`. This interface must include a `description` interface, which in turn contains the `properties` array.
|
||||
|
||||
!!! note "Class names and file names"
|
||||
Make sure the class name and the file name match. For example, given a class `FriendGrid`, the filename must be `FriendGrid.node.ts`.
|
||||
Make sure the class name and the file name match. For example, given a class `FriendGrid`, the filename must be `FriendGrid.node.ts`.
|
||||
|
||||
```typescript
|
||||
export class FriendGrid implements INodeType {
|
||||
|
||||
@@ -26,7 +26,7 @@ The n8n Data Processing Agreement includes the [Standard Contractual Clauses (S
|
||||
You can find a list of n8n sub-processors [here](https://n8n.io/legal/#subprocessors){:target=_blank .external-link}.
|
||||
|
||||
!!! note "Self-hosted n8n"
|
||||
For self-hosted versions, n8n is neither a Controller nor a Processor, as we don't manage your data
|
||||
For self-hosted versions, n8n is neither a Controller nor a Processor, as we don't manage your data
|
||||
|
||||
### Submitting a GDPR deletion request
|
||||
|
||||
|
||||
@@ -594,7 +594,7 @@ View the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.234.0...n8n@0.235
|
||||
This release contains new features, new nodes, node enhancements, and bug fixes.
|
||||
|
||||
!!! warning "Unstable version"
|
||||
This version is currently (4th July 2023) considered unstable. n8n recommends against upgrading.
|
||||
This version is currently (4th July 2023) considered unstable. n8n recommends against upgrading.
|
||||
|
||||
For full release details, refer to [Releases](https://github.com/n8n-io/n8n/releases){:target=_blank .external-link} on GitHub.
|
||||
|
||||
@@ -611,7 +611,7 @@ View the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.233.1...n8n@0.234
|
||||
This release contains new features, new nodes, node enhancements, and bug fixes.
|
||||
|
||||
!!! warning "Unstable version"
|
||||
This version is currently (4th July 2023) considered unstable. n8n recommends upgrading directly to 0.234.1.
|
||||
This version is currently (4th July 2023) considered unstable. n8n recommends upgrading directly to 0.234.1.
|
||||
|
||||
!!! warning "Irreversible database migration"
|
||||
This version contains a database migration that changes credential and workflow IDs to use nanoId strings, This migration may take a while to complete in some environments. This change doesn't break anything using the older numeric IDs.
|
||||
@@ -2021,7 +2021,7 @@ View the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.210.2...n8n@0.211
|
||||
**Release date:** 2023-01-13
|
||||
|
||||
!!! warning "Don't use this version"
|
||||
Upgrade directly to 0.211.1.
|
||||
Upgrade directly to 0.211.1.
|
||||
|
||||
### New features
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ contentType: howto
|
||||
# Set up user management on n8n Cloud
|
||||
|
||||
!!! info "Feature availability"
|
||||
* Available on paid self-hosted and selected Cloud plans. Refer to [Pricing](https://n8n.io/pricing/){:target=_blank .external-link} for more information.
|
||||
Available on paid self-hosted and selected Cloud plans. Refer to [Pricing](https://n8n.io/pricing/){:target=_blank .external-link} for more information.
|
||||
|
||||
To access user management, upgrade to version 0.195.0 or newer.
|
||||
|
||||
|
||||
@@ -6,8 +6,8 @@ contentType: howto
|
||||
# Lightweight Directory Access Protocol (LDAP)
|
||||
|
||||
!!! info "Feature availability"
|
||||
* Available on Self-hosted Enterprise and Cloud Enterprise plans.
|
||||
* You need access to the n8n instance owner account.
|
||||
* Available on Self-hosted Enterprise and Cloud Enterprise plans.
|
||||
* You need access to the n8n instance owner account.
|
||||
|
||||
This page tells you how to enable LDAP in n8n. It assumes you're familiar with LDAP, and have an existing LDAP server set up.
|
||||
|
||||
|
||||
@@ -5,11 +5,11 @@ description: How to enable 2FA for your n8n account
|
||||
# Two-factor authentication (2FA)
|
||||
|
||||
!!! info "Feature availability"
|
||||
* You need access to the n8n instance owner account.
|
||||
* Available on self-hosted n8n.
|
||||
* Coming soon to n8n Cloud.
|
||||
* You need access to the n8n instance owner account.
|
||||
* Available on self-hosted n8n.
|
||||
* Coming soon to n8n Cloud.
|
||||
|
||||
Twofactor authentication (2FA) adds a second authentication method on top of username and password. This increases account security. n8n supports 2FA using an authenticator app.
|
||||
Two-factor authentication (2FA) adds a second authentication method on top of username and password. This increases account security. n8n supports 2FA using an authenticator app.
|
||||
|
||||
## Enable 2FA
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ There are two workflow roles: owner and editor. The owner is the user who create
|
||||
You can't change the workflow owner, except when deleting the user.
|
||||
|
||||
!!! note "Credentials"
|
||||
Workflow sharing allows editors to use all credentials used in the workflow. This includes credentials that aren't explicitly shared with them using [credential sharing](/credentials/credential-sharing/).
|
||||
Workflow sharing allows editors to use all credentials used in the workflow. This includes credentials that aren't explicitly shared with them using [credential sharing](/credentials/credential-sharing/).
|
||||
|
||||
### Permissions
|
||||
|
||||
|
||||
Reference in New Issue
Block a user