Download OpenBRM: the 26.0.0 package
The complete platform, including the OpenRate rating engine and the ecommerce component. Self-hosted, no licence fee.
Download latest packageInstall and learn
Everything for an open source billing install: two short installation videos, the user guide and the full documentation.
Installation video — part 1YouTube ↗ Installation video — part 2YouTube ↗ OpenBRM user guidePDF ↓ Documentation & API referenceRead →System requirements
Install in three steps
- Download
openbrm-26.0.0.zipand unzip it into a folder whose path has no spaces, for exampleC:\openbrmon Windows or/opt/openbrmon Linux and macOS. Spaces in the path break the startup scripts. - Open a terminal in the
binfolder and runstartup.baton Windows, orchmod +x *.shand then./startup.shon Linux and macOS. There is nothing to configure first. - When the script opens
http://localhost:8080/openbrmin your browser, log in withadmin/123qweand follow the Getting Started guide to create your company, products and first invoice.
What the first run does
The startup script checks what is already on the machine and fills in the gaps. If no Java 17 JDK is found, it downloads and installs Eclipse Temurin 17. If PostgreSQL is installed but stopped, it starts the service; if it is missing, it installs PostgreSQL 18. It then restores the base database, saves the resolved settings to a small environment file and starts the bundled Tomcat 9.0.83. Each stage is skipped once it has been satisfied, so running the script again is safe.
The first run takes a few minutes, because setup may download a JDK and a database installer and Tomcat unpacks a 295 MB application archive. Later starts take seconds. Administrator rights, or sudo on Linux and macOS, are requested only when Java or PostgreSQL has to be installed; the server itself runs as your normal user.
Before you start
- Windows 10 (version 1803 or newer), Linux or macOS
- Port 8080 free for the application and port 5433 free for PostgreSQL
- Keep the bundled Tomcat 9: Tomcat 10 and later use a different servlet namespace that this release does not support
- Running your own Tomcat? Use the WAR-only package,
openbrm-26.0.0-war.zip, instead
Once it is running, the live API documentation is at /openbrm/swagger-ui.html and application metrics are at /actuator/prometheus.
Upgrading from OpenBRM 2.x
Moving from a 2.x release is a platform migration, not a file swap. The startup script creates a fresh 26.0.0 installation and does not bring 2.x data or configuration across for you. Plan to move to a Java 17 JDK, move your data to PostgreSQL (H2 and HSQLDB are not supported in this release) and carry your settings into conf/application.yml. The upgrade guide and release notes list every breaking change.
Stopping, troubleshooting and building from source
To stop the server, run shutdown.bat or ./shutdown.sh from the same bin folder. If setup stops with an error, the banner prints the path of its log file, and running the script again with --debug gives a step-by-step trace. Developers who prefer to build OpenBRM themselves can run it from source with Gradle 8 using ./gradlew bootRun; a source build skips the setup script, so the database and JAVA_HOME have to be configured by hand.