n8n-io/n8n
1
1
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2024-09-11 21:17:50 +03:00
Code Issues Projects Releases Wiki Activity

📚 Update n8n video and formatting

Browse Source
This commit is contained in:
Jan Oberhauser 2022-05-17 10:46:06 +02:00
parent 2a54f3eaf5
commit c43fc4e978
3 changed files with 51 additions and 85 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -6,19 +6,14 @@ n8n is an extendable workflow automation tool. With a [fair-code](http://faircod
<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> <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>
## Demo ## Demo
[:tv: A short demo (< 3 min)](https://www.youtube.com/watch?v=3w7xIMKLVAg) which shows how to create a simple workflow which [:tv: A short video (< 4 min)](https://www.youtube.com/watch?v=RpjQTGKm-ok) that goes over key concepts of creating workflows in n8n.
automatically sends a new Slack notification every time a Github repository
received or lost a star.
## Available integrations ## Available integrations
n8n has 200+ different nodes to automate workflows. The list can be found on: [https://n8n.io/nodes](https://n8n.io/nodes) n8n has 200+ different nodes to automate workflows. The list can be found on: [https://n8n.io/nodes](https://n8n.io/nodes)
## Documentation ## Documentation
The official n8n documentation can be found under: [https://docs.n8n.io](https://docs.n8n.io) The official n8n documentation can be found under: [https://docs.n8n.io](https://docs.n8n.io)
@ -27,46 +22,36 @@ Additional information and example workflows on the n8n.io website: [https://n8n
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). 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).
## Usage ## 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) - :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) - :whale: Learn [how to run n8n in **Docker**](https://github.com/n8n-io/n8n/tree/master/docker/images/n8n/README.md)
## Start ## Start
Execute: `npm run start` Execute: `npm run start`
## n8n.cloud ## n8n.cloud
Sign-up for an [n8n.cloud](https://www.n8n.cloud/) account. 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: 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 - Not having to set up and maintain your n8n instance
- Managed OAuth for authentication - Managed OAuth for authentication
- Easily upgrading to the newer n8n versions - Easily upgrading to the newer n8n versions
## Support ## Support
If you have problems or questions go to our forum, we will then try to help you asap: 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) [https://community.n8n.io](https://community.n8n.io)
## Jobs ## Jobs
If you are interested in working for n8n and so shape the future of the project 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/) check out our [job posts](https://apply.workable.com/n8n/)
## What does n8n mean and how do you pronounce it? ## What does n8n mean and how do you pronounce it?
**Short answer:** It means "nodemation" and it is pronounced as n-eight-n. **Short answer:** It means "nodemation" and it is pronounced as n-eight-n.
@ -81,14 +66,10 @@ 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 something that long every time in the CLI. That is when I then ended up on
'n8n'." - **Jan Oberhauser, Founder and CEO, n8n.io** 'n8n'." - **Jan Oberhauser, Founder and CEO, n8n.io**
## Development Setup ## 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. 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.
## License ## 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). 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).

94
docker/images/n8n/README.md
View File

@ -8,41 +8,36 @@ n8n is a free and open [fair-code](http://faircode.io) distributed node based Wo
## Contents ## Contents
- [Demo](#demo) - [Demo](#demo)
- [Available integrations](#available-integrations) - [Available integrations](#available-integrations)
- [Documentation](#documentation) - [Documentation](#documentation)
- [Start n8n in Docker](#start-n8n-in-docker) - [Start n8n in Docker](#start-n8n-in-docker)
- [Start with tunnel](#start-with-tunnel) - [Start with tunnel](#start-with-tunnel)
- [Securing n8n](#securing-n8n) - [Securing n8n](#securing-n8n)
- [Persist data](#persist-data) - [Persist data](#persist-data)
- [Passing Sensitive Data via File](#passing-sensitive-data-via-file) - [Passing Sensitive Data via File](#passing-sensitive-data-via-file)
- [Updating a Running docker-compose Instance](#updating-a-running-docker-compose-instance) - [Updating a Running docker-compose Instance](#updating-a-running-docker-compose-instance)
- [Example Setup with Lets Encrypt](#example-setup-with-lets-encrypt) - [Example Setup with Lets Encrypt](#example-setup-with-lets-encrypt)
- [What does n8n mean and how do you pronounce it](#what-does-n8n-mean-and-how-do-you-pronounce-it) - [What does n8n mean and how do you pronounce it](#what-does-n8n-mean-and-how-do-you-pronounce-it)
- [Support](#support) - [Support](#support)
- [Jobs](#jobs) - [Jobs](#jobs)
- [Upgrading](#upgrading) - [Upgrading](#upgrading)
- [License](#license) - [License](#license)
## Demo ## Demo
[:tv: A short demo (< 3 min)](https://www.youtube.com/watch?v=3w7xIMKLVAg) [:tv: A short video (< 4 min)](https://www.youtube.com/watch?v=RpjQTGKm-ok) that goes over key concepts of creating workflows in n8n.
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 ## Available integrations
n8n has 200+ different nodes to automate workflows. The list can be found on: [https://n8n.io/nodes](https://n8n.io/nodes) n8n has 200+ different nodes to automate workflows. The list can be found on: [https://n8n.io/nodes](https://n8n.io/nodes)
## Documentation ## Documentation
The official n8n documentation can be found under: [https://docs.n8n.io](https://docs.n8n.io) 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) Additional information and example workflows on the n8n.io website: [https://n8n.io](https://n8n.io)
## Start n8n in Docker ## Start n8n in Docker
``` ```
@ -56,7 +51,6 @@ docker run -it --rm \
You can then access n8n by opening: You can then access n8n by opening:
[http://localhost:5678](http://localhost:5678) [http://localhost:5678](http://localhost:5678)
## Start with tunnel ## Start with tunnel
> **WARNING**: This is only meant for local development and testing. Should not be used in production! > **WARNING**: This is only meant for local development and testing. Should not be used in production!
@ -121,12 +115,13 @@ it can not be used anymore as encrypting it is not possible anymore.
#### Use with PostgresDB #### Use with PostgresDB
Replace the following placeholders with the actual data: Replace the following placeholders with the actual data:
- POSTGRES_DATABASE
- POSTGRES_HOST - POSTGRES_DATABASE
- POSTGRES_PASSWORD - POSTGRES_HOST
- POSTGRES_PORT - POSTGRES_PASSWORD
- POSTGRES_USER - POSTGRES_PORT
- POSTGRES_SCHEMA - POSTGRES_USER
- POSTGRES_SCHEMA
``` ```
docker run -it --rm \ docker run -it --rm \
@ -149,11 +144,12 @@ A full working setup with docker-compose can be found [here](https://github.com/
#### Use with MySQL #### Use with MySQL
Replace the following placeholders with the actual data: Replace the following placeholders with the actual data:
- MYSQLDB_DATABASE
- MYSQLDB_HOST - MYSQLDB_DATABASE
- MYSQLDB_PASSWORD - MYSQLDB_HOST
- MYSQLDB_PORT - MYSQLDB_PASSWORD
- MYSQLDB_USER - MYSQLDB_PORT
- MYSQLDB_USER
``` ```
docker run -it --rm \ docker run -it --rm \
@ -172,20 +168,21 @@ docker run -it --rm \
## Passing Sensitive Data via File ## Passing Sensitive Data via File
To avoid passing sensitive information via environment variables "_FILE" may be 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 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 with the given name. That makes it possible to load data easily from
Docker- and Kubernetes-Secrets. Docker- and Kubernetes-Secrets.
The following environment variables support file input: The following environment variables support file input:
- DB_POSTGRESDB_DATABASE_FILE
- DB_POSTGRESDB_HOST_FILE - DB_POSTGRESDB_DATABASE_FILE
- DB_POSTGRESDB_PASSWORD_FILE - DB_POSTGRESDB_HOST_FILE
- DB_POSTGRESDB_PORT_FILE - DB_POSTGRESDB_PASSWORD_FILE
- DB_POSTGRESDB_USER_FILE - DB_POSTGRESDB_PORT_FILE
- DB_POSTGRESDB_SCHEMA_FILE - DB_POSTGRESDB_USER_FILE
- N8N_BASIC_AUTH_PASSWORD_FILE - DB_POSTGRESDB_SCHEMA_FILE
- N8N_BASIC_AUTH_USER_FILE - N8N_BASIC_AUTH_PASSWORD_FILE
- N8N_BASIC_AUTH_USER_FILE
## Example Setup with Lets Encrypt ## Example Setup with Lets Encrypt
@ -214,6 +211,7 @@ some scripts and commands return like `$ date`. The system timezone can be set v
the environment variable `TZ`. the environment variable `TZ`.
Example to use the same timezone for both: Example to use the same timezone for both:
``` ```
docker run -it --rm \ docker run -it --rm \
--name n8n \ --name n8n \
@ -223,7 +221,6 @@ docker run -it --rm \
n8nio/n8n n8nio/n8n
``` ```
## Build Docker-Image ## Build Docker-Image
``` ```
@ -233,7 +230,6 @@ docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 --build-arg
docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 --build-arg N8N_VERSION=0.114.0 -t n8nio/n8n:0.114.0 . docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 --build-arg N8N_VERSION=0.114.0 -t n8nio/n8n:0.114.0 .
``` ```
## What does n8n mean and how do you pronounce it? ## What does n8n mean and how do you pronounce it?
**Short answer:** It means "nodemation" and it is pronounced as n-eight-n. **Short answer:** It means "nodemation" and it is pronounced as n-eight-n.
@ -249,32 +245,22 @@ 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 "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. did not hear anybody complain there. So I guess it should be ok.
## Support ## Support
If you have problems or questions go to our forum, we will then try to help you asap: 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) [https://community.n8n.io](https://community.n8n.io)
## Jobs ## Jobs
If you are interested in working for n8n and so shape the future of the project 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/) check out our [job posts](https://apply.workable.com/n8n/)
## Upgrading ## Upgrading
Before you upgrade to the latest version make sure to check here if there are any breaking changes which concern you: Before you upgrade to the latest version make sure to check here if there are any breaking changes which concern you:
[Breaking Changes](https://github.com/n8n-io/n8n/blob/master/packages/cli/BREAKING-CHANGES.md) [Breaking Changes](https://github.com/n8n-io/n8n/blob/master/packages/cli/BREAKING-CHANGES.md)
## License ## 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). 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).

19
packages/cli/README.md
View File

@ -6,16 +6,16 @@ n8n is a free and open [fair-code](http://faircode.io) distributed node-based Wo
<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> <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 ## Contents
<!-- TOC --> <!-- TOC -->
- [Demo](#demo) - [Demo](#demo)
- [Getting Started](#getting-started) - [Getting Started](#getting-started)
- [Use npx](#use-npx) - [Use npx](#use-npx)
- [Run with Docker](#run-with-docker) - [Run with Docker](#run-with-docker)
- [Install with npm](#install-with-npm) - [Install with npm](#install-with-npm)
- [Sign-up on n8n.cloud](#sign-up-on-n8n.cloud) - [Sign-up on n8n.cloud](#sign-up-on-n8n.cloud)
- [Available integrations](#available-integrations) - [Available integrations](#available-integrations)
- [Documentation](#documentation) - [Documentation](#documentation)
- [Create Custom Nodes](#create-custom-nodes) - [Create Custom Nodes](#create-custom-nodes)
@ -29,7 +29,7 @@ n8n is a free and open [fair-code](http://faircode.io) distributed node-based Wo
## Demo ## 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. 📺 Here's a [:tv: short video (< 4 min)](https://www.youtube.com/watch?v=RpjQTGKm-ok) that goes over key concepts of creating workflows in n8n.
## Getting Started ## Getting Started
@ -96,6 +96,7 @@ n8n start
Sign-up for an [n8n.cloud](https://www.n8n.cloud/) account. 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: 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 - Not having to set up and maintain your n8n instance
- Managed OAuth for authentication - Managed OAuth for authentication
- Easily upgrading to the newer n8n versions - Easily upgrading to the newer n8n versions
@ -110,16 +111,15 @@ To learn more about n8n, refer to the official documentation here: [https://docs
You can find additional information and example workflows on the [n8n.io](https://n8n.io) website. You can find additional information and example workflows on the [n8n.io](https://n8n.io) website.
## Create Custom Nodes ## 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) 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 ## Contributing
🐛 Did you find a bug? 🐛 Did you find a bug?
✨ Do you want to contribute a feature? ✨ 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. The [CONTRIBUTING guide](https://github.com/n8n-io/n8n/blob/master/CONTRIBUTING.md) will help you set up your development environment.
@ -141,7 +141,6 @@ If you run into issues or have any questions reach out to us via our community f
If you are interested in working at n8n and building the project, check out the [job openings](https://apply.workable.com/n8n/). If you are interested in working at n8n and building the project, check out the [job openings](https://apply.workable.com/n8n/).
## Upgrading ## Upgrading
Before you upgrade to the latest version, make sure to check the changelogs: [Changelog](https://docs.n8n.io/reference/changelog.html) Before you upgrade to the latest version, make sure to check the changelogs: [Changelog](https://docs.n8n.io/reference/changelog.html)