mirror of
https://github.com/n8n-io/n8n.git
synced 2024-11-10 14:44:05 -08:00
a18081d749
* ✨ Inicial setup * ⚡ Add authentication handler * ⚡ Add GET /users route * ⚡ Improvements * 👕 Fix linting issues * ⚡ Add GET /users/:identifier endpoint * ⚡ Add POST /users endpoint * ⚡ Add DELETE /users/:identifier endpoint * ⚡ Return error using express native functions * 👕 Fix linting issue * ⚡ Possibility to add custom middleware * ⚡ Refactor POST /users * ⚡ Refactor DELETE /users * ⚡ Improve cleaning function * ⚡ Refactor GET /users and /users/:identifier * ⚡ Add API spec to route * ⚡ Add raw option to response helper * 🐛 Fix issue adding custom middleware * ⚡ Enable includeRole parameter in GET /users/:identifier * ⚡ Fix linting issues after merge * ⚡ Add missing config variable * ⚡ General improvements ⚡ asasas * ⚡ Add POST /users tests * Debug public API tests * Fix both sets of tests * ⚡ Improvements * ⚡ Load api versions dynamically * ⚡ Add endpoints to UM to create/delete an API Key * ⚡ Add index to apiKey column * 👕 Fix linting issue * ⚡ Clean open api spec * ⚡ Improvements * ⚡ Skip tests * 🐛 Fix bug with test * ⚡ Fix issue with the open api spec * ⚡ Fix merge issue * ⚡ Move token enpoints from /users to /me * ⚡ Apply feedback to openapi.yml * ⚡ Improvements to api-key endpoints * 🐛 Fix test to suport API dynamic loading * ⚡ Expose swagger ui in GET /{version}/docs * ⚡ Allow to disable public api via env variable * ⚡ Change handlers structure * 🚧 WIP create credential, delete credential complete * 🐛 fix route for creating api key * ⚡ return api key of authenticated user * ⚡ Expose public api activation to the settings * ⬆️ Update package-lock.json file * ⚡ Add execution resource * ⚡ Fix linting issues * 🛠 conditional public api endpoints excluding * ⚡️ create credential complete * ✨ Added n8n-card component. Added spacing utility classes. * ♻️ Made use of n8n-card in existing components. * ✨ Added api key setup view. * ✨ Added api keys get/create/delete actions. * ✨ Added public api permissions handling. * ♻️ Temporarily disabling card tests. * ♻️ Changed translations. Storing api key only in component. * ✨ Added utilities storybook entry * ♻️ Changed default value for generic copy input. * 🧹 clean up createCredential * ⚡ Add workflow resource to openapi spec * 🐛 Fix naming with env variable * ⚡ Allow multifile openapi spec * ⚡ Add POST /workflows/:workflowId/activate * fix up view, fix issues * remove delete api key modal * remove unused prop * clean up store api * remove getter * remove unused dispatch * fix component size to match * use existing components * match figma closely * fix bug when um is disabled in sidebar * set copy input color * remove unused import * ⚡ Remove css path * ⚡ Add POST /workflows/:workflowId/desactivate * ⚡ Add POST /workflows * Revert "⚡ Remove css path"a3d0a71719
* attempt to fix docker image issue * revert dockerfile test * disable public api * disable api differently * Revert "disable api differently"b70e29433e
* Revert "disable public api"886e5164fb
* remove unused box * ⚡ PUT /workflows/:workflowId * ⚡ Refactor workflow endpoints * ⚡ Refactor executions endpoints * ⚡ Fix typo * ✅ add credentials tests * ✅ adjust users tests * update text * add try it out link * ⚡ Add delete, getAll and get to the workflow resource * address spacing comments * ⚡️ apply correct structure * ⚡ Add missing test to user resource and fix some issues * ⚡ Add workflow tests * ⚡ Add missing workflow tests and fix some issues * ⚡ Executions tests * ⚡ finish execution tests * ⚡ Validate credentials data depending on type * ⚡️ implement review comments * 👕 fix lint issues * ⚡ Add apiKey to sanatizeUser * ⚡ Fix issues with spec and tests * ⚡ Add new structure * ⚡ Validate credentials type and properties * ⚡ Make all endpoints except /users independent on UM * ⚡ Add instance base path to swagger UI * ⚡ Remove testing endpoints * ⚡ Fix issue with openapi tags * ⚡ Add endpoint GET /credentialTypes/:id/schema * 🐛 Fix issue adding json middleware to public api * ⚡ Add API playground path to FE * ⚡ Add telemetry and external hooks * 🐛 Fix issue with user tests * ⚡ Move /credentialTypes under /credentials * ⚡ Add test to GET /credentials/schema/:id * 🛠 refactor schema naming * ⚡ Add DB migrations asas * ✅ add tests for crd apiKey * ✨ Added API View telemetry events. * ⚡ Remove rsync from the building process as it is missing on alpine base image * ⚡ add missing BE telemetry events * 🐛 Fix credential tests * ⚡ address outstanding feedback * 🔨 Remove move:openapi script * ⬆️ update dependency * ⬆️ update package-lock.json * 👕 Fix linting issue * 🐛 Fix package.json issue * 🐛 fix migrations and tests * 🐛 fix typos + naming * 🚧 WIP fixing tests * ⚡ Add json schema validation * ⚡ Add missing fields to node schema * ⚡ Add limit max upper limit * ⚡ Rename id paths * 🐛 Fix tests * Add package-lock.jsonto custom dockerfile * ⬆️ Update package-lock.json * 🐛 Fix issue with build * ✏️ add beta label to api view * 🔥 Remove user endpoints * ⚡ Add schema examples to GET /credentials/schema/:id * 🔥 Remove user endpoints tests * 🐛 Fix tests * 🎨 adapt points from design review * 🔥 remove unnecessary text-align * ⚡️ update UI * 🐛 Fix issue with executions filter * ⚡ Add tags filter to GET /workflows * ⚡ Add missing error messages * ✅ add and update public api tests * ✅ add tests for owner activiating/deactivating non-owned wfs * 🧪 add tests for filter for tags * 🧪 add tests for more filter params * 🐛 fix inclusion of tags * 🛠 enhance readability * ⚡️ small refactorings * 💄 improving readability/naming * ⚡ Set API latest version dinamically * Add comments to toJsonSchema function * ⚡ Fix issue * ⚡ Make execution data usable * ⚡ Fix validation issue * ⚡ Rename data field and change parameter and options * 🐛 Fix issue parameter "detailsFieldFormat" not resolving correctly * Skip executions tests * skip workflow failing test * Rename details property to data * ⚡ Add includeData parameter * 🐛 Fix issue with openapi spec * 🐛 Fix linting issue * ⚡ Fix execution schema Co-authored-by: Iván Ovejero <ivov.src@gmail.com> Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com> Co-authored-by: Alex Grozav <alex@grozav.com> Co-authored-by: Mutasem <mutdmour@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
905 lines
22 KiB
TypeScript
905 lines
22 KiB
TypeScript
/* eslint-disable no-restricted-syntax */
|
|
/* eslint-disable @typescript-eslint/no-unsafe-assignment */
|
|
|
|
import path from 'path';
|
|
import * as core from 'n8n-core';
|
|
|
|
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: 1000,
|
|
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: 'root',
|
|
env: 'DB_POSTGRESDB_USER',
|
|
},
|
|
schema: {
|
|
doc: 'PostgresDB Schema',
|
|
format: String,
|
|
default: 'public',
|
|
env: 'DB_POSTGRESDB_SCHEMA',
|
|
},
|
|
|
|
ssl: {
|
|
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: '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: {
|
|
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: { PARAMTER: 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',
|
|
format: String,
|
|
default: 'My workflow',
|
|
env: 'WORKFLOWS_DEFAULT_NAME',
|
|
},
|
|
onboardingFlowDisabled: {
|
|
doc: 'Show onboarding flow in new workflow',
|
|
format: 'Boolean',
|
|
default: false,
|
|
env: 'N8N_ONBOARDING_FLOW_DISABLED',
|
|
},
|
|
},
|
|
|
|
executions: {
|
|
// By default workflows get always executed in their own process.
|
|
// If this option gets set to "main" it will run them in the
|
|
// main-process instead.
|
|
process: {
|
|
doc: 'In what process workflows should be executed',
|
|
format: ['main', 'own'] as const,
|
|
default: 'own',
|
|
env: 'EXECUTIONS_PROCESS',
|
|
},
|
|
|
|
mode: {
|
|
doc: 'If it should run executions directly or via queue',
|
|
format: ['regular', 'queue'] as const,
|
|
default: 'regular',
|
|
env: 'EXECUTIONS_MODE',
|
|
},
|
|
|
|
// A Workflow times out and gets canceled after this time (seconds).
|
|
// If the workflow is executed in the main process a soft timeout
|
|
// is executed (takes effect after the current node finishes).
|
|
// If a workflow is running in its own process is a soft timeout
|
|
// tried first, before killing the process after waiting for an
|
|
// additional fifth of the given timeout duration.
|
|
//
|
|
// To deactivate timeout set it to -1
|
|
//
|
|
// Timeout is currently not activated by default which will change
|
|
// in a future version.
|
|
timeout: {
|
|
doc: 'Max run time (seconds) before stopping the workflow execution',
|
|
format: Number,
|
|
default: -1,
|
|
env: 'EXECUTIONS_TIMEOUT',
|
|
},
|
|
maxTimeout: {
|
|
doc: 'Max execution time (seconds) that can be set for a workflow individually',
|
|
format: Number,
|
|
default: 3600,
|
|
env: 'EXECUTIONS_TIMEOUT_MAX',
|
|
},
|
|
|
|
// If a workflow executes all the data gets saved by default. This
|
|
// could be a problem when a workflow gets executed a lot and processes
|
|
// a lot of data. To not exceed the database's capacity it is possible to
|
|
// prune the database regularly or to not save the execution at all.
|
|
// Depending on if the execution did succeed or error a different
|
|
// save behaviour can be set.
|
|
saveDataOnError: {
|
|
doc: 'What workflow execution data to save on error',
|
|
format: ['all', 'none'] as const,
|
|
default: 'all',
|
|
env: 'EXECUTIONS_DATA_SAVE_ON_ERROR',
|
|
},
|
|
saveDataOnSuccess: {
|
|
doc: 'What workflow execution data to save on success',
|
|
format: ['all', 'none'] as const,
|
|
default: 'all',
|
|
env: 'EXECUTIONS_DATA_SAVE_ON_SUCCESS',
|
|
},
|
|
saveExecutionProgress: {
|
|
doc: 'Wether or not to save progress for each node executed',
|
|
format: 'Boolean',
|
|
default: false,
|
|
env: 'EXECUTIONS_DATA_SAVE_ON_PROGRESS',
|
|
},
|
|
|
|
// If the executions of workflows which got started via the editor
|
|
// should be saved. By default they will not be saved as this runs
|
|
// are normally only for testing and debugging. This setting can
|
|
// also be overwritten on a per workflow basis in the workflow settings
|
|
// in the editor.
|
|
saveDataManualExecutions: {
|
|
doc: 'Save data of executions when started manually via editor',
|
|
format: 'Boolean',
|
|
default: false,
|
|
env: 'EXECUTIONS_DATA_SAVE_MANUAL_EXECUTIONS',
|
|
},
|
|
|
|
// To not exceed the database's capacity and keep its size moderate
|
|
// the execution data gets pruned regularly (default: 1 hour interval).
|
|
// All saved execution data older than the max age will be deleted.
|
|
// Pruning is currently not activated by default, which will change in
|
|
// a future version.
|
|
pruneData: {
|
|
doc: 'Delete data of past executions on a rolling basis',
|
|
format: 'Boolean',
|
|
default: false,
|
|
env: 'EXECUTIONS_DATA_PRUNE',
|
|
},
|
|
pruneDataMaxAge: {
|
|
doc: 'How old (hours) the execution data has to be to get deleted',
|
|
format: Number,
|
|
default: 336,
|
|
env: 'EXECUTIONS_DATA_MAX_AGE',
|
|
},
|
|
pruneDataTimeout: {
|
|
doc: 'Timeout (seconds) after execution data has been pruned',
|
|
format: Number,
|
|
default: 3600,
|
|
env: 'EXECUTIONS_DATA_PRUNE_TIMEOUT',
|
|
},
|
|
},
|
|
|
|
queue: {
|
|
health: {
|
|
active: {
|
|
doc: 'If health checks should be enabled',
|
|
format: 'Boolean',
|
|
default: false,
|
|
env: 'QUEUE_HEALTH_CHECK_ACTIVE',
|
|
},
|
|
port: {
|
|
doc: 'Port to serve health check on if activated',
|
|
format: Number,
|
|
default: 5678,
|
|
env: 'QUEUE_HEALTH_CHECK_PORT',
|
|
},
|
|
},
|
|
bull: {
|
|
prefix: {
|
|
doc: 'Prefix for all queue keys',
|
|
format: String,
|
|
default: '',
|
|
env: 'QUEUE_BULL_PREFIX',
|
|
},
|
|
redis: {
|
|
db: {
|
|
doc: 'Redis DB',
|
|
format: Number,
|
|
default: 0,
|
|
env: 'QUEUE_BULL_REDIS_DB',
|
|
},
|
|
host: {
|
|
doc: 'Redis Host',
|
|
format: String,
|
|
default: 'localhost',
|
|
env: 'QUEUE_BULL_REDIS_HOST',
|
|
},
|
|
password: {
|
|
doc: 'Redis Password',
|
|
format: String,
|
|
default: '',
|
|
env: 'QUEUE_BULL_REDIS_PASSWORD',
|
|
},
|
|
port: {
|
|
doc: 'Redis Port',
|
|
format: Number,
|
|
default: 6379,
|
|
env: 'QUEUE_BULL_REDIS_PORT',
|
|
},
|
|
timeoutThreshold: {
|
|
doc: 'Redis timeout threshold',
|
|
format: Number,
|
|
default: 10000,
|
|
env: 'QUEUE_BULL_REDIS_TIMEOUT_THRESHOLD',
|
|
},
|
|
},
|
|
queueRecoveryInterval: {
|
|
doc: 'If > 0 enables an active polling to the queue that can recover for Redis crashes. Given in seconds; 0 is disabled. May increase Redis traffic significantly.',
|
|
format: Number,
|
|
default: 60,
|
|
env: 'QUEUE_RECOVERY_INTERVAL',
|
|
},
|
|
},
|
|
},
|
|
|
|
generic: {
|
|
// The timezone to use. Is important for nodes like "Cron" which start the
|
|
// workflow automatically at a specified time. This setting can also be
|
|
// overwritten on a per worfklow basis in the workflow settings in the
|
|
// editor.
|
|
timezone: {
|
|
doc: 'The timezone to use',
|
|
format: '*',
|
|
default: 'America/New_York',
|
|
env: 'GENERIC_TIMEZONE',
|
|
},
|
|
},
|
|
|
|
// How n8n can be reached (Editor & REST-API)
|
|
path: {
|
|
format: String,
|
|
default: '/',
|
|
arg: 'path',
|
|
env: 'N8N_PATH',
|
|
doc: 'Path n8n is deployed to',
|
|
},
|
|
host: {
|
|
format: String,
|
|
default: 'localhost',
|
|
arg: 'host',
|
|
env: 'N8N_HOST',
|
|
doc: 'Host name n8n can be reached',
|
|
},
|
|
port: {
|
|
format: Number,
|
|
default: 5678,
|
|
arg: 'port',
|
|
env: 'N8N_PORT',
|
|
doc: 'HTTP port n8n can be reached',
|
|
},
|
|
listen_address: {
|
|
format: String,
|
|
default: '0.0.0.0',
|
|
env: 'N8N_LISTEN_ADDRESS',
|
|
doc: 'IP address n8n should listen on',
|
|
},
|
|
protocol: {
|
|
format: ['http', 'https'] as const,
|
|
default: 'http',
|
|
env: 'N8N_PROTOCOL',
|
|
doc: 'HTTP Protocol via which n8n can be reached',
|
|
},
|
|
ssl_key: {
|
|
format: String,
|
|
default: '',
|
|
env: 'N8N_SSL_KEY',
|
|
doc: 'SSL Key for HTTPS Protocol',
|
|
},
|
|
ssl_cert: {
|
|
format: String,
|
|
default: '',
|
|
env: 'N8N_SSL_CERT',
|
|
doc: 'SSL Cert for HTTPS Protocol',
|
|
},
|
|
editorBaseUrl: {
|
|
format: String,
|
|
default: '',
|
|
env: 'N8N_EDITOR_BASE_URL',
|
|
doc: 'Public URL where the editor is accessible. Also used for emails sent from n8n.',
|
|
},
|
|
|
|
security: {
|
|
excludeEndpoints: {
|
|
doc: 'Additional endpoints to exclude auth checks. Multiple endpoints can be separated by colon (":")',
|
|
format: String,
|
|
default: '',
|
|
env: 'N8N_AUTH_EXCLUDE_ENDPOINTS',
|
|
},
|
|
basicAuth: {
|
|
active: {
|
|
format: 'Boolean',
|
|
default: false,
|
|
env: 'N8N_BASIC_AUTH_ACTIVE',
|
|
doc: 'If basic auth should be activated for editor and REST-API',
|
|
},
|
|
user: {
|
|
format: String,
|
|
default: '',
|
|
env: 'N8N_BASIC_AUTH_USER',
|
|
doc: 'The name of the basic auth user',
|
|
},
|
|
password: {
|
|
format: String,
|
|
default: '',
|
|
env: 'N8N_BASIC_AUTH_PASSWORD',
|
|
doc: 'The password of the basic auth user',
|
|
},
|
|
hash: {
|
|
format: 'Boolean',
|
|
default: false,
|
|
env: 'N8N_BASIC_AUTH_HASH',
|
|
doc: 'If password for basic auth is hashed',
|
|
},
|
|
},
|
|
jwtAuth: {
|
|
active: {
|
|
format: 'Boolean',
|
|
default: false,
|
|
env: 'N8N_JWT_AUTH_ACTIVE',
|
|
doc: 'If JWT auth should be activated for editor and REST-API',
|
|
},
|
|
jwtHeader: {
|
|
format: String,
|
|
default: '',
|
|
env: 'N8N_JWT_AUTH_HEADER',
|
|
doc: 'The request header containing a signed JWT',
|
|
},
|
|
jwtHeaderValuePrefix: {
|
|
format: String,
|
|
default: '',
|
|
env: 'N8N_JWT_AUTH_HEADER_VALUE_PREFIX',
|
|
doc: 'The request header value prefix to strip (optional)',
|
|
},
|
|
jwksUri: {
|
|
format: String,
|
|
default: '',
|
|
env: 'N8N_JWKS_URI',
|
|
doc: 'The URI to fetch JWK Set for JWT authentication',
|
|
},
|
|
jwtIssuer: {
|
|
format: String,
|
|
default: '',
|
|
env: 'N8N_JWT_ISSUER',
|
|
doc: 'JWT issuer to expect (optional)',
|
|
},
|
|
jwtNamespace: {
|
|
format: String,
|
|
default: '',
|
|
env: 'N8N_JWT_NAMESPACE',
|
|
doc: 'JWT namespace to expect (optional)',
|
|
},
|
|
jwtAllowedTenantKey: {
|
|
format: String,
|
|
default: '',
|
|
env: 'N8N_JWT_ALLOWED_TENANT_KEY',
|
|
doc: 'JWT tenant key name to inspect within JWT namespace (optional)',
|
|
},
|
|
jwtAllowedTenant: {
|
|
format: String,
|
|
default: '',
|
|
env: 'N8N_JWT_ALLOWED_TENANT',
|
|
doc: 'JWT tenant to allow (optional)',
|
|
},
|
|
},
|
|
},
|
|
|
|
endpoints: {
|
|
payloadSizeMax: {
|
|
format: Number,
|
|
default: 16,
|
|
env: 'N8N_PAYLOAD_SIZE_MAX',
|
|
doc: 'Maximum payload size in MB.',
|
|
},
|
|
metrics: {
|
|
enable: {
|
|
format: 'Boolean',
|
|
default: false,
|
|
env: 'N8N_METRICS',
|
|
doc: 'Enable metrics endpoint',
|
|
},
|
|
prefix: {
|
|
format: String,
|
|
default: 'n8n_',
|
|
env: 'N8N_METRICS_PREFIX',
|
|
doc: 'An optional prefix for metric names. Default: n8n_',
|
|
},
|
|
},
|
|
rest: {
|
|
format: String,
|
|
default: 'rest',
|
|
env: 'N8N_ENDPOINT_REST',
|
|
doc: 'Path for rest endpoint',
|
|
},
|
|
webhook: {
|
|
format: String,
|
|
default: 'webhook',
|
|
env: 'N8N_ENDPOINT_WEBHOOK',
|
|
doc: 'Path for webhook endpoint',
|
|
},
|
|
webhookWaiting: {
|
|
format: String,
|
|
default: 'webhook-waiting',
|
|
env: 'N8N_ENDPOINT_WEBHOOK_WAIT',
|
|
doc: 'Path for waiting-webhook endpoint',
|
|
},
|
|
webhookTest: {
|
|
format: String,
|
|
default: 'webhook-test',
|
|
env: 'N8N_ENDPOINT_WEBHOOK_TEST',
|
|
doc: 'Path for test-webhook endpoint',
|
|
},
|
|
disableUi: {
|
|
format: Boolean,
|
|
default: false,
|
|
env: 'N8N_DISABLE_UI',
|
|
doc: 'Disable N8N UI (Frontend).',
|
|
},
|
|
disableProductionWebhooksOnMainProcess: {
|
|
format: Boolean,
|
|
default: false,
|
|
env: 'N8N_DISABLE_PRODUCTION_MAIN_PROCESS',
|
|
doc: 'Disable production webhooks from main process. This helps ensures no http traffic load to main process when using webhook-specific processes.',
|
|
},
|
|
skipWebhoooksDeregistrationOnShutdown: {
|
|
/**
|
|
* Longer explanation: n8n deregisters webhooks on shutdown / deactivation
|
|
* and registers on startup / activation. If we skip
|
|
* deactivation on shutdown, webhooks will remain active on 3rd party services.
|
|
* We don't have to worry about startup as it always
|
|
* checks if webhooks already exist.
|
|
* If users want to upgrade n8n, it is possible to run
|
|
* two instances simultaneously without downtime, similar
|
|
* to blue/green deployment.
|
|
* WARNING: Trigger nodes (like Cron) will cause duplication
|
|
* of work, so be aware when using.
|
|
*/
|
|
doc: 'Deregister webhooks on external services only when workflows are deactivated.',
|
|
format: Boolean,
|
|
default: false,
|
|
env: 'N8N_SKIP_WEBHOOK_DEREGISTRATION_SHUTDOWN',
|
|
},
|
|
},
|
|
|
|
publicApi: {
|
|
disabled: {
|
|
format: Boolean,
|
|
default: false,
|
|
env: 'N8N_PUBLIC_API_DISABLED',
|
|
doc: 'Whether to disable the Public API',
|
|
},
|
|
path: {
|
|
format: String,
|
|
default: 'api',
|
|
env: 'N8N_PUBLIC_API_ENDPOINT',
|
|
doc: 'Path for the public api endpoints',
|
|
},
|
|
},
|
|
|
|
workflowTagsDisabled: {
|
|
format: Boolean,
|
|
default: false,
|
|
env: 'N8N_WORKFLOW_TAGS_DISABLED',
|
|
doc: 'Disable worfklow tags.',
|
|
},
|
|
|
|
userManagement: {
|
|
disabled: {
|
|
doc: 'Disable user management and hide it completely.',
|
|
format: Boolean,
|
|
default: false,
|
|
env: 'N8N_USER_MANAGEMENT_DISABLED',
|
|
},
|
|
jwtSecret: {
|
|
doc: 'Set a specific JWT secret (optional - n8n can generate one)', // Generated @ start.ts
|
|
format: String,
|
|
default: '',
|
|
env: 'N8N_USER_MANAGEMENT_JWT_SECRET',
|
|
},
|
|
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',
|
|
},
|
|
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',
|
|
},
|
|
},
|
|
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',
|
|
},
|
|
},
|
|
},
|
|
},
|
|
|
|
externalHookFiles: {
|
|
doc: 'Files containing external hooks. Multiple files can be separated by colon (":")',
|
|
format: String,
|
|
default: '',
|
|
env: 'EXTERNAL_HOOK_FILES',
|
|
},
|
|
|
|
nodes: {
|
|
include: {
|
|
doc: 'Nodes to load',
|
|
format: function check(rawValue: string): void {
|
|
if (rawValue === '') {
|
|
return;
|
|
}
|
|
try {
|
|
const values = JSON.parse(rawValue);
|
|
if (!Array.isArray(values)) {
|
|
throw new Error();
|
|
}
|
|
|
|
for (const value of values) {
|
|
if (typeof value !== 'string') {
|
|
throw new Error();
|
|
}
|
|
}
|
|
} catch (error) {
|
|
throw new TypeError(`The Nodes to include is not a valid Array of strings.`);
|
|
}
|
|
},
|
|
default: undefined,
|
|
env: 'NODES_INCLUDE',
|
|
},
|
|
exclude: {
|
|
doc: 'Nodes not to load',
|
|
format: function check(rawValue: string): void {
|
|
try {
|
|
const values = JSON.parse(rawValue);
|
|
if (!Array.isArray(values)) {
|
|
throw new Error();
|
|
}
|
|
|
|
for (const value of values) {
|
|
if (typeof value !== 'string') {
|
|
throw new Error();
|
|
}
|
|
}
|
|
} catch (error) {
|
|
throw new TypeError(`The Nodes to exclude is not a valid Array of strings.`);
|
|
}
|
|
},
|
|
default: '[]',
|
|
env: 'NODES_EXCLUDE',
|
|
},
|
|
errorTriggerType: {
|
|
doc: 'Node Type to use as Error Trigger',
|
|
format: String,
|
|
default: 'n8n-nodes-base.errorTrigger',
|
|
env: 'NODES_ERROR_TRIGGER_TYPE',
|
|
},
|
|
},
|
|
|
|
logs: {
|
|
level: {
|
|
doc: 'Log output level',
|
|
format: ['error', 'warn', 'info', 'verbose', 'debug', 'silent'] as const,
|
|
default: 'info',
|
|
env: 'N8N_LOG_LEVEL',
|
|
},
|
|
output: {
|
|
doc: 'Where to output logs. Options are: console, file. Multiple can be separated by comma (",")',
|
|
format: String,
|
|
default: 'console',
|
|
env: 'N8N_LOG_OUTPUT',
|
|
},
|
|
file: {
|
|
fileCountMax: {
|
|
doc: 'Maximum number of files to keep.',
|
|
format: Number,
|
|
default: 100,
|
|
env: 'N8N_LOG_FILE_COUNT_MAX',
|
|
},
|
|
fileSizeMax: {
|
|
doc: 'Maximum size for each log file in MB.',
|
|
format: Number,
|
|
default: 16,
|
|
env: 'N8N_LOG_FILE_SIZE_MAX',
|
|
},
|
|
location: {
|
|
doc: 'Log file location; only used if log output is set to file.',
|
|
format: String,
|
|
default: path.join(core.UserSettings.getUserN8nFolderPath(), 'logs/n8n.log'),
|
|
env: 'N8N_LOG_FILE_LOCATION',
|
|
},
|
|
},
|
|
},
|
|
|
|
versionNotifications: {
|
|
enabled: {
|
|
doc: 'Whether feature is enabled to request notifications about new versions and security updates.',
|
|
format: Boolean,
|
|
default: true,
|
|
env: 'N8N_VERSION_NOTIFICATIONS_ENABLED',
|
|
},
|
|
endpoint: {
|
|
doc: 'Endpoint to retrieve version information from.',
|
|
format: String,
|
|
default: 'https://api.n8n.io/api/versions/',
|
|
env: 'N8N_VERSION_NOTIFICATIONS_ENDPOINT',
|
|
},
|
|
infoUrl: {
|
|
doc: `Url in New Versions Panel with more information on updating one's instance.`,
|
|
format: String,
|
|
default: 'https://docs.n8n.io/getting-started/installation/updating.html',
|
|
env: 'N8N_VERSION_NOTIFICATIONS_INFO_URL',
|
|
},
|
|
},
|
|
|
|
templates: {
|
|
enabled: {
|
|
doc: 'Whether templates feature is enabled to load workflow templates.',
|
|
format: Boolean,
|
|
default: true,
|
|
env: 'N8N_TEMPLATES_ENABLED',
|
|
},
|
|
host: {
|
|
doc: 'Endpoint host to retrieve workflow templates from endpoints.',
|
|
format: String,
|
|
default: 'https://api.n8n.io/api/',
|
|
env: 'N8N_TEMPLATES_HOST',
|
|
},
|
|
},
|
|
|
|
binaryDataManager: {
|
|
availableModes: {
|
|
format: String,
|
|
default: 'filesystem',
|
|
env: 'N8N_AVAILABLE_BINARY_DATA_MODES',
|
|
doc: 'Available modes of binary data storage, as comma separated strings',
|
|
},
|
|
mode: {
|
|
format: ['default', 'filesystem'] as const,
|
|
default: 'default',
|
|
env: 'N8N_DEFAULT_BINARY_DATA_MODE',
|
|
doc: 'Storage mode for binary data',
|
|
},
|
|
localStoragePath: {
|
|
format: String,
|
|
default: path.join(core.UserSettings.getUserN8nFolderPath(), 'binaryData'),
|
|
env: 'N8N_BINARY_DATA_STORAGE_PATH',
|
|
doc: 'Path for binary data storage in "filesystem" mode',
|
|
},
|
|
binaryDataTTL: {
|
|
format: Number,
|
|
default: 60,
|
|
env: 'N8N_BINARY_DATA_TTL',
|
|
doc: 'TTL for binary data of unsaved executions in minutes',
|
|
},
|
|
persistedBinaryDataTTL: {
|
|
format: Number,
|
|
default: 1440,
|
|
env: 'N8N_PERSISTED_BINARY_DATA_TTL',
|
|
doc: 'TTL for persisted binary data in minutes (binary data gets deleted if not persisted before TTL expires)',
|
|
},
|
|
},
|
|
|
|
deployment: {
|
|
type: {
|
|
format: String,
|
|
default: 'default',
|
|
env: 'N8N_DEPLOYMENT_TYPE',
|
|
},
|
|
},
|
|
|
|
hiringBanner: {
|
|
enabled: {
|
|
doc: 'Whether hiring banner in browser console is enabled.',
|
|
format: Boolean,
|
|
default: true,
|
|
env: 'N8N_HIRING_BANNER_ENABLED',
|
|
},
|
|
},
|
|
|
|
personalization: {
|
|
enabled: {
|
|
doc: 'Whether personalization is enabled.',
|
|
format: Boolean,
|
|
default: true,
|
|
env: 'N8N_PERSONALIZATION_ENABLED',
|
|
},
|
|
},
|
|
|
|
diagnostics: {
|
|
enabled: {
|
|
doc: 'Whether diagnostic mode is enabled.',
|
|
format: Boolean,
|
|
default: true,
|
|
env: 'N8N_DIAGNOSTICS_ENABLED',
|
|
},
|
|
config: {
|
|
frontend: {
|
|
doc: 'Diagnostics config for frontend.',
|
|
format: String,
|
|
default: '1zPn9bgWPzlQc0p8Gj1uiK6DOTn;https://telemetry.n8n.io',
|
|
env: 'N8N_DIAGNOSTICS_CONFIG_FRONTEND',
|
|
},
|
|
backend: {
|
|
doc: 'Diagnostics config for backend.',
|
|
format: String,
|
|
default: '1zPn7YoGC3ZXE9zLeTKLuQCB4F6;https://telemetry.n8n.io/v1/batch',
|
|
env: 'N8N_DIAGNOSTICS_CONFIG_BACKEND',
|
|
},
|
|
},
|
|
},
|
|
|
|
defaultLocale: {
|
|
doc: 'Default locale for the UI',
|
|
format: String,
|
|
default: 'en',
|
|
env: 'N8N_DEFAULT_LOCALE',
|
|
},
|
|
};
|