n8n-docs/docs/hosting/installation/npm.md
Deborah Barnard a5b1280565 add action
2024-01-08 11:39:47 +00:00

1.8 KiB

contentType
tutorial

npm

npm is a quick way to get started with n8n on your local machine. You must have Node.js{:target=_blank .external-link} installed. n8n requires Node.js 18 or above.

--8<-- "_snippets/self-hosting/installation/latest-next-version.md"

Try n8n with npx

You can try n8n without installing it using npx.

From the terminal, run:

npx n8n

This command will download everything that's needed to start n8n. You can then access n8n and start building workflows by opening http://localhost:5678{:target=_blank .external-link}.

Install globally with npm

To install n8n globally, use npm:

npm install n8n -g

To install or update to a specific version of n8n use the @ syntax to specify the version. For example:

npm install -g n8n@0.126.1

To install next:

npm install -g n8n@next

After the installation, start n8n by running:

n8n
# or
n8n start

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

Next steps

Try out n8n using the Quickstarts.

Updating

To update your n8n instance to the latest version, run:

npm update -g n8n

To install the next version:

npm install -g n8n@next

--8<-- "_snippets/self-hosting/installation/tunnel.md"

Start n8n with --tunnel by running:

n8n start --tunnel

Windows troubleshooting

If you are experiencing issues running n8n on Windows, make sure your Node.js environment is correctly set up. Follow Microsoft's guide to Install NodeJS on Windows{:target=_blank .external-link}.