mirror of
https://github.com/n8n-io/n8n.git
synced 2024-11-16 09:34:07 -08:00
156 lines
5.3 KiB
Markdown
156 lines
5.3 KiB
Markdown
# n8n - Workflow Automation Tool
|
|
|
|
|
|
|
|
n8n is a free and open [fair-code](http://faircode.io) distributed node-based Workflow Automation Tool. You can self-host n8n, easily extend it, and even use it with internal tools.
|
|
|
|
<a href="https://raw.githubusercontent.com/n8n-io/n8n/master/assets/n8n-screenshot.png"><img src="https://raw.githubusercontent.com/n8n-io/n8n/master/assets/n8n-screenshot.png" width="550" alt="n8n.io - Screenshot"></a>
|
|
|
|
|
|
## Contents
|
|
|
|
<!-- TOC -->
|
|
- [Demo](#demo)
|
|
- [Getting Started](#getting-started)
|
|
- [Use npx](#use-npx)
|
|
- [Run with Docker](#run-with-docker)
|
|
- [Install with npm](#install-with-npm)
|
|
- [Sign-up on n8n.cloud](#sign-up-on-n8n.cloud)
|
|
- [Available integrations](#available-integrations)
|
|
- [Documentation](#documentation)
|
|
- [Create Custom Nodes](#create-custom-nodes)
|
|
- [Contributing](#contributing)
|
|
- [What does n8n mean and how do you pronounce it](#what-does-n8n-mean-and-how-do-you-pronounce-it)
|
|
- [Support](#support)
|
|
- [Jobs](#jobs)
|
|
- [Upgrading](#upgrading)
|
|
- [License](#license)
|
|
<!-- /TOC -->
|
|
|
|
## Demo
|
|
|
|
📺 Here's a [short demo (<3 min)](https://www.youtube.com/watch?v=3w7xIMKLVAg) that shows how to create a simple workflow to automatically sends a notification on Slack every time a GitHub repository gets starred or un-starred.
|
|
|
|
## Getting Started
|
|
|
|
There are a couple of ways to get started with n8n.
|
|
|
|
### Use npx
|
|
|
|
To spin up n8n using npx, 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)
|
|
|
|
**Note:** The minimum required version for Node.js is v14.15. Make sure to update Node.js to v14.15 or above.
|
|
|
|
### Run 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:/home/node/.n8n \
|
|
n8nio/n8n
|
|
```
|
|
|
|
n8n also offers a Docker image for Raspberry Pi: `n8nio/n8n:latest-rpi`.
|
|
|
|
Refer to the [documentation](https://github.com/n8n-io/n8n/blob/master/docker/images/n8n/README.md) for more information on the Docker setup.
|
|
|
|
### Install with npm
|
|
|
|
To install n8n globally using npm:
|
|
|
|
```bash
|
|
npm install n8n -g
|
|
```
|
|
|
|
After the installation, start n8n running the following command:
|
|
|
|
```bash
|
|
n8n
|
|
# or
|
|
n8n start
|
|
```
|
|
|
|
### Sign-up on n8n.cloud
|
|
|
|
Sign-up for an [n8n.cloud](https://www.n8n.cloud/) account.
|
|
|
|
While n8n.cloud and n8n are the same in terms of features, n8n.cloud provides certain conveniences such as:
|
|
- Not having to set up and maintain your n8n instance
|
|
- Managed OAuth for authentication
|
|
- Easily upgrading to the newer n8n versions
|
|
|
|
## Available integrations
|
|
|
|
n8n has 280+ different nodes that allow you to connect various services and build your automation workflows. You can find the list of all the integrations at [https://n8n.io/integrations](https://n8n.io/integrations)
|
|
|
|
## Documentation
|
|
|
|
To learn more about n8n, refer to the official documentation here: [https://docs.n8n.io](https://docs.n8n.io)
|
|
|
|
You can find additional information and example workflows on the [n8n.io](https://n8n.io) website.
|
|
|
|
|
|
## Create Custom Nodes
|
|
|
|
You can create custom nodes for n8n. Follow the instructions mentioned in the documentation to create your node: [Creating nodes](https://docs.n8n.io/nodes/creating-nodes/create-node.html)
|
|
|
|
## Contributing
|
|
|
|
🐛 Did you find a bug?
|
|
|
|
✨ Do you want to contribute a feature?
|
|
|
|
The [CONTRIBUTING guide](https://github.com/n8n-io/n8n/blob/master/CONTRIBUTING.md) will help you set up your development environment.
|
|
|
|
You can find more information on how you can contribute to the project on our documentation: [How can I contribute?](https://docs.n8n.io/reference/contributing.html)
|
|
|
|
## What does n8n mean, and how do you pronounce it?
|
|
|
|
**Short answer:** n8n is an abbreviation for "nodemation", and it is pronounced as n-eight-n.
|
|
|
|
**Long answer:** In n8n, you build your automation ("-mation") workflows by connecting different nodes in the Editor UI. The project is also built using Node.js. As a consequence, the project was named nodemation.
|
|
|
|
However, the name was long, and it wouldn't be a good idea to use such a long name in the CLI. Hence, nodemation got abbreviated as "n8n" (there are eight characters between the first and the last n!).
|
|
|
|
## Support
|
|
|
|
If you run into issues or have any questions reach out to us via our community forum: [https://community.n8n.io](https://community.n8n.io).
|
|
|
|
## Jobs
|
|
|
|
If you are interested in working at n8n and building the project, check out the [job openings](https://apply.workable.com/n8n/).
|
|
|
|
|
|
## Upgrading
|
|
|
|
Before you upgrade to the latest version, make sure to check the changelogs: [Changelog](https://docs.n8n.io/reference/changelog.html)
|
|
|
|
You can also find breaking changes here: [Breaking Changes](./BREAKING-CHANGES.md)
|
|
|
|
## License
|
|
|
|
n8n is [fair-code](http://faircode.io) distributed under [**Apache 2.0 with Commons Clause**](https://github.com/n8n-io/n8n/blob/master/packages/cli/LICENSE.md) license.
|
|
|
|
Additional information on the license can be found in the [FAQ](https://docs.n8n.io/reference/faq.html#license)
|