refactor(core): Move backend config to a separate package (no-changelog) (#9325)
This commit is contained in:
committed by
GitHub
parent
1d5b9836ca
commit
c7d4b471c4
@@ -21,203 +21,6 @@ convict.addFormat({
|
||||
});
|
||||
|
||||
export const schema = {
|
||||
database: {
|
||||
type: {
|
||||
doc: 'Type of database to use',
|
||||
format: ['sqlite', 'mariadb', 'mysqldb', 'postgresdb'] as const,
|
||||
default: 'sqlite',
|
||||
env: 'DB_TYPE',
|
||||
},
|
||||
tablePrefix: {
|
||||
doc: 'Prefix for table names',
|
||||
format: '*',
|
||||
default: '',
|
||||
env: 'DB_TABLE_PREFIX',
|
||||
},
|
||||
logging: {
|
||||
enabled: {
|
||||
doc: 'Typeorm logging enabled flag.',
|
||||
format: Boolean,
|
||||
default: false,
|
||||
env: 'DB_LOGGING_ENABLED',
|
||||
},
|
||||
options: {
|
||||
doc: 'Logging level options, default is "error". Possible values: query,error,schema,warn,info,log. To enable all logging, specify "all"',
|
||||
format: String,
|
||||
default: 'error',
|
||||
env: 'DB_LOGGING_OPTIONS',
|
||||
},
|
||||
maxQueryExecutionTime: {
|
||||
doc: 'Maximum number of milliseconds query should be executed before logger logs a warning. Set 0 to disable long running query warning',
|
||||
format: Number,
|
||||
default: 0, // 0 disables the slow-query log
|
||||
env: 'DB_LOGGING_MAX_EXECUTION_TIME',
|
||||
},
|
||||
},
|
||||
postgresdb: {
|
||||
database: {
|
||||
doc: 'PostgresDB Database',
|
||||
format: String,
|
||||
default: 'n8n',
|
||||
env: 'DB_POSTGRESDB_DATABASE',
|
||||
},
|
||||
host: {
|
||||
doc: 'PostgresDB Host',
|
||||
format: String,
|
||||
default: 'localhost',
|
||||
env: 'DB_POSTGRESDB_HOST',
|
||||
},
|
||||
password: {
|
||||
doc: 'PostgresDB Password',
|
||||
format: String,
|
||||
default: '',
|
||||
env: 'DB_POSTGRESDB_PASSWORD',
|
||||
},
|
||||
port: {
|
||||
doc: 'PostgresDB Port',
|
||||
format: Number,
|
||||
default: 5432,
|
||||
env: 'DB_POSTGRESDB_PORT',
|
||||
},
|
||||
user: {
|
||||
doc: 'PostgresDB User',
|
||||
format: String,
|
||||
default: 'postgres',
|
||||
env: 'DB_POSTGRESDB_USER',
|
||||
},
|
||||
schema: {
|
||||
doc: 'PostgresDB Schema',
|
||||
format: String,
|
||||
default: 'public',
|
||||
env: 'DB_POSTGRESDB_SCHEMA',
|
||||
},
|
||||
poolSize: {
|
||||
doc: 'PostgresDB Pool Size',
|
||||
format: Number,
|
||||
default: 2,
|
||||
env: 'DB_POSTGRESDB_POOL_SIZE',
|
||||
},
|
||||
|
||||
ssl: {
|
||||
enabled: {
|
||||
doc: 'If SSL should be enabled. If `ca`, `cert`, or `key` are defined, this will automatically default to true',
|
||||
format: Boolean,
|
||||
default: false,
|
||||
env: 'DB_POSTGRESDB_SSL_ENABLED',
|
||||
},
|
||||
ca: {
|
||||
doc: 'SSL certificate authority',
|
||||
format: String,
|
||||
default: '',
|
||||
env: 'DB_POSTGRESDB_SSL_CA',
|
||||
},
|
||||
cert: {
|
||||
doc: 'SSL certificate',
|
||||
format: String,
|
||||
default: '',
|
||||
env: 'DB_POSTGRESDB_SSL_CERT',
|
||||
},
|
||||
key: {
|
||||
doc: 'SSL key',
|
||||
format: String,
|
||||
default: '',
|
||||
env: 'DB_POSTGRESDB_SSL_KEY',
|
||||
},
|
||||
rejectUnauthorized: {
|
||||
doc: 'If unauthorized SSL connections should be rejected',
|
||||
format: Boolean,
|
||||
default: true,
|
||||
env: 'DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED',
|
||||
},
|
||||
},
|
||||
},
|
||||
mysqldb: {
|
||||
database: {
|
||||
doc: '[DEPRECATED] MySQL Database',
|
||||
format: String,
|
||||
default: 'n8n',
|
||||
env: 'DB_MYSQLDB_DATABASE',
|
||||
},
|
||||
host: {
|
||||
doc: 'MySQL Host',
|
||||
format: String,
|
||||
default: 'localhost',
|
||||
env: 'DB_MYSQLDB_HOST',
|
||||
},
|
||||
password: {
|
||||
doc: 'MySQL Password',
|
||||
format: String,
|
||||
default: '',
|
||||
env: 'DB_MYSQLDB_PASSWORD',
|
||||
},
|
||||
port: {
|
||||
doc: 'MySQL Port',
|
||||
format: Number,
|
||||
default: 3306,
|
||||
env: 'DB_MYSQLDB_PORT',
|
||||
},
|
||||
user: {
|
||||
doc: 'MySQL User',
|
||||
format: String,
|
||||
default: 'root',
|
||||
env: 'DB_MYSQLDB_USER',
|
||||
},
|
||||
},
|
||||
sqlite: {
|
||||
database: {
|
||||
doc: 'SQLite Database file name',
|
||||
format: String,
|
||||
default: 'database.sqlite',
|
||||
env: 'DB_SQLITE_DATABASE',
|
||||
},
|
||||
enableWAL: {
|
||||
doc: 'Enable SQLite WAL mode (Always enabled for pool-size > 1)',
|
||||
format: Boolean,
|
||||
default: false,
|
||||
env: 'DB_SQLITE_ENABLE_WAL',
|
||||
},
|
||||
poolSize: {
|
||||
doc: 'SQLite Pool Size (Setting this to 0 disables pooling)',
|
||||
format: Number,
|
||||
default: 0,
|
||||
env: 'DB_SQLITE_POOL_SIZE',
|
||||
},
|
||||
executeVacuumOnStartup: {
|
||||
doc: 'Runs VACUUM operation on startup to rebuild the database. Reduces filesize and optimizes indexes. WARNING: This is a long running blocking operation. Will increase start-up time.',
|
||||
format: Boolean,
|
||||
default: false,
|
||||
env: 'DB_SQLITE_VACUUM_ON_STARTUP',
|
||||
},
|
||||
},
|
||||
},
|
||||
|
||||
credentials: {
|
||||
overwrite: {
|
||||
data: {
|
||||
// Allows to set default values for credentials which
|
||||
// get automatically prefilled and the user does not get
|
||||
// displayed and can not change.
|
||||
// Format: { CREDENTIAL_NAME: { PARAMETER: VALUE }}
|
||||
doc: 'Overwrites for credentials',
|
||||
format: '*',
|
||||
default: '{}',
|
||||
env: 'CREDENTIALS_OVERWRITE_DATA',
|
||||
},
|
||||
endpoint: {
|
||||
doc: 'Fetch credentials from API',
|
||||
format: String,
|
||||
default: '',
|
||||
env: 'CREDENTIALS_OVERWRITE_ENDPOINT',
|
||||
},
|
||||
},
|
||||
defaultName: {
|
||||
doc: 'Default name for credentials',
|
||||
format: String,
|
||||
default: 'My credentials',
|
||||
env: 'CREDENTIALS_DEFAULT_NAME',
|
||||
},
|
||||
},
|
||||
|
||||
workflows: {
|
||||
defaultName: {
|
||||
doc: 'Default name for workflow',
|
||||
@@ -814,98 +617,6 @@ export const schema = {
|
||||
format: Boolean,
|
||||
default: false,
|
||||
},
|
||||
emails: {
|
||||
mode: {
|
||||
doc: 'How to send emails',
|
||||
format: ['', 'smtp'] as const,
|
||||
default: 'smtp',
|
||||
env: 'N8N_EMAIL_MODE',
|
||||
},
|
||||
smtp: {
|
||||
host: {
|
||||
doc: 'SMTP server host',
|
||||
format: String, // e.g. 'smtp.gmail.com'
|
||||
default: '',
|
||||
env: 'N8N_SMTP_HOST',
|
||||
},
|
||||
port: {
|
||||
doc: 'SMTP server port',
|
||||
format: Number,
|
||||
default: 465,
|
||||
env: 'N8N_SMTP_PORT',
|
||||
},
|
||||
secure: {
|
||||
doc: 'Whether or not to use SSL for SMTP',
|
||||
format: Boolean,
|
||||
default: true,
|
||||
env: 'N8N_SMTP_SSL',
|
||||
},
|
||||
startTLS: {
|
||||
doc: 'Whether or not to use STARTTLS for SMTP when SSL is disabled',
|
||||
format: Boolean,
|
||||
default: true,
|
||||
env: 'N8N_SMTP_STARTTLS',
|
||||
},
|
||||
auth: {
|
||||
user: {
|
||||
doc: 'SMTP login username',
|
||||
format: String, // e.g.'you@gmail.com'
|
||||
default: '',
|
||||
env: 'N8N_SMTP_USER',
|
||||
},
|
||||
pass: {
|
||||
doc: 'SMTP login password',
|
||||
format: String,
|
||||
default: '',
|
||||
env: 'N8N_SMTP_PASS',
|
||||
},
|
||||
serviceClient: {
|
||||
doc: 'SMTP OAuth Service Client',
|
||||
format: String,
|
||||
default: '',
|
||||
env: 'N8N_SMTP_OAUTH_SERVICE_CLIENT',
|
||||
},
|
||||
privateKey: {
|
||||
doc: 'SMTP OAuth Private Key',
|
||||
format: String,
|
||||
default: '',
|
||||
env: 'N8N_SMTP_OAUTH_PRIVATE_KEY',
|
||||
},
|
||||
},
|
||||
sender: {
|
||||
doc: 'How to display sender name',
|
||||
format: String,
|
||||
default: '',
|
||||
env: 'N8N_SMTP_SENDER',
|
||||
},
|
||||
},
|
||||
templates: {
|
||||
invite: {
|
||||
doc: 'Overrides default HTML template for inviting new people (use full path)',
|
||||
format: String,
|
||||
default: '',
|
||||
env: 'N8N_UM_EMAIL_TEMPLATES_INVITE',
|
||||
},
|
||||
passwordReset: {
|
||||
doc: 'Overrides default HTML template for resetting password (use full path)',
|
||||
format: String,
|
||||
default: '',
|
||||
env: 'N8N_UM_EMAIL_TEMPLATES_PWRESET',
|
||||
},
|
||||
workflowShared: {
|
||||
doc: 'Overrides default HTML template for notifying that a workflow was shared (use full path)',
|
||||
format: String,
|
||||
default: '',
|
||||
env: 'N8N_UM_EMAIL_TEMPLATES_WORKFLOW_SHARED',
|
||||
},
|
||||
credentialsShared: {
|
||||
doc: 'Overrides default HTML template for notifying that credentials were shared (use full path)',
|
||||
format: String,
|
||||
default: '',
|
||||
env: 'N8N_UM_EMAIL_TEMPLATES_CREDENTIALS_SHARED',
|
||||
},
|
||||
},
|
||||
},
|
||||
authenticationMethod: {
|
||||
doc: 'How to authenticate users (e.g. "email", "ldap", "saml")',
|
||||
format: ['email', 'ldap', 'saml'] as const,
|
||||
|
||||
Reference in New Issue
Block a user