Configuración del Orquestrador¶
La configuración del Orquestrador se define en el fichero .env que se encuentra, por defecto, en la carpeta raíz donde se ubica el fichero docker-compose.yml.
Secciones de la guía:
- Configuración General
- Configuración Esencial
- Configuración Avanzada
- Configuración VPN
- Modo simple
- Modo redundante
Configuración General¶
En esta sección de la guía se abordan las opciones que comprenden y/o afectan el funcionamiento general del Orquestrador.
Configuración Esencial¶
Estas opciones deben configurarse acorde a las necesidades de tu host.
Clave API¶
Variable: API_KEY
Tipo: String
Explicación: Clave que utilizan los Proxy (Acexy) y el panel para acceder a los datos del Orquestrador. Muy importante definir una segura.
Valor por defecto: ninguno, sin autenticación
Puerto del Orquestrador¶
Variable: APP_PORT
Tipo: Integer
Explicación: Define el puerto utilizado por el Orquestrador. Es necesario que encaje con el segundo número de la definición portsen el docker-compose.
Valor por defecto: APP_PORT=8000
Red de Docker¶
Variable: DOCKER_NETWORK
Tipo: String
Explicación: Nombre de la red de Docker donde se instanciarán los contenedores. Debe ser la misma que la del Orquestrador.
Valor por defecto: red por defecto del contenedor (auto-generada por docker o especificada en el compose)
Variante de AceStream Engine¶
Variable: ENGINE_VARIANT
Tipo: Enum
Posibles Valores: krinkuto11-amd64, jopsis-amd64, jopsis-arm32, jopsis-arm64
Explicación: Define la variante pre-hecha para utilizar, dependiendo de la plataforma del host y las preferencias del usuario.
Valor por defecto: krinkuto11-amd64
Número mínimo de Engines¶
Variable: MIN_REPLICAS
Tipo: Integer (>0)
Explicación: Define la cantidad mínima de Engines que debe mantener activos el Orquestrador.
Valor por defecto: 1
Número máximo de Engines¶
Variable: MAX_REPLICAS
Tipo: Integer (>0)
Explicación: Define la cantidad máxima de Engines que puede mantener activos el Orquestrador. Importante si el sistema es limitado en cuanto a capacidad de procesamiento
Valor por defecto: 20
Rango de puertos para los Engines¶
Variable: PORT_RANGE_HOST
Tipo: Integer-Integer
Explicación: Define el rango de puertos en el que el Orquestrador puede crear los engines. Importante que estos puertos estén libres.
Valor por defecto: 19000-19999
Configuración Avanzada¶
Configuración opcional cuyo objetivo es optimizar al máximo el funcionamiento del Orquestrador. Es posible que cambiar estas opciones cause un comportamiento errático del mismo.
Ubicación de la Base de Datos¶
Variable: DB_URL
Tipo: sqlite://<ruta>
Explicación: Define la ruta (dentro del contenedor) del fichero .db donde se guarda el estado del Orquestrador. Útil cambiarlo si se desea una estructura de ficheros distinta.
Valor por defecto: sqlite:///./orchestrator.db