Search all guides
Documentation / Getting Started
Start with the relationship
DOMAINTAINS is the PBX-side part of an operator-authorised telephone service. Start by deciding who operates that service.
What you are installing
The community module targets FreePBX 16 and 17. It accepts validated service configuration from a compatible HTTPS provisioning service, applies it through FreePBX APIs and verifies the resulting local state. It is not a replacement distribution, carrier or general-purpose remote administration agent.
Choose your route
Administrators need a compatible operator endpoint and privately supplied activation token. Operators can build against the public BYOT and number-search contracts. Businesses considering the FreePBX UK integrated-service option should treat that as a separate service relationship, with availability and terms to be confirmed.
Evaluate before deployment
Version 0.7.0-dev is a development milestone, not a production release. The repository records local automated testing and independent development review. Real operator integration, genuine number-search browser acceptance and controlled production acceptance remain outstanding.
Your first evaluation, in order
Confirm the fit
You operate FreePBX 16 or 17 and need a compatible operator to authorise defined service configuration, not a general remote-management agent.
Prepare an isolated environment
Use a disposable PBX and synthetic operator data. Review PHP/HTTPS prerequisites and preserve existing configuration before changing anything.
Obtain the module
Inspect the public development source and install a reviewed module package through the appropriate FreePBX module-management workflow. The website does not supply a stable release archive.
Establish the operator relationship
Obtain a complete compatible HTTPS endpoint and privately delivered token. Without an operator implementation, start with the independent reference and its synthetic tests.
Configure deliberately
Read the persistent PBX identity, save the endpoint and choose an explicit outbound policy on a new neutral installation. Agree corresponding upstream calling permissions.
Activate and inspect
Activate through the hidden prompt or administrator interface. Inspect local state and any stage diagnostic. A locally provisioned result must follow complete verification.
Prove the service separately
Check native routes and reload behaviour, then actual carrier delivery and controlled calls. Confirm emergency registration and commercial correctness independently.
Who needs to be involved?
| Role | Required decision |
|---|---|
| PBX administrator | Is the endpoint correct, is the local policy intentional, and is the configuration conflict-free? |
| Operator integrator | Are customer, product, assignment and order authority enforced by real adapters? |
| Service operator | Have SIP edges, carrier routing, commercial entitlement and recovery been accepted? |