Your own edition of the app
For developers. Make your own named, coloured edition of the LibrePortal app from one small folder, installed beside the stock app, with your own release address and your own screens.
On this page
An edition is the LibrePortal app with your name, your identity (package name, link scheme, folders) and your own release address. It installs beside the stock app on the same computer or phone, and the two share nothing: not a folder, not a saved password, not a notification channel, not a link and not a background helper.
You do not change the code. You write one small brand folder and build with it.
What goes in the brand folder#
brand.properties: a name, an id and an Android package id are required. Everything else is worked out from them, never from the stock app's values.theme.json: optional colours laid over the app's theme. Each is kept readable, so a light button text is never lost.- Icons: a PNG for the window, launcher and installer, and a folder of Android resources for the phone.
defaults.json: a first-start theme and preloaded servers.
What the build refuses#
An edition cannot pretend to be the stock app. The build stops if the package is in org.libreportal.*, if it uses the stock app's signing certificate, or if a value is not plain text.
Your own screens#
An edition can add its own pages, status chips and notifications about its own software, hide or reorder the app's own entries, and run its own actions. This part of the interface is marked experimental and has a version number, so an old edition keeps working when it changes.
Licence#
The app is AGPL-3.0-or-later, so an edition is too. Your own screens ship as source with it.
The full guide#
The step-by-step guide, with every key, lives in the app's source: docs/editions. See also Building from source.