mirror of
https://github.com/n8n-io/n8n-docs.git
synced 2025-11-20 17:48:34 +00:00
117 lines
3.5 KiB
Markdown
117 lines
3.5 KiB
Markdown
---
|
|
contentType: reference
|
|
---
|
|
|
|
# Supported databases
|
|
|
|
By default, n8n uses SQLite to save credentials, past executions, and workflows. n8n also supports PostgresDB.
|
|
|
|
## Shared settings
|
|
|
|
The following environment variables get used by all databases:
|
|
|
|
- `DB_TABLE_PREFIX` (default: -) - Prefix for table names
|
|
|
|
## PostgresDB
|
|
|
|
To use PostgresDB as the database, you can provide the following environment variables:
|
|
|
|
- `DB_TYPE=postgresdb`
|
|
- `DB_POSTGRESDB_DATABASE` (default: 'n8n')
|
|
- `DB_POSTGRESDB_HOST` (default: 'localhost')
|
|
- `DB_POSTGRESDB_PORT` (default: 5432)
|
|
- `DB_POSTGRESDB_USER` (default: 'root')
|
|
- `DB_POSTGRESDB_PASSWORD` (default: empty)
|
|
- `DB_POSTGRESDB_SCHEMA` (default: 'public')
|
|
- `DB_POSTGRESDB_SSL_CA` (default: undefined): Path to the server's CA certificate used to validate the connection (opportunistic encryption isn't supported)
|
|
- `DB_POSTGRESDB_SSL_CERT` (default: undefined): Path to the client's TLS certificate
|
|
- `DB_POSTGRESDB_SSL_KEY` (default: undefined): Path to the client's private key corresponding to the certificate
|
|
- `DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED` (default: true): If TLS connections that fail validation should be rejected
|
|
|
|
```bash
|
|
export DB_TYPE=postgresdb
|
|
export DB_POSTGRESDB_DATABASE=n8n
|
|
export DB_POSTGRESDB_HOST=postgresdb
|
|
export DB_POSTGRESDB_PORT=5432
|
|
export DB_POSTGRESDB_USER=n8n
|
|
export DB_POSTGRESDB_PASSWORD=n8n
|
|
export DB_POSTGRESDB_SCHEMA=n8n
|
|
|
|
# optional:
|
|
export DB_POSTGRESDB_SSL_CA=$(pwd)/ca.crt
|
|
export DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED=false
|
|
|
|
n8n start
|
|
```
|
|
|
|
### Required permissions
|
|
|
|
n8n needs to create and modify the schemas of the tables it uses.
|
|
|
|
Recommended permissions:
|
|
|
|
```sql
|
|
CREATE DATABASE n8n-db;
|
|
CREATE USER n8n-user WITH PASSWORD 'random-password';
|
|
GRANT ALL PRIVILEGES ON DATABASE n8n-db TO n8n-user;
|
|
```
|
|
|
|
### TLS
|
|
|
|
You can choose between these configurations:
|
|
|
|
- Not declaring (default): Connect with `SSL=off`
|
|
- Declaring only the CA and unauthorized flag: Connect with `SSL=on` and verify the server's signature
|
|
- Declaring `_{CERT,KEY}` and the above: Use the certificate and key for client TLS authentication
|
|
|
|
## MySQL / MariaDB
|
|
|
|
/// warning | Deprecated
|
|
n8n deprecated MySQL and MariaDB as backend databases in version 0.227.0.
|
|
///
|
|
n8n recommends using PostgreSQL.
|
|
|
|
Refer to [how to export and import workflows and credentials](/hosting/cli-commands/) for instructions.
|
|
|
|
To use MySQL or MariaDB, provide the following environment variables:
|
|
|
|
- `DB_TYPE=mysqldb` or `DB_TYPE=mariadb`
|
|
- `DB_MYSQLDB_DATABASE` (default: 'n8n')
|
|
- `DB_MYSQLDB_HOST` (default: 'localhost')
|
|
- `DB_MYSQLDB_PORT` (default: 3306)
|
|
- `DB_MYSQLDB_USER` (default: 'root')
|
|
- `DB_MYSQLDB_PASSWORD` (default: empty)
|
|
|
|
|
|
```bash
|
|
export DB_TYPE=mysqldb
|
|
export DB_MYSQLDB_DATABASE=n8n
|
|
export DB_MYSQLDB_HOST=mysqldb
|
|
export DB_MYSQLDB_PORT=3306
|
|
export DB_MYSQLDB_USER=n8n
|
|
export DB_MYSQLDB_PASSWORD=n8n
|
|
|
|
n8n start
|
|
```
|
|
|
|
## SQLite
|
|
|
|
This is the default database that gets used if nothing is defined.
|
|
|
|
The database file is located at:
|
|
`~/.n8n/database.sqlite`
|
|
|
|
|
|
## Other databases
|
|
|
|
n8n officially supports SQLite and PostgresDB.
|
|
|
|
n8n internally uses [TypeORM](https://typeorm.io){:target=_blank .external-link}, so adding support for the following databases
|
|
should be possible:
|
|
|
|
- CockroachDB
|
|
- Microsoft SQL
|
|
- Oracle
|
|
|
|
If you can't use any of the supported databases for some reason and you can code, consider submitting a [pull request](https://github.com/n8n-io/n8n){:target=_blank .external-link}. You can also request support [here](https://community.n8n.io/c/feature-requests/cli){:target=_blank .external-link}.
|