import * as convict from 'convict'; import * as dotenv from 'dotenv'; dotenv.config(); const config = convict({ database: { type: { doc: 'Type of database to use', format: ['sqlite', 'mongodb', 'postgresdb'], default: 'sqlite', env: 'DB_TYPE' }, mongodb: { connectionUrl: { doc: 'MongoDB Connection URL', format: '*', default: 'mongodb://user:password@localhost:27017/database', env: 'DB_MONGODB_CONNECTION_URL' } }, 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' }, }, }, 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'], default: 'own', env: 'EXECUTIONS_PROCESS' }, // 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 write the database full it is possible 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'], default: 'all', env: 'EXECUTIONS_DATA_SAVE_ON_ERROR' }, saveDataOnSuccess: { doc: 'What workflow execution data to save on success', format: ['all', 'none'], default: 'all', env: 'EXECUTIONS_DATA_SAVE_ON_SUCCESS' }, // 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', default: false, env: 'EXECUTIONS_DATA_SAVE_MANUAL_EXECUTIONS' }, }, 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) 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' }, protocol: { format: ['http', 'https'], default: 'http', env: 'N8N_PROTOCOL', doc: 'HTTP Protocol via which n8n can be reached' }, security: { 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' }, }, 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' }, jwksUri: { format: String, default: '', env: 'N8N_JWKS_URI', doc: 'The URI to fetch JWK Set for JWT auh' }, } }, endpoints: { 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' }, webhookTest: { format: String, default: 'webhook-test', env: 'N8N_ENDPOINT_WEBHOOK_TEST', doc: 'Path for test-webhook endpoint' }, }, nodes: { exclude: { doc: 'Nodes not to load', format: function check(rawValue) { 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' }, }, }); config.validate({ allowed: 'strict', }); export = config;