AarView Documentation
Version described: 1.78.0 The managed SOC: AarSOC documentation →
Documentation contents

AarView · Get started

Licence

How the AarView licence is bound to your instance, what it sets (seats, modules, limits), activation codes, expiry and the grace period.

On this page

AarView needs a licence bound to your installation. It is issued by CyberAar.

Get and install the key

  1. Note the instance id. The installer prints it at the end; it is also in .env (AARVIEW_INSTANCE_ID, shaped aarv-…) and on the Licence page.
  2. Send it to CyberAar. You receive a key.
  3. Install it, either:
    • from AarView’s Licence page (Administration, Licence);
    • or in .env, then restart the stack:
AARVIEW_LICENCE_KEY=AARV1-...
docker compose up -d

Until then, users can sign in, and every data page says the licence is missing.

How the key is checked

  • The key is a document signed by CyberAar (Ed25519 signature). AarView carries only the public verification keys.
  • It is bound to one instance: it does not work on another installation.
  • It is verified again on every read. A key that was altered, issued for another instance, or expired blocks access.
  • A server clock set back in time is detected.

What the licence sets

The Licence page shows the licensee, the expiry, the seats, the included features and the instance id.

  • Seats: how many named people may use the instance. Depending on the licence, every user takes a seat, or only your own team’s accounts do (your clients’ accounts are then exempt). Beyond the seat count, no access is granted.
  • Modules: the licence can list the allowed modules (core, intelligence, forensics, orchestration, external monitoring, AI assistant). A service offer cannot grant more than the licence. A licence without a module list includes them all.
  • Limits: a maximum number of clients and of connected sources. Beyond it, creating a client or a source is refused, and the page says so before the form.

Activate a seat

  • The licence owner is activated at their first sign-in.
  • For everyone else, a super administrator issues a personal activation code for one e-mail address, valid 1 to 14 days and shown once. It only works with that address’s account, and only once. Several addresses can get a code at once.
  • Five wrong attempts block attempts for 15 minutes.
  • Any seat can be revoked, except your own. Disabling an account releases its seat.
  • The history of seats and codes (granted, revoked, failed activations) can be consulted.

A person without a seat lands on an activation screen that explains what to do.

Expiry

  • Super administrators are told at 60, 30, 14, 7, 3 and 1 days before expiry, then during the grace period. The Licence page shows a banner from 60 days.
  • After expiry, the platform keeps working for the grace period set by the licence (14 days by default). Then access is blocked.

What the licence never blocks

Alert intake. An existing connected source keeps delivering its alerts even on an expired licence: no security event is lost. Only creating a source requires the licence.