Getting help

Reports go to the issue tracker of the repository, under one of two templates. There is no support desk behind them: an answer is a best effort, not a service commitment.

A vulnerability is not an issue

Report it privately, through Security → Advisories → Report a vulnerability. If private reporting is unavailable to you, open a public issue saying only that you have a security report and asking for a channel, with no details. SECURITY.md has the scope and what a useful report carries.

Before you write

Read Troubleshooting for what breaks in a running application, and Startup failures for a stack that will not come up. Most first reports are one of those, and both name the log line to look at.

A bug report

The template asks for five things, and the last three are what decide whether anybody can act on it:

• What happened, and what you expected instead.
• Steps to reproduce, numbered from a screen you can name.
• Area: the interface, accessibility, the API, import and restore, prices and integrations, auth and sessions, deployment, or not sure.
• Version, as Settings → About reports it. A -dev suffix means a build made from main rather than from a release, which is worth saying as it stands.
• Environment: how you run it, and the browser if the problem is in the interface.

A logs box takes docker compose logs app or the browser console where either is relevant.

Scrub the figures first

Badlen holds your financial data, and an issue is public and permanent. Take the amounts, the account numbers and the names out of anything you paste, a log excerpt and a screenshot included.

A feature request

The other template asks for the need rather than the implementation: what is impossible or tedious today, how you imagine it working if you have an opinion, and the area it falls in.

One field is worth filling in properly. A request for a new data source asks which provider, and whether it has a free or keyless endpoint: Badlen only ships sources a self-hoster can reach without a paid contract, so a provider behind one is a request that cannot be taken whatever its merits.

A question that is not a report

The repository takes blank issues, so a question that fits neither template still has a place. Say which page of this site you read and what it left open. That is also how a page here gets fixed.

Changing something yourself is Contributing.