Astervis Docs

Installation Wizard

Step-by-step walkthrough of the Astervis installation wizard

The interactive wizard guides you through configuration. Here's what happens at each step.

Step 1: System Check

The installer verifies your environment:

[1/4] System Check
══════════════════════════════════════════════════════

OS:        Ubuntu 22.04 LTS           ✓
Arch:      x86_64 (amd64)             ✓
CPU:       4 cores                    ✓
RAM:       8 GB                       ✓
Disk:      47 GB free                 ✓
Docker:    24.0.7                     ✓

Auto-Detection

The installer automatically detects:

DetectionSourceResult
PBX TypeConfig file locationsFreePBX, Sangoma, Issabel, VitalPBX
MySQL Credentials/etc/freepbx.conf, /etc/issabel.conf, etc.Auto-filled in Step 3
OS Version/etc/os-releaseCompatibility check
DockerSystem checkAuto-install if missing

On FreePBX/Sangoma systems, MySQL credentials are extracted automatically from /etc/freepbx.conf. No manual entry needed.

If Docker is Missing

The installer offers to install Docker automatically:

Docker not found. Install Docker? [Y/n]

Selecting Y runs the official Docker installation script.

Step 2: License Validation

Enter your license key:

[2/4] License
══════════════════════════════════════════════════════

Enter license key: asp-xxxx-xxxx-xxxx

Validating... ✓

License: Trial
Operators: 5
Expires: 2024-02-15

License Types

TypeOperatorsDuration
Trial514 days
Starter10Subscription
Professional25Subscription
EnterpriseUnlimitedSubscription

Trial licenses require internet access for validation. Production licenses work offline after initial activation.

Skip License Prompt

Provide the license key via command line:

sudo ./astervis-installer install --license "asp-xxxx-xxxx-xxxx"

Step 3: Configuration

Configure credentials and settings:

[3/4] Configuration
══════════════════════════════════════════════════════

Admin username [admin]:
Admin password [auto-generated]:
Admin email: admin@company.com

Domain/IP [192.168.1.100]: pbx.company.com

MySQL Settings

If not auto-detected, you'll be prompted:

MySQL Configuration
───────────────────
Host [localhost]:
Port [3306]:
Database [asteriskcdrdb]:
Username [asteriskuser]:
Password: ********

Auto-detected from /etc/freepbx.conf:

  • Host: localhost
  • Database: asteriskcdrdb
  • Credentials: From FreePBX config

SSL Certificate

Choose certificate type:

SSL Certificate
───────────────
[1] Self-signed (quick, requires browser exception)
[2] Let's Encrypt (requires valid domain, ports 80/443)
[3] Custom (provide your own certificate)

Select [1]:
OptionBest ForRequirements
Self-signedTesting, internal useNone
Let's EncryptProductionDomain pointing to server, ports 80/443 open
CustomEnterpriseYour certificate files

Step 4: Installation

The installer deploys Astervis:

[4/4] Installation
══════════════════════════════════════════════════════

Pulling images...
  database       [████████████████████] 100%
  cache          [████████████████████] 100%
  sync           [████████████████████] 100%
  api            [████████████████████] 100%
  dashboard      [████████████████████] 100%
  proxy          [████████████████████] 100%

Starting services...       ✓
Configuring sync...        ✓
Running migrations...      ✓
Importing operators...     ✓

Installation complete!

What Gets Installed

ComponentLocation
Docker Compose/opt/astervis/docker-compose.yml
Configuration/opt/astervis/.env
Data/opt/astervis/data/
Logsdocker logs astervis-*

Real-time Sync Setup

The installer automatically:

  1. Enables MySQL binary logging (if needed)
  2. Creates a replication user
  3. Configures sync connector
  4. Starts initial data import

Initial CDR import happens after installation. Depending on CDR table size, this may take a few minutes.


Next: Post-Installation — verify services and access the dashboard

On this page