Ir al contenido

Referencia de la CLI

El binario cs-routeros-bouncer tiene una superficie de comandos reducida: ejecuta el bouncer, imprime información de versión/ayuda o realiza tareas de instalación/eliminación de systemd.

Ejecútalo con un archivo de configuración:

Ventana de terminal
cs-routeros-bouncer -c /etc/cs-routeros-bouncer/cs-routeros-bouncer.yaml

Flags de ejecución:

FlagDescripción
-cRuta al archivo de configuración YAML
-versionImprime la versión, el commit y la fecha de compilación

Cuando se omite -c, el binario comprueba /etc/cs-routeros-bouncer/config.yaml en cada ejecución y lo usa si ese archivo existe. El orden de resolución es: una ruta -c explícita tiene prioridad, después la ruta implícita /etc/cs-routeros-bouncer/config.yaml y, si ese archivo no existe, el bouncer arranca en modo solo entorno (variables de entorno más los valores por defecto integrados). Este comportamiento está integrado en el binario, así que se aplica siempre que arranque sin -c — incluida la imagen Docker, cuyo entrypoint no pasa ninguno. La unidad systemd que escribe setup siempre pasa un -c explícito, así que nunca llega a la ruta implícita.

Ten en cuenta que la ruta implícita es config.yaml, mientras que setup escribe su configuración de ejemplo como cs-routeros-bouncer.yaml y se la pasa al servicio con un -c explícito.

Imprime la información de compilación:

Ventana de terminal
cs-routeros-bouncer version

La forma con flag también está soportada:

Ventana de terminal
cs-routeros-bouncer -version

Instala el binario actual como un servicio de systemd:

Ventana de terminal
sudo ./cs-routeros-bouncer setup

Qué hace:

  1. Copia el binario a la ruta de instalación seleccionada.
  2. Crea el directorio de configuración.
  3. Escribe una configuración de ejemplo si no existe ya una.
  4. Escribe /etc/systemd/system/cs-routeros-bouncer.service.
  5. Ejecuta systemctl daemon-reload, habilita el servicio y lo inicia.

Flags:

FlagValor por defectoDescripción
-bin/usr/local/bin/cs-routeros-bouncerRuta de instalación del binario
-config-dir/etc/cs-routeros-bouncerDirectorio para los archivos de configuración

Ejemplo con rutas personalizadas:

Ventana de terminal
sudo ./cs-routeros-bouncer setup \
-bin /opt/cs-routeros-bouncer/cs-routeros-bouncer \
-config-dir /etc/cs-routeros-bouncer

Detiene y elimina el servicio de systemd y el binario instalado:

Ventana de terminal
sudo cs-routeros-bouncer uninstall

Flags:

FlagValor por defectoDescripción
-bin/usr/local/bin/cs-routeros-bouncerRuta del binario instalado a eliminar
-config-dir/etc/cs-routeros-bouncerDirectorio de configuración a eliminar con -purge
-purgefalseElimina también el directorio de configuración configurado

Por defecto, uninstall conserva los archivos de configuración. Si la instalación usó un -bin o -config-dir personalizado, pasa los mismos valores a uninstall para que se eliminen el binario y el directorio de configuración correctos.

Elimina también los archivos de configuración:

Ventana de terminal
sudo cs-routeros-bouncer uninstall -purge

Purga una ruta de instalación personalizada:

Ventana de terminal
sudo cs-routeros-bouncer uninstall \
-bin /opt/cs-routeros-bouncer/cs-routeros-bouncer \
-config-dir /opt/cs-routeros-bouncer/config \
-purge

Imprime la información de uso:

Ventana de terminal
cs-routeros-bouncer help

Los flags de ayuda habituales también están soportados:

Ventana de terminal
cs-routeros-bouncer -h
cs-routeros-bouncer --help