Ir al contenido

Referencia de la CLI

El binario opanel es un único ejecutable; cada demonio es un subcomando que corre bajo su propia unidad de systemd, y unos pocos subcomandos son para operadores. Todos los comandos aceptan --log-level y --log-format desde el comando raíz.

Instala y arranca todos los componentes en este servidor, convirtiéndolo en una plataforma completa (un clúster de uno). Ejecutalo como root en un Debian 13 recién instalado; volver a correrlo repara una instalación existente sin perder datos.

Ventana de terminal
opanel install --panel-hostname panel.example.com --acme-email ops@example.com
Flag Para qué sirve
--brand Nombre que ven los clientes (por defecto opanel)
--panel-hostname Dominio del panel de control
--ssh-hostname Dominio para SFTP/SSH de clientes (por defecto: el mismo del panel)
--acme-email Dirección de contacto para la autoridad certificadora
--support-email Dirección de soporte que ven los clientes
--node-name Nombre de este servidor (por defecto: su hostname)
--node-address IP que usan otros servidores para llegar a este (por defecto: se detecta sola)
--public-ipv4, --public-ipv6 Direcciones públicas de este servidor
--ssh-port Puerto de la puerta de enlace SFTP/SSH de clientes (por defecto 2222); vale para todo el clúster, fijo después de la primera instalación
--admin-cidr Red autorizada a llegar al puerto SSH propio del servidor (se puede repetir)
--apt-url URL del repositorio APT de OPanel
--channel Canal de lanzamiento: stable, beta o nightly
--skip-packages No instalar paquetes de Debian; deben estar presentes de antemano
--skip-services Escribir la configuración sin arrancar los servicios

Suma este servidor a un clúster existente con los roles de un token de unión creado con opanel cluster token create. Ejecutalo como root; volver a correrlo en un servidor que ya se unió lo repara sin necesitar el token de nuevo.

Ventana de terminal
opanel join --controller 10.0.0.1:7444 --token opj_... --ca-sha256 <fingerprint>
Flag Para qué sirve
--controller host:puerto de la API de clúster de un controlador
--token Token de unión de un solo uso de opanel cluster token create
--ca-sha256 Huella digital SHA-256 de la CA del clúster que debe presentar el controlador
--node-name Nombre de este servidor en el clúster
--node-address Dirección por la que otros servidores lo alcanzan
--public-ipv4, --public-ipv6 Direcciones públicas, si este servidor las tiene
--apt-url URL del repositorio APT de OPanel
--channel Canal de lanzamiento: stable, beta o nightly
--skip-packages No instalar paquetes de Debian
--skip-services Escribir la configuración sin arrancar los servicios

Comandos para sumar servidores, ejecutados en un servidor de control.

Crea un token de unión de un solo uso e imprime el comando opanel join a correr en el servidor nuevo.

Ventana de terminal
opanel cluster token create --roles web,edge --pool default --ttl 1h
Flag Para qué sirve
--roles Roles del servidor nuevo: web, edge, ssh, db, cache (separados por comas)
--pool Pool de nodos al que se une el servidor, por slug o ID (por defecto default)
--ttl Cuánto tiempo permanece válido el token, hasta 168h (por defecto 1h)

Hace que todos los edges del clúster sirvan los mismos certificados TLS que el edge de este servidor.

Ventana de terminal
opanel cluster share-certificates

Verifica la instalación de este servidor: la configuración, el servicio, el certificado y los listeners de cada componente, además de las cuotas de disco, la sincronización de reloj, las actualizaciones y el espacio libre en disco.

Ventana de terminal
opanel doctor
opanel doctor --json
Flag Para qué sirve
--json Imprimir los resultados en JSON, para monitoreo

Termina con código de salida distinto de cero cuando alguna verificación falla.

Comandos de operador para la configuración inicial y para recuperar el acceso. Ejecutalos en un servidor de control, como la cuenta de servicio opanel (runuser -u opanel -- opanel admin ...).

Crea un token/enlace de un solo uso para crear la primera cuenta de administrador.

Ventana de terminal
runuser -u opanel -- opanel admin setup-token --ttl 24h

Imprime un enlace de un solo uso para restablecer la contraseña de una cuenta.

Ventana de terminal
runuser -u opanel -- opanel admin reset-password --email persona@example.com
runuser -u opanel -- opanel admin reset-password --email persona@example.com --clear-mfa
Flag Para qué sirve
--email Dirección de email de la cuenta
--clear-mfa También quitar la app de autenticación, las passkeys y los códigos de recuperación de la cuenta, y cerrarle la sesión en todos lados

opanel controller / opanel agent / opanel edge / opanel sshgw

Sección titulada «opanel controller / opanel agent / opanel edge / opanel sshgw»

Ejecutan los demonios del controlador, el agente de nodo, el proxy edge y la puerta de enlace SSH respectivamente; cada uno lo gestiona su propia unidad de systemd (opanel-controller, opanel-agent, opanel-edge, opanel-sshgw) y toma --config apuntando a su archivo de configuración TOML. Los operadores normalmente no invocan estos comandos directamente.

Ventana de terminal
opanel controller --config /etc/opanel/controller.toml

El subcomando controller también tiene opanel controller migrate (aplicar las migraciones de base de datos pendientes y salir) y opanel controller openapi (imprimir el documento OpenAPI de la API pública).

Imprime información de versión.

Ventana de terminal
opanel version