docs: Refer to docker.n8n.io/n8nio/n8n for pulling n8n docker images (no-changelog) (#5763)

This commit is contained in:
Cornelius Suermann
2023-03-23 15:38:01 +01:00
committed by GitHub
parent 4498c6013d
commit 573bc8bcea
6 changed files with 73 additions and 70 deletions

View File

@@ -20,7 +20,7 @@ services:
- ${DATA_FOLDER}/letsencrypt:/letsencrypt - ${DATA_FOLDER}/letsencrypt:/letsencrypt
- /var/run/docker.sock:/var/run/docker.sock:ro - /var/run/docker.sock:/var/run/docker.sock:ro
n8n: n8n:
image: n8nio/n8n image: docker.n8n.io/n8nio/n8n
ports: ports:
- '127.0.0.1:5678:5678' - '127.0.0.1:5678:5678'
labels: labels:

View File

@@ -23,7 +23,7 @@ services:
retries: 10 retries: 10
n8n: n8n:
image: n8nio/n8n image: docker.n8n.io/n8nio/n8n
restart: always restart: always
environment: environment:
- DB_TYPE=mariadb - DB_TYPE=mariadb

View File

@@ -24,7 +24,7 @@ services:
retries: 10 retries: 10
n8n: n8n:
image: n8nio/n8n image: docker.n8n.io/n8nio/n8n
restart: always restart: always
environment: environment:
- DB_TYPE=postgresdb - DB_TYPE=postgresdb

View File

@@ -63,14 +63,14 @@ services:
n8n: n8n:
<<: *shared <<: *shared
image: n8nio/n8n image: docker.n8n.io/n8nio/n8n
command: /bin/sh -c "n8n start --tunnel" command: /bin/sh -c "n8n start --tunnel"
ports: ports:
- 5678:5678 - 5678:5678
n8n-worker: n8n-worker:
<<: *shared <<: *shared
image: n8nio/n8n image: docker.n8n.io/n8nio/n8n
command: /bin/sh -c "sleep 5; n8n worker" command: /bin/sh -c "sleep 5; n8n worker"
depends_on: depends_on:
- n8n - n8n

View File

@@ -40,12 +40,12 @@ Additional information and example workflows on the n8n.io website: [https://n8n
## Start n8n in Docker ## Start n8n in Docker
``` ```bash
docker run -it --rm \ docker run -it --rm \
--name n8n \ --name n8n \
-p 5678:5678 \ -p 5678:5678 \
-v ~/.n8n:/home/node/.n8n \ -v ~/.n8n:/home/node/.n8n \
n8nio/n8n docker.n8n.io/n8nio/n8n
``` ```
You can then access n8n by opening: You can then access n8n by opening:
@@ -62,13 +62,13 @@ n8n instance.
To use it simply start n8n with `--tunnel` To use it simply start n8n with `--tunnel`
``` ```bash
docker run -it --rm \ docker run -it --rm \
--name n8n \ --name n8n \
-p 5678:5678 \ -p 5678:5678 \
-v ~/.n8n:/home/node/.n8n \ -v ~/.n8n:/home/node/.n8n \
n8nio/n8n \ docker.n8n.io/n8nio/n8n \
n8n start --tunnel n8n start --tunnel
``` ```
## Securing n8n ## Securing n8n
@@ -79,7 +79,7 @@ to make sure that n8n is protected!
Right now we have very basic protection via basic-auth in place. It can be activated Right now we have very basic protection via basic-auth in place. It can be activated
by setting the following environment variables: by setting the following environment variables:
``` ```text
N8N_BASIC_AUTH_ACTIVE=true N8N_BASIC_AUTH_ACTIVE=true
N8N_BASIC_AUTH_USER=<USER> N8N_BASIC_AUTH_USER=<USER>
N8N_BASIC_AUTH_PASSWORD=<PASSWORD> N8N_BASIC_AUTH_PASSWORD=<PASSWORD>
@@ -91,12 +91,12 @@ The workflow data gets by default saved in an SQLite database in the user
folder (`/home/node/.n8n`). That folder also additionally contains the folder (`/home/node/.n8n`). That folder also additionally contains the
settings like webhook URL and encryption key. settings like webhook URL and encryption key.
``` ```bash
docker run -it --rm \ docker run -it --rm \
--name n8n \ --name n8n \
-p 5678:5678 \ -p 5678:5678 \
-v ~/.n8n:/home/node/.n8n \ -v ~/.n8n:/home/node/.n8n \
n8nio/n8n docker.n8n.io/n8nio/n8n
``` ```
### Start with other Database ### Start with other Database
@@ -123,20 +123,20 @@ Replace the following placeholders with the actual data:
- POSTGRES_USER - POSTGRES_USER
- POSTGRES_SCHEMA - POSTGRES_SCHEMA
``` ```bash
docker run -it --rm \ docker run -it --rm \
--name n8n \ --name n8n \
-p 5678:5678 \ -p 5678:5678 \
-e DB_TYPE=postgresdb \ -e DB_TYPE=postgresdb \
-e DB_POSTGRESDB_DATABASE=<POSTGRES_DATABASE> \ -e DB_POSTGRESDB_DATABASE=<POSTGRES_DATABASE> \
-e DB_POSTGRESDB_HOST=<POSTGRES_HOST> \ -e DB_POSTGRESDB_HOST=<POSTGRES_HOST> \
-e DB_POSTGRESDB_PORT=<POSTGRES_PORT> \ -e DB_POSTGRESDB_PORT=<POSTGRES_PORT> \
-e DB_POSTGRESDB_USER=<POSTGRES_USER> \ -e DB_POSTGRESDB_USER=<POSTGRES_USER> \
-e DB_POSTGRESDB_SCHEMA=<POSTGRES_SCHEMA> \ -e DB_POSTGRESDB_SCHEMA=<POSTGRES_SCHEMA> \
-e DB_POSTGRESDB_PASSWORD=<POSTGRES_PASSWORD> \ -e DB_POSTGRESDB_PASSWORD=<POSTGRES_PASSWORD> \
-v ~/.n8n:/home/node/.n8n \ -v ~/.n8n:/home/node/.n8n \
n8nio/n8n \ docker.n8n.io/n8nio/n8n \
n8n start n8n start
``` ```
A full working setup with docker-compose can be found [here](https://github.com/n8n-io/n8n/blob/master/docker/compose/withPostgres/README.md) A full working setup with docker-compose can be found [here](https://github.com/n8n-io/n8n/blob/master/docker/compose/withPostgres/README.md)
@@ -151,19 +151,19 @@ Replace the following placeholders with the actual data:
- MYSQLDB_PORT - MYSQLDB_PORT
- MYSQLDB_USER - MYSQLDB_USER
``` ```bash
docker run -it --rm \ docker run -it --rm \
--name n8n \ --name n8n \
-p 5678:5678 \ -p 5678:5678 \
-e DB_TYPE=mysqldb \ -e DB_TYPE=mysqldb \
-e DB_MYSQLDB_DATABASE=<MYSQLDB_DATABASE> \ -e DB_MYSQLDB_DATABASE=<MYSQLDB_DATABASE> \
-e DB_MYSQLDB_HOST=<MYSQLDB_HOST> \ -e DB_MYSQLDB_HOST=<MYSQLDB_HOST> \
-e DB_MYSQLDB_PORT=<MYSQLDB_PORT> \ -e DB_MYSQLDB_PORT=<MYSQLDB_PORT> \
-e DB_MYSQLDB_USER=<MYSQLDB_USER> \ -e DB_MYSQLDB_USER=<MYSQLDB_USER> \
-e DB_MYSQLDB_PASSWORD=<MYSQLDB_PASSWORD> \ -e DB_MYSQLDB_PASSWORD=<MYSQLDB_PASSWORD> \
-v ~/.n8n:/home/node/.n8n \ -v ~/.n8n:/home/node/.n8n \
n8nio/n8n \ docker.n8n.io/n8nio/n8n \
n8n start n8n start
``` ```
## Passing Sensitive Data via File ## Passing Sensitive Data via File
@@ -191,16 +191,21 @@ A basic step by step example setup of n8n with docker-compose and Lets Encrypt i
## Updating a running docker-compose instance ## Updating a running docker-compose instance
``` 1. Pull the latest version from the registry
# Pull down the latest version from dockerhub
docker pull n8nio/n8n `docker pull docker.n8n.io/n8nio/n8n`
# Stop current setup
sudo docker-compose stop 2. Stop the current setup
# Delete it (will only delete the docker-containers, data is stored separately)
sudo docker-compose rm `sudo docker-compose stop`
# Then start it again
sudo docker-compose up -d 3. Delete it (will only delete the docker-containers, data is stored separately)
```
`sudo docker-compose rm`
4. Then start it again
`sudo docker-compose up -d`
## Setting Timezone ## Setting Timezone
@@ -212,22 +217,22 @@ the environment variable `TZ`.
Example to use the same timezone for both: Example to use the same timezone for both:
``` ```bash
docker run -it --rm \ docker run -it --rm \
--name n8n \ --name n8n \
-p 5678:5678 \ -p 5678:5678 \
-e GENERIC_TIMEZONE="Europe/Berlin" \ -e GENERIC_TIMEZONE="Europe/Berlin" \
-e TZ="Europe/Berlin" \ -e TZ="Europe/Berlin" \
n8nio/n8n docker.n8n.io/n8nio/n8n
``` ```
## Build Docker-Image ## Build Docker-Image
``` ```bash
docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 --build-arg N8N_VERSION=<VERSION> -t n8nio/n8n:<VERSION> . docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 --build-arg N8N_VERSION=<VERSION> -t n8n:<VERSION> .
# For example: # For example:
docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 --build-arg N8N_VERSION=0.114.0 -t n8nio/n8n:0.114.0 . docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 --build-arg N8N_VERSION=0.114.0 -t n8n:0.114.0 .
``` ```
## What does n8n mean and how do you pronounce it? ## What does n8n mean and how do you pronounce it?

View File

@@ -58,7 +58,7 @@ To play around with n8n, you can also start it using Docker:
docker run -it --rm \ docker run -it --rm \
--name n8n \ --name n8n \
-p 5678:5678 \ -p 5678:5678 \
n8nio/n8n docker.n8n.io/n8nio/n8n
``` ```
Be aware that all the data will be lost once the Docker container gets removed. To persist the data mount the `~/.n8n` folder: Be aware that all the data will be lost once the Docker container gets removed. To persist the data mount the `~/.n8n` folder:
@@ -68,11 +68,9 @@ docker run -it --rm \
--name n8n \ --name n8n \
-p 5678:5678 \ -p 5678:5678 \
-v ~/.n8n:/home/node/.n8n \ -v ~/.n8n:/home/node/.n8n \
n8nio/n8n docker.n8n.io/n8nio/n8n
``` ```
n8n also offers a Docker image for Raspberry Pi: `n8nio/n8n:latest-rpi`.
Refer to the [documentation](https://github.com/n8n-io/n8n/blob/master/docker/images/n8n/README.md) for more information on the Docker setup. Refer to the [documentation](https://github.com/n8n-io/n8n/blob/master/docker/images/n8n/README.md) for more information on the Docker setup.
### Install with npm ### Install with npm