n8n-docs/docs/getting-started/installation
2021-09-14 11:03:13 +03:00
..
advanced 📚 Updated Scaling docs re Encryption 2021-09-14 11:03:13 +03:00
docker-quickstart.md 📚 Updates Docker install 2021-09-01 15:04:02 +03:00
README.md 📚 Add Cloud IP address 2021-09-06 11:11:30 +03:00
updating.md Add updating n8n page 2021-07-05 12:15:40 +03:00

Installation

Get started with n8n right away by using our hosted n8n.cloud offering or running n8n locally via npm.

n8n is also available as a Docker image.

toc

n8n.cloud

In addition to all the features of n8n, n8n.cloud provides added benefits such as:

  • No set up or maintenance for your n8n instance
  • Managed OAuth for authentication
  • Easy upgrades to the newest n8n versions

If this option is for you, sign up for an n8n.cloud account.

::: tip 💡 Keep in mind The IP address of n8n.cloud is 20.79.72.105, however this may change in the future. :::

npm

You can try n8n without installing it using npx.

From the terminal, run:

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.

If you want to install n8n globally, use npm:

npm install n8n -g

After the installation, start n8n by running:

n8n
# or
n8n start

Docker

See the Docker installation page for running n8n using Docker.

n8n also offers a Docker image for Raspberry Pi: n8nio/n8n:latest-rpi.

n8n with tunnel

::: danger This is only meant for local development and testing. It should not be used in production. :::

To be able to use webhooks for trigger nodes of external services like GitHub, n8n has to be reachable from the web. To make that easy, n8n has a special tunnel service which redirects requests from our servers to your local n8n instance.

If you installed n8n with npm, start n8n with --tunnel by running:

n8n start --tunnel

If you are running n8n with Docker, start n8n with --tunnel by running:

docker run -it --rm \
	--name n8n \
	-p 5678:5678 \
	-v ~/.n8n:/home/node/.n8n \
	n8nio/n8n \
	n8n start --tunnel

In case you run into issues with the installation, check out the troubleshooting page or ask for help in the community forum.