Documentación
Instalar la edición gratuita de LUAXERR
Esta guía supone que solo tiene lo que se le ha entregado. Cada paso termina con lo que debe ver. Si ve otra cosa, deténgase en ese paso.
Lo que ha recibido
| Archivo | Contenido |
|---|---|
luaxerr-gratuite-documents.tar.gz | esta guía, compose.yaml, env.example, la licencia, el aviso de componentes de terceros, el SBOM, alertas de ejemplo |
luaxerr-gratuite-0.1.0.tar.gz | la imagen de la API y de la consola |
luaxerr-llm-cpu.tar.gz | la imagen del servidor del modelo |
SHA256SUMS-LIVRAISON | la huella de cada uno de los archivos anteriores |
Los pesos del modelo (4,1 GB) no están en estos archivos. El paso 5 indica dónde obtenerlos y cómo comprobarlos.
1. Requisitos
- Linux x86_64 con Docker Engine y el complemento
docker compose. En Windows o macOS sirve Docker Desktop; los comandos propios de Windows se indican al lado. - 4 núcleos, 12 GB de memoria libre (el modelo usa hasta 10), 10 GB de disco.
- No hace falta acceso a la red una vez que los archivos están en el equipo.
2. Comprobar lo que ha recibido
En la carpeta donde están los cuatro archivos:
sha256sum -c SHA256SUMS-LIVRAISON
Debe leer OK en cada línea. Si los pesos del modelo no se le entregaron con el resto, añada --ignore-missing: el paso 5 los comprueba. En Windows, compare a mano:
Get-FileHash -Algorithm SHA256 luaxerr-gratuite-0.1.0.tar.gz
Una sola huella distinta: no siga, el archivo se ha alterado o truncado.
3. Desempaquetar los documentos
tar xzf luaxerr-gratuite-documents.tar.gz
cd luaxerr-gratuite
sha256sum -c SHA256SUMS
Todas las líneas en OK. Todo lo que sigue se hace en esta carpeta.
4. Cargar las imágenes
docker load -i ../luaxerr-gratuite-0.1.0.tar.gz
docker load -i ../luaxerr-llm-cpu.tar.gz
Debe leer Loaded image: luaxerr-gratuite:0.1.0 y después Loaded image: luaxerr-llm:cpu.
5. Colocar los pesos del modelo
El modelo por defecto es Mistral 7B Instruct v0.3, cuantizado en Q4_K_M, con licencia Apache 2.0. Descárguelo desde https://huggingface.co/MaziyarPanahi/Mistral-7B-Instruct-v0.3-GGUF/resolve/main/Mistral-7B-Instruct-v0.3.Q4_K_M.gguf, o use la copia que se le ha entregado. Coloque el archivo junto a los demás archivos recibidos y, todavía en la carpeta luaxerr-gratuite:
mkdir -p models
mv ../Mistral-7B-Instruct-v0.3.Q4_K_M.gguf models/
sha256sum models/Mistral-7B-Instruct-v0.3.Q4_K_M.gguf
La huella debe ser exactamente:
14850c84ff9f06e9b51d505d64815d5cc0cea0257380353ac0b3d21b21f6e024
Se puede servir otro modelo (variable LUAXERR_MODEL_FILE), pero los resultados publicados solo valen para este: el modelo y el prompt se miden juntos.
6. Configurar
cp env.example .env
chmod 600 .env
openssl rand -hex 32
Copie el valor mostrado después de LUAXERR_API_KEY= en .env. En Windows, para generar la clave:
$b = New-Object byte[] 32; [Security.Cryptography.RandomNumberGenerator]::Create().GetBytes($b); -join ($b | ForEach-Object { $_.ToString('x2') })
Esta clave abre todos los veredictos: guárdela como una contraseña. Sin ella, el paso siguiente se niega a arrancar, y es intencionado.
La consola escucha en el puerto 8000 del equipo. Si ya está ocupado, por ejemplo por la interfaz web de Splunk, elija otro con LUAXERR_PORT en .env y sustituya 8000 por ese puerto en lo que sigue.
7. Arrancar
docker compose up -d
docker compose ps
El servidor del modelo carga los pesos en memoria: cuente hasta diez minutos en procesador. Mientras tanto llm está en health: starting y la API espera. Ha terminado cuando docker compose ps muestra llm en healthy y api en Up.
curl http://127.0.0.1:8000/health
Debe leer {"status":"ok"}.
8. Usar
Cree primero su cuenta, en el servidor. La contraseña se escribe en el indicador, doce caracteres como mínimo, nunca como argumento:
docker compose exec api python -m core.comptes creer soc@example.com
Sirve cualquier dirección, Gmail u otra: es el identificador, no se envía ningún correo. Abra después <http://127.0.0.1:8000/> en el propio equipo e inicie sesión con esa dirección y esa contraseña. La sesión dura 30 minutos. La consola está en francés y en inglés.
La clave de API de .env no se escribe en la consola: sirve a los SIEM que envían sus alertas.
| Objetivo | Comando |
|---|---|
| Contraseña perdida | docker compose exec api python -m core.comptes mot-de-passe soc@example.com |
| Eliminar una cuenta | docker compose exec api python -m core.comptes supprimer soc@example.com |
| Listar las cuentas | docker compose exec api python -m core.comptes lister |
Una contraseña cambiada o una cuenta eliminada corta de inmediato las sesiones abiertas antes.
Envíe una alerta de ejemplo. El comando lee la clave en .env, así que no queda en el historial del shell:
curl -H "X-API-Key: $(grep '^LUAXERR_API_KEY=' .env | cut -d= -f2)" \
-H "Content-Type: application/json" \
--data @examples/sample_wazuh_alert.json http://127.0.0.1:8000/alerts/wazuh
El comando espera a que termine el análisis: varios minutos en procesador. Devuelve entonces el veredicto, que también aparece en Alerts. Los conectores incluidos son wazuh, elastic, splunk, qradar, sentinel, google_secops, cef y ocsf, con un ejemplo de cada uno en examples/.
Microsoft Sentinel
Microsoft Sentinel, el SIEM, envía, LUAXERR nunca consulta: ninguna aplicación que registrar, ninguna credencial de Azure de su lado. No debe confundirse con SentinelOne, que es un EDR. Lo más sencillo es una regla de automatización sobre creación de incidente que lanza un playbook:
1. Playbook con el desencadenador Microsoft Sentinel incident. 2. Acción HTTP: POST https://<su-luaxerr>/alerts/sentinel, cuerpo = el cuerpo del desencadenador, cabeceras Content-Type: application/json y X-API-Key. 3. Clave leída en Azure Key Vault, con Secure inputs activado en la acción: si no, aparece en el historial de ejecuciones. 4. LUAXERR detrás de un proxy inverso con TLS, abierto solo a las direcciones salientes de Logic Apps de su región.
También se leen el desencadenador de alerta y la exportación de la tabla SecurityAlert. Ejemplos: sample_sentinel_incident.json, sample_sentinel_playbook_alert.json. Evite la regla sobre «actualización»: cada cambio lanza un análisis de varios minutos. Un reenvío actualiza el incidente, no lo duplica. Cuerpo limitado a 1 MB.
Google SecOps
Mismo principio: SecOps envía, LUAXERR nunca consulta, ninguna cuenta de servicio de Google de su lado.
1. Playbook SOAR con la acción Execute HTTP Request de la integración HTTP v2: POST https://<su-luaxerr>/alerts/google_secops, cuerpo = la detección en el formato de la API Detection Engine (type, detection, collectionElements). 2. Clave configurada en la integración (API Key Field Name = X-API-Key, API Key Secret = la clave), nunca en el cuerpo del playbook. 3. LUAXERR detrás de un proxy inverso con TLS, abierto solo a las direcciones salientes de su instancia de SecOps.
Los campos UDM se leen en camelCase y en snake_case. En un lanzamiento de proceso, la línea de comandos del proceso lanzado va antes que la del padre. Ejemplo: sample_google_secops_detection.json.
CEF (cortafuegos, sondas, EDR)
Para cualquier equipo que emita CEF (ArcSight Common Event Format) por syslog. LUAXERR recibe por HTTPS: un relé syslog de su lado envía una línea por petición, envuelta en {"message": "<línea CEF>"}, a POST https://<su-luaxerr>/alerts/cef, con la cabecera X-API-Key.
Se tolera el prefijo syslog. Línea limitada a 64 KiB y leída en una sola pasada: un mensaje hostil solo cuesta su longitud. Un mensaje ilegible se rechaza con 422, sin que la respuesta copie su contenido. Sin externalId, el mismo mensaje conserva el mismo identificador: un reenvío no duplica la alerta. La línea de comandos solo se lee en un campo csN cuya etiqueta la nombra (CommandLine). Ejemplo: sample_cef_alert.json.
9. Verificar
- El estado: el panel System health de la consola debe indicar que el modelo está accesible.
- El registro: Decision log y después Verify the chain. El resultado debe ser «Chain intact.». Cada decisión está encadenada a la anterior: una línea modificada o eliminada rompe la cadena.
- La exposición: la API solo escucha en el propio equipo.
docker compose port api 8000
Debe leer 127.0.0.1:8000, o el puerto elegido en el paso 6.
Acceso desde otro equipo
Esta guía se limita al propio equipo. Para abrir la consola a otros equipos, coloque delante un proxy inverso con TLS, mantenga la clave de API, cree una cuenta por persona y lea SECURITY.md. No quite nunca la clave para ir más rápido.
Detener, hacer copia de seguridad, desinstalar
| Objetivo | Comando |
|---|---|
| Detener | docker compose down (los datos se conservan) |
| Copia de seguridad de los datos | docker compose stop api, después docker compose cp api:/app/data ./sauvegarde, después docker compose start api |
| Borrarlo todo, datos incluidos | docker compose down -v |
La API se detiene durante la copia: una copia tomada en mitad de una escritura no serviría. El registro está en el mismo archivo que los veredictos.
Los datos están en el volumen luaxerr-gratuite_luaxerr-gratuite-data. Contienen nombres de cuentas, direcciones y nombres de equipos: son datos personales. Cifre el disco y las copias de seguridad.
Lo que la edición gratuita no hace
- Cuentas para abrir la consola, pero sin roles ni registro nominativo: el registro no dice quién ha clasificado qué.
- Un análisis por alerta, bajo demanda. Los agentes, las campañas, la cobertura ATT&CK, las declaraciones reglamentarias y el expediente firmado están en la edición Enterprise.