Referencia del instalador
El instalador, install.sh, instala, actualiza, reinstala y desinstala Excubius en un servidor. Se ejecuta como root desde el paquete del instalador descomprimido. Esta referencia enumera sus opciones, sus comprobaciones previas, las preguntas que hace y lo que deja en el servidor. Para conocer los pasos de una instalación, consulta Instalar Excubius.
sudo ./install.sh [options]
Opciones
| Opción | Efecto |
|---|---|
| (ninguna) | Instala. En un servidor donde Excubius ya está instalado, ofrece Upgrade (la opción predeterminada: conserva los datos y la configuración, y solo hace las preguntas nuevas de esta versión), Reinstall, Purge o Cancel |
--check-only | Ejecuta solo las comprobaciones previas. No cambia nada |
--images FILE | Instala desde un archivo de imágenes, sin acceso al registro. Un archivo en images/ junto al script, como en el paquete sin conexión, se usa automáticamente |
--answers FILE | No interactivo: líneas key=value, secretos incluidos. Consulta Archivo de respuestas |
--reconfigure | En una actualización, vuelve a hacer todas las preguntas. Las respuestas de TLS que se den entonces se aplican a la plataforma en ejecución |
--reinstall | Quita el software instalado y conserva la base de datos; luego instala haciendo todas las preguntas |
--purge | Elimina todo, incluida la base de datos, y luego hace una instalación nueva |
--uninstall | Quita el software. Primero escribe un volcado final de la base de datos en <dir>/backups/ y luego quita las unidades de usuario, los contenedores, las imágenes, <dir>/releases, <dir>/current, /etc/excubius y la configuración de puertos sin root. Conserva los volúmenes de la base de datos y de los certificados, <dir>/backups, <dir>/.env y la cuenta de servicio, para que una instalación posterior encuentre los datos |
--uninstall --purge | Elimina además todos los volúmenes, el directorio de instalación completo con sus copias de seguridad, la cuenta de servicio que creó el instalador con su almacenamiento de contenedores y los servicios de firewall que agregó la instalación. Te pide que escribas purge |
--no-backup | Sin volcado final de la base de datos con --uninstall o --reinstall |
--yes, -y | Acepta todos los valores predeterminados que existan; las respuestas obligatorias deben seguir llegando desde --answers o el teclado. En un servidor instalado significa Upgrade, y confirma una purga |
--dry-run | Muestra lo que se haría y no cambia nada. Una instalación igualmente escribe sus archivos de configuración para que los revises; si ya existe un .env, junto a él, como .env.dry-run |
--skip-checks | Continúa aunque fallen las comprobaciones previas, en sistemas no compatibles, bajo tu propia responsabilidad |
--help, -h | Muestra las opciones |
Se rechazan estas combinaciones: --uninstall con --reinstall o --reconfigure; --purge con --reinstall; --check-only con --uninstall, --purge o --reinstall; --reconfigure con --purge o --reinstall.
Solo se elimina el directorio de instalación registrado, nunca una ruta del sistema ni un directorio personal.
Comprobaciones previas
| Comprobación | Requisito | Cuando no se cumple |
|---|---|---|
| Sistema operativo | Rocky Linux u otro sistema de la familia RHEL | Falla |
| Versión principal | 9 o 10 | Advierte |
| Arquitectura | x86-64 | Falla |
| Sistema de inicio | systemd | Falla |
| Administrador de paquetes | dnf | Falla |
| Memoria | 4 GiB | Advierte |
| CPU | 2 vCPU | Advierte |
| Disco | 20 GiB libres en /home, donde la cuenta de servicio guarda las imágenes y la base de datos | Advierte |
| Puertos | 80 y 443 libres, en una instalación nueva | Falla |
| SELinux | Se informa | — |
| Registros | ghcr.io y docker.io accesibles por HTTPS, o un archivo de imágenes legible | Falla |
| Reloj | Sincronizado | Advierte; se habilita chrony |
Preguntas
Presiona Entrar para aceptar el valor entre corchetes. En una actualización, solo se hacen las preguntas introducidas después de la versión que escribió tus respuestas; Desde indica qué versión introdujo cada una.
| Clave | Pregunta | Valor predeterminado | Cuándo se hace | Desde |
|---|---|---|---|---|
install_dir | Directorio de instalación | /opt/excubius | Siempre; una ruta absoluta | 0.2.0 |
service_user | Cuenta de servicio que ejecuta la plataforma | excubius | Siempre; se crea si no existe y ejecuta los contenedores sin root | 0.2.0 |
public_url | URL pública que abrirán los usuarios | https://monitoring.example.com | Siempre; su host es el nombre principal del servidor | 0.2.0 |
server_aliases | Otros nombres para este servidor | ninguno | Siempre; separados por espacios, Entrar para ninguno | 0.3.0 |
tls_mode | Cómo se proporciona HTTPS | letsencrypt | Siempre: letsencrypt, letsencrypt-dns, selfsigned, custom, gateway o later | 0.2.0 |
tls_cert_names | Nombres que se incluyen en el certificado | all | Hay alias y el modo genera un certificado | 0.3.0 |
tls_email | Correo electrónico de la cuenta de Let's Encrypt | — | letsencrypt o letsencrypt-dns | 0.2.0 |
tls_dns_provider | Proveedor de DNS de la zona de los nombres | — | letsencrypt-dns; un id. de dnsapi de acme.sh como dns_cf, dns_dreamhost o dns_azure | 0.3.0 |
tls_dns_credentials | Credenciales de la API de DNS | — | letsencrypt-dns; se escriben una por una sin eco | 0.3.0 |
tls_cert_file | Archivo de la cadena de certificados | — | custom; PEM, primero el certificado del servidor | 0.3.0 |
tls_key_file | Archivo de la clave privada | — | custom; PEM, sin frase de contraseña, que coincida con el certificado | 0.3.0 |
default_preset | Preset base | enterprise | Siempre: enterprise, databases o core | 0.2.0 |
registry_user, registry_token | Usuario del registro y token de solo lectura para las imágenes | — | Sin un archivo de imágenes | 0.2.0 |
slack_bot_token | Token de bot de Slack | — | Siempre; opcional | 0.2.0 |
slack_default_channel | Canal de Slack para las alertas | #alerts | Siempre | 0.2.0 |
entra_tenant_id | Id. del inquilino de Entra ID para el inicio de sesión | — | Siempre; opcional | 0.2.0 |
entra_client_id, entra_client_secret | Id. de la aplicación y secreto de cliente de Entra ID | — | Se indicó un id. de inquilino | 0.2.0 |
Los modos de TLS:
| Modo | Úsalo cuando |
|---|---|
letsencrypt | Todos los nombres están en el DNS público apuntando al servidor y el puerto 80 es accesible desde Internet |
letsencrypt-dns | Tienes credenciales de API para la zona DNS de los nombres. No hace falta que el servidor sea accesible desde Internet |
selfsigned | En cualquier lugar. Los navegadores muestran una advertencia hasta que los usuarios confían en el certificado |
custom | Tu organización emite el certificado |
gateway | TLS termina en un equilibrador de carga o un proxy inverso que está delante |
later | HTTP sin cifrar por ahora |
Con un modo de Let's Encrypt, el instalador comprueba los nombres en el DNS público y, por HTTP, que apunten a este servidor. Si no es así, explica las alternativas, y nunca se detiene por eso. Las respuestas de TLS solo inicializan la configuración de la plataforma; después se administran en Configuración › Servidor.
Valores generados
El instalador genera estos valores una sola vez y nunca los sobrescribe: la contraseña de la base de datos (POSTGRES_PASSWORD), el secreto de firma de las sesiones (JWT_SECRET), la clave que cifra los secretos guardados (EXCUBIUS_DATA_KEY) y el token del recolector (EXCUBIUS_COLLECTOR_TOKEN). Consulta Variables de entorno.
Archivo de respuestas
Para una instalación desatendida, pasa --answers FILE con una línea key=value por pregunta. Este archivo incluye secretos; protégelo y elimínalo después. Las credenciales de DNS van en una sola línea, separadas por ;. Una respuesta que falta toma el valor predeterminado; una respuesta obligatoria que falta o que no es válida detiene el instalador con el nombre de la clave, para que puedas completar el archivo y volver a ejecutarlo.
Un extracto:
install_dir=/opt/excubius
service_user=excubius
public_url=https://monitoring.areito.example
server_aliases=
tls_mode=letsencrypt-dns
tls_email=ops@areito.example
tls_dns_provider=dns_cf
tls_dns_credentials=CF_Token=<token>
default_preset=enterprise
registry_user=<registry user>
registry_token=<read-only token>
slack_bot_token=<bot token>
slack_default_channel=#areito-alerts
sudo ./install.sh --answers ./answers.conf --yes
Actualizaciones y respuestas con versión
El instalador registra tus respuestas que no son secretas en <dir>/install.answers, con la versión del instalador que las escribió y si esa ejecución terminó. En una actualización, solo hace las preguntas introducidas desde esa versión. Una ejecución que no terminó se trata como una instalación nueva: se vuelven a hacer todas las preguntas, con las respuestas anteriores como valores predeterminados. Los secretos nunca se escriben en install.answers.
En el servidor
| Ruta | Qué es |
|---|---|
<dir>/.env | Configuración y secretos; modo 0600, propiedad de la cuenta de servicio |
<dir>/install.answers | Tus respuestas que no son secretas, la versión que las escribió y si esa ejecución terminó |
<dir>/current | La versión instalada, un vínculo a <dir>/releases/ |
<dir>/backups | Volcados diarios de la base de datos, se conservan los últimos 14, además del volcado final de una desinstalación |
~<service account>/.config/systemd/user/ | excubius.service y el temporizador de copias de seguridad |
/var/log/excubius-install.log | El registro del instalador, sin secretos |
Como la cuenta de servicio:
sudo -iu excubius
export XDG_RUNTIME_DIR=/run/user/$(id -u) # once per shell, for systemctl --user
systemctl --user status excubius # the platform
<dir>/current/scripts/compose.sh ps # the containers
<dir>/current/scripts/compose.sh logs -f backend # the API's log
<dir>/current/scripts/backup-db.sh # a database backup now
<dir>/current/scripts/enable-tls.sh --status # TLS without the console
<dir>/current/scripts/rollback.sh # back to the previous release