n8n Documentation

commit 814a648773cbae9d5ca4a3ec5b289b01a9cf2ac8 Author: Jan Oberhauser Date: Sun Jul 5 13:01:30 2020 +0200 deploy old docs diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000000..e69de29bb2 diff --git a/CNAME b/CNAME new file mode 100644 index 0000000000..22a8459481 --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +docs-old.n8n.io diff --git a/README.md b/README.md new file mode 100644 index 0000000000..3454cc15e2 --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# n8n Documentation + +This is the documentation of n8n, a free and open [fair-code](http://faircode.io) licensed node-based Workflow Automation Tool. + +It covers everything from setup to usage and development. It is still a work in progress and all contributions are welcome. + + +## What is n8n? + +n8n (pronounced nodemation) helps you to interconnect every app with an API in the world with each other to share and manipulate its data without a single line of code. It is an easy to use, user-friendly and highly customizable service, which uses an intuitive user interface for you to design your unique workflows very fast. Hosted on your server and not based in the cloud, it keeps your sensible data very secure in your own trusted database. diff --git a/_sidebar.md b/_sidebar.md new file mode 100644 index 0000000000..6cbe725286 --- /dev/null +++ b/_sidebar.md @@ -0,0 +1,43 @@ +- Home + + - [Welcome](/) + +- Getting started + + - [Key Components](key-components.md) + - [Quick Start](quick-start.md) + - [Setup](setup.md) + - [Tutorials](tutorials.md) + - [Docker](docker.md) + +- Advanced + + - [Configuration](configuration.md) + - [Data Structure](data-structure.md) + - [Database](database.md) + - [Keyboard Shortcuts](keyboard-shortcuts.md) + - [Node Basics](node-basics.md) + - [Nodes](nodes.md) + - [Security](security.md) + - [Sensitive Data](sensitive-data.md) + - [Server Setup](server-setup.md) + - [Start Workflows via CLI](start-workflows-via-cli.md) + - [Workflow](workflow.md) + +- Development + + - [Create Node](create-node.md) + - [Development](development.md) + + +- Other + + - [FAQ](faq.md) + - [License](license.md) + - [Troubleshooting](troubleshooting.md) + + +- Links + + - [![Jobs](https://n8n.io/favicon.ico ':size=16')Jobs](https://jobs.n8n.io) + - [![Website](https://n8n.io/favicon.ico ':size=16')n8n.io](https://n8n.io) diff --git a/configuration.md b/configuration.md new file mode 100644 index 0000000000..63b8c95f12 --- /dev/null +++ b/configuration.md @@ -0,0 +1,244 @@ + + +# Configuration + +It is possible to change some of the n8n defaults via special environment variables. +The ones that currently exist are: + + +## Publish + +Sets how n8n should be made available. + +```bash +# The port n8n should be made available on +N8N_PORT=5678 + +# The IP address n8n should listen on +N8N_LISTEN_ADDRESS=0.0.0.0 + +# This ones are currently only important for the webhook URL creation. +# So if "WEBHOOK_TUNNEL_URL" got set they do get ignored. It is however +# encouraged to set them correctly anyway in case they will become +# important in the future. +N8N_PROTOCOL=https +N8N_HOST=n8n.example.com +``` + + +## Base URL + +Tells the frontend how to reach the REST API of the backend. + +```bash +export VUE_APP_URL_BASE_API="https://n8n.example.com/" +``` + + +## Execution Data Manual Runs + +n8n creates a random encryption key automatically on the first launch and saves +it in the `~/.n8n` folder. That key is used to encrypt the credentials before +they get saved to the database. It is also possible to overwrite that key and +set it via an environment variable. + +```bash +export N8N_ENCRYPTION_KEY="" +``` + + +## Execution Data Manual Runs + +Normally executions which got started via the Editor UI will not be saved as +they are normally only for testing and debugging. That default can be changed +with this environment variable. + +```bash +export EXECUTIONS_DATA_SAVE_MANUAL_EXECUTIONS=true +``` + +This setting can also be overwritten on a per workflow basis in the workflow +settings in the Editor UI. + + +## Execution Data Error/Success + +When a workflow gets executed, it will save the result in the database. That's +the case for executions that succeeded and for the ones that failed. The +default behavior can be changed like this: + +```bash +export EXECUTIONS_DATA_SAVE_ON_ERROR=none +export EXECUTIONS_DATA_SAVE_ON_SUCCESS=none +``` + +Possible values are: + - **all**: Saves all data + - **none**: Does not save anything (recommended if a workflow runs very often and/or processes a lot of data, set up "Error Workflow" instead) + +These settings can also be overwritten on a per workflow basis in the workflow +settings in the Editor UI. + + +## Execute In Same Process + +All workflows get executed in their own separate process. This ensures that all CPU cores +get used and that they do not block each other on CPU intensive tasks. Additionally, this makes sure that +the crash of one execution does not take down the whole application. The disadvantage is, however, +that it slows down the start-time considerably and uses much more memory. So in case the +workflows are not CPU intensive and they have to start very fast, it is possible to run them +all directly in the main-process with this setting. + +```bash +export EXECUTIONS_PROCESS=main +``` + + +## Exclude Nodes + +It is possible to not allow users to use nodes of a specific node type. For example, if you +do not want that people can write data to the disk with the "n8n-nodes-base.writeBinaryFile" +node and that they cannot execute commands with the "n8n-nodes-base.executeCommand" node, you can +set the following: + +```bash +export NODES_EXCLUDE="[\"n8n-nodes-base.executeCommand\",\"n8n-nodes-base.writeBinaryFile\"]" +``` + + +## Custom Nodes Location + +Every user can add custom nodes that get loaded by n8n on startup. The default +location is in the subfolder `.n8n/custom` of the user who started n8n. +Additional folders can be defined with an environment variable. + +```bash +export N8N_CUSTOM_EXTENSIONS="/home/jim/n8n/custom-nodes;/data/n8n/nodes" +``` + + +## Use built-in and external modules in Function-Nodes + +For security reasons, importing modules is restricted by default in the Function-Nodes. +It is, however, possible to lift that restriction for built-in and external modules by +setting the following environment variables: +- `NODE_FUNCTION_ALLOW_BUILTIN`: For builtin modules +- `NODE_FUNCTION_ALLOW_EXTERNAL`: For external modules sourced from n8n/node_modules directory. External module support is disabled when env variable is not set. + +```bash +# Allows usage of all builtin modules +export NODE_FUNCTION_ALLOW_BUILTIN=* + +# Allows usage of only crypto +export NODE_FUNCTION_ALLOW_BUILTIN=crypto + +# Allows usage of only crypto and fs +export NODE_FUNCTION_ALLOW_BUILTIN=crypto,fs + +# Allow usage of external npm modules. Wildcard matching is not supported. +export NODE_FUNCTION_ALLOW_EXTERNAL=moment,lodash +``` + + +## SSL + +It is possible to start n8n with SSL enabled by supplying a certificate to use: + + +```bash +export N8N_PROTOCOL=https +export N8N_SSL_KEY=/data/certs/server.key +export N8N_SSL_CERT=/data/certs/server.pem +``` + + + +## Timezone + +The timezone is set by default to "America/New_York". For instance, it is used by the +Cron node to know at what time the workflow should be started. To set a different +default timezone simply set `GENERIC_TIMEZONE` to the appropriate value. For example, +if you want to set the timezone to Berlin (Germany): + +```bash +export GENERIC_TIMEZONE="Europe/Berlin" +``` + +You can find the name of your timezone here: +[https://momentjs.com/timezone/](https://momentjs.com/timezone/) + + +## User Folder + +User-specific data like the encryption key, SQLite database file, and +the ID of the tunnel (if used) gets saved by default in the subfolder +`.n8n` of the user who started n8n. It is possible to overwrite the +user-folder via an environment variable. + +```bash +export N8N_USER_FOLDER="/home/jim/n8n" +``` + + +## Webhook URL + +The webhook URL will normally be created automatically by combining +`N8N_PROTOCOL`, `N8N_HOST` and `N8N_PORT`. However, if n8n runs behind a +reverse proxy that would not work. That's because n8n runs internally +on port 5678 but is exposed to the web via the reverse proxy on port 443. In +that case, it is important to set the webhook URL manually so that it can be +displayed correctly in the Editor UI and even more important is that the correct +webhook URLs get registred with the external services. + +```bash +export WEBHOOK_TUNNEL_URL="https://n8n.example.com/" +``` + + +## Configuration via file + +It is also possible to configure n8n using a configuration file. + +It is not necessary to define all values but only the ones that should be +different from the defaults. + +If needed multiple files can also be supplied to. For example, have generic +base settings and some specific ones depending on the environment. + +The path to the JSON configuration file to use can be set using the environment +variable `N8N_CONFIG_FILES`. + +```bash +# Single file +export N8N_CONFIG_FILES=/folder/my-config.json + +# Multiple files can be comma-separated +export N8N_CONFIG_FILES=/folder/my-config.json,/folder/production.json +``` + +A possible configuration file could look like this: +```json +{ + "executions": { + "process": "main", + "saveDataOnSuccess": "none" + }, + "generic": { + "timezone": "Europe/Berlin" + }, + "security": { + "basicAuth": { + "active": true, + "user": "frank", + "password": "some-secure-password" + } + }, + "nodes": { + "exclude": "[\"n8n-nodes-base.executeCommand\",\"n8n-nodes-base.writeBinaryFile\"]" + } +} +``` + +All possible values which can be set and their defaults can be found here: + +[https://github.com/n8n-io/n8n/blob/master/packages/cli/config/index.ts](https://github.com/n8n-io/n8n/blob/master/packages/cli/config/index.ts) diff --git a/create-node.md b/create-node.md new file mode 100644 index 0000000000..183c11c734 --- /dev/null +++ b/create-node.md @@ -0,0 +1,145 @@ +# Create Node + +It is quite easy to create your own nodes in n8n. Mainly three things have to be defined: + + 1. Generic information like name, description, image/icon + 1. The parameters to display via which the user can interact with it + 1. The code to run once the node gets executed + +To simplify the development process, we created a very basic CLI which creates boilerplate code to get started, builds the node (as they are written in TypeScript), and copies it to the correct location. + + +## Create the first basic node + + 1. Install the n8n-node-dev CLI: `npm install -g n8n-node-dev` + 1. Create and go into the newly created folder in which you want to keep the code of the node + 1. Use CLI to create boilerplate node code: `n8n-node-dev new` + 1. Answer the questions (the “Execute” node type is the regular node type that you probably want to create). + It will then create the node in the current folder. + 1. Program… Add the functionality to the node + 1. Build the node and copy to correct location: `n8n-node-dev build` + That command will build the JavaScript version of the node from the TypeScript code and copy it to the user folder where custom nodes get read from `~/.n8n/custom/` + 1. Restart n8n and refresh the window so that the new node gets displayed + + +## Create own custom n8n-nodes-module + +If you want to create multiple custom nodes which are either: + + - Only for yourself/your company + - Are only useful for a small number of people + - Require many or large dependencies + +It is best to create your own `n8n-nodes-module` which can be installed separately. +That is a simple npm package that contains the nodes and is set up in a way +that n8n can automatically find and load them on startup. + +When creating such a module the following rules have to be followed that n8n +can automatically find the nodes in the module: + + - The name of the module has to start with `n8n-nodes-` + - The `package.json` file has to contain a key `n8n` with the paths to nodes and credentials + - The module has to be installed alongside n8n + +An example starter module which contains one node and credentials and implements +the above can be found here: + +[https://github.com/n8n-io/n8n-nodes-starter](https://github.com/n8n-io/n8n-nodes-starter) + + +### Setup to use n8n-nodes-module + +To use a custom `n8n-nodes-module`, it simply has to be installed alongside n8n. +For example like this: + +```bash +# Create folder for n8n installation +mkdir my-n8n +cd my-n8n + +# Install n8n +npm install n8n + +# Install custom nodes module +npm install n8n-nodes-my-custom-nodes + +# Start n8n +n8n +``` + + +### Development/Testing of custom n8n-nodes-module + +This works in the same way as for any other npm module. + +Execute in the folder which contains the code of the custom `n8n-nodes-module` +which should be loaded with n8n: + +```bash +# Build the code +npm run build + +# "Publish" the package locally +npm link +``` + +Then in the folder in which n8n is installed: + +```bash +# "Install" the above locally published module +npm link n8n-nodes-my-custom-nodes + +# Start n8n +n8n +``` + + + +## Node Development Guidelines + + +Please make sure that everything works correctly and that no unnecessary code gets added. It is important to follow the following guidelines: + + +### Do not change incoming data + +Never change the incoming data a node receives (which can be queried with `this.getInputData()`) as it gets shared by all nodes. If data has to get added, changed or deleted it has to be cloned and the new data returned. If that is not done, sibling nodes which execute after the current one will operate on the altered data and would process different data than they were supposed to. +It is however not needed to always clone all the data. If a node for, example only, changes only the binary data but not the JSON data, a new item can be created which reuses the reference to the JSON item. + +An example can be seen in the code of the [ReadBinaryFile-Node](https://github.com/n8n-io/n8n/blob/master/packages/nodes-base/nodes/ReadBinaryFile.node.ts#L69-L83). + + +### Write nodes in TypeScript + +All code of n8n is written in TypeScript and hence, the nodes should also be written in TypeScript. That makes development easier, faster, and avoids at least some bugs. + + +### Use the built in request library + +Some third-party services have their own libraries on npm which make it easier to create an integration. It can be quite tempting to use them. The problem with those is that you add another dependency and not just one you add but also all the dependencies of the dependencies. This means more and more code gets added, has to get loaded, can introduce security vulnerabilities, bugs and so on. So please use the built-in module which can be used like this: + +```typescript +const response = await this.helpers.request(options); +``` + +That is simply using the npm package [`request-promise-native`](https://github.com/request/request-promise-native) which is the basic npm `request` module but with promises. For a full set of `options` consider looking at [the underlying `request` options documentation](https://github.com/request/request#requestoptions-callback). + + +### Reuse parameter names + +When a node can perform multiple operations like edit and delete some kind of entity, for both operations, it would need an entity-id. Do not call them "editId" and "deleteId" simply call them "id". n8n can handle multiple parameters with the same name without a problem as long as only one is visible. To make sure that is the case, the "displayOptions" can be used. By keeping the same name, the value can be kept if a user switches the operation from "edit" to "delete". + + +### Create an "Options" parameter + +Some nodes may need a lot of options. Add only the very important ones to the top level and for all others, create an "Options" parameter where they can be added if needed. This ensures that the interface stays clean and does not unnecessarily confuse people. A good example of that would be the XML node. + + +### Follow existing parameter naming guideline + +There is not much of a guideline yet but if your node can do multiple things, call the parameter which sets the behavior either "mode" (like "Merge" and "XML" node) or "operation" like the most other ones. If these operations can be done on different resources (like "User" or "Order) create a "resource" parameter (like "Pipedrive" and "Trello" node) + + +### Node Icons + +Check existing node icons as a reference when you create own ones. The resolution of an icon should be 60x60px and saved as PNG. diff --git a/data-structure.md b/data-structure.md new file mode 100644 index 0000000000..daeea8474d --- /dev/null +++ b/data-structure.md @@ -0,0 +1,39 @@ +# Data Structure + +For "basic usage" it is not necessarily needed to understand how the data that +gets passed from one node to another is structured. However, it becomes important if you want to: + + - create your own node + - write custom expressions + - use the Function or Function Item node + - you want to get the most out of n8n + + +In n8n, all the data that is passed between nodes is an array of objects. It has the following structure: + +```json +[ + { + // Each item has to contain a "json" property. But it can be an empty object like {}. + // Any kind of JSON data is allowed. So arrays and the data being deeply nested is fine. + json: { // The actual data n8n operates on (required) + // This data is only an example it could be any kind of JSON data + jsonKeyName: 'keyValue', + anotherJsonKey: { + lowerLevelJsonKey: 1 + } + }, + // Binary data of item. The most items in n8n do not contain any (optional) + binary: { + // The key-name "binaryKeyName" is only an example. Any kind of key-name is possible. + binaryKeyName: { + data: '....', // Base64 encoded binary data (required) + mimeType: 'image/png', // Optional but should be set if possible (optional) + fileExtension: 'png', // Optional but should be set if possible (optional) + fileName: 'example.png', // Optional but should be set if possible (optional) + } + } + }, + ... +] +``` diff --git a/database.md b/database.md new file mode 100644 index 0000000000..041520cf15 --- /dev/null +++ b/database.md @@ -0,0 +1,109 @@ +# Database + +By default, n8n uses SQLite to save credentials, past executions, and workflows. However, +n8n also supports MongoDB and PostgresDB. + + +## Shared Settings + +The following environment variables get used by all databases: + + - `DB_TABLE_PREFIX` (default: '') - Prefix for table names + + +## MongoDB + +!> **WARNING**: Use PostgresDB, if possible! MongoDB has problems saving large + amounts of data in a document, among other issues. So, support + may be dropped in the future. + +To use MongoDB as the database, you can provide the following environment variables like +in the example below: + - `DB_TYPE=mongodb` + - `DB_MONGODB_CONNECTION_URL=` + +Replace the following placeholders with the actual data: + - MONGO_DATABASE + - MONGO_HOST + - MONGO_PORT + - MONGO_USER + - MONGO_PASSWORD + +```bash +export DB_TYPE=mongodb +export DB_MONGODB_CONNECTION_URL=mongodb://MONGO_USER:MONGO_PASSWORD@MONGO_HOST:MONGO_PORT/MONGO_DATABASE +n8n start +``` + + +## PostgresDB + +To use PostgresDB as the database, you can provide the following environment variables + - `DB_TYPE=postgresdb` + - `DB_POSTGRESDB_DATABASE` (default: 'n8n') + - `DB_POSTGRESDB_HOST` (default: 'localhost') + - `DB_POSTGRESDB_PORT` (default: 5432) + - `DB_POSTGRESDB_USER` (default: 'root') + - `DB_POSTGRESDB_PASSWORD` (default: empty) + - `DB_POSTGRESDB_SCHEMA` (default: 'public') + + +```bash +export DB_TYPE=postgresdb +export DB_POSTGRESDB_DATABASE=n8n +export DB_POSTGRESDB_HOST=postgresdb +export DB_POSTGRESDB_PORT=5432 +export DB_POSTGRESDB_USER=n8n +export DB_POSTGRESDB_PASSWORD=n8n +export DB_POSTGRESDB_SCHEMA=n8n + +n8n start +``` + +## MySQL / MariaDB + +The compatibility with MySQL/MariaDB has been tested. Even then, it is advisable to observe the operation of the application with this database as this option has been recently added. If you spot any problems, feel free to submit a burg report or a pull request. + +To use MySQL as database you can provide the following environment variables: + - `DB_TYPE=mysqldb` or `DB_TYPE=mariadb` + - `DB_MYSQLDB_DATABASE` (default: 'n8n') + - `DB_MYSQLDB_HOST` (default: 'localhost') + - `DB_MYSQLDB_PORT` (default: 3306) + - `DB_MYSQLDB_USER` (default: 'root') + - `DB_MYSQLDB_PASSWORD` (default: empty) + + +```bash +export DB_TYPE=mysqldb +export DB_MYSQLDB_DATABASE=n8n +export DB_MYSQLDB_HOST=mysqldb +export DB_MYSQLDB_PORT=3306 +export DB_MYSQLDB_USER=n8n +export DB_MYSQLDB_PASSWORD=n8n + +n8n start +``` + +## SQLite + +This is the default database that gets used if nothing is defined. + +The database file is located at: +`~/.n8n/database.sqlite` + + +## Other Databases + +Currently, only the databases mentioned above are supported. n8n internally uses +[TypeORM](https://typeorm.io), so adding support for the following databases +should not be too much work: + + - CockroachDB + - Microsoft SQL + - Oracle + +If you cannot use any of the currently supported databases for some reason and +you can code, we'd appreciate your support in the form of a pull request. If not, you can request +for support here: + +[https://community.n8n.io/c/feature-requests/cli](https://community.n8n.io/c/feature-requests/cli) diff --git a/development.md b/development.md new file mode 100644 index 0000000000..d7d8de4744 --- /dev/null +++ b/development.md @@ -0,0 +1,3 @@ +# Development + +Have you found a bug :bug:? Or maybe you have a nice feature :sparkles: to contribute? The [CONTRIBUTING guide](https://github.com/n8n-io/n8n/blob/master/CONTRIBUTING.md) will help you get your development environment ready in minutes. diff --git a/docker.md b/docker.md new file mode 100644 index 0000000000..317b5b9552 --- /dev/null +++ b/docker.md @@ -0,0 +1,7 @@ +# Docker + +Detailed information about how to run n8n in Docker can be found in the README +of the [Docker Image](https://github.com/n8n-io/n8n/blob/master/docker/images/n8n/README.md). + +A basic step by step example setup of n8n with docker-compose and Let's Encrypt is available on the +[Server Setup](server-setup.md) page. diff --git a/faq.md b/faq.md new file mode 100644 index 0000000000..2b03a0b76d --- /dev/null +++ b/faq.md @@ -0,0 +1,47 @@ +# FAQ + +## Integrations + + +### Can you create an integration for service X? + +You can request new integrations to be added to our forum. There is a special section for that where +other users can also upvote it so that we know which integrations are important and should be +created next. Request a new feature [here](https://community.n8n.io/c/feature-requests/nodes). + + +### An integration exists already but a feature is missing. Can you add it? + +Adding new functionality to an existing integration is normally not that complicated. So the chance is +high that we can do that quite fast. Post your feature request in the forum and we'll see +what we can do. Request a new feature [here](https://community.n8n.io/c/feature-requests/nodes). + + +### How can I create an integration myself? + +Information about that can be found in the [CONTRIBUTING guide](https://github.com/n8n-io/n8n/blob/master/CONTRIBUTING.md). + + +## License + + +### Which license does n8n use? + +n8n is [fair-code](http://faircode.io) licensed under [Apache 2.0 with Commons Clause](https://github.com/n8n-io/n8n/blob/master/packages/cli/LICENSE.md) + + +### Is n8n open-source? + +No. The [Commons Clause](https://commonsclause.com) that is attached to the Apache 2.0 license takes away some rights. Hence, according to the definition of the [Open Source Initiative (OSI)](https://opensource.org/osd), n8n is not open-source. Nonetheless, the source code is open and everyone (individuals and companies) can use it for free. However, it is not allowed to make money directly with n8n. + +For instance, one cannot charge others to host or support n8n. However, to make things simpler, we grant everyone (individuals and companies) the right to offer consulting or support without prior permission as long as it is less than 30,000 USD ($30k) per annum. +If your revenue from services based on n8n is greater than $30k per annum, we'd invite you to become a partner and apply for a license. If you have any questions about this, feel free to reach out to us at [license@n8n.io](mailto:license@n8n.io). + + +### Why is n8n not open-source but [fair-code](http://faircode.io) licensed instead? + +We love open-source and the idea that everybody can freely use and extend what we wrote. Our community is at the heart of everything that we do and we understand that people who contribute to a project are the main drivers that push a project forward. So to make sure that the project continues to evolve and stay alive in the longer run, we decided to attach the Commons Clause. This ensures that no other person or company can make money directly with n8n. Especially if it competes with how we plan to finance our further development. For the greater majority of the people, it will not make any difference at all. At the same time, it protects the project. + +As n8n itself depends on and uses a lot of other open-source projects, it is only fair that we support them back. That is why we have planned to contribute a certain percentage of revenue/profit every month to these projects. + +We have already started with the first monthly contributions via [Open Collective](https://opencollective.com/n8n). It is not much yet, but we hope to be able to ramp that up substantially over time. diff --git a/images/n8n-logo.png b/images/n8n-logo.png new file mode 100644 index 0000000000..a77f36aeee Binary files /dev/null and b/images/n8n-logo.png differ diff --git a/images/n8n-screenshot.png b/images/n8n-screenshot.png new file mode 100644 index 0000000000..55b476cfb6 Binary files /dev/null and b/images/n8n-screenshot.png differ diff --git a/index.html b/index.html new file mode 100644 index 0000000000..bd53af45e6 --- /dev/null +++ b/index.html @@ -0,0 +1,53 @@ + + + + + + n8n Documentation + + + + + + + + +

+ + + + + + + + + + + + + diff --git a/key-components.md b/key-components.md new file mode 100644 index 0000000000..9caba3a0b0 --- /dev/null +++ b/key-components.md @@ -0,0 +1,25 @@ +# Key Components + + +## Connection + +A connection establishes a link between nodes to route data through the workflow. Each node can have one or multiple connections. + + +## Node + +A node is an entry point for retrieving data, a function to process data or an exit for sending data. The data process includes filtering, recomposing and changing data. There can be one or several nodes for your API, service or app. You can easily connect multiple nodes, which allows you to create simple and complex workflows with them intuitively. + +For example, consider a Google Sheets node. It can be used to retrieve or write data to a Google Sheet. + + +## Trigger Node + +A trigger node is a node that starts a workflow and supplies the initial data. What triggers it, depends on the node. It could be the time, a webhook call or an event from an external service. + +For example, consider a Trello trigger node. When a Trello Board gets updated, it will trigger a workflow to start using the data from the updated board. + + +## Workflow + +A workflow is a canvas on which you can place and connect nodes. A workflow can be started manually or by trigger nodes. A workflow run ends when all active and connected nodes have processed their data. diff --git a/keyboard-shortcuts.md b/keyboard-shortcuts.md new file mode 100644 index 0000000000..ace6db8d8e --- /dev/null +++ b/keyboard-shortcuts.md @@ -0,0 +1,28 @@ +# Keyboard Shortcuts + +The following keyboard shortcuts can currently be used: + +## General + + - **Ctrl + Left Mouse Button**: Move/Pan Node View + - **Ctrl + a**: Select all nodes + - **Ctrl + Alt + n**: Create new workflow + - **Ctrl + o**: Open workflow + - **Ctrl + s**: Save the current workflow + - **Ctrl + v**: Paste nodes + - **Tab**: Open "Node Creator". Type to filter and navigate with arrow keys. To create press "enter" + + +## With node(s) selected + + - **ArrowDown**: Select sibling node bellow the current one + - **ArrowLeft**: Select node left of the current one + - **ArrowRight**: Select node right of the current one + - **ArrowUp**: Select sibling node above the current one + - **Ctrl + c**: Copy nodes + - **Ctrl + x**: Cut nodes + - **d**: Deactivate nodes + - **Delete**: Delete nodes + - **F2**: Rename node + - **Shift + ArrowLeft**: Select all nodes left of the current one + - **Shift + ArrowRight**: Select all nodes right of the current one diff --git a/license.md b/license.md new file mode 100644 index 0000000000..ace732e676 --- /dev/null +++ b/license.md @@ -0,0 +1,5 @@ +# License + +n8n is [fair-code](http://faircode.io) licensed under [Apache 2.0 with Commons Clause](https://github.com/n8n-io/n8n/blob/master/packages/cli/LICENSE.md) + +Additional information about the license can be found in the [FAQ](faq.md?id=license) and [fair-code](http://faircode.io). diff --git a/node-basics.md b/node-basics.md new file mode 100644 index 0000000000..aea6bf6e33 --- /dev/null +++ b/node-basics.md @@ -0,0 +1,76 @@ +# Node Basics + + +## Types + +There are two main node types in n8n: Trigger nodes and Regular nodes. + + +### Trigger Nodes + +The Trigger nodes start a workflow and supply the initial data. A workflow can contain multiple trigger nodes but with each execution, only one of them will execute. This is because the other trigger nodes would not have any input as they are the nodes from which the execution of the workflow starts. + + +### Regular Nodes + +These nodes do the actual work. They can add, remove, and edit the data in the flow as well as request and send data to external APIs. They can do everything possible with Node.js in general. + + +## 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 very long multi-line private key and can be saved in n8n as credentials. + +Nodes in n8n can then request that credential information. As an additional layer of security credentials can only be accessed by node types which specifically have the right to do so. + +To make sure that the data is secure, it gets saved to the database encrypted. A random personal encryption key is used which gets automatically generated on the first run of n8n and then saved under `~/.n8n/config`. + + +## Expressions + +With the help of expressions, it is possible to set node parameters dynamically by referencing other data. That can be data from the flow, nodes, the environment or self-generated data. Expressions are normal text with placeholders (everything between {{...}}) that can execute JavaScript code, which offers access to special variables to access data. + +An expression could look like this: + +My name is: `{{$node["Webhook"].json["query"]["name"]}}` + +This one would return "My name is: " and then attach the value that the node with the name "Webhook" outputs and there select the property "query" and its key "name". So if the node would output this data: + +```json +{ + "query": { + "name": "Jim" + } +} +``` + +the value would be: "My name is: Jim" + +The following special variables are available: + + - **$binary**: Incoming binary data of a node + - **$evaluateExpression**: Evaluates a string as expression + - **$env**: Environment variables + - **$items**: Environment variables + - **$json**: Incoming JSON data of a node + - **$node**: Data of other nodes (binary, context, json, parameter, runIndex) + - **$parameters**: Parameters of the current node + - **$runIndex**: The current run index (first time node gets executed it is 0, second time 1, ...) + - **$workflow**: Returns workflow metadata like: active, id, name + +Normally it is not needed to write the JavaScript variables manually as they can be selected with the help of the Expression Editor. + + +## Parameters + +Parameters can be set for most nodes in n8n. The values that get set define what exactly a node does. + +Parameter values are static by default and are always the same no matter what kind of data the node processes. However, it is possible to set the values dynamically with the help of an Expression. Using Expressions, it is possible to make the parameter value dependent on other factors like the data of flow or parameters of other nodes. + +More information about it can be found under [Expressions](#expressions). + + +## Pausing Node + +Sometimes when creating and debugging a workflow, it is helpful to not execute specific nodes. To do that without disconnecting each node, you can pause them. When a node gets paused, the data passes through the node without being changed. + +There are two ways to pause a node. You can either press the pause button which gets displayed above the node when hovering over it or select the node and press “d”. diff --git a/nodes.md b/nodes.md new file mode 100644 index 0000000000..8b9c7cbf0e --- /dev/null +++ b/nodes.md @@ -0,0 +1,247 @@ +# Nodes + +## Function and Function Item Nodes + +These are the most powerful nodes in n8n. With these, almost everything can be done if you know how to +write JavaScript code. Both nodes work very similarly. They give you access to the incoming data +and you can manipulate it. + + +### Difference between both nodes + +The difference is that the code of the Function node gets executed only once. It receives the +full items (JSON and binary data) as an array and expects an array of items as a return value. The items +returned can be totally different from the incoming ones. So it is not only possible to remove and edit +existing items, but also to add or return totally new ones. + +The code of the Function Item node on the other hand gets executed once for every item. It receives +one item at a time as input and also just the JSON data. As a return value, it expects the JSON data +of one single item. That makes it possible to add, remove and edit JSON properties of items +but it is not possible to add new or remove existing items. Accessing and changing binary data is only +possible via the methods `getBinaryData` and `setBinaryData`. + +Both nodes support promises. So instead of returning the item or items directly, it is also possible to +return a promise which resolves accordingly. + + +### Function-Node + +#### Variable: items + +It contains all the items that the node received as input. + +Information about how the data is structured can be found on the page [Data Structure](data-structure.md). + +The data can be accessed and manipulated like this: + +```typescript +// Sets the JSON data property "myFileName" of the first item to the name of the +// file which is set in the binary property "image" of the same item. +items[0].json.myFileName = items[0].binary.image.fileName; + +return items; +``` + +This example creates 10 dummy items with the ids 0 to 9: + +```typescript +const newItems = []; + +for (let i=0;i<10;i++) { + newItems.push({ + json: { + id: i + } + }); +} + +return newItems; +``` + + +#### Method: $item(index: number, runIndex?: number) + +With `$item` it is possible to access the data of parent nodes. That can be the item data but also +the parameters. It expects as input an index of the item the data should be returned for. This is +needed because for each item the data returned can be different. This is probably obvious for the +item data itself but maybe less for data like parameters. The reason why it is also needed, is +that they may contain an expression. Expressions get always executed of the context for an item. +If that would not be the case, for example, the Email Send node not would be able to send multiple +emails at once to different people. Instead, the same person would receive multiple emails. + +The index is 0 based. So `$item(0)` will return the first item, `$item(1)` the second one, ... + +By default the item of the last run of the node will be returned. So if the referenced node ran +3x (its last runIndex is 2) and the current node runs the first time (its runIndex is 0) the +data of runIndex 2 of the referenced node will be returned. + +For more information about what data can be accessed via $node, check [here](#variable-node). + +Example: + +```typescript +// Returns the value of the JSON data property "myNumber" of Node "Set" (first item) +const myNumber = $item(0).$node["Set"].json["myNumber"]; +// Like above but data of the 6th item +const myNumber = $item(5).$node["Set"].json["myNumber"]; + +// Returns the value of the parameter "channel" of Node "Slack". +// If it contains an expression the value will be resolved with the +// data of the first item. +const channel = $item(0).$node["Slack"].parameter["channel"]; +// Like above but resolved with the value of the 10th item. +const channel = $item(9).$node["Slack"].parameter["channel"]; +``` + + +#### Method: $items(nodeName?: string, outputIndex?: number, runIndex?: number) + +Gives access to all the items of current or parent nodes. If no parameters get supplied, +it returns all the items of the current node. +If a node-name is given, it returns the items the node output on its first output +(index: 0, most nodes only have one output, exceptions are IF and Switch-Node) on +its last run. + +Example: + +```typescript +// Returns all the items of the current node and current run +const allItems = $items(); + +// Returns all items the node "IF" outputs (index: 0 which is Output "true" of its most recent run) +const allItems = $items("IF"); + +// Returns all items the node "IF" outputs (index: 0 which is Output "true" of the same run as current node) +const allItems = $items("IF", 0, $runIndex); + +// Returns all items the node "IF" outputs (index: 1 which is Output "false" of run 0 which is the first run) +const allItems = $items("IF", 1, 0); +``` + + +#### Variable: $node + +Works exactly like `$item` with the difference that it will always return the data of the first item and +the last run of the node. + +```typescript +// Returns the fileName of binary property "data" of Node "HTTP Request" +const fileName = $node["HTTP Request"].binary["data"]["fileName"]}} + +// Returns the context data "noItemsLeft" of Node "SplitInBatches" +const noItemsLeft = $node["SplitInBatches"].context["noItemsLeft"]; + +// Returns the value of the JSON data property "myNumber" of Node "Set" +const myNumber = $node["Set"].json['myNumber']; + +// Returns the value of the parameter "channel" of Node "Slack" +const channel = $node["Slack"].parameter["channel"]; + +// Returns the index of the last run of Node "HTTP Request" +const runIndex = $node["HTTP Request"].runIndex}} +``` + + +#### Variable: $runIndex + +Contains the index of the current run of the node. + +```typescript +// Returns all items the node "IF" outputs (index: 0 which is Output "true" of the same run as current node) +const allItems = $items("IF", 0, $runIndex); +``` + + +#### Variable: $workflow + +Gives information about the current workflow. + +```typescript +const isActive = $workflow.active; +const workflowId = $workflow.id; +const workflowName = $workflow.name; +``` + + +#### Method: $evaluateExpression(expression: string, itemIndex: number) + +Evaluates a given string as expression. +If no `itemIndex` is provided it uses by default in the Function-Node the data of item 0 and +in the Function Item-Node the data of the current item. + +Example: + +```javascript +items[0].json.variable1 = $evaluateExpression('{{1+2}}'); +items[0].json.variable2 = $evaluateExpression($node["Set"].json["myExpression"], 1); + +return items; +``` + + +#### Method: getWorkflowStaticData(type) + +Gives access to the static workflow data. +It is possible to save data directly with the workflow. This data should, however, be very small. +A common use case is to for example to save a timestamp of the last item that got processed from +an RSS-Feed or database. It will always return an object. Properties can then read, delete or +set on that object. When the workflow execution succeeds, n8n will check automatically if the data +has changed and will save it, if necessary. + +There are two types of static data. The "global" and the "node" one. Global static data is the +same in the whole workflow. And every node in the workflow can access it. The node static data +, however, is different for every node and only the node which set it can retrieve it again. + +Example: + +```javascript +// Get the global workflow static data +const staticData = getWorkflowStaticData('global'); +// Get the static data of the node +const staticData = getWorkflowStaticData('node'); + +// Access its data +const lastExecution = staticData.lastExecution; + +// Update its data +staticData.lastExecution = new Date().getTime(); + +// Delete data +delete staticData.lastExecution; +``` + +It is important to know that the static data can not be read and written when testing via the UI. +The data there will always be empty and the changes will not persist. Only when a workflow +is active and it gets called by a Trigger or Webhook, the static data will be saved. + + + +### Function Item-Node + + +#### Variable: item + +It contains the "json" data of the currently processed item. + +The data can be accessed and manipulated like this: + +```json +// Uses the data of an already existing key to create a new additional one +item.newIncrementedCounter = item.existingCounter + 1; +return item; +``` + + +#### Method: getBinaryData() + +Returns all the binary data (all keys) of the item which gets currently processed. + + +#### Method: setBinaryData(binaryData) + +Sets all the binary data (all keys) of the item which gets currently processed. + + +#### Method: getWorkflowStaticData(type) + +As described above for Function node. diff --git a/quick-start.md b/quick-start.md new file mode 100644 index 0000000000..0c33cafbe8 --- /dev/null +++ b/quick-start.md @@ -0,0 +1,43 @@ +# Quick Start + + +## Give n8n a spin + +To spin up n8n, you can run: + +```bash +npx n8n +``` + +It will download everything that is needed to start n8n. + +You can then access n8n by opening: +[http://localhost:5678](http://localhost:5678) + + +## Start with docker + +To play around with n8n, you can also start it using docker: + +```bash +docker run -it --rm \ + --name n8n \ + -p 5678:5678 \ + n8nio/n8n +``` + +Be aware that all the data will be lost once the docker container gets removed. To +persist the data mount the `~/.n8n` folder: + +```bash +docker run -it --rm \ + --name n8n \ + -p 5678:5678 \ + -v ~/.n8n:/root/.n8n \ + n8nio/n8n +``` + +More information about the Docker setup can be found in the README file of the +[Docker Image](https://github.com/n8n-io/n8n/blob/master/docker/images/n8n/README.md). + +In case you run into issues, check out the [troubleshooting](troubleshooting.md) page or ask for help in the community [forum](https://community.n8n.io/). diff --git a/security.md b/security.md new file mode 100644 index 0000000000..5682b2c29a --- /dev/null +++ b/security.md @@ -0,0 +1,13 @@ +# Security + +By default, n8n can be accessed by everybody. This is okay if you only have it running +locally but if you deploy it on a server which is accessible from the web, you have +to make sure that n8n is protected. +Right now we have very basic protection in place using basic-auth. It can be activated +by setting the following environment variables: + +```bash +export N8N_BASIC_AUTH_ACTIVE=true +export N8N_BASIC_AUTH_USER= +export N8N_BASIC_AUTH_PASSWORD= +``` diff --git a/sensitive-data.md b/sensitive-data.md new file mode 100644 index 0000000000..fa7b0bb1b6 --- /dev/null +++ b/sensitive-data.md @@ -0,0 +1,18 @@ +# Sensitive Data via File + +To avoid passing sensitive information via environment variables, "_FILE" may be +appended to some environment variables. It will then load the data from a file +with the given name. That makes it possible to load data easily from +Docker and Kubernetes secrets. + +The following environment variables support file input: + + - DB_MONGODB_CONNECTION_URL_FILE + - DB_POSTGRESDB_DATABASE_FILE + - DB_POSTGRESDB_HOST_FILE + - DB_POSTGRESDB_PASSWORD_FILE + - DB_POSTGRESDB_PORT_FILE + - DB_POSTGRESDB_USER_FILE + - DB_POSTGRESDB_SCHEMA_FILE + - N8N_BASIC_AUTH_PASSWORD_FILE + - N8N_BASIC_AUTH_USER_FILE diff --git a/server-setup.md b/server-setup.md new file mode 100644 index 0000000000..d34d076a6f --- /dev/null +++ b/server-setup.md @@ -0,0 +1,183 @@ +# Server Setup + +!> ***Important***: Make sure that you secure your n8n instance as described under [Security](security.md). + + +## Example setup with docker-compose + +If you have already installed docker and docker-compose, then you can directly start with step 4. + + +### 1. Install Docker + +This can vary depending on the Linux distribution used. Example bellow is for Ubuntu: + +```bash +sudo apt update +sudo apt install apt-transport-https ca-certificates curl software-properties-common +curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - +sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu bionic stable" +sudo apt update +sudo apt install docker-ce -y +``` + +### 2. Optional: If it should run as not root user + +Run when logged in as the user that should also be allowed to run docker: + +```bash +sudo usermod -aG docker ${USER} +su - ${USER} +``` + +### 3. Install Docker-compose + +This can vary depending on the Linux distribution used. Example bellow is for Ubuntu: + +Check before what version the latestand replace "1.24.1" with that version accordingly. +https://github.com/docker/compose/releases + +```bash +sudo curl -L https://github.com/docker/compose/releases/download/1.24.1/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose +sudo chmod +x /usr/local/bin/docker-compose +``` + + +### 4. Setup DNS + +Add A record to route the subdomain accordingly. + +``` +Type: A +Name: n8n (or whatever the subdomain should be) +IP address: +``` + + +### 5. Create docker-compose file + +Save this file as `docker-compose.yml` + +Normally no changes should be needed. + +```yaml +version: "3" + +services: + traefik: + image: "traefik" + command: + - "--api=true" + - "--api.insecure=true" + - "--providers.docker=true" + - "--providers.docker.exposedbydefault=false" + - "--entrypoints.websecure.address=:443" + - "--certificatesresolvers.mytlschallenge.acme.tlschallenge=true" + - "--certificatesresolvers.mytlschallenge.acme.email=${SSL_EMAIL}" + - "--certificatesresolvers.mytlschallenge.acme.storage=/letsencrypt/acme.json" + ports: + - "443:443" + volumes: + - ${DATA_FOLDER}/letsencrypt:/letsencrypt + - /var/run/docker.sock:/var/run/docker.sock:ro + + n8n: + image: n8nio/n8n + ports: + - "127.0.0.1:5678:5678" + labels: + - traefik.enable=true + - traefik.http.routers.n8n.rule=Host(`${SUBDOMAIN}.${DOMAIN_NAME}`) + - traefik.http.routers.n8n.tls=true + - traefik.http.routers.n8n.entrypoints=websecure + - traefik.http.routers.n8n.tls.certresolver=mytlschallenge + - traefik.http.middlewares.n8n.headers.SSLRedirect=true + - traefik.http.middlewares.n8n.headers.STSSeconds=315360000 + - traefik.http.middlewares.n8n.headers.browserXSSFilter=true + - traefik.http.middlewares.n8n.headers.contentTypeNosniff=true + - traefik.http.middlewares.n8n.headers.forceSTSHeader=true + - traefik.http.middlewares.n8n.headers.SSLHost=${DOMAIN_NAME} + - traefik.http.middlewares.n8n.headers.STSIncludeSubdomains=true + - traefik.http.middlewares.n8n.headers.STSPreload=true + environment: + - N8N_BASIC_AUTH_ACTIVE=true + - N8N_BASIC_AUTH_USER + - N8N_BASIC_AUTH_PASSWORD + - N8N_HOST=${SUBDOMAIN}.${DOMAIN_NAME} + - N8N_PORT=5678 + - N8N_LISTEN_ADDRESS=0.0.0.0 + - N8N_PROTOCOL=https + - NODE_ENV=production + - WEBHOOK_TUNNEL_URL=https://${SUBDOMAIN}.${DOMAIN_NAME}/ + - VUE_APP_URL_BASE_API=https://${SUBDOMAIN}.${DOMAIN_NAME}/ + volumes: + - /var/run/docker.sock:/var/run/docker.sock + - ${DATA_FOLDER}/.n8n:/root/.n8n +``` + + +### 6. Create `.env` file + +Create `.env` file and change it accordingly. + +```bash +# Folder where data should be saved +DATA_FOLDER=/root/n8n/ + +# The top level domain to serve from +DOMAIN_NAME=example.com + +# The subdomain to serve from +SUBDOMAIN=n8n + +# DOMAIN_NAME and SUBDOMAIN combined decide where n8n will be reachable from +# above example would result in: https://n8n.example.com + +# The user name to use for autentication - IMPORTANT ALWAYS CHANGE! +N8N_BASIC_AUTH_USER=user + +# The password to use for autentication - IMPORTANT ALWAYS CHANGE! +N8N_BASIC_AUTH_PASSWORD=password + +# Optional timezone to set which gets used by Cron-Node by default +# If not set New York time will be used +GENERIC_TIMEZONE=Europe/Berlin + +# The email address to use for the SSL certificate creation +SSL_EMAIL=user@example.com +``` + + +### 7. Create data folder + +Create the folder which is defined as `DATA_FOLDER`. In the example +above, it is `/root/n8n/`. + +In that folder, the database file from SQLite as well as the encryption key will be saved. + +The folder can be created like this: +``` +mkdir /root/n8n/ +``` + + +### 8. Start docker-compose setup + +n8n can now be started via: + +```bash +sudo docker-compose up -d +``` + +In case it should ever be stopped that can be done with this command: +```bash +sudo docker-compose stop +``` + + +### 9. Done + +n8n will now be reachable via the above defined subdomain + domain combination. +The above example would result in: https://n8n.example.com + +n8n will only be reachable via https and not via http. diff --git a/setup.md b/setup.md new file mode 100644 index 0000000000..27e65e54ea --- /dev/null +++ b/setup.md @@ -0,0 +1,35 @@ +# Setup + + +## Installation + +To install n8n globally: + +```bash +npm install n8n -g +``` + +## Start + +After the installation n8n can be started by simply typing in: + +```bash +n8n +# or +n8n start +``` + + +## Start with tunnel + +!> **WARNING**: This is only meant for local development and testing. It should not be used in production! + +To be able to use webhooks for trigger nodes of external services like GitHub, n8n has to be reachable from the web. To make that easy, n8n has a special tunnel service, which redirects requests from our servers to your local n8n instance (uses this code: [https://github.com/localtunnel/localtunnel](https://github.com/localtunnel/localtunnel)). + +To use it, simply start n8n with `--tunnel` + +```bash +n8n start --tunnel +``` + +In case you run into issues, check out the [troubleshooting](troubleshooting.md) page or ask for help in the community [forum](https://community.n8n.io/). diff --git a/start-workflows-via-cli.md b/start-workflows-via-cli.md new file mode 100644 index 0000000000..6327f32963 --- /dev/null +++ b/start-workflows-via-cli.md @@ -0,0 +1,15 @@ +# Start Workflows via CLI + +Workflows cannot be only started by triggers, webhooks or manually via the +Editor. It is also possible to start them directly via the CLI. + +Execute a saved workflow by its ID: + +```bash +n8n execute --id +``` + +Execute a workflow from a workflow file: +```bash +n8n execute --file +``` diff --git a/test.md b/test.md new file mode 100644 index 0000000000..02a308b3ad --- /dev/null +++ b/test.md @@ -0,0 +1,3 @@ +# This is a simple test + +with some text diff --git a/troubleshooting.md b/troubleshooting.md new file mode 100644 index 0000000000..7e6b4b058b --- /dev/null +++ b/troubleshooting.md @@ -0,0 +1,58 @@ +# Troubleshooting + +## Windows + +If you are experiencing issues running n8n with the typical flow of: + +```powershell +npx n8n +``` + +### Requirements + +Please ensure that you have the following requirements fulfilled: + +- Install latest version of [NodeJS](https://nodejs.org/en/download/) +- Install [Python 2.7](https://www.python.org/downloads/release/python-2717/) (It is okay to have multiple versions installed on the machine) +- Windows SDK +- C++ Desktop Development Tools +- Windows Build Tools + +#### Install build tools + +If you haven't satisfied the above, follow this procedure through your PowerShell (run with administrative privileges). +This command installs the build tools, windows SDK and the C++ development tools in one package. + +```powershell +npm install --global --production windows-build-tools +``` + +#### Configure npm to use Python version 2.7 + +```powershell +npm config set python python2.7 +``` + +#### Configure npm to use correct msvs version + +```powershell +npm config set msvs_version 2017 --global +``` + +### Lesser known issues: + +#### mmmagic npm package when using MSbuild tools with Visual Studio + +While installing this package, `node-gyp` is run and it might fail to install it with an error appearing in the ballpark of: + +``` +gyp ERR! stack Error: spawn C:\Program Files (x86)\Microsoft Visual Studio\2019\**Enterprise**\MSBuild\Current\Bin\MSBuild.exe ENOENT +``` + +It is seeking the `MSBuild.exe` in a directory that does not exist. If you are using Visual Studio Community or vice versa, you can change the path of MSBuild with command: + +```powershell +npm config set msbuild_path "C:\Program Files (x86)\Microsoft Visual Studio\2019\**Community**\MSBuild\Current\Bin\MSBuild.exe" +``` + +Attempt to install package again after running the command above. diff --git a/tutorials.md b/tutorials.md new file mode 100644 index 0000000000..527274be53 --- /dev/null +++ b/tutorials.md @@ -0,0 +1,26 @@ +# Tutorials + + +## Examples + +Example workflows which show what can be done with n8n can be found here: +[https://n8n.io/workflows](https://n8n.io/workflows) + +If you want to know how a node can get used in context, you can search for it here: +[https://n8n.io/nodes](https://n8n.io/nodes). There it shows in which workflows the +node got used. + + + +## Videos + + - [Slack Notification on Github Star](https://www.youtube.com/watch?v=3w7xIMKLVAg) + - [Typeform to Google Sheet and Slack or Email](https://www.youtube.com/watch?v=rn3-d4IiW44) + + +### Community Tutorials + + - [n8n basics 1/3 - Getting Started](https://www.youtube.com/watch?v=JIaxjH2CyFc) + - [n8n basics 2/3 - Simple Workflow](https://www.youtube.com/watch?v=ovlxledZfM4) + - [n8n basics 3/3 - Transforming JSON](https://www.youtube.com/watch?v=wGAEAcfwV8w) + - [n8n Google Integration - Using Google Sheets and Google Api nodes](https://www.youtube.com/watch?v=KFqx8OmkqVE) diff --git a/workflow.md b/workflow.md new file mode 100644 index 0000000000..344504d158 --- /dev/null +++ b/workflow.md @@ -0,0 +1,111 @@ +# Workflow + + +## Activate + +Activating a workflow means that the Trigger and Webhook nodes get activated and can trigger a workflow to run. By default all the newly created workflows are deactivated. That means that even if a Trigger node like the Cron node should start a workflow because a predefined time is reached, it will not unless the workflow gets activated. It is only possible to activate a workflow which contains a Trigger or a Webhook node. + + +## Data Flow + +Nodes do not only process one "item", they process multiple ones. So if the Trello node is set to "Create-Card" and it has an expression set for "Name" to be set depending on "name" property, it will create a card for each item, always choosing the name-property-value of the current one. + +This data would, for example, create two boards. One named "test1" the other one named "test2": + +```json +[ + { + name: "test1" + }, + { + name: "test2" + } +] +``` + + +## Error Workflows + +For each workflow, an optional "Error Workflow" can be set. It gets executed in case the execution of the workflow fails. That makes it possible to, for instance, inform the user via Email or Slack if something goes wrong. The same "Error Workflow" can be set on multiple workflows. + +The only difference between a regular workflow and an "Error Workflow" is that it contains an "Error Trigger" node. So it is important to make sure that this node gets created before setting a workflow as "Error Workflow". + +The "Error Trigger" node will trigger in case the execution fails and receives information about it. The data looks like this: + +```json +[ + { + "execution": { + "id": "231", + "url": "https://n8n.example.com/execution/231", + "retryOf": "34", + "error": { + "message": "Example Error Message", + "stack": "Stacktrace" + }, + "lastNodeExecuted": "Node With Error", + "mode": "manual" + }, + "workflow": { + "id": "1", + "name": "Example Workflow" + } + } +] + +``` + +All information is always present except: +- **execution.id**: Only present when the execution gets saved in the database +- **execution.url**: Only present when the execution gets saved in the database +- **execution.retryOf**: Only present when the execution is a retry of a previously failed execution + + +### Setting Error Workflow + +An "Error Workflow" can be set in the Workflow Settings which can be accessed by pressing the "Workflow" button in the menu on the on the left side. The last option is "Settings". In the window that appears, the "Error Workflow" can be selected via the Dropdown "Error Workflow". + + +## Share Workflows + +All workflows are JSON and can be shared very easily. + +There are multiple ways to download a workflow as JSON to then share it with other people via Email, Slack, Skype, Dropbox, … + + 1. Press the "Download" button under the Workflow menu in the sidebar on the left. It then downloads the workflow as a JSON file. + 1. Select the nodes in the editor which should be exported and then copy them (Ctrl + c). The nodes then get saved as JSON in the clipboard and can be pasted wherever desired (Ctrl + v). + +Importing that JSON representation again into n8n is as easy and can also be done in different ways: + + 1. Press "Import from File" or "Import from URL" under the Workflow menu in the sidebar on the left. + 1. Copy the JSON workflow to the clipboard (Ctrl + c) and then simply pasting it directly into the editor (Ctrl + v). + + +## Workflow Settings + +On each workflow, it is possible to set some custom settings and overwrite some of the global default settings. Currently, the following settings can be set: + + +### Error Workflow + +Workflow to run in case the execution of the current workflow fails. More information in section [Error Workflows](#error-workflows). + + +### Timezone + +The timezone to use in the current workflow. If not set, the global Timezone (by default "New York" gets used). For instance, this is important for the Cron Trigger node. + + +### Save Data Error Execution + +If the Execution data of the workflow should be saved when it fails. + + +### Save Data Success Execution + +If the Execution data of the workflow should be saved when it succeeds. + + +### Save Manual Executions + +If executions started from the Editor UI should be saved.