mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2025-01-12 05:17:28 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Update docker readme (#8752)

Browse source
This commit is contained in:
Jon 2024-02-27 15:34:16 +00:00 committed by GitHub
parent 2aaf211dfc
commit 1e750c26b7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 4 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
docker/images/n8n/README.md
View file

@ -18,7 +18,6 @@ n8n is an extendable workflow automation tool. With a [fair-code](https://fairco
- [Persist data](#persist-data) - [Persist data](#persist-data)
- [Start with other Database](#start-with-other-database) - [Start with other Database](#start-with-other-database)
- [Use with PostgresDB](#use-with-postgresdb) - [Use with PostgresDB](#use-with-postgresdb)
- [Use with MySQL](#use-with-mysql)
- [Passing Sensitive Data via File](#passing-sensitive-data-via-file) - [Passing Sensitive Data via File](#passing-sensitive-data-via-file)
- [Example Setup with Lets Encrypt](#example-setup-with-lets-encrypt) - [Example Setup with Lets Encrypt](#example-setup-with-lets-encrypt)
- [Updating a running docker-compose instance](#updating-a-running-docker-compose-instance) - [Updating a running docker-compose instance](#updating-a-running-docker-compose-instance)
@ -95,10 +94,9 @@ docker run -it --rm \
### Start with other Database ### Start with other Database
By default n8n uses SQLite to save credentials, past executions and workflows. By default n8n uses SQLite to save credentials, past executions and workflows.
n8n however also supports PostgresDB, MySQL and MariaDB. To use them simply a few n8n however also supports PostgresDB.
environment variables have to be set.
It is important to still persist the data in the `/root/.n8n` folder. The reason It is important to still persist the data in the `/home/node/.n8n` folder. The reason
is that it contains n8n user data. That is the name of the webhook is that it contains n8n user data. That is the name of the webhook
(in case) the n8n tunnel gets used and even more important the encryption key (in case) the n8n tunnel gets used and even more important the encryption key
for the credentials. If none gets found n8n creates automatically one on for the credentials. If none gets found n8n creates automatically one on
@ -128,37 +126,11 @@ docker run -it --rm \
-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 \
docker.n8n.io/n8nio/n8n \ docker.n8n.io/n8nio/n8n
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)
#### Use with MySQL
Replace the following placeholders with the actual data:
- MYSQLDB_DATABASE
- MYSQLDB_HOST
- MYSQLDB_PASSWORD
- MYSQLDB_PORT
- MYSQLDB_USER
```bash
docker run -it --rm \
--name n8n \
-p 5678:5678 \
-e DB_TYPE=mysqldb \
-e DB_MYSQLDB_DATABASE=<MYSQLDB_DATABASE> \
-e DB_MYSQLDB_HOST=<MYSQLDB_HOST> \
-e DB_MYSQLDB_PORT=<MYSQLDB_PORT> \
-e DB_MYSQLDB_USER=<MYSQLDB_USER> \
-e DB_MYSQLDB_PASSWORD=<MYSQLDB_PASSWORD> \
-v ~/.n8n:/home/node/.n8n \
docker.n8n.io/n8nio/n8n \
n8n start
```
## Passing Sensitive Data via File ## Passing Sensitive Data via File
To avoid passing sensitive information via environment variables "\_FILE" may be To avoid passing sensitive information via environment variables "\_FILE" may be
@ -222,7 +194,7 @@ docker run -it --rm \
docker buildx build --platform linux/amd64,linux/arm64 --build-arg N8N_VERSION=<VERSION> -t n8n:<VERSION> . docker buildx build --platform linux/amd64,linux/arm64 --build-arg N8N_VERSION=<VERSION> -t n8n:<VERSION> .
# For example: # For example:
docker buildx build --platform linux/amd64,linux/arm64 --build-arg N8N_VERSION=0.114.0 -t n8n:0.114.0 . docker buildx build --platform linux/amd64,linux/arm64 --build-arg N8N_VERSION=1.30.1 -t n8n:1.30.1 .
``` ```
## What does n8n mean and how do you pronounce it? ## What does n8n mean and how do you pronounce it?