mirror of
https://github.com/n8n-io/n8n.git
synced 2024-12-25 20:54:07 -08:00
37 lines
748 B
Markdown
37 lines
748 B
Markdown
|
# Setup
|
||
|
|
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
To install n8n globally:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm install n8n -g
|
||
|
|
```
|
||
|
|
|
||
|
|
## Start
|
||
|
|
|
||
|
|
After the installation n8n can be started by simply typing in:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
n8n
|
||
|
|
# or
|
||
|
|
n8n start
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Start with tunnel
|
||
|
|
|
||
|
|
!> **WARNING**: This is only meant for local development and testing. Should not be used in production!
|
||
|
|
|
||
|
|
To be able to use webhooks which all triggers of external services like Github
|
||
|
|
rely on n8n has to be reachable from the web. To make that easy n8n has a
|
||
|
|
special tunnel service (uses this code: [https://github.com/localtunnel/localtunnel](https://github.com/localtunnel/localtunnel)) which redirects requests from our servers to your local
|
||
|
|
n8n instance.
|
||
|
|
|
||
|
|
To use it simply start n8n with `--tunnel`
|
||
|
|
|
||
|
|
```bash
|
||
|
|
n8n start --tunnel
|
||
|
|
```
|