Внимание

Эта страница содержит описание конфигурации для Юкка 0.4.0, для последней версии перейдите по ссылке.

Конфигурация Юкка 0.4.0¶

Настройка может осуществляться через конфигурационный файл, аргументы командной строки или переменные окружения. Приоритет при чтении конфигурации:

аргументы командной строки;
файл;
переменные окружения.

Параметры делятся на логические разделы (блоки), которые соответствуют префиксу в аргументах командной строки и переменных окружения.

analytics¶

Сбор аналитики.

enabled¶

Включить сбор и отправку аналитических данных и конфигурации системы: модель процессора, тип и версия операционной системы, размер оперативной памяти, размер дисков, количество запущенных потоков. Мы не собираем информацию об источниках стримов и прочие чувствительные данные. По умолчанию true.

Значение можно определить одним из способов:

с помощью аргумента запуска: --analytics-enabled=true
с помощью переменной окружения: export YUCCA_ANALYTICS_ENABLED=true
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[analytics]
enabled = true

Информация о сборе также есть в условиях использования.

address¶

Адрес на который происходит отправка данных. По умолчанию https://analytics.yucca.app/.

Значение можно определить одним из способов:

с помощью аргумента запуска: --analytics-address=https://analytics.yucca.app/
с помощью переменной окружения: export YUCCA_ANALYTICS_ADDRESS=https://analytics.yucca.app/
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[analytics]
address = "https://analytics.yucca.app/"

branding¶

Доступно только в Enterprise

Брендирование.

app_logo¶

Путь к файлу с логотипом.

Значение можно определить одним из способов:

с помощью аргумента запуска: --branding-app-logo=/opt/yucca/logo.png
с помощью переменной окружения: export YUCCA_BRANDING_APP_LOGO=/opt/yucca/logo.png
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[branding]
app_logo = "/opt/yucca/logo.png"

app_title¶

Текст в поле Title.

Значение можно определить одним из способов:

с помощью аргумента запуска: --branding-app-title=Yucca
с помощью переменной окружения: export YUCCA_BRANDING_APP_TITLE=Yucca
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[branding]
app_title = "Yucca"

fav_icon¶

Путь к файлу Favicon.

Значение можно определить одним из способов:

с помощью аргумента запуска: --branding-fav-icon=/opt/yucca/favicon.ico
с помощью переменной окружения: export YUCCA_BRANDING_FAV_ICON=/opt/yucca/favicon.ico
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[branding]
fav_icon = "/opt/yucca/favicon.ico"

database¶

Подключение к базе данных.

type¶

Поддерживается 2 типа баз данных для хранения состояния – sqlite3 и postgres. В небольших инсталляциях, достаточно sqlite3, при большом количестве стримов, мы рекомендуем использовать postgres. По умолчанию sqlite3.

Значение можно определить одним из способов:

с помощью аргумента запуска: --database-type=sqlite3
с помощью переменной окружения: export YUCCA_DATABASE_TYPE=sqlite3
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[database]
type = "sqlite3"

path¶

Путь к файлу базы (только для sqlite3).

Значение можно определить одним из способов:

с помощью аргумента запуска: --database-path=/opt/yucca/server/state.db
с помощью переменной окружения: export YUCCA_DATABASE_PATH=/opt/yucca/server/state.db
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[database]
path = "/opt/yucca/server/state.db"

host¶

Адрес подключения к базе (только для postgres). По умолчанию 127.0.0.1:5432.

Значение можно определить одним из способов:

с помощью аргумента запуска: --database-host=127.0.0.1:5432
с помощью переменной окружения: export YUCCA_DATABASE_HOST=127.0.0.1:5432
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[database]
host = "127.0.0.1:5432"

name¶

Название базы данных (только для postgres). По умолчанию yucca.

Значение можно определить одним из способов:

с помощью аргумента запуска: --database-name=yucca
с помощью переменной окружения: export YUCCA_DATABASE_NAME=yucca
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[database]
name = "yucca"

user¶

Имя пользователя для подключения (только для postgres). По умолчанию postgres.

Значение можно определить одним из способов:

с помощью аргумента запуска: --database-user=postgres
с помощью переменной окружения: export YUCCA_DATABASE_USER=postgres
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[database]
user = "postgres"

password¶

Пароль пользователя для подключения (только для postgres). По умолчанию postgres.

Значение можно определить одним из способов:

с помощью аргумента запуска: --database-password=postgres
с помощью переменной окружения: export YUCCA_DATABASE_PASSWORD=postgres
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[database]
password = "postgres"

ssl_mode¶

Использовать при подключении SSL (шифрованное соединение) (только для postgres). Возможные значения: disable, require, verify-full). По умолчанию disable.

Значение можно определить одним из способов:

с помощью аргумента запуска: --database-ssl-mode=disable
с помощью переменной окружения: export YUCCA_DATABASE_SSL_MODE=disable
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[database]
ssl_mode = "disable"

busy_timeout¶

Тайм-аут в секундах для ожидания разблокировки таблицы SQLite (только для sqlite3). По умолчанию 500.

Значение можно определить одним из способов:

с помощью аргумента запуска: --database-busy-timeout=500
с помощью переменной окружения: export YUCCA_DATABASE_BUSY_TIMEOUT=500
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[database]
busy_timeout = 500

ca_cert_path¶

Путь к сертификату центра сертификации (CA) случае использования SSL (только для postgres). По умолчанию /etc/ssl/certs.

Значение можно определить одним из способов:

с помощью аргумента запуска: --database-ca-cert-path=/etc/ssl/certs
с помощью переменной окружения: export YUCCA_DATABASE_CA_CERT_PATH=/etc/ssl/certs
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[database]
ca_cert_path = "/etc/ssl/certs"

client_cert_path¶

Путь к файлу с сертификатом в случае использования SSL (только для postgres).

Значение можно определить одним из способов:

с помощью аргумента запуска: --database-client-cert-path=/opt/yucca/ssl/cert.crt
с помощью переменной окружения: export YUCCA_DATABASE_CLIENT_CERT_PATH=/opt/yucca/ssl/cert.crt
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[database]
client_cert_path = "/opt/yucca/ssl/cert.crt"

client_key_path¶

Путь к файлу с ключом в случае использования SSL (только для postgres).

Значение можно определить одним из способов:

с помощью аргумента запуска: --database-client-key-path=/opt/yucca/ssl/cert.key
с помощью переменной окружения: export YUCCA_DATABASE_CLIENT_KEY_PATH=/opt/yucca/ssl/cert.key
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[database]
client_key_path = "/opt/yucca/ssl/cert.key"

cache_mode¶

Параметр общего кэша, используемый для подключения к базе данных (только для sqlite3). Возможные значения: private, shared. По умолчанию shared.

Значение можно определить одним из способов:

с помощью аргумента запуска: --database-cache-mode=shared
с помощью переменной окружения: export YUCCA_DATABASE_CACHE_MODE=shared
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[database]
cache_mode = "shared"

conn_max_lifetime¶

Устанавливает максимальное время, в течение которого соединение может быть повторно использовано. По умолчанию 0s.

Значение можно определить одним из способов:

с помощью аргумента запуска: --database-conn-max-lifetime=0s
с помощью переменной окружения: export YUCCA_DATABASE_CONN_MAX_LIFETIME=0s
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[database]
conn_max_lifetime = "0s"

log_queries¶

Логировать SQL-запросы и время выполнения. По умолчанию false.

Значение можно определить одним из способов:

с помощью аргумента запуска: --database-log-queries=false
с помощью переменной окружения: export YUCCA_DATABASE_LOG_QUERIES=false
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[database]
log_queries = false

max_open_conn¶

Максимальное количество открытых соединений с базой данных (только для postgres). По умолчанию 0.

Значение можно определить одним из способов:

с помощью аргумента запуска: --database-max-open-conn=0
с помощью переменной окружения: export YUCCA_DATABASE_MAX_OPEN_CONN=0
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[database]
max_open_conn = 0

max_idle_conn¶

Максимальное количество соединений в ожидании (только для postgres). По умолчанию 2.

Значение можно определить одним из способов:

с помощью аргумента запуска: --database-max-idle-conn=2
с помощью переменной окружения: export YUCCA_DATABASE_MAX_IDLE_CONN=2
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[database]
max_idle_conn = 2

executor¶

Параметры запуска стримов.

type¶

Тип исполнителя, для парковки стримов. По умолчанию docker.

Значение можно определить одним из способов:

с помощью аргумента запуска: --executor=docker
с помощью переменной окружения: export YUCCA_EXECUTOR_TYPE=docker
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[executor]
type = "docker"

log_level¶

Уровень логирования. Возможные значения: panic, fatal, error, warning, info, debug). По умолчанию info.

Значение можно определить одним из способов:

с помощью аргумента запуска: --executor-log-level=info
с помощью переменной окружения: export YUCCA_EXECUTOR_LOG_LEVEL=info
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[executor]
log_level = "info"

docker¶

image¶

Имя Docker-образа для работы в качестве исполнителя.

Значение можно определить одним из способов:

с помощью аргумента запуска: --docker-image=registry.gitlab.com/yuccastream/yucca
с помощью переменной окружения: export YUCCA_EXECUTOR_DOCKER_IMAGE=registry.gitlab.com/yuccastream/yucca
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[executor.docker]
image = "registry.gitlab.com/yuccastream/yucca"

cap_add¶

Добавить привилегии Linux для Docker-контейнера.

Значение можно определить одним из способов:

с помощью аргумента запуска: --docker-cap-add=ALL
с помощью переменной окружения: export YUCCA_EXECUTOR_DOCKER_CAP_ADD=ALL
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[executor.docker]
cap_add = "ALL"

cap_drop¶

Сбросить привилегии Linux для Docker-контейнера.

Значение можно определить одним из способов:

с помощью аргумента запуска: --docker-cap-drop=ALL
с помощью переменной окружения: export YUCCA_EXECUTOR_DOCKER_CAP_DROP=ALL
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[executor.docker]
cap_drop = "ALL"

cpu_shares¶

Ограничение потребления процессора для Dcoker-контейнера. Доли процессора (относительный вес по сравнению с другими контейнерами). По умолчанию 0.

Значение можно определить одним из способов:

с помощью аргумента запуска: --docker-cpu-shares=0
с помощью переменной окружения: export YUCCA_EXECUTOR_DOCKER_CPU_SHARES=0
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[executor.docker]
cpu_shares = 0

dns¶

Список DNS-серверов для использования Docker-контейнером.

Значение можно определить одним из способов:

с помощью аргумента запуска: --docker-dns=8.8.8.8
с помощью переменной окружения: export YUCCA_EXECUTOR_DOCKER_DNS=8.8.8.8
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[executor.docker]
dns = "8.8.8.8"

dns_search¶

Список DNS-доменов поиска.

Значение можно определить одним из способов:

с помощью аргумента запуска: --docker-dns-search=8.8.8.8
с помощью переменной окружения: export YUCCA_EXECUTOR_DOCKER_DNS_SEARCH=8.8.8.8
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[executor.docker]
dns_search = "8.8.8.8"

memory¶

Ограничение памяти для Docker-контейнера. По умолчанию 0.

Значение можно определить одним из способов:

с помощью аргумента запуска: --docker-memory=0
с помощью переменной окружения: export YUCCA_EXECUTOR_DOCKER_MEMORY=0
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[executor.docker]
memory = 0

memory_reservation¶

Мягкий предел памяти. По умолчанию 0.

Значение можно определить одним из способов:

с помощью аргумента запуска: --docker-memory-reservation=0
с помощью переменной окружения: export YUCCA_EXECUTOR_DOCKER_MEMORY_RESERVATION=0
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[executor.docker]
memory_reservation = 0

memory_swap¶

Общий предел памяти. По умолчанию 0.

Значение можно определить одним из способов:

с помощью аргумента запуска: --docker-memory-swap=0
с помощью переменной окружения: export YUCCA_EXECUTOR_DOCKER_MEMORY_SWAP=0
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[executor.docker]
memory_swap = 0

nano_cpus¶

Квота процессора в единицах. По умолчанию 0.

Значение можно определить одним из способов:

с помощью аргумента запуска: --docker-nano-cpus=0
с помощью переменной окружения: export YUCCA_EXECUTOR_DOCKER_NANO_CPUS=0
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[executor.docker]
nano_cpus = 0

network_driver¶

Сетевой драйвер Docker.

Значение можно определить одним из способов:

с помощью аргумента запуска: --docker-network-driver=bridge
с помощью переменной окружения: export YUCCA_EXECUTOR_DOCKER_NETWORK_DRIVER=bridge
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[executor.docker]
network_driver = "bridge"

oom_kill_disable¶

Не уничтожать процессы в контейнере, если возникает ошибка нехватки памяти (OOM). По умолчанию false.

Значение можно определить одним из способов:

с помощью аргумента запуска: --docker-oom-kill-disable=false
с помощью переменной окружения: export YUCCA_EXECUTOR_DOCKER_OOM_KILL_DISABLE=false
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[executor.docker]
oom_kill_disable = false

oom_score_adjust¶

Настройка показателей OOM. По умолчанию 0.

Значение можно определить одним из способов:

с помощью аргумента запуска: --docker-oom-score-adjust=0
с помощью переменной окружения: export YUCCA_EXECUTOR_DOCKER_OOM_SCORE_ADJUST=0
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[executor.docker]
oom_score_adjust = 0

security_opt¶

Список строковых значений для настройки меток системы MLS, таких как SELinux.

Значение можно определить одним из способов:

с помощью аргумента запуска: --docker-security-opt="label=user:USER"
с помощью переменной окружения: export YUCCA_EXECUTOR_DOCKER_SECURITY_OPT="label=user:USER"
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[executor.docker]
security_opt = "label=user:USER"

quota¶

Доступно только в Enterprise

Глобальные квоты на ресурсы. Может ограничивать максимальное количество определённых ресурсов, которые можно создать/добавить в рамках инсталяции.

global_stream¶

Квота на создание потоков. По умолчанию -1 – без ограничений.

Значение можно определить одним из способов:

с помощью аргумента запуска: --quota-global-stream=-1
с помощью переменной окружения: export YUCCA_QUOTA_GLOBAL_STREAM=-1
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[quota]
global_stream = -1

global_team¶

Квота на создание команд. По умолчанию -1 – без ограничений.

Значение можно определить одним из способов:

с помощью аргумента запуска: --quota-global-team=-1
с помощью переменной окружения: export YUCCA_QUOTA_GLOBAL_TEAM=-1
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[quota]
global_team = -1

global_user¶

Квота на создание пользователей. По умолчанию -1 – без ограничений.

Значение можно определить одним из способов:

с помощью аргумента запуска: --quota-global-user=-1
с помощью переменной окружения: export YUCCA_QUOTA_GLOBAL_USER=-1
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[quota]
global_user = -1

security¶

Параметры безопасности.

brute_force_login_protection¶

Включить защиту от подбора пароля. По умолчанию true.

Значение можно определить одним из способов:

с помощью аргумента запуска: --security-brute-force-login-protection=true
с помощью переменной окружения: export YUCCA_SECURITY_BRUTE_FORCE_LOGIN_PROTECTION=true
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[security]
brute_force_login_protection = true

smtp_server¶

Настройки встроенного SMTP-сервера.

enabled¶

Включить встроенный SMTP-сервер для получения события от камер. По умолчанию true.

Значение можно определить одним из способов:

с помощью аргумента запуска: --smtp-server=true
с помощью переменной окружения: export YUCCA_SMTP_SERVER_ENABLED=true
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[smtp_server]
enabled = true

listen_address¶

Адрес, на котором будет работать SMTP-сервер. По умолчанию 0.0.0.0:1025.

Значение можно определить одним из способов:

с помощью аргумента запуска: --smtp-server-listen-address=0.0.0.0:1025
с помощью переменной окружения: export YUCCA_SMTP_SERVER_LISTEN_ADDRESS=0.0.0.0:1025
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[smtp_server]
listen_address = "0.0.0.0:1025"

password¶

Пароль для подключения к SMTP-серверу.

Значение можно определить одним из способов:

с помощью аргумента запуска: --smtp-server-password=admin
с помощью переменной окружения: export YUCCA_SMTP_SERVER_PASSWORD=admin
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[smtp_server]
password = "admin"

username¶

Логин для подключения к SMTP-серверу.

Значение можно определить одним из способов:

с помощью аргумента запуска: --smtp-server-username=admin
с помощью переменной окружения: export YUCCA_SMTP_SERVER_USERNAME=admin
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[smtp_server]
username = "admin"

read_timeout¶

Таймаут чтения входящего сообщения. По умолчанию 1s.

Значение можно определить одним из способов:

с помощью аргумента запуска: --smtp-server-read-timeout=1s
с помощью переменной окружения: export YUCCA_SMTP_SERVER_READ_TIMEOUT=1s
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[smtp_server]
read_timeout = "1s"

server¶

Глобальные параметры сервера.

data_dir¶

Глобальный каталог для хранения состояния (в случае использования sqlite3) и данных стримов. По умолчанию ./data.

Значение можно определить одним из способов:

с помощью аргумента запуска: --data-dir=/opt/yucca/data/
с помощью переменной окружения: export YUCCA_SERVER_DATA_DIR=/opt/yucca/data/
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[server]
data_dir = "/opt/yucca/data/"

alloc_dir¶

Каталог с данными стримов (видео архив и прочее). По умолчанию ./data/alloc.

Значение можно определить одним из способов:

с помощью аргумента запуска: --alloc-dir=/opt/yucca/data/alloc/
с помощью переменной окружения: export YUCCA_SERVER_ALLOC_DIR=/opt/yucca/data/alloc/
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[server]
alloc_dir = "/opt/yucca/data/alloc/"

state_dir¶

Каталог с файлом базы данных (в случае использования sqlite3). По умолчанию ./data/state.

Значение можно определить одним из способов:

с помощью аргумента запуска: --state-dir=/opt/yucca/data/state/
с помощью переменной окружения: export YUCCA_SERVER_STATE_DIR=/opt/yucca/data/state/
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[server]
state_dir = "/opt/yucca/data/state/"

stats_collection_interval¶

Интервал сборка статистики по ресурсам системы. По умолчанию 1s.

Значение можно определить одним из способов:

с помощью аргумента запуска: --stats-collection-interval=1s
с помощью переменной окружения: export YUCCA_STATS_COLLECTION_INTERVAL=1s
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[server]
stats_collection_interval = "1s"

default_language¶

Язык интерфейса по умолчанию у новых пользователей. Возможные значения: en, ru. По умолчанию en.

Значение можно определить одним из способов:

с помощью аргумента запуска: --default-language=en
с помощью переменной окружения: export YUCCA_SERVER_DEFAULT_LANGUAGE=en
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[server]
default_language = "en"

listen_address¶

IP адрес и порт на котором будет доступен веб интерфейс. По умолчанию 0.0.0.0:9910.

Значение можно определить одним из способов:

с помощью аргумента запуска: --web.listen-address=0.0.0.0:9910
с помощью переменной окружения: export YUCCA_SERVER_LISTEN_ADDRESS=0.0.0.0:9910
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[server]
listen_address = "0.0.0.0:9910"

cert_file¶

Путь к файлу сертификата, в случае использования HTTPS.

Значение можно определить одним из способов:

с помощью аргумента запуска: --cert-file=/opt/yucca/ssl/cert.crt
с помощью переменной окружения: export YUCCA_SERVER_CERT_FILE=/opt/yucca/ssl/cert.crt
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[server]
cert_file = "/opt/yucca/ssl/cert.crt"

cert_key¶

Путь к файлу ключа, в случае использования HTTPS.

Значение можно определить одним из способов:

с помощью аргумента запуска: --cert-key=/opt/yucca/ssl/cert.key
с помощью переменной окружения: export YUCCA_SERVER_CERT_KEY=/opt/yucca/ssl/cert.key
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[server]
cert_key = "/opt/yucca/ssl/cert.key"

pprof¶

Включить профилирование. По умолчанию true.

Значение можно определить одним из способов:

с помощью аргумента запуска: --pprof=true
с помощью переменной окружения: export YUCCA_SERVER_PPROF=true
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[server]
pprof = true

streams¶

Параметры относящиеся к поведению стримов.

archive_download_max_duration¶

Максимальная допустимая длина запрашиваемого отрезка времени для скачивания. По умолчанию 24h.

Значение можно определить одним из способов:

с помощью аргумента запуска: --streams-archive-download-max-duration=24h
с помощью переменной окружения: export YUCCA_STREAMS_ARCHIVE_DOWNLOAD_MAX_DURATION=24h
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[streams]
archive_download_max_duration = "24h"

playlist_max_duration¶

Максимально допустимая длина запрашиваемого отрезка времени для M3U8-плейлиста. По умолчанию 3h.

Значение можно определить одним из способов:

с помощью аргумента запуска: --streams-playlist-max-duration=3h
с помощью переменной окружения: export YUCCA_STREAMS_PLAYLIST_MAX_DURATION=3h
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[streams]
playlist_max_duration = "3h"

ranges_max_duration¶

Максимальная допустимая длина запрашиваемого отрезка времени для рейнджей (диапазон доступности архива). По умолчанию 168h.

Значение можно определить одним из способов:

с помощью аргумента запуска: --streams-ranges-max-duration=168h
с помощью переменной окружения: export YUCCA_STREAMS_RANGES_MAX_DURATION=168h
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[streams]
ranges_max_duration = "168h"

uuid_slug¶

Использовать, в качестве публичного идентификатора потока, сгенерированный UUID. По умолчанию false.

Значение можно определить одним из способов:

с помощью аргумента запуска: --streams-uuid-slug=false
с помощью переменной окружения: export YUCCA_STREAMS_UUID_SLUG=false
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[streams]
uuid_slug = false

telemetry¶

Телеметрия.

enabled¶

Включить предоставление метрик в формате Prometheus. По умолчанию true.

Значение можно определить одним из способов:

с помощью аргумента запуска: --telemetry=true
с помощью переменной окружения: export YUCCA_TELEMETRY_ENABLED=true
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[telemetry]
enabled = true

path¶

URI для доступа к телеметрии. По умолчанию /metrics.

Значение можно определить одним из способов:

с помощью аргумента запуска: --web.telemetry-path=/metrics
с помощью переменной окружения: export YUCCA_TELEMETRY_PATH=/metrics
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[telemetry]
path = "/metrics"

basic_auth_username¶

Логин базовой авторизации для доступа к телеметрии.

Значение можно определить одним из способов:

с помощью аргумента запуска: --telemetry-basic-auth-username=admin
с помощью переменной окружения: export YUCCA_TELEMETRY_BASIC_AUTH_USERNAME=admin
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[telemetry]
basic_auth_username = "admin"

basic_auth_password¶

Пароль базовой авторизации для доступа к телеметрии.

Значение можно определить одним из способов:

с помощью аргумента запуска: --telemetry-basic-auth-password=admin
с помощью переменной окружения: export YUCCA_TELEMETRY_BASIC_AUTH_PASSWORD=admin
с помощью конфигурационного файла:

# /opt/yucca/yucca.toml
[telemetry]
basic_auth_password = "admin"