User Guide

This guide covers what an analyst does on a sos-vault appliance after the operator has provisioned their account. If you are the operator, start with the Administration Guide instead.

Signing in

Open https://<your-appliance>/ and sign in with the email your operator gave you. Until the operator replaces the installer's self-signed certificate you will see a browser warning — that is normal, and once a real cert is installed it will go away.

Uploading an SOS report

  1. From the home page, click Upload SOS report.
  2. Select the sosreport-*.tar.xz file produced on the source system.
  3. Choose the team / vault the report belongs to. The dropdown only shows teams you are a member of.
  4. Submit. The appliance verifies the archive, extracts machine tokens, and ingests the case into the vault. Large reports take a minute or two; progress is reported inline.

Browsing a case

Open the vault from the sidebar. Each case lists its uploaded sosreport plus all decrypted artifacts (logs, config, sosreport sections). Click a node to expand it; right-click for the per-file actions (download, view raw, verify checksum).

Vault open and close

Each vault has an "open" state that holds decrypted files in memory-backed storage. Vaults auto-close after a configurable inactivity period; analysts can also force-close from the vault header. Closing scrubs the decrypted view; reopening prompts for the vault passphrase if the vault is not set to always open.

Verification reports

Download a verification report from the vault toolbar. The report bundles checksums, signatures, and a JSON summary of the case. The customer portal on the SaaS side accepts these for warranty / audit follow-up.

Modules

The Customer Portal hosts optional modules (e.g. german-support, add-on analysers). Operator-installed modules surface in the analyser ribbon once enabled.

What gets logged

The appliance writes structured logs locally only. Nothing about your case data leaves the appliance unless you explicitly run sos-vault:capture-server-report to package a support bundle and upload it via your existing support channel.