2019-06-23 03:35:23 -07:00
# n8n - Workflow Automation Tool
2019-07-26 04:11:21 -07:00
2019-06-23 03:35:23 -07:00
2020-01-01 13:40:37 -08:00
n8n is a free and open node based Workflow Automation Tool. It can be
self-hosted, easily extended, and so also used with internal tools.
2019-06-23 03:35:23 -07:00
2019-07-26 04:11:21 -07:00
< a href = "https://raw.githubusercontent.com/n8n-io/n8n/master/docs/images/n8n-screenshot.png" > < img src = "https://raw.githubusercontent.com/n8n-io/n8n/master/docs/images/n8n-screenshot.png" width = "550" alt = "n8n.io - Screenshot" > < / a >
2019-06-23 11:56:42 -07:00
2019-08-09 02:19:36 -07:00
2019-06-27 09:45:28 -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
2019-06-27 09:45:28 -07:00
automatically sends a new Slack notification every time a Github repository
2019-08-21 14:01:42 -07:00
received or lost a star.
2019-06-27 09:45:28 -07:00
2019-10-05 09:54:08 -07:00
## Available integrations
2019-10-05 10:19:01 -07:00
n8n has 50+ different nodes to automate workflows. The list can be found on: [https://n8n.io/nodes ](https://n8n.io/nodes )
2019-10-05 09:54:08 -07:00
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 )
2019-08-09 02:19:36 -07:00
2019-06-23 03:35:23 -07:00
## Usage
2019-08-21 14:01:42 -07:00
- :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-08-09 02:19:36 -07:00
2019-06-23 03:35:23 -07:00
## Start
Execute: `npm run start`
2019-08-09 02:19:36 -07:00
## Hosted n8n
If you are interested in a hosted version of n8n on our infrastructure please contact us via:
[hosting@n8n.io ](mailto:hosting@n8n.io )
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 )
2019-08-09 08:11:41 -07:00
## What does n8n mean and how do you pronounce it
**Short answer:** It means "nodemation"
**Long answer:** I get that question quite often (more often than I expected)
2019-10-13 13:16:31 -07:00
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
2019-08-09 08:11:41 -07:00
nodemation. "node-" in the sense that it uses a Node-View and that it uses
2019-10-13 13:16:31 -07:00
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". Sure does not work perfectly but does neither for Kubernetes (k8s) and
did not hear anybody complain there. So I guess it should be ok.
2019-08-21 14:01:42 -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-08-21 14:01:42 -07:00
2019-06-23 03:35:23 -07:00
## License
2019-06-24 04:21:07 -07:00
[Apache 2.0 with Commons Clause ](https://github.com/n8n-io/n8n/blob/master/packages/cli/LICENSE.md )
2019-10-04 11:40:23 -07:00
Additional information about license can be found in the [FAQ ](https://docs.n8n.io/#/faq?id=license )
