Перейти до основного вмісту

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

Налаштування може здійснюватися через конфігураційний файл, аргументи командного рядка або змінні оточення.

Пріоритет при читанні конфігурації:
  1. Файл
  2. Змінні оточення
  3. Аргументи командного рядка
порада
  1. Згенерувати конфігураційний файл зі значеннями за замовчуванням:
/opt/yucca/yucca server --show-config --show-config-format=toml
  1. Переглянути всі доступні змінні оточення можна такою командою:
/opt/yucca/yucca server --show-config --show-config-format=env
  1. Переглянути всі доступні аргументи командного рядка можна такою командою:
/opt/yucca/yucca server --help

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

server​

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

log_level​

Доступно с версии:0.9.0

Рівень логування для сервера.
Можливі значення: panic, fatal, error, warning, info, debug

За замовчуванням info

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --log-level=info
  • за допомогою змінної оточення: #!shell export YUCCA_SERVER_LOG_LEVEL=info
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[server]
log_level = "info"

data_dir​

Доступно с версии:0.4.0

Глобальний каталог для зберігання стану (у разі використання sqlite3) і даних потоків.

За замовчуванням ./data

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --data-dir=/opt/yucca/data/
  • за допомогою змінної оточення: #!shell export YUCCA_SERVER_DATA_DIR=/opt/yucca/data/
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[server]
data_dir = "/opt/yucca/data/"

alloc_dir​

Доступно с версии:0.4.0

Каталог з даними потоків (відеоархів та інше).

За замовчуванням <data_dir>/alloc

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --alloc-dir=/opt/yucca/data/alloc/
  • за допомогою змінної оточення: #!shell export YUCCA_SERVER_ALLOC_DIR=/opt/yucca/data/alloc/
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[server]
alloc_dir = "/opt/yucca/data/alloc/"

state_dir​

Доступно с версии:0.4.0

Каталог з файлом бази даних (у разі використання sqlite3).

За замовчуванням <data_dir>/server

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --state-dir=/opt/yucca/data/server/
  • за допомогою змінної оточення: #!shell export YUCCA_SERVER_STATE_DIR=/opt/yucca/data/server/
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[server]
state_dir = "/opt/yucca/data/server/"

temp_dir​

Доступно с версии:0.9.0

Каталог tmpfs для даних з коротким терміном зберігання. (тут зберігаються чанки, що ротуються для живого потоку)

За замовчуванням /dev/shm/yucca

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --temp-dir=/dev/shm/yucca
  • за допомогою змінної оточення: #!shell export YUCCA_SERVER_TEMP_DIR=/dev/shm/yucca
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[server]
temp_dir = "/dev/shm/yucca"

alloc_dir_warning_threshold​

Доступно с версии:0.9.0

Пороговий відсоток для попередження про використання диска.
В інтерфейсі сервера всім адміністраторам буде показуватися попередження, якщо налаштовано SMTP-клієнт, всі адміністратори також отримають сповіщення по E-mail про те, що закінчується вільний простір на диску.

За замовчуванням 80

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --alloc-dir-warning-threshold=80
  • за допомогою змінної оточення: #!shell export YUCCA_SERVER_ALLOC_DIR_WARNING_THRESHOLD=80
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[server]
alloc_dir_warning_threshold = "80"

stats_collection_interval​

Доступно с версии:0.8.0

Інтервал збору статистики по ресурсах системи.

За замовчуванням 1s

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --stats-collection-interval=1s
  • за допомогою змінної оточення: #!shell export YUCCA_SERVER_STATS_COLLECTION_INTERVAL=1s
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[server]
stats_collection_interval = "1s"

default_language​

Доступно с версии:0.9.0

Мова інтерфейсу за замовчуванням у нових користувачів, також вона буде використана на сторінці входу.
Можливі значення: en, ru, uk, es, pt, tr

За замовчуванням en

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --default-language=en
  • за допомогою змінної оточення: #!shell export YUCCA_SERVER_DEFAULT_LANGUAGE=en
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[server]
default_language = "en"

domain​

Доступно с версии:0.9.0

Використовується для визначення поля Server під час налаштування отримання подій по Email

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --domain=demo.yucca.app
  • за допомогою змінної оточення: #!shell export YUCCA_SERVER_DOMAIN=192.168.188.15
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[server]
domain = "demo.yucca.app"

health_check_interval​

Доступно с версии:0.9.0

Інтервал для перевірки працездатності залежностей.

За замовчуванням "30s"

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --health-check-interval="30s"
  • за допомогою змінної оточення: #!shell export YUCCA_SERVER_HEALTH_CHECK_INTERVAL="30s"
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[server]
health_check_interval = "30s"

listen_address​

Доступно с версии:0.4.0

IP адреса і порт, на якому буде доступний веб інтерфейс.

За замовчуванням :9910

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --web.listen-address=:9910
  • за допомогою змінної оточення: #!shell export YUCCA_SERVER_LISTEN_ADDRESS=:9910
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[server]
listen_address = ":9910"

log_file​

Доступно с версии:0.9.0

Шлях до файлу з логами, якщо не вказано, то stdout.

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --log-file=/var/log/yucca.log
  • за допомогою змінної оточення: #!shell export YUCCA_SERVER_LOG_FILE=/var/log/yucca.log
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[server]
log_file = "/var/log/yucca.log"

self_logs​

Доступно с версии:0.9.0

Перегляд логів сервера і потоків в інтерфейсі у вкладці відладка.

За замовчуванням true

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --self-logs=true
  • за допомогою змінної оточення: #!shell export YUCCA_SERVER_SELF_LOGS=false
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[server]
self_logs = true

log_buffer_size​

Доступно с версии:0.9.0

Кількість останніх повідомлень в інтерфейсі у вкладці відладка.

За замовчуванням 50

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --log-buffer-size=50
  • за допомогою змінної оточення: #!shell export YUCCA_SERVER_LOG_BUFFER_SIZE=50
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[server]
log_buffer_size = 50

cert_file​

Доступно с версии:0.4.0

Шлях до файлу сертифіката, у разі використання HTTPS.

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --cert-file=/opt/yucca/ssl/cert.crt
  • за допомогою змінної оточення: #!shell export YUCCA_SERVER_CERT_FILE=/opt/yucca/ssl/cert.crt
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[server]
cert_file = "/opt/yucca/ssl/cert.crt"

cert_key​

Доступно с версии:0.4.0

Шлях до файлу ключа, у разі використання HTTPS.

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --cert-key=/opt/yucca/ssl/cert.key
  • за допомогою змінної оточення: #!shell export YUCCA_SERVER_CERT_KEY=/opt/yucca/ssl/cert.key
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[server]
cert_key = "/opt/yucca/ssl/cert.key"

pprof​

Доступно с версии:0.8.0

Увімкнути профілювання.

За замовчуванням false

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --pprof=true
  • за допомогою змінної оточення: #!shell export YUCCA_SERVER_PPROF=true
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[server]
pprof = true

pprof_listen_address​

Доступно с версии:0.8.0

IP адреса і порт, на якому буде доступний pprof профілювальник.

За замовчуванням :9911

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --pprof-listen-address=":9911"
  • за допомогою змінної оточення: #!shell export YUCCA_SERVER_PPROF_LISTEN_ADDRESS=":9911"
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[server]
pprof_listen_address = ":9911"

validate​

Доступно с версии:0.9.0

Прапорець для перевірки коректності конфігурації.

примітка

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --validate

Приклад використання

./yucca server --config /opt/yucca/yucca.toml --validate
Valid configuration

database​

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

type​

Доступно с версии:0.4.0

Підтримується 2 типи баз даних для зберігання стану – sqlite3 і postgres. У невеликих інсталяціях достатньо sqlite3, при великій кількості потоків ми рекомендуємо використовувати postgres.

За замовчуванням sqlite3

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --database-type=sqlite3
  • за допомогою змінної оточення: #!shell export YUCCA_DATABASE_TYPE=sqlite3
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[database]
type = "sqlite3"

path​

Доступно с версии:0.4.0

Шлях до файлу бази (тільки для sqlite3).

За замовчуванням <state_dir>/state.db

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --database-path=/opt/yucca/server/state.db
  • за допомогою змінної оточення: #!shell export YUCCA_DATABASE_PATH=/opt/yucca/server/state.db
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[database]
path = "/opt/yucca/server/state.db"

host​

Доступно с версии:0.4.0

Адреса підключення до бази (тільки для postgres).

За замовчуванням 127.0.0.1:5432

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --database-host=127.0.0.1:5432
  • за допомогою змінної оточення: #!shell export YUCCA_DATABASE_HOST=127.0.0.1:5432
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[database]
host = "127.0.0.1:5432"

name​

Доступно с версии:0.4.0

Назва бази даних (тільки для postgres).

За замовчуванням yucca

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --database-name=yucca
  • за допомогою змінної оточення: #!shell export YUCCA_DATABASE_NAME=yucca
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[database]
name = "yucca"

user​

Доступно с версии:0.4.0

Ім'я користувача для підключення (тільки для postgres).

За замовчуванням postgres

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --database-user=postgres
  • за допомогою змінної оточення: #!shell export YUCCA_DATABASE_USER=postgres
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[database]
user = "postgres"

password​

Доступно с версии:0.4.0

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

За замовчуванням postgres

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --database-password=postgres
  • за допомогою змінної оточення: #!shell export YUCCA_DATABASE_PASSWORD=postgres
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[database]
password = "postgres"

ssl_mode​

Доступно с версии:0.4.0

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

За замовчуванням disable

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --database-ssl-mode=disable
  • за допомогою змінної оточення: #!shell export YUCCA_DATABASE_SSL_MODE=disable
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[database]
ssl_mode = "disable"

busy_timeout​

Доступно с версии:0.4.0

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

За замовчуванням 500

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --database-busy-timeout=500
  • за допомогою змінної оточення: #!shell export YUCCA_DATABASE_BUSY_TIMEOUT=500
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[database]
busy_timeout = 500

ca_cert_path​

Доступно с версии:0.4.0

Шлях до сертифіката центру сертифікації (CA) у разі використання SSL (тільки для postgres).

За замовчуванням /etc/ssl/certs

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --database-ca-cert-path=/etc/ssl/certs
  • за допомогою змінної оточення: #!shell export YUCCA_DATABASE_CA_CERT_PATH=/etc/ssl/certs
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[database]
ca_cert_path = "/etc/ssl/certs"

client_cert_path​

Доступно с версии:0.4.0

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

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --database-client-cert-path=/opt/yucca/ssl/cert.crt
  • за допомогою змінної оточення: #!shell 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​

Доступно с версии:0.4.0

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

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --database-client-key-path=/opt/yucca/ssl/cert.key
  • за допомогою змінної оточення: #!shell 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​

Доступно с версии:0.4.0

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

За замовчуванням shared

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --database-cache-mode=shared
  • за допомогою змінної оточення: #!shell export YUCCA_DATABASE_CACHE_MODE=shared
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[database]
cache_mode = "shared"

conn_max_lifetime​

Доступно с версии:0.4.0

Встановлює максимальний час, протягом якого з'єднання може бути повторно використане.

За замовчуванням 0s

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --database-conn-max-lifetime=0s
  • за допомогою змінної оточення: #!shell export YUCCA_DATABASE_CONN_MAX_LIFETIME=0s
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[database]
conn_max_lifetime = "0s"

log_queries​

Доступно с версии:0.4.0

Логувати SQL-запити і час виконання.

За замовчуванням false

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --database-log-queries=false
  • за допомогою змінної оточення: #!shell export YUCCA_DATABASE_LOG_QUERIES=false
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[database]
log_queries = false

max_open_conn​

Доступно с версии:0.4.0

Максимальна кількість відкритих з'єднань з базою даних (тільки для postgres).

За замовчуванням 0

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --database-max-open-conn=0
  • за допомогою змінної оточення: #!shell export YUCCA_DATABASE_MAX_OPEN_CONN=0
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[database]
max_open_conn = 0

max_idle_conn​

Доступно с версии:0.4.0

Максимальна кількість з'єднань в очікуванні (тільки для postgres).

За замовчуванням 2

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --database-max-idle-conn=2
  • за допомогою змінної оточення: #!shell export YUCCA_DATABASE_MAX_IDLE_CONN=2
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[database]
max_idle_conn = 2

streams​

Параметри, що стосуються поведінки потоків.

archive_download_max_duration​

Доступно с версии:0.9.0

Максимальна допустима довжина запитуваного відрізка часу для завантаження.

За замовчуванням 24h

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --streams-archive-download-max-duration=24h
  • за допомогою змінної оточення: #!shell export YUCCA_STREAMS_ARCHIVE_DOWNLOAD_MAX_DURATION=24h
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[streams]
archive_download_max_duration = "24h"

archive_download_request_lifetime​

Доступно с версии:0.9.0

Час життя запитаного для завантаження відрізка.

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

За замовчуванням 1h0m0s

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --streams-archive-download-request-lifetime=6h
  • за допомогою змінної оточення: #!shell export YUCCA_STREAMS_ARCHIVE_DOWNLOAD_REQUEST_LIFETIME=1h0m0s
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[streams]
archive_download_request_lifetime = "1h0m0s"

archive_max_depth_hours​

Доступно с версии:0.9.0

Максимальна допустима глибина для зберігання архіву в годинах.

За замовчуванням не обмежено -1

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --streams-archive-max-depth-hours=-1
  • за допомогою змінної оточення: #!shell export YUCCA_STREAMS_ARCHIVE_MAX_DEPTH_HOURS=-1
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[streams]
archive_max_depth_hours = -1

live_on_demand_lease_duration​

Доступно с версии:0.9.0

Час життя оренди для живого потоку за запитом (live on-demand).

Час, протягом якого запитаний live on-demand потік буде працювати після останнього продовження оренди, тобто час життя оренди після останнього її продовження. Оренда продовжується при запиті статусу потоку на сторінці його перегляду. Чим менше число, тим швидше потік перейде в стан паузи після закриття сторінки перегляду.

За замовчуванням 1m0s

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --streams-live-on-demand-lease-duration=1m0s
  • за допомогою змінної оточення: #!shell export YUCCA_STREAMS_LIVE_ON_DEMAND_LEASE_DURATION=1m0s
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[streams]
live_on_demand_lease_duration = 1m0s

live_on_demand_lease_interval​

Доступно с версии:0.9.0

Частота перевірки активної оренди для живого потоку за запитом (live on-demand). Параметр повинен бути меншим, ніж live_on_demand_lease_duration.

За замовчуванням 30s

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --streams-live-on-demand-lease-interval=30s
  • за допомогою змінної оточення: #!shell export YUCCA_STREAMS_LIVE_ON_DEMAND_LEASE_INTERVAL=30s
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[streams]
live_on_demand_lease_interval = 30s

playlist_max_duration​

Доступно с версии:0.9.0

Максимально допустима довжина запитуваного відрізка часу для M3U8-плейлиста.

За замовчуванням 3h

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --streams-playlist-max-duration=3h
  • за допомогою змінної оточення: #!shell export YUCCA_STREAMS_PLAYLIST_MAX_DURATION=3h
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[streams]
playlist_max_duration = "3h"

ranges_max_duration​

Доступно с версии:0.9.0

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

За замовчуванням 168h

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --streams-ranges-max-duration=168h
  • за допомогою змінної оточення: #!shell export YUCCA_STREAMS_RANGES_MAX_DURATION=168h
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[streams]
ranges_max_duration = "168h"

uuid_slug​

Доступно с версии:0.9.0

Використовувати, як публічний ідентифікатор потоку, згенерований UUID.

За замовчуванням false

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --streams-uuid-slug=false
  • за допомогою змінної оточення: #!shell export YUCCA_STREAMS_UUID_SLUG=false
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[streams]
uuid_slug = false

executor​

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

type​

Доступно с версии:0.8.0

Тип виконавця для паркування потоків. Доступні значення exec, docker.

  • Exec - сервер запускає ffmpeg і стежить за його роботою безпосередньо сам, без використання docker і yucca-worker.
  • Docker - (застарів і буде видалений у майбутньому) на кожен потік сервер запускає docker контейнер, в якому працює yucca-worker, який у свою чергу запускає ffmpeg і стежить за його роботою, у разі проблем перезапускає.
За замовчуванням exec

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --executor=exec
  • за допомогою змінної оточення: #!shell export YUCCA_EXECUTOR_TYPE=docker
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[executor]
type = "exec"

log_level​

Доступно с версии:0.8.0

Рівень логування executor. Можливі значення: panic, fatal, error, warning, info, debug).

За замовчуванням info

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --executor-log-level=info
  • за допомогою змінної оточення: #!shell export YUCCA_EXECUTOR_LOG_LEVEL=info
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[executor]
log_level = "info"

executor.exec​

Доступно с версии:0.8.0

Додаткові параметри для типу exec.

cancel_grace_period​

Доступно с версии:0.8.0

Інтервал очікування завершення всіх запущених підпроцесів (ffmpeg, ffprobe, ...).

За замовчуванням 5s

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --exec-cancel-grace-period=5s
  • за допомогою змінної оточення: #!shell export YUCCA_EXECUTOR_EXEC_CANCEL_GRACE_PERIOD=5s
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[executor.exec]
cancel_grace_period = "5s"

ffmpeg_log_level​

Доступно с версии:0.8.0

Рівень логування для процесів ffmpeg.

За замовчуванням error

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --exec-ffmpeg-log-level="error"
  • за допомогою змінної оточення: #!shell export YUCCA_EXECUTOR_EXEC_FFMPEG_LOG_LEVEL="error"
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[executor.exec]
ffmpeg_log_level = "error"

ffmpeg_log_max_file​

Доступно с версии:0.8.0

Максимальна кількість файлів журналу, які можуть бути присутніми.

За замовчуванням 5

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --exec-ffmpeg-log-max-file=5
  • за допомогою змінної оточення: #!shell export YUCCA_EXECUTOR_EXEC_FFMPEG_LOG_MAX_FILE=5
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[executor.exec]
ffmpeg_log_max_file = 5

ffmpeg_log_max_size​

Доступно с версии:0.8.0

Максимальний розмір файлу журналу перед його ротацією і стисненням.

За замовчуванням "20mb"

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --exec-ffmpeg-log-max-size"20mb"
  • за допомогою змінної оточення: #!shell export YUCCA_EXECUTOR_EXEC_FFMPEG_LOG_MAX_SIZE"20mb"
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[executor.exec]
ffmpeg_log_max_size ="20mb"

hls_list_size​

Доступно с версии:0.8.0

Довжина m3u8 HLS плейлиста.

За замовчуванням 5

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --exec-hls-list-size=5
  • за допомогою змінної оточення: #!shell export YUCCA_EXECUTOR_EXEC_HLS_LIST_SIZE=5
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[executor.exec]
hls_list_size = 5

hls_time​

Доступно с версии:0.8.0

Бажана довжина сегмента відео HLS сегментів у секундах.

За замовчуванням 2

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --exec-hls-time=2
  • за допомогою змінної оточення: #!shell export YUCCA_EXECUTOR_EXEC_HLS_TIME=5
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[executor.exec]
hls_time = 5

preview​

Доступно с версии:0.8.0

Увімкнення створення прев'ю зображень у фоні.

За замовчуванням true

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --exec-preview=true
  • за допомогою змінної оточення: #!shell export YUCCA_EXECUTOR_EXEC_PREVIEW=false
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[executor.exec]
preview = true

preview_interval​

Доступно с версии:0.8.0

Інтервал створення прев'ю зображень.

За замовчуванням 5s

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --exec-preview-interval=5s
  • за допомогою змінної оточення: #!shell export YUCCA_EXECUTOR_EXEC_PREVIEW_INTERVAL=5s
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[executor.exec]
preview_interval = "5s"

probe_interval​

Доступно с версии:0.8.0

Інтервал, з якого потік починає перевірятися на доступність, інтервал поступово зростає (щоб уникнути проблеми, коли часті перевірки призводять до зависання IP камери) до значення, заданого в probe_interval_maximum, при цьому кількість спроб не повинна перевищувати значення probe_retries, інакше потік перейде в статус Failed.

За замовчуванням 5s

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --exec-probe-interval="5s"
  • за допомогою змінної оточення: #!shell export YUCCA_EXECUTOR_EXEC_PROBE_INTERVAL="5s"
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[executor.exec]
probe_interval = "5s"

probe_interval_maximum​

Доступно с версии:0.8.0

Дивись опис probe_interval.

За замовчуванням 1m0s

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --exec-probe-interval-maximum="1m0s"
  • за допомогою змінної оточення: #!shell export YUCCA_EXECUTOR_EXEC_PROBE_INTERVAL_MAXIMUM="1m0s"
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[executor.exec]
probe_interval_maximum = "1m0s"

probe_retries​

Доступно с версии:0.8.0

Дивись опис probe_interval.

За замовчуванням 5

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --exec-probe-retries=5
  • за допомогою змінної оточення: #!shell export YUCCA_EXECUTOR_EXEC_PROBE_RETRIES=5
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[executor.exec]
probe_retries = 5

probe_timeout​

Доступно с версии:0.8.0

Таймаут отримання інформації по джерелу.

За замовчуванням 5

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --exec-probe-timeout="1m0s"
  • за допомогою змінної оточення: #!shell export YUCCA_EXECUTOR_EXEC_PROBE_TIMEOUT="1m0s"
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[executor.exec]
probe_timeout = "1m0s"

smtp_client​

Налаштування вбудованого SMTP-клієнта. Відповідає за розсилку сповіщень користувачам поштою, наприклад про те, що скоро закінчується ліцензія.

enabled​

Доступно с версии:0.8.0

Увімкнути SMTP-клієнт для відправки електронних листів.

За замовчуванням false

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --smtp-client=true
  • за допомогою змінної оточення: #!shell export YUCCA_SMTP_CLIENT_ENABLED=true
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[smtp_client]
enabled = true

host​

Доступно с версии:0.8.0

Адреса SMTP сервера.

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --smtp-client-host="smtp.gmail.com:465"
  • за допомогою змінної оточення: #!shell export YUCCA_SMTP_CLIENT_HOST="smtp.yandex.ru:465"
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[smtp_client]
host = ""

user​

Доступно с версии:0.8.0

Користувач для авторизації на SMTP сервері.

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --smtp-client-user=""
  • за допомогою змінної оточення: #!shell export YUCCA_SMTP_CLIENT_USER=""
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[smtp_client]
user = ""

password​

Доступно с версии:0.8.0

Пароль для авторизації на SMTP сервері.

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --smtp-client-password=""
  • за допомогою змінної оточення: #!shell export YUCCA_SMTP_CLIENT_PASSWORD=""
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[smtp_client]
password = ""

from_address​

Доступно с версии:0.8.0

Адреса, яка використовується при відправці електронних листів.

За замовчуванням "admin@yucca.localhost"

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --smtp-client-from-address="admin@yucca.localhost"
  • за допомогою змінної оточення: #!shell export YUCCA_SMTP_CLIENT_FROM_ADDRESS="admin@yucca.localhost"
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[smtp_client]
from_address = "admin@yucca.localhost"

from_name​

Доступно с версии:0.8.0

Ім'я, яке використовується при відправці електронних листів.

За замовчуванням "Yucca"

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --smtp-client-from-name="Yucca"
  • за допомогою змінної оточення: #!shell export YUCCA_SMTP_CLIENT_FROM_NAME="Yucca"
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[smtp_client]
from_name = "Yucca"

cert_path​

Доступно с версии:0.8.0

Шлях до файлу з сертифікатом.

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --smtp-client-cert-path=""
  • за допомогою змінної оточення: #!shell export YUCCA_SMTP_CLIENT_CERT_PATH=""
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[smtp_client]
cert_path = ""

key_path​

Доступно с версии:0.8.0

Шлях до файлу з ключем.

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --smtp-client-key-path=""
  • за допомогою змінної оточення: #!shell export YUCCA_SMTP_CLIENT_KEY_PATH=""
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[smtp_client]
key_path = ""

skip_verify​

Доступно с версии:0.8.0

Перевіряти SSL сертифікат SMTP сервера.

За замовчуванням false

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --smtp-client-skip-verify=""
  • за допомогою змінної оточення: #!shell export YUCCA_SMTP_CLIENT_SKIP_VERIFY=""
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[smtp_client]
skip_verify = ""

smtp_server​

Налаштування вбудованого SMTP-сервера для прийому сповіщень про рух від камер.

enabled​

Доступно с версии:0.8.0

Увімкнути вбудований SMTP-сервер для отримання подій від камер.

За замовчуванням true

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --smtp-server=true
  • за допомогою змінної оточення: #!shell export YUCCA_SMTP_SERVER_ENABLED=true
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[smtp_server]
enabled = true

listen_address​

Доступно с версии:0.8.0

Адреса, на якій буде працювати SMTP-сервер.

За замовчуванням :1025

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --smtp-server-listen-address=:1025
  • за допомогою змінної оточення: #!shell export YUCCA_SMTP_SERVER_LISTEN_ADDRESS=:1025
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[smtp_server]
listen_address = ":1025"

password​

Доступно с версии:0.8.0

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

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --smtp-server-password=admin
  • за допомогою змінної оточення: #!shell export YUCCA_SMTP_SERVER_PASSWORD=admin
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[smtp_server]
password = "admin"

username​

Доступно с версии:0.8.0

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

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --smtp-server-username=admin
  • за допомогою змінної оточення: #!shell export YUCCA_SMTP_SERVER_USERNAME=admin
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[smtp_server]
username = "admin"

read_timeout​

Доступно с версии:0.8.0

Таймаут читання вхідного повідомлення.

За замовчуванням 1s

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --smtp-server-read-timeout=1s
  • за допомогою змінної оточення: #!shell export YUCCA_SMTP_SERVER_READ_TIMEOUT=1s
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[smtp_server]
read_timeout = "1s"

event_window_duration​

Доступно с версии:0.9.0

Довжина нової події детекції руху.

За замовчуванням 40s

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --smtp-server-event-window-duration=40s
  • за допомогою змінної оточення: #!shell export YUCCA_SMTP_SERVER_EVENT_WINDOW_DURATION=40s
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[smtp_server]
event_window_duration = "40s"

security​

Параметри безпеки.

audit_logs 💰​

Доступно с версии:0.10.0 💰 Платний функціонал, доступно за підпискоюEnterprise

Увімкнути журнали аудиту.

За замовчуванням false

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --security-audit-logs=false
  • за допомогою змінної оточення: #!shell export YUCCA_SECURITY_AUDIT_LOGS=false
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[security]
audit_logs = false

brute_force_login_protection​

Доступно с версии:0.9.0

Увімкнути захист від підбору пароля.

За замовчуванням true

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --security-brute-force-login-protection=true
  • за допомогою змінної оточення: #!shell export YUCCA_SECURITY_BRUTE_FORCE_LOGIN_PROTECTION=true
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[security]
brute_force_login_protection = true

security_password_length​

Доступно с версии:0.9.0

Мінімальна допустима довжина пароля.

За замовчуванням 3

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --security-password-length=3
  • за допомогою змінної оточення: #!shell export YUCCA_SECURITY_PASSWORD_LENGTH=3
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[security]
password_length = 3

telemetry​

Телеметрія. Сервер Yucca віддає метрики у форматі prometheus, що дозволяє наприклад стежити за доступністю камер зовнішньою системою моніторингу. Ось тут ви знайдете приклад з налаштуванням.

enabled​

Доступно с версии:0.7.0

Увімкнути надання метрик у форматі Prometheus.

За замовчуванням true

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --telemetry=true
  • за допомогою змінної оточення: #!shell export YUCCA_TELEMETRY_ENABLED=true
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[telemetry]
enabled = true

listen_address​

Доступно с версии:0.7.0

IP адреса і порт, на якому буде доступна телеметрія.

За замовчуванням :9912

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --telemetry-listen-address=:9912
  • за допомогою змінної оточення: #!shell export YUCCA_TELEMETRY_LISTEN_ADDRESS=:9912
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[telemetry]
listen_address = ":9912"

path​

Доступно с версии:0.7.0

URI для доступу до телеметрії.

За замовчуванням /metrics

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --telemetry-path=/metrics
  • за допомогою змінної оточення: #!shell export YUCCA_TELEMETRY_PATH=/metrics
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[telemetry]
path = "/metrics"

basic_auth_username​

Доступно с версии:0.7.0

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

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --telemetry-basic-auth-username=admin
  • за допомогою змінної оточення: #!shell export YUCCA_TELEMETRY_BASIC_AUTH_USERNAME=admin
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[telemetry]
basic_auth_username = "admin"

basic_auth_password​

Доступно с версии:0.7.0

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

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --telemetry-basic-auth-password=admin
  • за допомогою змінної оточення: #!shell export YUCCA_TELEMETRY_BASIC_AUTH_PASSWORD=admin
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[telemetry]
basic_auth_password = "admin"

environment_info​

Доступно с версии:0.7.0

Лейбли для метрики yucca_environment_info.

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --telemetry-environment-info=env:test
  • за допомогою змінної оточення: #!shell export YUCCA_TELEMETRY_ENVIRONMENT_INFO=env:test
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[telemetry.environment_info]
env = "test"

analytics​

Збір аналітики з інтерфейсу сервера за допомогою Yandex.Metrika.

yandex_metrika_counter_id​

Доступно с версии:0.10.0

Yandex.Metrika Counter ID. Увімкнено, якщо визначено.

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --analytics-yandex-metrika-counter-id=12345678
  • за допомогою змінної оточення: #!shell export YUCCA_ANALYTICS_YANDEX_METRIKA_COUNTER_ID=12345678
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[analytics]
yandex_metrika_counter_id = 12345678

yandex_metrika_webvisor​

Доступно с версии:0.10.0

Вмикає вебвізор, детальні записи активності користувачів на сайті: рух миші, прокручування і кліки.

За замовчуванням false

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --analytics-yandex-metrika-webvisor=true
  • за допомогою змінної оточення: #!shell export YUCCA_ANALYTICS_YANDEX_METRIKA_WEBVISOR=true
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[analytics]
yandex_metrika_webvisor = true

quota 💰​

💰 Платний функціонал, доступно за підпискоюEnterprise або Plus

Глобальні квоти на ресурси. Може обмежувати максимальну кількість певних ресурсів, які можна створити/додати в рамках сервера.

global_stream​

Доступно с версии:0.8.0 💰 Платний функціонал, доступно за підпискоюEnterprise

Квота на створення потоків.

За замовчуванням без обмежень -1

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --quota-global-stream=-1
  • за допомогою змінної оточення: #!shell export YUCCA_QUOTA_GLOBAL_STREAM=-1
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[quota]
global_stream = -1

global_team​

Доступно с версии:0.8.0 💰 Платний функціонал, доступно за підпискоюEnterprise

Квота на створення команд.

За замовчуванням без обмежень -1

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --quota-global-team=-1
  • за допомогою змінної оточення: #!shell export YUCCA_QUOTA_GLOBAL_TEAM=-1
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[quota]
global_team = -1

global_user​

Доступно с версии:0.8.0 💰 Платний функціонал, доступно за підпискоюEnterprise

Квота на створення користувачів.

За замовчуванням без обмежень -1

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --quota-global-user=-1
  • за допомогою змінної оточення: #!shell export YUCCA_QUOTA_GLOBAL_USER=-1
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[quota]
global_user = -1

team_user​

Доступно с версии:0.8.0 💰 Платний функціонал, доступно за підпискоюEnterprise

Квота на максимальну кількість користувачів у команді.

За замовчуванням без обмежень -1

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --quota-team-user=-1
  • за допомогою змінної оточення: #!shell export YUCCA_QUOTA_TEAM_USER=-1
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[quota]
team_user = -1

branding 💰​

💰 Платний функціонал, доступно за підпискоюEnterprise

Брендування інтерфейсу.

Доступно с версии:0.10.0 💰 Платний функціонал, доступно за підпискоюEnterprise

Шлях до файлу з логотипом. Можна вказувати http(s) URL http:// або шлях у файловій системі file://.

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --branding-app-logo=https://example.com/logo.png
  • за допомогою змінної оточення: #!shell export YUCCA_BRANDING_APP_LOGO=file:///opt/yucca/logo.png
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[branding]
app_logo = "file:///opt/yucca/logo.png"

app_title​

Доступно с версии:0.10.0 💰 Платний функціонал, доступно за підпискоюEnterprise

Текст у полі Title.

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --branding-app-title=Yucca
  • за допомогою змінної оточення: #!shell export YUCCA_BRANDING_APP_TITLE=Yucca
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[branding]
app_title = "Yucca"

site​

Доступно с версии:0.10.0 💰 Платний функціонал, доступно за підпискоюEnterprise

Посилання на ваш сайт.

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --branding-site=https://yucca.app
  • за допомогою змінної оточення: #!shell export YUCCA_BRANDING_SITE=https://yucca.app
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[branding]
site = "https://yucca.app"

documentation​

Доступно с версии:0.10.0 💰 Платний функціонал, доступно за підпискоюEnterprise

Посилання на сторінку з документацією.

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --branding-documentation=https://docs.yucca.app
  • за допомогою змінної оточення: #!shell export YUCCA_BRANDING_DOCUMENTATION=https://docs.yucca.app
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[branding]
documentation = "https://docs.yucca.app"

fav_icon​

Доступно с версии:0.10.0 💰 Платний функціонал, доступно за підпискоюEnterprise

Шлях до файлу Favicon. Можна вказувати http(s) URL http:// або шлях у файловій системі file://.

За замовчуванням не визначено ""

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --branding-fav-icon=https://example.com/favicon.ico
  • за допомогою змінної оточення: #!shell export YUCCA_BRANDING_FAV_ICON=https://example.com/favicon.ico
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[branding]
fav_icon = "file:///opt/yucca/favicon.ico"

cluster 💰​

💰 Платний функціонал, доступно за підпискоюEnterprise

Параметри, що стосуються налаштування кластера (розподілений режим).

cluster_enabled​

Доступно с версии:0.10.0 💰 Платний функціонал, доступно за підпискоюEnterprise

Увімкнути режим кластера.

За замовчуванням false

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --cluster=true
  • за допомогою змінної оточення: #!shell export YUCCA_CLUSTER_ENABLED=true
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[cluster]
enabled = true

cluster_advertise_address​

Доступно с версии:0.10.0 💰 Платний функціонал, доступно за підпискоюEnterprise

Адреса для оголошення іншим учасникам кластера.

За замовчуванням 127.0.0.1:9940

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --cluster-advertise-address="127.0.0.1:9940"
  • за допомогою змінної оточення: #!shell export YUCCA_CLUSTER_LISTEN_ADDRESS=24h
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[cluster]
advertise_address = "127.0.0.1:9940"

cluster_listen_address​

Доступно с версии:0.10.0 💰 Платний функціонал, доступно за підпискоюEnterprise

Адреса для підключення учасників кластера.

За замовчуванням 0.0.0.0:9940

Значення можна визначити одним зі способів:

  • за допомогою аргументу запуску: --cluster-listen-address="0.0.0.0:9940"
  • за допомогою змінної оточення: #!shell export YUCCA_CLUSTER_LISTEN_ADDRESS="0.0.0.0:9940"
  • за допомогою конфігураційного файлу:
# /opt/yucca/yucca.toml
[cluster]
listen_address = "0.0.0.0:9940"