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

History

Deborah Barnard 45c454843e added blog post link		2022-03-14 10:41:41 +00:00
..
advanced	📚 Update docker compose instructions to account for compose v2 (#701 )	2022-01-04 14:27:49 +01:00
docker-quickstart.md	📚 Updates Docker install	2021-09-01 15:04:02 +03:00
README.md	added blog post link	2022-03-14 10:41:41 +00:00
updating.md	✨ Add instructions on how to update the desktop app (#692 )	2021-12-20 11:53:20 +01:00

README.md

Installation

There are a few different ways to set up n8n depending on how you intend to use it:

n8n.cloud - Hosted solution, no need to install anything
Desktop app - The fastest way to try n8n on your computer
Self-host - Recommended method for production or customized usecases

n8n.cloud

n8n.cloud is our hosted solution. In addition to all the features of n8n, it provides added benefits such as:

No technical set up or maintenance for your n8n instance
24/7 uptime monitoring
Managed OAuth for authentication
Easy upgrades to the newest n8n versions

::: 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. :::

::: warning Russia and Belarus n8n Cloud is not available in Russia and Belarus. Refer to our blog post Update on n8n cloud accounts in Russia and Belarus for more information. :::

Desktop app

The n8n desktop app is the fastest way to try n8n on Windows or Mac computers (support for Linux is coming soon). Download the app from the link below:

Download for Windows Download for macOS

::: tip 💡 Keep in mind If you have already installed n8n locally via npm, the desktop app will connect to the existing sqlite database. :::

::: tip 💡 Tunnel credentials The n8n desktop creates a tunnel in order to receive webhooks from external services such as Google. This tunnel is protected using a randomly generated combination of username and password. If you are asked for a login to your personal tunnel URL, you can find the generated credentials in the n8n-desktop.env file in the .n8n folder of your home directory. :::

Self-hosting n8n

You can install via Docker or npm.

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

::: tip 💡 Keep in mind Windows users remember to change into the .n8n directory of your Home folder (~/.n8n) before running n8n start. :::

Docker

See the Docker installation page for running n8n using Docker.

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.