Open-source telecoms. Operator-controlled.0.7.0-dev / Development preview ↗
DOMAINTAINS.
Search all guides

Documentation / Getting Started

Install in a controlled environment

Treat installation as preparation. It is not service activation and it does not authorise carrier traffic.

Prepare a disposable test PBX

Back up any existing configuration and protected DOMAINTAINS state. Obtain the module source from the public repository and use the FreePBX module-management workflow appropriate to your test system. This guide does not invent a release archive or an unattended installation command: the current version is a development milestone.

Verified command example
fwconsole domaintains status
fwconsole domaintains identity

Locate the administrator interface

After installing and enabling the module through FreePBX, open Connectivity > DOMAINTAINS. The interface exposes connectivity status, the module version, activation, the complete provisioning endpoint and Show PBX identity. Pending or provisioned state also exposes confirmed lifecycle operations.

Keep the two applications separate

Do not install the operator example as though it were part of the FreePBX web interface. It is an independent HTTPS service. Its source, private configuration, state, logs and operator utilities must remain outside its public document root.

Installation acceptance checklist

  1. Review the exact source version

    The website describes 0.7.0-dev at snapshot d06d16b. Check module.xml in the source you will install; do not infer stability from a branch name.

  2. Use FreePBX module management

    Install and enable a reviewed module package using your FreePBX installation’s supported module-management workflow. No carrier credentials or operator examples belong inside the module package.

  3. Open Connectivity > DOMAINTAINS

    Confirm that the interface reports the expected module version and exposes status, endpoint configuration and PBX identity.

  4. Confirm identity before provider linking

    Obtain the actual persistent identity from the module and use it in the operator’s authorised relationship. Do not substitute a guessed hostname.

  5. Stop before activation if prerequisites are missing

    A module installed without a compatible operator endpoint, entitlement or explicit neutral routing policy is not ready to activate.