mirror of https://github.com/n8n-io/n8n-docs.git synced 2025-11-20 17:48:34 +00:00

History

umutbozdag f38a21204a Fix typos in Wait node and Scaling n8n docs (#628 ) * 📚 Delete reduntant word in Wait node's README.md file * 📚 Fix typo in scaling-n8n.md file		2021-09-22 12:19:26 +03:00
..
advanced	Fix typos in Wait node and Scaling n8n docs (#628 )	2021-09-22 12:19:26 +03:00
docker-quickstart.md	📚 Updates Docker install	2021-09-01 15:04:02 +03:00
README.md	📚 Update re: Cloud IP address	2021-09-16 17:36:34 +03:00
updating.md

README.md

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 and the NAT address is 20.79.72.36, however this may change in the future. Recommended practice is to whitelist 20.79.72.0/24, but if more strict measures are needed, at minimum both 20.79.72.105 and 20.79.72.36 must be whitelisted. :::

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.