Configuración
La configuración se puede realizar mediante un archivo de configuración, argumentos de línea de comandos o variables de entorno.
- Archivo
- Variables de entorno
- Argumentos de línea de comandos
- Generar un archivo de configuración con los valores por defecto:
- TOML
- YAML
/opt/yucca/yucca server --show-config --show-config-format=toml
/opt/yucca/yucca server --show-config --show-config-format=yaml
- Puede ver todas las variables de entorno disponibles con el siguiente comando:
/opt/yucca/yucca server --show-config --show-config-format=env
- Puede ver todos los argumentos de línea de comandos disponibles con el siguiente comando:
/opt/yucca/yucca server --help
Los parámetros se dividen en secciones lógicas (bloques) que corresponden al prefijo en los argumentos de línea de comandos y las variables de entorno.
server
Parámetros globales del servidor.
log_level
Nivel de registro del servidor.
Valores posibles: panic, fatal, error, warning, info, debug
infoEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--log-level=info - mediante una variable de entorno:
#!shell export YUCCA_SERVER_LOG_LEVEL=info - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[server]
log_level = "info"
data_dir
Directorio global para almacenar el estado (en caso de usar sqlite3) y los datos de los flujos.
./dataEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--data-dir=/opt/yucca/data/ - mediante una variable de entorno:
#!shell export YUCCA_SERVER_DATA_DIR=/opt/yucca/data/ - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[server]
data_dir = "/opt/yucca/data/"
alloc_dir
Directorio con los datos de los flujos (archivo de vídeo y otros).
<data_dir>/allocEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--alloc-dir=/opt/yucca/data/alloc/ - mediante una variable de entorno:
#!shell export YUCCA_SERVER_ALLOC_DIR=/opt/yucca/data/alloc/ - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[server]
alloc_dir = "/opt/yucca/data/alloc/"
state_dir
Directorio con el archivo de la base de datos (en caso de usar sqlite3).
<data_dir>/serverEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--state-dir=/opt/yucca/data/server/ - mediante una variable de entorno:
#!shell export YUCCA_SERVER_STATE_DIR=/opt/yucca/data/server/ - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[server]
state_dir = "/opt/yucca/data/server/"
temp_dir
Directorio tmpfs para datos de corta duración. (aquí se almacenan los fragmentos rotados del flujo en vivo)
/dev/shm/yuccaEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--temp-dir=/dev/shm/yucca - mediante una variable de entorno:
#!shell export YUCCA_SERVER_TEMP_DIR=/dev/shm/yucca - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[server]
temp_dir = "/dev/shm/yucca"
alloc_dir_warning_threshold
Porcentaje umbral para la advertencia de uso de disco.
En la interfaz del servidor se mostrará una advertencia a todos los administradores; si el cliente SMTP está configurado, todos los administradores también recibirán una notificación por E-mail indicando que el espacio libre en disco se está agotando.
80El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--alloc-dir-warning-threshold=80 - mediante una variable de entorno:
#!shell export YUCCA_SERVER_ALLOC_DIR_WARNING_THRESHOLD=80 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[server]
alloc_dir_warning_threshold = "80"
stats_collection_interval
Intervalo de recopilación de estadísticas de los recursos del sistema.
1sEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--stats-collection-interval=1s - mediante una variable de entorno:
#!shell export YUCCA_SERVER_STATS_COLLECTION_INTERVAL=1s - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[server]
stats_collection_interval = "1s"
default_language
Idioma de interfaz predeterminado para los nuevos usuarios; también se usará en la página de inicio de sesión.
Valores posibles: en, ru, uk, es, pt, tr
enEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--default-language=en - mediante una variable de entorno:
#!shell export YUCCA_SERVER_DEFAULT_LANGUAGE=en - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[server]
default_language = "en"
domain
Se usa para determinar el campo Server al configurar la recepción de eventos por Email
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--domain=demo.yucca.app - mediante una variable de entorno:
#!shell export YUCCA_SERVER_DOMAIN=192.168.188.15 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[server]
domain = "demo.yucca.app"
health_check_interval
Intervalo para comprobar el estado de las dependencias.
"30s"El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--health-check-interval="30s" - mediante una variable de entorno:
#!shell export YUCCA_SERVER_HEALTH_CHECK_INTERVAL="30s" - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[server]
health_check_interval = "30s"
listen_address
Dirección IP y puerto en los que estará disponible la interfaz web.
:9910El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--web.listen-address=:9910 - mediante una variable de entorno:
#!shell export YUCCA_SERVER_LISTEN_ADDRESS=:9910 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[server]
listen_address = ":9910"
log_file
Ruta al archivo de registros; si no se especifica, se usa stdout.
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--log-file=/var/log/yucca.log - mediante una variable de entorno:
#!shell export YUCCA_SERVER_LOG_FILE=/var/log/yucca.log - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[server]
log_file = "/var/log/yucca.log"
self_logs
Ver los registros del servidor y de los flujos en la interfaz, en la pestaña depuración.
trueEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--self-logs=true - mediante una variable de entorno:
#!shell export YUCCA_SERVER_SELF_LOGS=false - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[server]
self_logs = true
log_buffer_size
Número de mensajes recientes en la interfaz, en la pestaña depuración.
50El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--log-buffer-size=50 - mediante una variable de entorno:
#!shell export YUCCA_SERVER_LOG_BUFFER_SIZE=50 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[server]
log_buffer_size = 50
cert_file
Ruta al archivo del certificado, en caso de usar HTTPS.
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--cert-file=/opt/yucca/ssl/cert.crt - mediante una variable de entorno:
#!shell export YUCCA_SERVER_CERT_FILE=/opt/yucca/ssl/cert.crt - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[server]
cert_file = "/opt/yucca/ssl/cert.crt"
cert_key
Ruta al archivo de la clave, en caso de usar HTTPS.
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--cert-key=/opt/yucca/ssl/cert.key - mediante una variable de entorno:
#!shell export YUCCA_SERVER_CERT_KEY=/opt/yucca/ssl/cert.key - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[server]
cert_key = "/opt/yucca/ssl/cert.key"
pprof
Habilita la generación de perfiles (profiling).
falseEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--pprof=true - mediante una variable de entorno:
#!shell export YUCCA_SERVER_PPROF=true - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[server]
pprof = true
pprof_listen_address
Dirección IP y puerto en los que estará disponible el generador de perfiles pprof.
:9911El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--pprof-listen-address=":9911" - mediante una variable de entorno:
#!shell export YUCCA_SERVER_PPROF_LISTEN_ADDRESS=":9911" - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[server]
pprof_listen_address = ":9911"
validate
Marca para comprobar que la configuración es correcta.
El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--validate
Ejemplo de uso
./yucca server --config /opt/yucca/yucca.toml --validate
Valid configuration
database
Conexión a la base de datos.
type
Se admiten 2 tipos de bases de datos para almacenar el estado: sqlite3 y postgres. En instalaciones pequeñas, sqlite3 es suficiente; con un gran número de flujos, recomendamos usar postgres.
sqlite3El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--database-type=sqlite3 - mediante una variable de entorno:
#!shell export YUCCA_DATABASE_TYPE=sqlite3 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[database]
type = "sqlite3"
path
Ruta al archivo de la base de datos (solo para sqlite3).
<state_dir>/state.dbEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--database-path=/opt/yucca/server/state.db - mediante una variable de entorno:
#!shell export YUCCA_DATABASE_PATH=/opt/yucca/server/state.db - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[database]
path = "/opt/yucca/server/state.db"
host
Dirección de conexión a la base de datos (solo para postgres).
127.0.0.1:5432El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--database-host=127.0.0.1:5432 - mediante una variable de entorno:
#!shell export YUCCA_DATABASE_HOST=127.0.0.1:5432 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[database]
host = "127.0.0.1:5432"
name
Nombre de la base de datos (solo para postgres).
yuccaEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--database-name=yucca - mediante una variable de entorno:
#!shell export YUCCA_DATABASE_NAME=yucca - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[database]
name = "yucca"
user
Nombre de usuario para la conexión (solo para postgres).
postgresEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--database-user=postgres - mediante una variable de entorno:
#!shell export YUCCA_DATABASE_USER=postgres - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[database]
user = "postgres"
password
Contraseña de usuario para la conexión (solo para postgres).
postgresEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--database-password=postgres - mediante una variable de entorno:
#!shell export YUCCA_DATABASE_PASSWORD=postgres - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[database]
password = "postgres"
ssl_mode
Usar SSL (conexión cifrada) al conectarse (solo para postgres). Valores posibles: disable, require, verify-full).
disableEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--database-ssl-mode=disable - mediante una variable de entorno:
#!shell export YUCCA_DATABASE_SSL_MODE=disable - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[database]
ssl_mode = "disable"
busy_timeout
Tiempo de espera en segundos para que se desbloquee la tabla de SQLite (solo para sqlite3).
500El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--database-busy-timeout=500 - mediante una variable de entorno:
#!shell export YUCCA_DATABASE_BUSY_TIMEOUT=500 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[database]
busy_timeout = 500
ca_cert_path
Ruta al certificado de la autoridad de certificación (CA) en caso de usar SSL (solo para postgres).
/etc/ssl/certsEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--database-ca-cert-path=/etc/ssl/certs - mediante una variable de entorno:
#!shell export YUCCA_DATABASE_CA_CERT_PATH=/etc/ssl/certs - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[database]
ca_cert_path = "/etc/ssl/certs"
client_cert_path
Ruta al archivo del certificado en caso de usar SSL (solo para postgres).
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--database-client-cert-path=/opt/yucca/ssl/cert.crt - mediante una variable de entorno:
#!shell export YUCCA_DATABASE_CLIENT_CERT_PATH=/opt/yucca/ssl/cert.crt - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[database]
client_cert_path = "/opt/yucca/ssl/cert.crt"
client_key_path
Ruta al archivo de la clave en caso de usar SSL (solo para postgres).
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--database-client-key-path=/opt/yucca/ssl/cert.key - mediante una variable de entorno:
#!shell export YUCCA_DATABASE_CLIENT_KEY_PATH=/opt/yucca/ssl/cert.key - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[database]
client_key_path = "/opt/yucca/ssl/cert.key"
cache_mode
Parámetro de caché compartida usado para la conexión a la base de datos (solo para sqlite3). Valores posibles: private, shared.
sharedEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--database-cache-mode=shared - mediante una variable de entorno:
#!shell export YUCCA_DATABASE_CACHE_MODE=shared - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[database]
cache_mode = "shared"
conn_max_lifetime
Establece el tiempo máximo durante el cual una conexión puede reutilizarse.
0sEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--database-conn-max-lifetime=0s - mediante una variable de entorno:
#!shell export YUCCA_DATABASE_CONN_MAX_LIFETIME=0s - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[database]
conn_max_lifetime = "0s"
log_queries
Registrar las consultas SQL y su tiempo de ejecución.
falseEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--database-log-queries=false - mediante una variable de entorno:
#!shell export YUCCA_DATABASE_LOG_QUERIES=false - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[database]
log_queries = false
max_open_conn
Número máximo de conexiones abiertas a la base de datos (solo para postgres).
0El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--database-max-open-conn=0 - mediante una variable de entorno:
#!shell export YUCCA_DATABASE_MAX_OPEN_CONN=0 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[database]
max_open_conn = 0
max_idle_conn
Número máximo de conexiones inactivas en espera (solo para postgres).
2El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--database-max-idle-conn=2 - mediante una variable de entorno:
#!shell export YUCCA_DATABASE_MAX_IDLE_CONN=2 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[database]
max_idle_conn = 2
streams
Parámetros relacionados con el comportamiento de los flujos.
archive_download_max_duration
Duración máxima permitida del intervalo de tiempo solicitado para la descarga.
24hEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--streams-archive-download-max-duration=24h - mediante una variable de entorno:
#!shell export YUCCA_STREAMS_ARCHIVE_DOWNLOAD_MAX_DURATION=24h - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[streams]
archive_download_max_duration = "24h"
archive_download_request_lifetime
Tiempo de vida de un intervalo de archivo descargado.
Al descargar intervalos del archivo, se genera un archivo de la duración solicitada, que estará disponible para su descarga durante el tiempo indicado en este parámetro. Si descarga intervalos largos con una velocidad de descarga lenta, se recomienda aumentar el valor de este parámetro.
1h0m0sEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--streams-archive-download-request-lifetime=6h - mediante una variable de entorno:
#!shell export YUCCA_STREAMS_ARCHIVE_DOWNLOAD_REQUEST_LIFETIME=1h0m0s - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[streams]
archive_download_request_lifetime = "1h0m0s"
archive_max_depth_hours
Profundidad máxima permitida para el almacenamiento del archivo, en horas.
-1El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--streams-archive-max-depth-hours=-1 - mediante una variable de entorno:
#!shell export YUCCA_STREAMS_ARCHIVE_MAX_DEPTH_HOURS=-1 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[streams]
archive_max_depth_hours = -1
live_on_demand_lease_duration
Duración del arrendamiento (lease) para un flujo en vivo bajo demanda (live on-demand).
Tiempo durante el cual un flujo live on-demand solicitado seguirá funcionando tras la última renovación del arrendamiento, es decir, la vida útil del arrendamiento después de su última renovación. El arrendamiento se renueva al consultar el estado del flujo en su página de visualización. Cuanto menor sea el número, más rápido pasará el flujo al estado de pausa después de cerrar la página de visualización.
1m0sEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--streams-live-on-demand-lease-duration=1m0s - mediante una variable de entorno:
#!shell export YUCCA_STREAMS_LIVE_ON_DEMAND_LEASE_DURATION=1m0s - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[streams]
live_on_demand_lease_duration = 1m0s
live_on_demand_lease_interval
Frecuencia de comprobación del arrendamiento activo para un flujo en vivo bajo demanda (live on-demand). Este parámetro debe ser menor que live_on_demand_lease_duration.
30sEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--streams-live-on-demand-lease-interval=30s - mediante una variable de entorno:
#!shell export YUCCA_STREAMS_LIVE_ON_DEMAND_LEASE_INTERVAL=30s - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[streams]
live_on_demand_lease_interval = 30s
playlist_max_duration
Duración máxima permitida del intervalo de tiempo solicitado para una lista de reproducción M3U8.
3hEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--streams-playlist-max-duration=3h - mediante una variable de entorno:
#!shell export YUCCA_STREAMS_PLAYLIST_MAX_DURATION=3h - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[streams]
playlist_max_duration = "3h"
ranges_max_duration
Duración máxima permitida del intervalo de tiempo solicitado para los rangos (rango de disponibilidad del archivo).
168hEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--streams-ranges-max-duration=168h - mediante una variable de entorno:
#!shell export YUCCA_STREAMS_RANGES_MAX_DURATION=168h - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[streams]
ranges_max_duration = "168h"
uuid_slug
Usar un UUID generado como identificador público del flujo.
falseEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--streams-uuid-slug=false - mediante una variable de entorno:
#!shell export YUCCA_STREAMS_UUID_SLUG=false - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[streams]
uuid_slug = false
executor
Parámetros de ejecución de los flujos.
type
Tipo de ejecutor para gestionar los flujos. Valores disponibles: exec, docker.
- Exec: el servidor ejecuta ffmpeg y supervisa su funcionamiento directamente, sin usar docker ni yucca-worker.
- Docker: (obsoleto, se eliminará en el futuro) para cada flujo, el servidor lanza un contenedor docker en el que se ejecuta yucca-worker, que a su vez lanza ffmpeg y supervisa su funcionamiento, reiniciándolo en caso de problemas.
execEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--executor=exec - mediante una variable de entorno:
#!shell export YUCCA_EXECUTOR_TYPE=docker - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[executor]
type = "exec"
log_level
Nivel de registro del executor. Valores posibles: panic, fatal, error, warning, info, debug).
infoEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--executor-log-level=info - mediante una variable de entorno:
#!shell export YUCCA_EXECUTOR_LOG_LEVEL=info - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[executor]
log_level = "info"
executor.exec
Parámetros adicionales para el tipo exec.
cancel_grace_period
Intervalo de espera para que finalicen todos los subprocesos en ejecución (ffmpeg, ffprobe, ...).
5sEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--exec-cancel-grace-period=5s - mediante una variable de entorno:
#!shell export YUCCA_EXECUTOR_EXEC_CANCEL_GRACE_PERIOD=5s - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[executor.exec]
cancel_grace_period = "5s"
ffmpeg_log_level
Nivel de registro para los procesos ffmpeg.
errorEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--exec-ffmpeg-log-level="error" - mediante una variable de entorno:
#!shell export YUCCA_EXECUTOR_EXEC_FFMPEG_LOG_LEVEL="error" - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[executor.exec]
ffmpeg_log_level = "error"
ffmpeg_log_max_file
Número máximo de archivos de registro que pueden existir.
5El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--exec-ffmpeg-log-max-file=5 - mediante una variable de entorno:
#!shell export YUCCA_EXECUTOR_EXEC_FFMPEG_LOG_MAX_FILE=5 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[executor.exec]
ffmpeg_log_max_file = 5
ffmpeg_log_max_size
Tamaño máximo del archivo de registro antes de rotarlo y comprimirlo.
"20mb"El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--exec-ffmpeg-log-max-size"20mb" - mediante una variable de entorno:
#!shell export YUCCA_EXECUTOR_EXEC_FFMPEG_LOG_MAX_SIZE"20mb" - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[executor.exec]
ffmpeg_log_max_size ="20mb"
hls_list_size
Longitud de la lista de reproducción HLS m3u8.
5El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--exec-hls-list-size=5 - mediante una variable de entorno:
#!shell export YUCCA_EXECUTOR_EXEC_HLS_LIST_SIZE=5 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[executor.exec]
hls_list_size = 5
hls_time
Duración deseada de los segmentos de vídeo HLS, en segundos.
2El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--exec-hls-time=2 - mediante una variable de entorno:
#!shell export YUCCA_EXECUTOR_EXEC_HLS_TIME=5 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[executor.exec]
hls_time = 5
preview
Habilita la generación de imágenes de vista previa en segundo plano.
trueEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--exec-preview=true - mediante una variable de entorno:
#!shell export YUCCA_EXECUTOR_EXEC_PREVIEW=false - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[executor.exec]
preview = true
preview_interval
Intervalo de generación de imágenes de vista previa.
5sEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--exec-preview-interval=5s - mediante una variable de entorno:
#!shell export YUCCA_EXECUTOR_EXEC_PREVIEW_INTERVAL=5s - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[executor.exec]
preview_interval = "5s"
probe_interval
Intervalo con el que se empieza a comprobar la disponibilidad del flujo; el intervalo aumenta
progresivamente (para evitar que las comprobaciones frecuentes provoquen que la cámara IP se bloquee)
hasta el valor definido en probe_interval_maximum, sin que el número de intentos supere
el valor de probe_retries; de lo contrario, el flujo pasará al estado Failed.
5sEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--exec-probe-interval="5s" - mediante una variable de entorno:
#!shell export YUCCA_EXECUTOR_EXEC_PROBE_INTERVAL="5s" - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[executor.exec]
probe_interval = "5s"
probe_interval_maximum
Consulte la descripción de probe_interval.
1m0sEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--exec-probe-interval-maximum="1m0s" - mediante una variable de entorno:
#!shell export YUCCA_EXECUTOR_EXEC_PROBE_INTERVAL_MAXIMUM="1m0s" - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[executor.exec]
probe_interval_maximum = "1m0s"
probe_retries
Consulte la descripción de probe_interval.
5El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--exec-probe-retries=5 - mediante una variable de entorno:
#!shell export YUCCA_EXECUTOR_EXEC_PROBE_RETRIES=5 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[executor.exec]
probe_retries = 5
probe_timeout
Tiempo de espera para obtener información de la fuente.
5El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--exec-probe-timeout="1m0s" - mediante una variable de entorno:
#!shell export YUCCA_EXECUTOR_EXEC_PROBE_TIMEOUT="1m0s" - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[executor.exec]
probe_timeout = "1m0s"
smtp_client
Configuración del cliente SMTP integrado. Se encarga de enviar notificaciones a los usuarios por correo, por ejemplo, sobre la próxima expiración de la licencia.
enabled
Activa el cliente SMTP para el envío de correos electrónicos.
falseEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--smtp-client=true - mediante una variable de entorno:
#!shell export YUCCA_SMTP_CLIENT_ENABLED=true - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[smtp_client]
enabled = true
host
Dirección del servidor SMTP.
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--smtp-client-host="smtp.gmail.com:465" - mediante una variable de entorno:
#!shell export YUCCA_SMTP_CLIENT_HOST="smtp.yandex.ru:465" - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[smtp_client]
host = ""
user
Usuario para la autenticación en el servidor SMTP.
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--smtp-client-user="" - mediante una variable de entorno:
#!shell export YUCCA_SMTP_CLIENT_USER="" - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[smtp_client]
user = ""
password
Contraseña para la autenticación en el servidor SMTP.
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--smtp-client-password="" - mediante una variable de entorno:
#!shell export YUCCA_SMTP_CLIENT_PASSWORD="" - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[smtp_client]
password = ""
from_address
Dirección usada al enviar correos electrónicos.
"admin@yucca.localhost"El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--smtp-client-from-address="admin@yucca.localhost" - mediante una variable de entorno:
#!shell export YUCCA_SMTP_CLIENT_FROM_ADDRESS="admin@yucca.localhost" - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[smtp_client]
from_address = "admin@yucca.localhost"
from_name
Nombre usado al enviar correos electrónicos.
"Yucca"El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--smtp-client-from-name="Yucca" - mediante una variable de entorno:
#!shell export YUCCA_SMTP_CLIENT_FROM_NAME="Yucca" - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[smtp_client]
from_name = "Yucca"
cert_path
Ruta al archivo del certificado.
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--smtp-client-cert-path="" - mediante una variable de entorno:
#!shell export YUCCA_SMTP_CLIENT_CERT_PATH="" - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[smtp_client]
cert_path = ""
key_path
Ruta al archivo de la clave.
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--smtp-client-key-path="" - mediante una variable de entorno:
#!shell export YUCCA_SMTP_CLIENT_KEY_PATH="" - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[smtp_client]
key_path = ""
skip_verify
Verificar el certificado SSL del servidor SMTP.
falseEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--smtp-client-skip-verify="" - mediante una variable de entorno:
#!shell export YUCCA_SMTP_CLIENT_SKIP_VERIFY="" - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[smtp_client]
skip_verify = ""
smtp_server
Configuración del servidor SMTP integrado para recibir notificaciones de detección de movimiento de las cámaras.
enabled
Activa el servidor SMTP integrado para recibir eventos de las cámaras.
trueEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--smtp-server=true - mediante una variable de entorno:
#!shell export YUCCA_SMTP_SERVER_ENABLED=true - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[smtp_server]
enabled = true
listen_address
Dirección en la que funcionará el servidor SMTP.
:1025El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--smtp-server-listen-address=:1025 - mediante una variable de entorno:
#!shell export YUCCA_SMTP_SERVER_LISTEN_ADDRESS=:1025 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[smtp_server]
listen_address = ":1025"
password
Contraseña para conectarse al servidor SMTP.
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--smtp-server-password=admin - mediante una variable de entorno:
#!shell export YUCCA_SMTP_SERVER_PASSWORD=admin - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[smtp_server]
password = "admin"
username
Nombre de usuario para conectarse al servidor SMTP.
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--smtp-server-username=admin - mediante una variable de entorno:
#!shell export YUCCA_SMTP_SERVER_USERNAME=admin - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[smtp_server]
username = "admin"
read_timeout
Tiempo de espera para leer un mensaje entrante.
1sEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--smtp-server-read-timeout=1s - mediante una variable de entorno:
#!shell export YUCCA_SMTP_SERVER_READ_TIMEOUT=1s - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[smtp_server]
read_timeout = "1s"
event_window_duration
Duración de un nuevo evento de detección de movimiento.
40sEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--smtp-server-event-window-duration=40s - mediante una variable de entorno:
#!shell export YUCCA_SMTP_SERVER_EVENT_WINDOW_DURATION=40s - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[smtp_server]
event_window_duration = "40s"
security
Parámetros de seguridad.
audit_logs 💰
Habilita los registros de auditoría.
falseEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--security-audit-logs=false - mediante una variable de entorno:
#!shell export YUCCA_SECURITY_AUDIT_LOGS=false - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[security]
audit_logs = false
brute_force_login_protection
Habilita la protección contra ataques de fuerza bruta al iniciar sesión.
trueEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--security-brute-force-login-protection=true - mediante una variable de entorno:
#!shell export YUCCA_SECURITY_BRUTE_FORCE_LOGIN_PROTECTION=true - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[security]
brute_force_login_protection = true
security_password_length
Longitud mínima permitida de la contraseña.
3El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--security-password-length=3 - mediante una variable de entorno:
#!shell export YUCCA_SECURITY_PASSWORD_LENGTH=3 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[security]
password_length = 3
telemetry
Telemetría. El servidor Yucca expone métricas en formato prometheus, lo que permite, por ejemplo, monitorizar la disponibilidad de las cámaras con un sistema de monitorización externo. Encontrará un ejemplo de configuración aquí.
enabled
Activa la exposición de métricas en formato Prometheus.
trueEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--telemetry=true - mediante una variable de entorno:
#!shell export YUCCA_TELEMETRY_ENABLED=true - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[telemetry]
enabled = true
listen_address
Dirección IP y puerto en los que estará disponible la telemetría.
:9912El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--telemetry-listen-address=:9912 - mediante una variable de entorno:
#!shell export YUCCA_TELEMETRY_LISTEN_ADDRESS=:9912 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[telemetry]
listen_address = ":9912"
path
URI para acceder a la telemetría.
/metricsEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--telemetry-path=/metrics - mediante una variable de entorno:
#!shell export YUCCA_TELEMETRY_PATH=/metrics - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[telemetry]
path = "/metrics"
basic_auth_username
Nombre de usuario de autenticación básica para acceder a la telemetría.
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--telemetry-basic-auth-username=admin - mediante una variable de entorno:
#!shell export YUCCA_TELEMETRY_BASIC_AUTH_USERNAME=admin - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[telemetry]
basic_auth_username = "admin"
basic_auth_password
Contraseña de autenticación básica para acceder a la telemetría.
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--telemetry-basic-auth-password=admin - mediante una variable de entorno:
#!shell export YUCCA_TELEMETRY_BASIC_AUTH_PASSWORD=admin - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[telemetry]
basic_auth_password = "admin"
environment_info
Etiquetas para la métrica yucca_environment_info.
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--telemetry-environment-info=env:test - mediante una variable de entorno:
#!shell export YUCCA_TELEMETRY_ENVIRONMENT_INFO=env:test - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[telemetry.environment_info]
env = "test"
analytics
Recopilación de analítica desde la interfaz del servidor mediante Yandex.Metrika.
yandex_metrika_counter_id
ID de contador de Yandex.Metrika. Se activa si está definido.
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--analytics-yandex-metrika-counter-id=12345678 - mediante una variable de entorno:
#!shell export YUCCA_ANALYTICS_YANDEX_METRIKA_COUNTER_ID=12345678 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[analytics]
yandex_metrika_counter_id = 12345678
yandex_metrika_webvisor
Activa Webvisor, un registro detallado de la actividad de los usuarios en el sitio: movimiento del ratón, desplazamiento y clics.
falseEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--analytics-yandex-metrika-webvisor=true - mediante una variable de entorno:
#!shell export YUCCA_ANALYTICS_YANDEX_METRIKA_WEBVISOR=true - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[analytics]
yandex_metrika_webvisor = true
quota 💰
Cuotas globales de recursos. Permiten limitar la cantidad máxima de determinados recursos que se pueden crear o añadir en el servidor.
global_stream
Cuota para la creación de flujos.
-1El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--quota-global-stream=-1 - mediante una variable de entorno:
#!shell export YUCCA_QUOTA_GLOBAL_STREAM=-1 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[quota]
global_stream = -1
global_team
Cuota para la creación de equipos.
-1El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--quota-global-team=-1 - mediante una variable de entorno:
#!shell export YUCCA_QUOTA_GLOBAL_TEAM=-1 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[quota]
global_team = -1
global_user
Cuota para la creación de usuarios.
-1El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--quota-global-user=-1 - mediante una variable de entorno:
#!shell export YUCCA_QUOTA_GLOBAL_USER=-1 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[quota]
global_user = -1
team_user
Cuota del número máximo de usuarios por equipo.
-1El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--quota-team-user=-1 - mediante una variable de entorno:
#!shell export YUCCA_QUOTA_TEAM_USER=-1 - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[quota]
team_user = -1
branding 💰
Personalización de marca de la interfaz.
app_logo
Ruta al archivo del logotipo. Puede especificar una URL http(s) http:// o una ruta del sistema de archivos file://.
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--branding-app-logo=https://example.com/logo.png - mediante una variable de entorno:
#!shell export YUCCA_BRANDING_APP_LOGO=file:///opt/yucca/logo.png - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[branding]
app_logo = "file:///opt/yucca/logo.png"
app_title
Texto del campo Title.
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--branding-app-title=Yucca - mediante una variable de entorno:
#!shell export YUCCA_BRANDING_APP_TITLE=Yucca - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[branding]
app_title = "Yucca"
site
Enlace a su sitio web.
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--branding-site=https://yucca.app - mediante una variable de entorno:
#!shell export YUCCA_BRANDING_SITE=https://yucca.app - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[branding]
site = "https://yucca.app"
documentation
Enlace a la página de documentación.
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--branding-documentation=https://docs.yucca.app - mediante una variable de entorno:
#!shell export YUCCA_BRANDING_DOCUMENTATION=https://docs.yucca.app - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[branding]
documentation = "https://docs.yucca.app"
fav_icon
Ruta al archivo Favicon. Puede especificar una URL http(s) http:// o una ruta del sistema de archivos file://.
""El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--branding-fav-icon=https://example.com/favicon.ico - mediante una variable de entorno:
#!shell export YUCCA_BRANDING_FAV_ICON=https://example.com/favicon.ico - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[branding]
fav_icon = "file:///opt/yucca/favicon.ico"
cluster 💰
Parámetros relacionados con la configuración del clúster (modo distribuido).
cluster_enabled
Activa el modo clúster.
falseEl valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--cluster=true - mediante una variable de entorno:
#!shell export YUCCA_CLUSTER_ENABLED=true - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[cluster]
enabled = true
cluster_advertise_address
Dirección para anunciarse a otros miembros del clúster.
127.0.0.1:9940El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--cluster-advertise-address="127.0.0.1:9940" - mediante una variable de entorno:
#!shell export YUCCA_CLUSTER_LISTEN_ADDRESS=24h - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[cluster]
advertise_address = "127.0.0.1:9940"
cluster_listen_address
Dirección para que los miembros del clúster se conecten.
0.0.0.0:9940El valor se puede definir de una de las siguientes maneras:
- mediante un argumento de inicio:
--cluster-listen-address="0.0.0.0:9940" - mediante una variable de entorno:
#!shell export YUCCA_CLUSTER_LISTEN_ADDRESS="0.0.0.0:9940" - mediante un archivo de configuración:
# /opt/yucca/yucca.toml
[cluster]
listen_address = "0.0.0.0:9940"