Installation guide

Install MaxiPBX on your server

Ten steps, from your PBX domain name to your first login to the interface. First you prepare the FQDN and the firewall, then the Control Plane generates a unique script that you run over SSH, and finally a web wizard takes over for the configuration.

Before you begin

  • A freshly installed Debian 13 server, with no other service or application on it.
  • SSH access with the root account (or an account that can become root).
  • A domain name whose DNS zone you manage, to create your PBX's FQDN (for example pbx.yourdomain.com).
  • An account on the MaxiPBX Control Plane, at my.maxipbx.com.
  • Access to the firewall or router in front of the server, to open the required ports.
Before installation

Prepare the network

  1. Step 1 : Create your server's FQDN

    First of all, give your PBX a fully qualified domain name (FQDN), for example pbx.yourdomain.com. In your domain's DNS zone, point this name to your server's IP address:

    CautionThe FQDN must already point to your server when you start the installation (step 8). Create it first.

    NameTypeValue
    pbx.yourdomain.com A IPv4 address of your serverRequired
    pbx.yourdomain.com AAAA IPv6 address of your serverIf your server has an IPv6 address

    TipA DNS change can take a few minutes to propagate. To check that the name resolves to your server's IP, run “ping pbx.yourdomain.com” from your computer.

  2. Step 2 : Open the firewall ports

    The PBX has its own firewall, which opens exactly the ports it needs. If a firewall or router sits in front of it (hosting provider firewall, corporate router, internet box), open all the ports below on it, from the outside to the PBX.

    CautionPort 8443 TCP is only needed during installation: it is used by the installation wizard (step 10). Open it before starting the installation, then close it again once the PBX is activated: it is no longer needed.

    PortProtocolServiceWhat it is for
    8443 Only during installation TCP Wizard Installation wizard (step 10). Close it again once the PBX is activated
    80 TCP Nginx Phone provisioning over HTTP, Let's Encrypt certificate renewal
    443 TCP Nginx Web interface, API, mobile and desktop apps, web phone (WebRTC), HTTPS provisioning
    5060 UDP + TCP Kamailio SIP: phones, softphones, carrier trunks
    5061 TCP Kamailio Encrypted SIP (TLS), ECDSA certificate
    5062 TCP Kamailio Encrypted SIP (TLS), RSA certificate for phones that do not support ECDSA
    30000-40000 UDP rtpengine Voice (RTP) for all calls: without these ports, there is no audio
    3478-3479 UDP + TCP coturn STUN/TURN: audio for the apps and the web phone behind NAT
    5349-5350 UDP + TCP coturn Encrypted TURN (TLS), same role on restrictive networks
    389 TCP MaxiPBX API LDAP directory for phones
    10389 TCP MaxiPBX API LDAP directory on an alternative port, for certain models
    22 TCP SSH Remote administration and maintenance by MaxiPBX. Can be restricted to our IP addresses

    TipIf the PBX is behind NAT (private IP address), set up port forwarding for this entire list to its internal IP, with the same RTP range 30000-40000 UDP.

In the Control Plane

Generate your installation key

  1. Step 3 : Log in to the Control Plane

    Open my.maxipbx.com in your browser and log in with your account. The Control Plane is where you manage your entire PBX fleet.

    Open the Control Plane
  2. Step 4 : Open your PBX list

    In the menu, go to “PBX Fleet”, then click “PBX”. There you will see all the PBXs already linked to your account.

  3. Step 5 : Generate an installation key

    Click “Generate an installation key”. This key links the future server to your account: once installed, it will appear directly in your fleet.

  4. Step 6 : Display and copy the installation script

    Display the installation script and copy it in full. It already contains your key: you do not need to change anything in it.

    CautionThe script contains a key specific to your account. Do not share it or publish it anywhere.

On your server

Run the installation

  1. Step 7 : Connect over SSH with the root account

    From a terminal (or a client such as PuTTY on Windows), connect to your brand-new Debian 13 server with the root account. Replace YOUR_IP with your server's IP address.

    ssh root@YOUR_IP

    TipIf you are logged in with another account, switch to root with the command “su -” or “sudo -i” before continuing.

  2. Step 8 : Paste the script and press Enter

    Paste the installation script copied in step 6 into the terminal, then press Enter.

  3. Step 9 : Let the installation run

    The installation progress is displayed on screen as it goes. Let it run to completion without touching anything.

    CautionDo not close the terminal or interrupt the SSH connection during the installation.

In your browser

Complete the configuration

  1. Step 10 : Open the installation wizard

    At the end of the installation, the terminal displays your PBX's address, in the form shown below. Open it in your browser, then follow the installation wizard: it guides you through the initial configuration.

    https://YOUR_IP:8443

    TipIf your browser shows a security warning about the certificate on this first visit, you can proceed to the site to launch the wizard.

    Need help?If you have any doubts while using the wizard, feel free to contact your MaxiPBX reseller partner: they are there to support you.

Your PBX is installed

Once the wizard is complete, your PBX is ready and linked to your fleet in the Control Plane. You can now create your users, phones and lines.

Need a hand?

Our team can support you during the installation or take care of it for you.