Getting help

The repository takes reports in two places, depending on what you have to say. A defect you can reproduce and a feature you want go to the issue tracker, under one of two templates. A question, a problem you cannot name yet and help getting an installation up go to Discussions. Neither is a support desk: answers are given on a best-effort basis, in the discussions as anywhere else.

A vulnerability is neither an issue nor a discussion

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 covers the scope and what a useful report contains.

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 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 the output of 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

Ask it in Discussions, along with anything you cannot yet state as steps: an installation that will not come up, a figure that does not read the way you expected, a choice you are weighing. Say which page of this site you read and what it left open. That is also how a page here gets fixed. What comes out of a discussion as a reproducible defect becomes an issue afterwards.

To change something yourself, see Contributing.