Administrar el servidor mediante comandos
Además de iniciar el servidor, el ejecutable de SpaceBuilder (setfn-spacebuilder) incluye comandos administrativos para el terminal. Utilícelos para recuperar cuentas o restricciones de acceso cuando no pueda iniciar sesión en la página de administración y para consultar ajustes como el puerto y el idioma.
Este documento es una referencia para administradores que instalan y operan el servidor. Realice la administración habitual desde la página de administración y utilice los comandos solo cuando esa página no esté disponible.
Antes de comenzar
- Ejecute los comandos en el terminal del equipo donde está instalado SpaceBuilder.
- Utilice la misma cuenta del sistema operativo que ejecuta SpaceBuilder. La configuración predeterminada se encuentra bajo la carpeta principal de ese usuario; si utiliza una ruta distinta, especifique el mismo archivo de configuración que el servidor en funcionamiento.
- Los ejemplos presuponen que el ejecutable se encuentra en la carpeta principal (
~/setfn-spacebuilder). Sustituya la ruta si está en otra ubicación. - Detenga el servidor antes de ejecutar comandos administrativos que empiecen por
user,unblock,ip,admin,loginologout.
Especificar la ruta de configuración del servidor
El archivo predeterminado en Linux es ~/.config/SetFN/config.yaml. Si el servicio se ejecuta con otra cuenta o ruta, consulte la ruta indicada en el comando de ejecución del servicio.
Especifique el archivo mediante -c o --config. El ejemplo siguiente utiliza /srv/setfn/config.yaml; sustitúyalo por la ruta real.
~/setfn-spacebuilder -c /srv/setfn/config.yaml port get
~/setfn-spacebuilder -c /srv/setfn/config.yaml user list
Añada la misma opción -c a los demás comandos de este documento. Si opera con una ruta indicada mediante -H o --home, utilice también esa opción. Cuando se especifica -c, tiene prioridad para elegir el archivo de configuración.
Detener y volver a iniciar el servidor
Los comandos que administran usuarios, restricciones y dispositivos, incluidos admin status y admin logout-all, abren directamente la base de datos. Si otro proceso la utiliza, pueden terminar con Database is still locked tras varios intentos. admin reset-config no abre la base, pero también debe ejecutarse con el servidor detenido.
Si configuró el inicio automático, deténgalo primero.
sudo systemctl stop setfn-spacebuilder
Después de ejecutar los comandos necesarios, vuelva a iniciarlo.
sudo systemctl start setfn-spacebuilder
Si lo ejecuta directamente desde un terminal, pulse Ctrl+C en ese terminal.
Definir la contraseña de acceso a la consola
Los comandos user y unblock solicitan Console Access Password. Esta contraseña es el valor de la variable de entorno SETFN_CONSOLE_PASSWORD. Defínala en el mismo terminal antes de ejecutar el comando.
export SETFN_CONSOLE_PASSWORD="contraseña elegida"
Sirve únicamente para comprobar el acceso a comandos locales. No cambia la contraseña del administrador de Workspace ni la de la cuenta de SetFN. Cuando aparezca Console Access Password, introduzca el valor que definió en el terminal.
Resumen de comandos
| Comando | Función | ¿Detener servidor? |
|---|---|---|
serv | Inicia el servidor. Ejecutar el archivo sin comando también lo inicia. | No |
version | Muestra la versión y la información de compilación. | No |
lang get, lang set <código>, lang list | Consulta o cambia el idioma de los mensajes del terminal. Admite en, ko, ja, zh y de. | No |
port get | Consulta el puerto actual y si está en uso. | No |
homepath get | Consulta la ruta principal donde se guardan los datos. | No |
user list | Muestra las cuentas de usuario. | Sí |
user add, user delete | Añade o elimina una cuenta. | Sí |
user password | Cambia la contraseña de un usuario. | Sí |
user promote | Cambia la función de un usuario. | Sí |
user mfa reset | Desactiva la verificación en dos pasos de una cuenta de administrador (recuperación de emergencia). | Sí |
unblock | Recupera de emergencia un bloqueo de inicio de sesión. Equivale a user unblock. | Sí |
ip status, ip add, ip remove, ip enable, ip disable | Administra las restricciones por IP y la lista de permitidas. | Sí |
admin status, admin status-json | Consulta el estado y la configuración; status-json devuelve JSON. | Sí |
admin logout-all | Cierra las sesiones de todos los usuarios. | Sí |
admin reset-config | Elimina el archivo de configuración para repetir la configuración inicial. | Sí |
admin knowledge-backup, admin knowledge-restore | Realiza o restaura una copia del almacenamiento de conocimiento. | Sí |
admin vector-instance-id, admin prepare-clone | Prepara un servidor copiado como instancia independiente. Consulte Migrar un servidor. | Sí |
login, logout | Registra o desvincula este dispositivo de una cuenta de SetFN desde el terminal. | Sí |
Añada --help después de un comando para consultar sus opciones.
~/setfn-spacebuilder user --help
Recuperar el acceso si no puede iniciar sesión
Detenga el servidor y defina la contraseña de consola antes de ejecutar cualquiera de estos comandos.
Eliminar un bloqueo de inicio de sesión
Si los fallos repetidos bloquearon al administrador, añada a la lista blanca de seguridad la IP del equipo desde el que accederá.
~/setfn-spacebuilder unblock --ip 203.0.113.10
Consulte el estado de recuperación.
~/setfn-spacebuilder unblock --status
Si todavía no puede acceder, desactive temporalmente la seguridad de inicio de sesión.
~/setfn-spacebuilder unblock --all
~/setfn-spacebuilder unblock --enable-security
Comprobar la cuenta de usuario de destino
Consulte primero las cuentas de usuario existentes.
~/setfn-spacebuilder user list
Busque en la columna Username el nombre de inicio de sesión de la cuenta de destino. Sustituya todo el marcador "<cuenta de usuario>" de los comandos siguientes por ese valor. La columna Nick, en cambio, contiene el nombre mostrado.
Cambiar la contraseña del administrador
~/setfn-spacebuilder user password -u "<cuenta de usuario>" --password "nueva contraseña"
En -u, sustituya todo el marcador por el nombre de inicio de sesión de la cuenta de usuario existente de Workspace que aparece en la columna Username. No utilice el nombre mostrado en Nick. El comando queda en el historial del terminal; recomendamos volver a cambiar la contraseña desde la página de administración después de iniciar sesión. La contraseña nueva debe cumplir las reglas de contraseña del servidor; las contraseñas habituales o filtradas se rechazan. En los servidores recién instalados, la regla predeterminada es un mínimo de 12 caracteres.
Desactivar la verificación en dos pasos de un administrador
Úselo cuando un administrador ha perdido la app de autenticación y los códigos de recuperación, no puede iniciar sesión y no hay otro superusuario que pueda restablecerla desde la página de administración.
~/setfn-spacebuilder user mfa reset "<cuenta de usuario>"
Se eliminan la app de autenticación y los códigos de recuperación de esa cuenta y se cierran todas sus sesiones iniciadas. El siguiente inicio de sesión solo pide la contraseña; si la política Exigir verificación en dos pasos a administradores está activada, deberá configurarla de nuevo después de iniciar sesión. La ejecución queda registrada en el registro de auditoría como Verificación en dos pasos restablecida. Si se ejecuta en una cuenta que no usa la verificación en dos pasos, solo se muestra un aviso y no cambia nada. El procedimiento de configuración se explica en Configurar la verificación en dos pasos para administradores.
Recuperar permisos de administrador
Si no queda ninguna cuenta con permisos de administrador, cambie la función de un usuario existente.
~/setfn-spacebuilder user promote -u "<cuenta de usuario>" -r admin
En este comando, -u identifica el nombre de inicio de sesión de la cuenta existente. -r admin asigna el valor fijo de rol admin; en cambio, admin en admin status es el nombre de un grupo de comandos administrativos.
| Opción | Descripción |
|---|---|
-u, --username | Nombre de inicio de sesión de una cuenta existente, mostrado en la columna Username. |
-r, --role | Uno de superuser, admin o user. Si se omite, utiliza superuser. |
Añadir y eliminar cuentas de usuario
~/setfn-spacebuilder user add -u newadmin -n "Nuevo administrador" --admin
| Opción | Descripción |
|---|---|
-u, --username | Nombre utilizado para iniciar sesión. |
-n, --nickname | Nombre mostrado en la pantalla. |
--password | Contraseña. Si se omite, se muestra una contraseña generada automáticamente. |
--admin | Añade la cuenta como administrador. |
Para eliminar una cuenta, especifique el nombre. No puede eliminar al último administrador.
~/setfn-spacebuilder user delete -u olduser
Administrar restricciones de acceso por IP
Cuando se activan, solo las IP de la lista de permitidas pueden acceder a la página de administración. Corrija mediante comandos una lista incorrecta que impida acceder a la página de administración.
Consulte el estado y la lista.
~/setfn-spacebuilder ip status
Añada o elimine una dirección IP o un intervalo CIDR.
~/setfn-spacebuilder ip add --ip 192.168.1.100
~/setfn-spacebuilder ip add --ip 192.168.1.0/24
~/setfn-spacebuilder ip remove --ip 192.168.1.100
Active o desactive la restricción.
~/setfn-spacebuilder ip enable
~/setfn-spacebuilder ip disable
Consultar la configuración del servidor
~/setfn-spacebuilder port get
~/setfn-spacebuilder homepath get
~/setfn-spacebuilder lang get
- Puede cambiar inmediatamente el idioma de los mensajes, por ejemplo con
lang set ko. port set <puerto>yhomepath set <ruta>no cambian los valores. Muestran qué debe escribir en el archivo de configuración;port settambién indica si el puerto está disponible. Edite el archivo y reinicie el servidor para aplicar el cambio.- Los puertos admitidos van de
3000a65535. El predeterminado es8510.
Recuperar la conexión del dispositivo con la cuenta de SetFN
Estos comandos administran la conexión entre la cuenta de SetFN y el dispositivo del servidor. Para bloqueos o contraseñas de usuarios de Workspace, utilice user y unblock.
Detenga el servidor y comience la conexión utilizando la misma ruta de configuración.
~/setfn-spacebuilder login
Siga las instrucciones de autenticación del terminal y apruebe en el navegador. Para volver a conectar un dispositivo ya registrado, utilice:
~/setfn-spacebuilder login --force
Si la autenticación caducó o dejó de ser válida, desvincule y vuelva a registrar.
~/setfn-spacebuilder logout
~/setfn-spacebuilder login --force
logout elimina de forma predeterminada el token del sitio local, la clave del dispositivo y los archivos de autenticación. logout --unlink es una opción compatible que realiza la misma desvinculación completa. Para conservar la clave y los archivos y eliminar solo el token de sesión del sitio, utilice logout --keep-link.
Después de reconectar, inicie el servidor y compruebe el estado de registro de la licencia.
Administrar el estado del servidor y las sesiones
Consulte el estado y la configuración actuales.
~/setfn-spacebuilder admin status
Si sospecha que se han filtrado credenciales, cierre todas las sesiones. Los usuarios deberán volver a iniciar sesión.
~/setfn-spacebuilder admin logout-all
Para realizar y restaurar copias del almacenamiento de conocimiento, consulte Operar el almacenamiento de conocimiento.
Información útil
- Linux conserva solo 15 caracteres del nombre de un proceso, por lo que
ps -eytopmuestransetfn-spacebuil. Utilicepgrep -f setfn-spacebuilderpara comprobar si se está ejecutando. - Recomendamos realizar desde la página de administración las tareas disponibles allí, como añadir usuarios o administrar bloqueos. Los comandos de cuentas y bloqueos requieren detener el servidor.