split updating

This commit is contained in:
Deborah Barnard
2022-12-12 15:30:22 +00:00
parent b2044054e8
commit 8a944d3d39
17 changed files with 134 additions and 160 deletions

View File

Before

Width:  |  Height:  |  Size: 78 KiB

After

Width:  |  Height:  |  Size: 78 KiB

View File

Before

Width:  |  Height:  |  Size: 89 KiB

After

Width:  |  Height:  |  Size: 89 KiB

View File

Before

Width:  |  Height:  |  Size: 156 KiB

After

Width:  |  Height:  |  Size: 156 KiB

View File

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 52 KiB

View File

@@ -5,6 +5,10 @@
/hosting/installation/desktop-app/ /choose-n8n/desktop-app/
/hosting/server-setups/* /hosting/installation/server-setups/:splat
/hosting/environment-variables/ /hosting/configuration/environment-variables/
/hosting/updating/cloud/ /choose-n8n/cloud/
/hosting/updating/desktop/ /choose-n8n/desktop/
/hosting/updating/npm/ /choose-n8n/npm/
# 2022 SEO audit

View File

@@ -12,6 +12,21 @@ n8n Cloud is n8n's hosted solution. In addition to all the features of n8n, it p
!!! note "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](https://n8n.io/blog/update-on-n8n-cloud-accounts-in-russia-and-belarus/) for more information.
## Update your Cloud version
To updated your n8n Cloud instance navigate to your Dashboard:
![Admin Dashboard](/_images/choose-n8n/cloud/dashboard.png)
1. Click the **Settings** button or switch to the **Manage** tab.
2. From **Instance Settings**, use the **n8n version** dropdown to select your desired release version: Latest Stable, Beta, or Latest Beta.
![Manage Tab](/_images/choose-n8n/cloud/manage_version.png)
3. Click **Save Changes** to restart your n8n instance and perform the update. A confirmation modal will appear and the **Instance Status** will reflect the update in progress.
![Instance Status](/_images/choose-n8n/cloud/instance_status.png)
## Cloud IP addresses

View File

@@ -1,6 +1,10 @@
## Desktop app
# 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:
The n8n desktop app is the fastest way to try n8n on Windows or Mac computers (support for Linux is coming soon).
## Install Desktop
Download the app from the link below:
[Download for Windows](https://downloads.n8n.io/file/n8n-downloads/n8n-win.zip)
@@ -12,3 +16,17 @@ The n8n desktop app is the fastest way to try n8n on Windows or Mac computers (s
!!! note "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.
## Update Desktop
If you're using the n8n desktop app follow the below mentioned steps to update n8n.
### For Windows
1. [Download](https://downloads.n8n.io/file/n8n-downloads/n8n-win.zip) the latest version.
2. Run the installer.
### For MacOS
1. Move the old app to trash.
2. [Download](https://downloads.n8n.io/file/n8n-downloads/n8n-mac.zip) the latest app.

View File

@@ -1,17 +1,17 @@
# Docker Installation
[Docker](https://www.docker.com/) is a quick and simple way to download and start automating with n8n. By using Docker you are able to:
[Docker](https://www.docker.com/){:target=_blank .external-link} offers the following advantages:
* Install to a pristine environment
* Easily install and run your preferred database with n8n
* Enjoy a quick and simplified installation experience regardless of your OS
* Install n8n in a clean environment.
* Easier setup for your preferred database.
* Can avoid issues due to different operating systems, as Docker provides a consistent system.
## Prerequisites
Before proceeding ensure that you have installed [Docker Desktop](https://docs.docker.com/get-docker/).
Before proceeding, install [Docker Desktop](https://docs.docker.com/get-docker/){:target=_blank .external-link}.
!!! note "Linux Users "
Docker Desktop is only available for Mac and Windows. You must install [Docker Engine](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/) individually for your distribution.
Docker Desktop is available for Mac and Windows. Linux users must install [Docker Engine](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/) individually for your distribution.
## Starting n8n
@@ -33,8 +33,7 @@ By default n8n uses SQLite to save credentials, past executions and workflows.
n8n also supports PostgresDB, MySQL and MariaDB, configurable via
environment variables as detailed below.
It is important to still persist data in the `/root/.n8n` folder as it contains n8n user data and even more importantly the encryption key
for credentials. It is also the name of the webhook when the n8n tunnel is used.
It's important to still persist data in the `/root/.n8n` folder as it contains n8n user data and even more importantly the encryption key for credentials. It's also the name of the webhook when the n8n tunnel is used.
If no directory is found, n8n creates automatically one on
startup. In this case, existing credentials saved with a different encryption key can not be used anymore.
@@ -102,6 +101,53 @@ docker run -it --rm \
n8nio/n8n
```
## Updating
From your Docker Desktop, navigate to the **Images** tab and select **Pull** from the context menu to download the latest n8n image:
![Docker Desktop](/_images/hosting/installation/docker/docker_desktop.png)
You can also use the command line to pull the latest, or a specific version:
```sh
// Pull latest version
docker pull n8nio/n8n
// Pull specific version
docker pull n8nio/n8n:0.126.1
```
Stop the container and start it again. You can also use the command line:
```sh
// Get the container ID
docker ps -a
// Stop the container with ID container_id
docker stop [container_id]
// Remove the container with ID container_id
docker rm [container_id]
// Start the container
docker run --name=[container_name] [options] -d n8nio/n8n
```
### Docker Compose
If you've running n8n using a docker-compose file, follow the below mentioned steps to update n8n.
```sh
// Pull latest version
docker-compose pull
// Stop and remove older version
docker-compose down
// Start the container
docker-compose up -d
```
## Further reading
More information about Docker setup can be found in the README file of the [Docker Image](https://github.com/n8n-io/n8n/tree/master/docker/images/n8n).

View File

@@ -1,7 +1,24 @@
# Installation
Installation guides for n8n:
## Installation guides for n8n
* [npm](/hosting/installation/npm/)
* [Docker](/hosting/installation/docker/)
## Server setup guides for specific platforms
Self-host with Docker Compose:
* [Digital Ocean](/hosting/installation/server-setups/digital-ocean/)
* [Heroku](/hosting/installation/server-setups/heroku/)
* [Hetzner Cloud](/hosting/installation/server-setups/hetzner/)
Starting points for a Kubernetes setup:
* [AWS](/hosting/installation/server-setups/aws/)
* [Azure](/hosting/installation/server-setups/azure/)
* [Google Cloud Platform](/hosting/installation/server-setups/google-cloud/)
Configuration guides to help you get started on other platforms:
* [Docker Compose](/hosting/installation/server-setups/docker-compose/)

View File

@@ -1,5 +1,9 @@
# npm
npm is a quick way to get started with n8n on your local machine. You must have [Node.js](https://nodejs.org/en/){:target=_blank .external-link} installed.
## Try n8n with npx
You can try n8n without installing it using npx.
From the terminal, run:
@@ -8,7 +12,9 @@ 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](http://localhost:5678).
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](http://localhost:5678){:target=_blank .external-link}.
## Install globally with npm
If you want to install n8n globally, use npm:
@@ -27,6 +33,19 @@ n8n start
!!! note "Keep in mind"
Windows users remember to change into the `.n8n` directory of your Home folder (`~/.n8n`) before running `n8n start`.
## Updating
To update your n8n instance to the latest released version, run:
```bash
npm update -g n8n
```
To install/update to a specific version of n8n use the `@` syntax to specify the desired version. For example:
```bash
npm install n8n@0.126.1
```
--8<-- "_snippets/self-hosting/installation/tunnel.md"
@@ -38,55 +57,4 @@ n8n start --tunnel
## Windows troubleshooting
If you are experiencing issues running n8n with the typical flow of:
```powershell
npx n8n
```
### Requirements
Please ensure that you have the following requirements fulfilled:
- Install latest version of [NodeJS](https://nodejs.org/en/download/)
- Install [Python 2.7](https://www.python.org/downloads/release/python-2717/) (It is okay to have multiple versions installed on the machine)
- Windows SDK
- C++ Desktop Development Tools
- Windows Build Tools
### Install build tools
If you haven't satisfied the above, follow this procedure through your PowerShell (run with administrative privileges).
This command installs the build tools, windows SDK and the C++ development tools in one package.
```powershell
npm install --global --production windows-build-tools
```
### Configure npm to use Python version 2.7
```powershell
npm config set python python2.7
```
### Configure npm to use correct msvs version
```powershell
npm config set msvs_version 2017 --global
```
### mmmagic npm package when using MSbuild tools with Visual Studio
While installing this package, `node-gyp` is run and it might fail to install it with an error appearing in the ballpark of:
```
gyp ERR! stack Error: spawn C:\Program Files (x86)\Microsoft Visual Studio\2019\**Enterprise**\MSBuild\Current\Bin\MSBuild.exe ENOENT
```
It is seeking the `MSBuild.exe` in a directory that does not exist. If you are using Visual Studio Community or vice versa, you can change the path of MSBuild with command:
```powershell
npm config set msbuild_path "C:\Program Files (x86)\Microsoft Visual Studio\2019\**Community**\MSBuild\Current\Bin\MSBuild.exe"
```
Attempt to install package again after running the command above.
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](https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows){:target=_blank .external-link}.

View File

@@ -1,14 +0,0 @@
# n8n Cloud
To updated your n8n Cloud instance navigate to your Dashboard:
![Admin Dashboard](/_images/hosting/updating/cloud/dashboard.png)
1. Click the **Settings** button or switch to the **Manage** tab.
2. From **Instance Settings**, use the **n8n version** dropdown to select your desired release version: Latest Stable, Beta, or Latest Beta.
![Manage Tab](/_images/hosting/updating/cloud/manage_version.png)
3. Click **Save Changes** to restart your n8n instance and perform the update. A confirmation modal will appear and the **Instance Status** will reflect the update in progress.
![Instance Status](/_images/hosting/updating/cloud/instance_status.png)

View File

@@ -1,13 +0,0 @@
# n8n Desktop App
If you're using the n8n desktop app follow the below mentioned steps to update n8n.
### For Windows
1. [Download](https://downloads.n8n.io/file/n8n-downloads/n8n-win.zip) the latest version.
2. Run the installer.
### For MacOS
1. Move the old app to trash.
2. [Download](https://downloads.n8n.io/file/n8n-downloads/n8n-mac.zip) the latest app.

View File

@@ -1,46 +0,0 @@
# Docker
From your Docker Desktop, navigate to the **Images** tab and select **Pull** from the context menu to download the latest n8n image:
![Docker Desktop](/_images/hosting/updating/docker/docker_desktop.png)
You can also use the command line to pull the latest, or a specific version:
```sh
// Pull latest version
docker pull n8nio/n8n
// Pull specific version
docker pull n8nio/n8n:0.126.1
```
Stop the container and start it again. You can also use the command line:
```sh
// Get the container ID
docker ps -a
// Stop the container with ID container_id
docker stop [container_id]
// Remove the container with ID container_id
docker rm [container_id]
// Start the container
docker run --name=[container_name] [options] -d n8nio/n8n
```
## Docker Compose
If you've running n8n using a docker-compose file, follow the below mentioned steps to update n8n.
```sh
// Pull latest version
docker-compose pull
// Stop and remove older version
docker-compose down
// Start the container
docker-compose up -d
```

View File

@@ -1,3 +0,0 @@
# Updating n8n
In order to take advantage of the newest features and functionality added to n8n (detailed in our [Release notes](/reference/release-notes/) you must update to the latest [released version](https://github.com/n8n-io/n8n/releases).

View File

@@ -1,13 +0,0 @@
# npm
To update your n8n instance to the latest released version, run:
```bash
npm update -g n8n
```
To install/update to a specific version of n8n use the `@` syntax to specify the desired version. For example:
```bash
npm install n8n@0.126.1
```

View File

@@ -455,7 +455,7 @@ nav:
- npm: hosting/installation/npm.md
- Docker: hosting/installation/docker.md
- Server setups:
- hosting/server-setups/index.md
- hosting/installation/server-setups/index.md
- Digital Ocean: hosting/installation/server-setups/digital-ocean.md
- Heroku: hosting/installation/server-setups/heroku.md
- Hetzner: hosting/installation/server-setups/hetzner.md
@@ -474,12 +474,6 @@ nav:
- hosting/databases/index.md
- Supported databases and settings: hosting/databases/supported-databases-settings.md
- Database structure: hosting/databases/structure.md
- Updating:
- hosting/updating/index.md
- npm: hosting/updating/npm.md
- Docker: hosting/updating/docker.md
- Desktop app: hosting/updating/desktop.md
- Cloud: hosting/updating/cloud.md
- Scaling:
- hosting/scaling/index.md
- Execution data: hosting/scaling/execution-data.md

View File

@@ -16,6 +16,7 @@ enum
Fargate
Firestore
GIMP
Hetzner
invalid
kubectl
Kafka