Skip to content

Updating BeePanel

Last updated:

Browse articles
On this page

BeePanel updates only from the server's command line; nothing is installed from the browser and nothing updates on its own. The update command downloads the newest release, checks it, and installs it only when it is newer than the installed version. Configuration and data are kept.

Before you start

  • Root access to the BeePanel server.
  • Internet access from the server to the BeePanel download address. See Network and ports.
  • An update entitlement that covers the release. Every license includes one year of updates; a release published after the entitlement ends cannot be installed, while the installed version keeps working. The end date is on the Status page, under Update entitlement.
  • A short interruption: the service stops while the new version is installed, and users' live screens lose their connection until it starts again.

Updating to the newest release

  1. Run as root:

    beepanel update
  2. Wait for the command to finish. It shows each stage:

    ==> Downloading BeePanel 1.2.0
    ==> Stopping BeePanel
    ==> Installing the update
    ==> Starting and verifying BeePanel
    
    success: BeePanel updated to 1.2.0

Before it stops anything, the command checks the release's signature, that it fits the installed configuration and data, that your update entitlement covers it, and that your license is not revoked. If a check fails, nothing changes and the installed version keeps running. When the installed version is already the newest, it reports success: BeePanel 1.2.0 is already installed.

The Status page also shows the command: choose How to update? on its System card.

Installing one exact version

beepanel update --version=1.2.0

This installs exactly the release you name, if its data and configuration fit the installed ones. Naming the installed version again replaces the program with that release's exact signed program, which repairs a program file that was replaced by hand.

Checking the result

  • beepanel version prints the installed version.
  • Management > Status shows the new version under BeePanel version.

Common problems

error: update failed

The update was not installed. The cause: line below it gives the reason:

  • update must run from the installed BeePanel executable: the command was run from a copy of the program. Run the installed beepanel update.
  • the requested release is newer than the signed update entitlement: your update entitlement ended before this release. Renew it to install the release; the installed version keeps working.
  • the installed license is revoked or superseded: the license was revoked or moved to another server. BeePanel locks its operational features, such as the live panel and reports, until a valid license is installed on the License page.
  • fetch release manifest: ... or download release artifact: ...: the server could not reach the download address. Check its internet access and firewall.
  • verify update manifest: release signature verification failed or verify downloaded update artifact: release artifact checksum or size mismatch: the download did not pass verification. Run the command again; if it repeats, contact support.
  • release migration chain is not compatible with the installed state: the release cannot be installed over the installed version. Contact support.
  • installation lifecycle must run as root: run the command as root.

error: BeePanel 1.2.0 is installed, but service verification failed

The new version is installed but did not start correctly, so the service is left stopped. Fix the cause it reports, then run the command it suggests, such as beepanel update --version=1.2.0, to finish the update.

Can’t find what you need? Write to support@beepanel.io.