Installation has two stages. First you run one command on your server as root. Then you complete the setup wizard in your browser: you start the trial or enter your license key, create the administrator account, and review the settings BeePanel detected.
Before you start
- A server that meets the system requirements, ideally the server your PBX runs on.
- Root access to that server.
- Internet access from the server, and an email address for the trial or a license key.
- Browser access to the server on port 18080. See Network and ports.
Running the install command
The install command is published here with the first release. Run it as root. It downloads BeePanel, checks the download against its published SHA-256 checksum, and starts the installer, which:
- installs BeePanel under
/opt/beepaneland thebeepanelcommand; - creates the
beepanelsystem account, which the service runs as; - starts the
beepanelservice; - detects your PBX and prepares the AMI connection, the call history events, and read access to the recordings and the queue log. See What BeePanel changes on your PBX.
The installer asks no questions. It ends with a line like this:
success: BeePanel installed
hint: complete setup at http://<server-address>:18080/setupWhen a step could not be completed, the first line says how many need
attention, such as success: BeePanel installed; 1 step needs attention,
and that step shows a warning: line followed by a hint: line earlier in
the output. The installation still works; you can finish that step in the setup wizard or
afterwards.
Warning
Until setup is complete, anyone who can open the setup address can complete setup and become BeePanel's administrator. Complete it right away, and keep the port closed to untrusted networks until then.
Completing the setup wizard
- Open the setup address the installer printed, with your server's address
in place of
<server-address>. - On Welcome, choose Start setup.
- On Licensing, choose one, then choose Continue:
- Enter existing license key: enter the License key and choose Activate.
- Start 15-day Pro trial: enter your email address, choose Start trial, confirm the address from the email you receive, then choose Retrieve trial outcome.
- On Administrator account, enter the username and password of the first BeePanel user, then choose Continue. This account manages BeePanel and creates the other users.
- On Configuration, review the settings BeePanel detected. Each row is checked as the screen opens and shows Verified or the reason it failed. Choose Edit to correct a row. To set up an optional row later, clear its checkbox. See Settings for each row.
- Choose Complete installation.
The last screen shows the Panel address. Choose Sign in to BeePanel and sign in with the administrator account.
Checking the result
- You can sign in at the panel address.
- Management > Status shows each part of BeePanel and whether it works.
- The live panel shows your extensions.
Running the installer again
Running the install command again keeps BeePanel's configuration and data, repairs missing files, and restarts the service. It ends with:
success: BeePanel reinstalled; configuration and data kept
hint: open BeePanel at http://<server-address>:18080/The second line reads hint: complete setup at ... while setup is not yet
complete. To move to a newer version, use beepanel update. Setup itself cannot be repeated: once it is
complete, the setup screens close for good. To start over, uninstall
BeePanel together with its data and install it again; see
Uninstalling BeePanel.
Common problems
error: installation failed
The cause: below it gives the reason:
installation lifecycle must run as root: run the installer as root.required command "<name>" is unavailable: install the tool it names with your distribution's package manager.existing host state conflicts with BeePanel: something BeePanel would install is already taken, such as abeepanelaccount with a root identity or abeepanel.serviceunit from another product. Each line below it names the path, the reason, and the fix; fix every line.
Then run the installer again.
error: BeePanel files installed, but the service did not start
BeePanel is installed but its service failed. Check it with
systemctl status beepanel, fix the problem, and run the installer again.
warning: no supported local PBX detected
The installer found no Asterisk on this server, so it prepared nothing on the PBX. This is expected on a separate server; see Installing on a server separate from the PBX. Otherwise enter the AMI connection in the setup wizard.
warning: AMI listener is disabled in /etc/asterisk/manager.conf; connection not verified
The AMI user is prepared, but Asterisk does not accept AMI connections. See AMI connection.
warning: CEL capture not configured
The installer could not add the call history events. See Call history source.
The setup address does not open
Check that the service runs with systemctl status beepanel, and that your
firewall lets your browser reach port 18080 on the server.