n8n/README.md

97 lines
3.7 KiB
Markdown
Raw Normal View History

2019-06-23 03:35:23 -07:00
# n8n - Workflow Automation Tool
2020-07-08 03:32:26 -07:00
![n8n.io - Workflow Automation](https://raw.githubusercontent.com/n8n-io/n8n/master/assets/n8n-logo.png)
2019-06-23 03:35:23 -07:00
2020-12-09 23:44:06 -08:00
n8n is an extendable workflow automation tool. With a [fair-code](http://faircode.io) distribution model, n8n will always have visible source code, be available to self-host, and allow you to add your own custom functions, logic and apps. n8n's node-based approach makes it highly versatile, enabling you to connect anything to everything.
2019-06-23 03:35:23 -07:00
2020-07-08 03:32:26 -07:00
<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>
2019-06-23 11:56:42 -07:00
## Demo
2019-09-05 23:30:30 -07:00
[:tv: A short demo (< 3 min)](https://www.youtube.com/watch?v=3w7xIMKLVAg) which shows how to create a simple workflow which
automatically sends a new Slack notification every time a Github repository
received or lost a star.
## Available integrations
2020-12-09 23:44:06 -08:00
n8n has 200+ different nodes to automate workflows. The list can be found on: [https://n8n.io/nodes](https://n8n.io/nodes)
2019-06-23 03:35:23 -07:00
2019-09-22 09:29:03 -07:00
## Documentation
The official n8n documentation can be found under: [https://docs.n8n.io](https://docs.n8n.io)
Additional information and example workflows on the n8n.io website: [https://n8n.io](https://n8n.io)
The changelog can be found [here](https://docs.n8n.io/reference/changelog.html) and the list of breaking changes [here](https://github.com/n8n-io/n8n/blob/master/packages/cli/BREAKING-CHANGES.md).
2019-06-23 03:35:23 -07:00
## Usage
- :books: Learn [how to **install** and **use** it from the command line](https://github.com/n8n-io/n8n/tree/master/packages/cli/README.md)
- :whale: Learn [how to run n8n in **Docker**](https://github.com/n8n-io/n8n/tree/master/docker/images/n8n/README.md)
2019-06-23 03:35:23 -07:00
2019-06-23 03:35:23 -07:00
## Start
Execute: `npm run start`
## 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
2019-09-09 12:46:42 -07:00
## Support
If you have problems or questions go to our forum, we will then try to help you asap:
[https://community.n8n.io](https://community.n8n.io)
2020-02-13 22:49:38 -08:00
## Jobs
If you are interested in working for n8n and so shape the future of the project
2021-05-09 15:55:27 -07:00
check out our [job posts](https://apply.workable.com/n8n/)
2020-02-13 22:49:38 -08:00
2020-08-24 01:50:37 -07:00
## What does n8n mean and how do you pronounce it?
2019-08-09 08:11:41 -07:00
2020-08-24 01:50:37 -07:00
**Short answer:** It means "nodemation" and it is pronounced as n-eight-n.
2019-08-09 08:11:41 -07:00
**Long answer:** "I get that question quite often (more often than I expected)
so I decided it is probably best to answer it here. While looking for a
good name for the project with a free domain I realized very quickly that all the
good ones I could think of were already taken. So, in the end, I chose
nodemation. 'node-' in the sense that it uses a Node-View and that it uses
Node.js and '-mation' for 'automation' which is what the project is supposed to help with.
However, I did not like how long the name was and I could not imagine writing
2019-08-09 08:11:41 -07:00
something that long every time in the CLI. That is when I then ended up on
'n8n'." - **Jan Oberhauser, Founder and CEO, n8n.io**
2019-08-09 08:11:41 -07:00
## Development Setup
2019-09-22 09:29:03 -07:00
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.
2019-06-23 03:35:23 -07:00
## 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 about license can be found in the [FAQ](https://docs.n8n.io/#/faq?id=license).