Конфігурація

Платформа має ієрархічну структуру визначення пріоритетів конфігураційних параметрів:

1. Файл конфігурації, який знаходиться за шляхом - {homedir}/.x-fiber/{configuration-file-name}.json
2. Файл конфігурації, який знаходиться в корні проекта за шляхом - {processdir}/config/${configuration-file-name}.json,
3. Параметри, за замовчуванням, які визначені всередині ядер платформи.

Якщо параметр визначений в різних файлах, то платформа візьме той параметр, конфігураційний файл, який вищий по пріорітету.

Файл конфігурації домашньої директорії

Файл конфігурації директорії проекту

Перелік конфігураційних параметрів

Ядро обчислень

Зʼєднувачі

Ядро обчислень дозволяє конфігурувати наступними види зʼєднувачів:

MongoDB

Шлях	Тип	Знач. за замовч.	Опис
connectors.mongodb.enable	boolean	false	Ознака підключення зʼєднувача з MongoDB NoSQL базою даних.
connectors.mongodb.database	string	default	Назва бази даних.
connectors.mongodb.connect.protocol	string	mongodb	Тип протоколу url шляху до бази даних.
connectors.mongodb.connect.host	string	0.0.0.0	Хост url шляху до бази даних.
connectors.mongodb.connect.port	number	27017	Порт url шляху до бази даних.
connectors.mongodb.auth.username	string	' '	Імʼя користувача, під яким будет відбуватись авторизація в базі даних.
connectors.mongodb.auth.password	string	' '	Пароль користувача, під яким будет відбуватись авторизація в базі даних.
connectors.mongodb.options.bufferCommands	boolean	undefined	Чи слід використовувати буферизацію команд для всіх моделей, пов'язаних з цим підключенням. Якщо встановлено в false, Mongoose не буде буферизувати команди і може виникнути ситуація, коли колбеки не виконуються.
connectors.mongodb.options.autoIndex	boolean	undefined	Чи слід автоматично створювати індекси для всіх моделей, пов'язаних з цим підключенням. Якщо встановлено в false, автоматичне створення індексів буде вимкнено.
connectors.mongodb.options.autoCreate	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.tls.enable	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.tls.tlsCertificateKeyFile	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.tls.tlsCertificateKeyFilePassword	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.tls.tlsCAFile	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.tls.tlsAllowInvalidCertificates	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.tls.tlsInsecure	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.replicaSet	string	undefined	Назва групи реплік replicas.
connectors.mongodb.options.replicates	Array<{ host: string, number: string}>	[]	Масив обʼєктів з хостом та портом підключення до replicas.
connectors.mongodb.options.connectTimeoutMS	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.socketTimeoutMS	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.zlibCompressionLevel	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.maxPoolSize	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.minPoolSize	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.maxConnecting	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.maxIdleTimeMS	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.waitQueueTimeoutMS	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.serverSelectionTimeoutMS	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.heartbeatFrequencyMS	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.minHeartbeatFrequencyMS	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.retryReads	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.retryWrites	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.readConcernLevel	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .
connectors.mongodb.options.readPreference	boolean	undefined	Чи має Mongoose автоматично викликати createCollection() для кожної моделі, створеної на цьому з'єднанні. Якщо встановлено в true, Mongoose автоматично створюватиме колекції для моделей .

readConcernLevel

readonly
local: "local";
readonly
majority: "majority";
readonly
linearizable: "linearizable";
readonly
available: "available";
readonly
snapshot: "snapshot";

readPreference

readonly
primary: "primary";
readonly
primaryPreferred: "primaryPreferred";
readonly
secondary: "secondary";
readonly
secondaryPreferred: "secondaryPreferred";
readonly
nearest: "nearest";

Redis

Шлях	Тип	Знач. за замовч.	Опис
connectors.redis.enable	boolean	false	Ознака підключення зʼєднувача з MongoDB NoSQL базою даних.
connectors.redis.connect.protocol	string	redis	Тип протоколу url шляху до Redis.
connectors.redis.connect.host	string	0.0.0.0	Хост url шляху до Redis.
connectors.redis.connect.port	number	6379	Порт url шляху до Redis.
connectors.redis.options.keyPrefix	string	' '	Дозволяє задати префікс для всіх ключів, які зберігаються в Redis.
connectors.redis.options.showFriendlyErrorStack	boolean	false	Ознака потреби виводити дружелюбні помилки повʼязаних з Redis.
connectors.redis.options.common.commandTimeout	number	undefined
connectors.redis.options.common.keepAlive	number	undefined
connectors.redis.options.common.noDelay	boolean	undefined
connectors.redis.options.common.connectionName	connectionName	undefined
connectors.redis.options.common.username	string	undefined
connectors.redis.options.common.password	string	undefined
connectors.redis.options.common.autoResubscribe	boolean	undefined
connectors.redis.options.common.autoResendUnfulfilledCommands	boolean	undefined
connectors.redis.options.common.connectTimeout	number	undefined
connectors.redis.options.common.maxRetriesPerRequest	number / null	undefined
connectors.redis.options.common.maxLoadingRetryTime	number	undefined
connectors.redis.options.common.enableAutoPipelining	boolean	undefined
connectors.redis.options.common.autoPipeliningIgnoredCommands	string[]	undefined
connectors.redis.options.common.enableOfflineQueue	boolean	undefined
connectors.redis.options.common.enableReadyCheck	boolean	undefined
connectors.redis.options.sentinel.name	string	undefined
connectors.redis.options.sentinel.role	string	undefined	Role master / slave
connectors.redis.options.sentinel.sentinelUsername	string	undefined
connectors.redis.options.sentinel.sentinelPassword	string	undefined
connectors.redis.options.sentinel.sentinels	Array<{ port: number;host: string;family?: number;}>	undefined
connectors.redis.options.sentinel.connectTimeout	number	undefined
connectors.redis.options.sentinel.disconnectTimeout	number	undefined
connectors.redis.options.sentinel.sentinelCommandTimeout	number	undefined
connectors.redis.options.sentinel.enableTLSForSentinelMode	boolean	undefined
connectors.redis.options.sentinel.updateSentinels	boolean	undefined
connectors.redis.options.sentinel.sentinelMaxConnections	number	undefined
connectors.redis.options.sentinel.failoverDetector	boolean	undefined
connectors.redis.options.standalone.disconnectTimeout	number	undefined

TypeORM

Шлях	Тип	Знач. за замовч.	Опис
connectors.typeorm.enable	boolean	false	Ознака підключення зʼєднувача TypeORM з базою даних.
connectors.typeorm.connect.dbType	string	postgres	Тип SQL бази даних.
connectors.typeorm.connect.protocol	string	http	Тип протоколу url шляху до бази даних.
connectors.typeorm.connect.host	string	0.0.0.0	Хост url шляху до бази даних.
connectors.typeorm.connect.port	number	5432	Порт url шляху до бази даних.
connectors.typeorm.connect.database	string	' '	Назва бази даних.
connectors.typeorm.connect.schema	string	public	Назва схеми бази даних.
connectors.typeorm.auth.username	string	postgres	Імʼя користувача, під яким будет відбуватись авторизація в базі даних.
connectors.typeorm.auth.password	string	postgres	Пароль користувача, під яким будет відбуватись авторизація в базі даних.

Адаптери

Ядро обчислень дозволяє конфігурувати наступні види адаптерів:

HTTP Adapter

Шлях	Тип	Знач. за замовч.	Опис
adapters.http.enable	boolean	true	Ознака підключення http адаптера ядра обчислень.
adapters.http.kind	enum	fastify	Тип http фреймворку, який буде задіяний в роботі ядра обчислень, наразі доступний лише fastify, в послідуючому будуть доступні express, hapi.
adapters.http.serverTag	string	ANONYMOUS_01	Унікальна назва ядра обчислень, яке повинно бути унікальним при використанні групи ядер обчислень, оскільки воно використовується в логувані та трейсінгу.
adapters.http.protocol	string	http	Тип протоколу, може бути http або https
adapters.http.host	string	0.0.0.0	Хост url шляху доступу до http веб-сервера.
adapters.http.port	number	11010	Порт url шляху доступу до http веб-сервера.
adapters.http.https.key	string	' '	Шлях до файлу закритого ключа.
adapters.http.https.cert	string	' '	Шлях до сертифікату.
adapters.http.fastify.connectionTimeout	number	undefined	Час очікування (в мілісекундах), після якого Fastify розірве зʼєднання з клієнтом, якщо клієнт не відповів.
adapters.http.fastify.keepAliveTimeout	number	undefined	Час очікування (в мілісекундах), між запитами на цьому ж сокеті. Це час, напротязі якого Fastify очікує, наступного запиту від клієнта на цьому ж зʼєднанні.
adapters.http.fastify.maxRequestsPerSocket	number	undefined	Максимальна кількість запитів, які Fastify дозволить обробляти на одному сокеті до його закриття.
adapters.http.fastify.forceCloseConnections	boolean	undefined	Якщо встановлено в true, Fastify закриє з'єднання відразу після завершення обробки запиту. Якщо встановлено значення idle, Fastify буде закривати неактивні з'єднання після keepAliveTimeout
adapters.http.fastify.requestTimeout	number	undefined	Максимальний час виконання запиту (в мілісекундах). Якщо запит не завершиться протягом цього часу, Fastify його перерве.
adapters.http.fastify.bodyLimit	number	undefined	Максимальний розмір тіла запиту (в байтах). Якщо розмір тіла запиту перевищує це значення, Fastify відхилить запит з помилкою 413 Payload Too Large.
adapters.http.urls.api	string	/v1/call/api	Базовий маршрут REST API.

WS Adapter

Шлях	Тип	Знач. за замовч.	Опис
adapters.ws.enable	boolean	false	Ознака підключення ws адаптера ядра обчислень.
adapters.ws.kind	string	ws	Тип ws фреймворку, який буде задіяний в роботі ядра обчислень, наразі доступний лише ws, в послідуючому буде доступний ще й socketIO
adapters.ws.protocol	string	ws	Тип протоколу, може бути ws або wss.
adapters.ws.host	string	0.0.0.0	Хост url шляху доступу до ws веб-сервера.
adapters.ws.port	number	11011	Хост url шляху доступу до ws веб-сервера.
adapters.ws.wss.key	string	' '	Шлях до файлу закритого ключа.
adapters.ws.wss.cert	string	' '	Шлях до сертифікату.
adapters.ws.ws.backlog	number	undefined	Максимальна довжина черги з'єднань TCP, яка буде використана при відкритті серверного сокету.
adapters.ws.ws.maxPayload	number	undefined	Максимальний розмір повідомлення (в байтах), яке сервер WebSocket приймає.
adapters.ws.ws.skipUTF8Validation	boolean	undefined	Якщо цей параметр встановлено в true, ws server пропустить перевірку правильності кодування UTF-8 для отриманих повідомлень
adapters.ws.ws.perMessageDeflate	boolean	undefined	Стискання повідомлень (per-message compression), яке дозволяє стискати дані перед їх відправленням через WebSocket з'єднання. Це може бути корисно для зменшення обсягу даних, які передаються між клієнтом і сервером, що в свою чергу може поліпшити швидкодію та знизити використання мережевого трафіку.
adapters.ws.ws.perMessageDeflate.serverNoContextTakeover	boolean	undefined	Вказує, чи повинен ws адаптер зберігати стан стискання між повідомленнями.
adapters.ws.ws.perMessageDeflate.serverMaxWindowBits	number	undefined	Визначає максимальний розмір вікна стискання для сервера та клієнта.
adapters.ws.ws.perMessageDeflate.threshold	number	undefined	Мінімальний розмір повідомлення, який потрібно стискати.
adapters.ws.ws.perMessageDeflate.concurrencyLimit	number	undefined	СМаксимальна кількість одночасних компресій або декомпресій, які дозволені одночасно.

Інтеграції

Шлях	Тип	Знач. за замовч.	Опис
integrations.mail.enable	boolean	false
integrations.mail.host	string	' '
integrations.mail.port	number	587
integrations.mail.secure	boolean	false
integrations.mail.secure.auth.user	string	' '
integrations.mail.secure.auth.pass	string	' '
integrations.mail.contact.from	string	' '
integrations.mail.withMessageId	boolean	true

Сервіси

LocalizationService

Шлях	Тип	Знач. за замовч.	Опис
services.localization.enable	boolean	true
services.localization.supportedLanguages	string[]	['en']
services.localization.defaultLanguages	string	en

LoggerService

Шлях	Тип	Знач. за замовч.	Опис
services.logger.enable	boolean	true
services.logger.loggers.core	boolean	true
services.logger.loggers.schema	boolean	true
services.logger.transports.console.core.enable	boolean	true
services.logger.transports.console.core.level	string	verbose
services.logger.transports.console.schema.level	string	debug

ScramblerService

Шлях	Тип	Знач. за замовч.	Опис
services.scrambler.enable	boolean	true
services.scrambler.salt	number	5
services.scrambler.secret	string	default
services.scrambler.randomBytes	number	10
services.scrambler.accessExpiredAt	number	10
services.scrambler.refreshExpiredAt	number	30
services.scrambler.defaultAlgorithm	string	MD5

SpecificationService

Шлях	Тип	Знач. за замовч.	Опис
services.specification.enable	boolean	false
services.specification.liveReload	boolean	false
services.specification.liveReload	boolean	false

Ядро відображення

Адаптери

Ядро обчислень дозволяє конфігурувати наступні види адаптерів:

HTTP Adapter

Шлях	Тип	Знач. за замовч.	Опис
adapters.http.enable	boolean	true
adapters.http.protocol	string	http
adapters.http.host	string	0.0.0.0
adapters.http.port	number	11010
adapters.http.urls.baseApiUrl	string	/v1/call/api
adapters.http.urls.baseExceptionUrl	string	v1/exception-tunnel

WS Adapter

Шлях	Тип	Знач. за замовч.	Опис
adapters.ws.enable	boolean	false
adapters.ws.connect.protocol	string	ws
adapters.ws.connect.host	string	0.0.0.0
adapters.ws.connect.port	number	11011

Інтеграції

Sentry

Шлях	Тип	Знач. за замовч.	Опис
integrations.sentry.enable	boolean	false
integrations.sentry.options.token	string	' '
integrations.sentry.options.logLevel	string	0.0.0.0
integrations.sentry.options.tracesSampleRate	number	100
integrations.sentry.options.replaysSessionSampleRate	number	0.1
integrations.sentry.options.replaysOnErrorSampleRate	number	1.0

Сервіси

Шлях	Тип	Знач. за замовч.	Опис
services.localization.enable	boolean	true
services.localization.fallbackLanguage	string	en
services.localization.defaultLanguage	string	en
services.localization.supportedLanguages	string[]	["en"]