n8n/README.md

93 lines
3.9 KiB
Markdown
Raw Normal View History

![n8n.io - Workflow Automation](https://user-images.githubusercontent.com/65276001/173571060-9f2f6d7b-bac0-43b6-bdb2-001da9694058.png)
2019-06-23 03:35:23 -07:00
# n8n - Workflow automation tool
2019-06-23 03:35:23 -07: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
![n8n.io - Screenshot](https://raw.githubusercontent.com/n8n-io/n8n/master/assets/n8n-screenshot.png)
2019-06-23 11:56:42 -07:00
## Demo
[:tv: A short video (< 4 min)](https://www.youtube.com/watch?v=RpjQTGKm-ok) that goes over key concepts of
creating workflows in n8n.
## Available integrations
n8n has 200+ different nodes to automate workflows. The list can be found on:
[https://n8n.io/integrations](https://n8n.io/integrations)
2019-09-22 09:29:03 -07:00
## Documentation
The official n8n documentation can be found on our [documentation website](https://docs.n8n.io)
2019-09-22 09:29:03 -07:00
Additional information and example workflows on the [n8n.io website](https://n8n.io)
2019-09-22 09:29:03 -07:00
The release notes can be found [here](https://docs.n8n.io/reference/release-notes/) 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 **use** it from the command line](https://docs.n8n.io/reference/cli-commands/)
- :whale: Learn
[how to run n8n in **Docker**](https://docs.n8n.io/hosting/installation/docker/)
2019-06-23 03:35:23 -07:00
## Start
You can try n8n without installing it using npx. You must have [Node.js](https://nodejs.org/en/) installed.
From the terminal, run:
2019-06-23 03:35:23 -07:00
`npx n8n`
This command will download everything that is needed to start n8n. You can then access n8n and start building workflows by opening [http://localhost:5678](http://localhost:5678).
2019-06-23 03:35:23 -07:00
## n8n cloud
Sign-up for an [n8n cloud](https://www.n8n.io/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 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 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
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 the
[**Sustainable Use License**](https://github.com/n8n-io/n8n/blob/master/packages/cli/LICENSE.md) and the
[**n8n Enterprise License**](https://github.com/n8n-io/n8n/blob/master/packages/cli/LICENSE_EE.md).
Additional information about the license model can be found in the
[docs](https://docs.n8n.io/reference/license/).