Installation

Installation is one command, run from the standalone edition’s folder (portal/deploy/standalone in the AarView distribution). To obtain the distribution, contact CyberAar.

Run the installer

cd portal/deploy/standalone
./install.sh

The installer asks for three values, or reads them from .env or the environment:

Value	Variable	Example
The domain your users will type	AARVIEW_DOMAIN	aarview.example.org
Your organisation’s name	AARVIEW_OPERATOR_NAME	shown on the sign-in page, reports and e-mails
The administrator’s address	AARVIEW_ADMIN_EMAIL	identity provider administrator, contact shown when an account is locked

For an installation without questions, set them before running the script:

AARVIEW_DOMAIN=aarview.example.org \
AARVIEW_OPERATOR_NAME="My organisation" \
[email protected] \
./install.sh

What the installer does

1. It creates .env from .env.example and generates every secret in it (file mode 0600). No secret is printed.
2. It creates a private certificate authority and the portal certificate, unless you put your own in traefik/tls/. See TLS certificate.
3. It builds the images from the source tree, applies the database schema and starts the stack.
4. It configures the identity provider: mandatory two-factor authentication, account lockout, password policy, set-password links.
5. It configures the portal’s directory account, then checks that this account has the rights it needs and no more. If the check fails, the installation stops.

At the end it prints the portal address, the first sign-in and the instance id, needed for the licence.

Safe to re-run

The script can be re-run: it never replaces a secret or a certificate that exists. The instance id is fixed once and for all, because the licence is bound to it: never change it on a running install.

The containers

The Docker Compose stack contains:

Service	Role
traefik	HTTPS entry point, the only published port (443)
web	the AarView interface
api	the AarView API
migrate	applies the database schema, then stops
postgres	the database (PostgreSQL)
redis	the key-value store (Redis)
authentik-server, authentik-worker	the identity provider (Authentik)

If something fails

The script stops at the first problem and says what to look at, for example:

docker compose logs authentik-server
docker compose logs authentik-worker

Next step: the first sign-in.