v3.x.x (поточна версія)

INFO
This documentation is up to date as of version 3.x.x.

All cellar configuration is handled through API settings, and such API configuration handled through environment variables.

You must configure both the application settings as well as one datastore and one cryptography engine. See below for details.

Додаток

Name	Type	Min Version	Description	Default
`APP_CLIENT_ADDRESS`	string		Визначає FQDN (повністю визначення ім’я домена) куди ви розгортаєте Cellar.	`http://127.0.0.1:8080`
`APP_BIND_ADDRESS`	string		Визначає адресу на який Cellar буде примати зв’язок. За замовчуванням.	`127.0.0.1:8080`
`APP_MAX_FILE_SIZE_MB`	integer	v3.2.0	Визначає максимальний розмір файлу в мегабайтах для завантаження файлів v2. Встановіть `0` щоб вимкнути завантаження файлів. Дивіться Найкращі практики безпеки для деталей. Мінімальне значення: `0`.	`8`
`APP_MAX_ACCESS_COUNT`	integer	v3.4.0	Визначає максимальну кількість разів, коли секрет може бути доступний перед автоматичним видаленням. Мінімальне значення: `1`.	`100`
`APP_MAX_EXPIRATION_SECONDS`	integer	v3.4.0	Визначає максимальний час життя в секундах для секретів. Мінімальне значення: `900` (15 хвилин).	`604800` (7 днів)
`LOGGING_LEVEL`	string		Визначає мінімальний рівень серйозності для ведення журналу. Має бути один з `trace`, `debug`, `info`, `warning`, `error`, `fatal`, `panic`.	`info`
`LOGGING_ENABLE_STDOUT`	boolean		Визначає чи Cellar повинен писати логи в стандартне виведення (stdout).	`true`
`LOGGING_FORMAT`	string	v3.1.0	Визначає формат для ведення журналу. Має бути один з `json`, `text`	`text`
`LOGGING_DIRECTORY` (optional)	string		Визначає папку туда, куда Cellar повинен писати логи. Cellar створює папку якщо її немає.

Система Зберігання Даних (Datastore)

All datastore settings are contained in a “datastore” section

NOTE
Since there is currently only one datastore, it is enabled by default.

Redis

Name	Type	Min Version	Description	Default
`DATASTORE_REDIS_HOST`	string	v3.0.0	Визначає хост на яких база даних Redis приймає зв’язки.	`localhost`
`DATASTORE_REDIS_PORT`	integer	v3.0.0	Визначає порт на яких база даних Redis приймає зв’язки.	`6379`
`DATASTORE_REDIS_PASSWORD` (optional)	string	v3.0.0	Це пароль від база даних Redis.
`DATASTORE_REDIS_DB`	integer	v3.0.0	Визначає номер база даних в екземпляр Redis з яким ви хочете взаємодіяти.	`0`

Обмеження Швидкості (Rate Limiting)

Обмеження швидкості захищає ваше розгортання Cellar від зловживань та вичерпання ресурсів. Для детальної інформації про поведінку обмеження швидкості, див. Обмеження Швидкості.

NOTE
Обмеження швидкості увімкнено за замовчуванням у виробничих розгортаннях.

Name	Type	Min Version	Description	Default
`RATE_LIMIT_ENABLED`	boolean	v3.4.0	Вмикає або вимикає обмеження швидкості для всіх кінцевих точок.	`true`
`RATE_LIMIT_WINDOW_SECONDS`	integer	v3.4.0	Тривалість у секундах для ковзаючого вікна обмеження швидкості.	`60`
`RATE_LIMIT_TIER1_REQUESTS_PER_WINDOW`	integer	v3.4.1	Максимальна кількість запитів для Tier 1 (дорогі операції) за вікно.	`300`
`RATE_LIMIT_TIER2_REQUESTS_PER_WINDOW`	integer	v3.4.1	Максимальна кількість запитів для Tier 2 (помірні операції) за вікно.	`600`
`RATE_LIMIT_TIER3_REQUESTS_PER_WINDOW`	integer	v3.4.1	Максимальна кількість запитів для Tier 3 (легкі операції) за вікно.	`1200`
`RATE_LIMIT_HEALTH_CHECK_REQUESTS_PER_WINDOW`	integer	v3.4.1	Максимальна кількість запитів для кінцевої точки перевірки здоров’я за вікно.	`1200`

Криптографія (Cryptography)

All cryptography settings are contained in a “cryptography” section. Each of them contains an “enabled” option. It must be set to true for that cryptography engine to be enabled. However, only one engine can be enabled at a time.

AWS KMS

Name	Type	Min Version	Description	Default
`CRYPTOGRAPHY_AWS_ENABLED`	boolean	v3.0.0	Enables AWS as a cryptography engine	`false`
`CRYPTOGRAPHY_AWS_REGION`	string	v3.0.0	Specifies the AWS region where your kms key is located.
`CRYPTOGRAPHY_AWS_KMS_KEY_ID`	string	v3.0.0	Specifies the ID of the KMS key from AWS to use for encrypting and decrypting.

Vault

Name	Type	Min Version	Description	Default
`CRYPTOGRAPHY_VAULT_ENABLED`	boolean	v3.0.0	Enables vault as a cryptography engine	`false`
`CRYPTOGRAPHY_VAULT_ADDRESS`	string	v3.0.0	Визначає вся адреса екземпляр Vault.	`http://localhost:8200`
`CRYPTOGRAPHY_VAULT_ENCRYPTION_TOKEN_NAME`	string	v3.0.0	Визначає назва ключа з Vault Transit Secrets Engine який Cellar буде використовувати щоб зашифрувати та розшифрувати.
`CRYPTOGRAPHY_VAULT_AUTH_MOUNT_PATH`	string	v3.0.0	Specifies the mount path of the auth engine you whish to use to authenticate from Cellar API to vault (see below for more information)

Cellar supports multiple methods of authentication between your api and vault. You must configure exactly one of them.

For more information on how each of these auth methods work, please refer to the Vault Auth Methods documentation.

AppRole Auth

Name	Type	Min Version	Description	Default
`CRYPTOGRAPHY_VAULT_AUTH_APPROLE_ROLE_ID`	string	v3.0.0	Визначає те, який `role_id` використовувати щоб увійти в Vault з [з методом автентифікації AppRole][vault-approle].
`CRYPTOGRAPHY_VAULT_AUTH_APPROLE_SECRET_ID`	string	v3.0.0	Визначає те, який `secret_id` використовувати щоб увійти в Vault з [з методом автентифікації AppRole][vault-approle].

AWS IAM Auth

Name	Type	Min Version	Description	Default
`CRYPTOGRAPHY_VAULT_AUTH_AWSIAM_ROLE`	string	v3.0.0	Specifies the AWS IAM `role` to use for authenticating to vault with AWS IAM authentication.

GCP IAM Auth

Name	Type	Min Version	Description	Default
`CRYPTOGRAPHY_VAULT_AUTH_GCPIAM_ROLE`	string	v3.0.0	Specifies the GCP IAM `role` to use for authenticating to vault with GCP IAM authentication.

Kubernetes Auth

Name	Type	Min Version	Description	Default
`CRYPTOGRAPHY_VAULT_AUTH_KUBERNETES_ROLE`	string	v3.0.0	Specifies the K8s `role` to use for authenticating to vault with K8s authentication.