Documentation
Installing the LUAXERR free edition
This guide assumes you only have what was delivered to you. Each step ends with what you should see. If you see something else, stop at that step.
What you received
| File | Contents |
|---|---|
luaxerr-gratuite-documents.tar.gz | this guide, compose.yaml, env.example, the licence, the third-party notice, the SBOM, sample alerts |
luaxerr-gratuite-0.1.0.tar.gz | the API and console image |
luaxerr-llm-cpu.tar.gz | the model server image |
SHA256SUMS-LIVRAISON | the checksum of each file above |
The model weights (4.1 GB) are not in these archives. Step 5 says where to get them and how to check them.
1. Requirements
- Linux x86_64 with Docker Engine and the
docker composeplugin. On Windows or macOS, Docker Desktop works; Windows-specific commands are given alongside. - 4 cores, 12 GB of free memory (the model uses up to 10), 10 GB of disk.
- No network access is needed once the files are on the machine.
2. Check what you received
In the folder holding the four files:
sha256sum -c SHA256SUMS-LIVRAISON
You should read OK on every line. If the model weights were not delivered with the rest, add --ignore-missing: step 5 checks them. On Windows, compare by hand:
Get-FileHash -Algorithm SHA256 luaxerr-gratuite-0.1.0.tar.gz
A single checksum that differs: go no further, the file was altered or truncated.
3. Unpack the documents
tar xzf luaxerr-gratuite-documents.tar.gz
cd luaxerr-gratuite
sha256sum -c SHA256SUMS
Every line OK. Everything that follows happens in this folder.
4. Load the images
docker load -i ../luaxerr-gratuite-0.1.0.tar.gz
docker load -i ../luaxerr-llm-cpu.tar.gz
You should read Loaded image: luaxerr-gratuite:0.1.0 then Loaded image: luaxerr-llm:cpu.
5. Put the model weights in place
The default model is Mistral 7B Instruct v0.3, quantised as Q4_K_M, under the Apache 2.0 licence. Download it from https://huggingface.co/MaziyarPanahi/Mistral-7B-Instruct-v0.3-GGUF/resolve/main/Mistral-7B-Instruct-v0.3.Q4_K_M.gguf, or use the copy delivered to you. Put the file next to the archives, then, still in the luaxerr-gratuite folder:
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
The checksum must be exactly:
14850c84ff9f06e9b51d505d64815d5cc0cea0257380353ac0b3d21b21f6e024
Another model can be served (variable LUAXERR_MODEL_FILE), but the published results only hold for this one: the model and the prompt are measured together.
6. Configure
cp env.example .env
chmod 600 .env
openssl rand -hex 32
Copy the value shown after LUAXERR_API_KEY= in .env. On Windows, to generate the key:
$b = New-Object byte[] 32; [Security.Cryptography.RandomNumberGenerator]::Create().GetBytes($b); -join ($b | ForEach-Object { $_.ToString('x2') })
This key opens every verdict: keep it like a password. Without it, the next step refuses to start, on purpose.
The console listens on port 8000 of the machine. If it is already taken, for instance by the Splunk web interface, choose another one with LUAXERR_PORT in .env, and replace 8000 with that port in what follows.
7. Start
docker compose up -d
docker compose ps
The model server loads the weights into memory: allow up to ten minutes on a CPU. Meanwhile llm is health: starting and the API waits. It is done when docker compose ps shows llm as healthy and api as Up.
curl http://127.0.0.1:8000/health
You should read {"status":"ok"}.
8. Use
First create your account, on the server. The password is typed at the prompt, twelve characters minimum, never as an argument:
docker compose exec api python -m core.comptes creer soc@example.com
Any address works, Gmail or other: it is the identifier, no e-mail is sent. Then open <http://127.0.0.1:8000/> on the machine itself and sign in with this address and password. The session lasts 30 minutes.
The API key from .env is not typed into the console: it is for the SIEMs that push their alerts.
| Goal | Command |
|---|---|
| Lost password | docker compose exec api python -m core.comptes mot-de-passe soc@example.com |
| Delete an account | docker compose exec api python -m core.comptes supprimer soc@example.com |
| List accounts | docker compose exec api python -m core.comptes lister |
A changed password or a deleted account immediately cuts the sessions opened before.
Send a sample alert. The command reads the key from .env, so it does not stay in the shell history:
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
The command waits for the judgement to finish: several minutes on a CPU. It then returns the verdict, which also appears under Alerts. The bundled connectors are wazuh, elastic, splunk, qradar, sentinel, google_secops, cef and ocsf, with a sample for each in examples/.
Microsoft Sentinel
Microsoft Sentinel, the SIEM, pushes, LUAXERR never polls: no app registration, no Azure credentials on your side. Not to be confused with SentinelOne, which is an EDR. The simplest path is an automation rule on incident created that runs a playbook:
1. Playbook with the Microsoft Sentinel incident trigger. 2. HTTP action: POST https://<your-luaxerr>/alerts/sentinel, body = the trigger body, headers Content-Type: application/json and X-API-Key. 3. Key read from Azure Key Vault, with Secure inputs on the action: otherwise it shows in the run history. 4. LUAXERR behind a TLS reverse proxy, open only to the Logic Apps outbound addresses of your region.
The playbook alert trigger and the SecurityAlert table export are read too. Samples: sample_sentinel_incident.json, sample_sentinel_playbook_alert.json. Avoid a rule on "updated": each change starts a judgement of several minutes. A replay updates the incident, it does not duplicate it. Body limited to 1 MB.
Google SecOps
Same principle: SecOps pushes, LUAXERR never polls, no Google service account on your side.
1. SOAR playbook with the Execute HTTP Request action of the HTTP v2 integration: POST https://<your-luaxerr>/alerts/google_secops, body = the detection in the Detection Engine API format (type, detection, collectionElements). 2. Key set in the integration (API Key Field Name = X-API-Key, API Key Secret = the key), never in the playbook body. 3. LUAXERR behind a TLS reverse proxy, open only to the outbound addresses of your SecOps instance.
UDM fields are read in camelCase and in snake_case. For a process launch, the command line of the launched process comes before the parent's. Sample: sample_google_secops_detection.json.
CEF (firewalls, sensors, EDR)
For any device that emits CEF (ArcSight Common Event Format) over syslog. LUAXERR receives over HTTPS: a syslog relay on your side sends one line per request, wrapped as {"message": "<CEF line>"}, to POST https://<your-luaxerr>/alerts/cef, with the X-API-Key header.
The syslog prefix is tolerated. Lines are limited to 64 KiB and read in a single pass: a hostile message costs only its length. An unreadable message is rejected with 422, and the response does not echo its content. Without externalId, the same message keeps the same identifier: a replay does not duplicate the alert. The command line is only read from a csN field whose label names it (CommandLine). Sample: sample_cef_alert.json.
9. Verify
- Health: the console's System health panel should say the model is reachable.
- The log: Decision log, then Verify the chain. The result should be "Chain intact." Each decision is chained to the previous one: a modified or removed line breaks the chain.
- Exposure: the API only listens on the local machine.
docker compose port api 8000
You should read 127.0.0.1:8000, or the port chosen in step 6.
Access from another computer
This guide stops at the local machine. To open the console to other computers, put a TLS reverse proxy in front, keep the API key, create one account per person, and read SECURITY.md. Never remove the key to go faster.
Stop, back up, uninstall
| Goal | Command |
|---|---|
| Stop | docker compose down (the data stays) |
| Back up the data | docker compose stop api, then docker compose cp api:/app/data ./sauvegarde, then docker compose start api |
| Remove everything, data included | docker compose down -v |
The API is stopped during the copy: a copy taken in the middle of a write would be unusable. The log is in the same file as the verdicts.
The data lives in the luaxerr-gratuite_luaxerr-gratuite-data volume. It holds account names, addresses and machine names: this is personal data. Encrypt the disk and the backups.
What the free edition does not do
- Accounts to open the console, but no roles and no named log: the log does not say who classified what.
- One judgement per alert, on demand. Agents, campaigns, ATT&CK coverage, regulatory declarations and the signed file are in the Enterprise edition.