Account

Default account #

Since v3.2.0, there is no default account. On a fresh installation, BorgWarehouse redirects you to the setup wizard (/setup) where you create the first admin account with the username and password of your choice.

The password can be changed by clicking on the account icon in the upper right corner :

And change your password :

Date format #

Since v3.2.0, you can choose how dates are displayed throughout BorgWarehouse (last save, repository list, etc.).

Four formats are available :

The setting is saved per user and applies immediately across the interface.

Alerting #

Email #

By activating this option you will receive an email if one of your repositories has a down status.

The email alerts are triggered once every 24 hours for each repository. In order to limit the email flow, you can’t receive more than one alert every 24 hours for a down for each repository.

Also, let’s take the example of a simultaneous down of 5 repositories, you will not receive 5 different emails but only one with the list of repositories down in it.

Here is an example of an email alert :

Send a test mail #

You cand send a test email to test your SMTP configuration and to be sure that everything is okay ! Just click on the button and wait. Here is the email you should receive :

Email alerts dependencies #

This email alert is dependent on :

• Cron task checkStatus. Check the documentation here.
• SMTP configuration. Check the documentation here.

Apprise #

Apprise alert switch #

By activating the “Apprise alert” option you will receive a notification on all your configured service if one of your repositories has a down status. Within the limit of one alert every 24 hours for each status down.

Apprise URLs #

For each service (Discord, Matrix, SMS, Mattermost…) to notify, there is a different Apprise URL. You can find the URL syntax for each service on this documentation.

The number of services that can be notified is unlimited.

Apprise Mode #

• If Apprise is installed as a Python package (pip install apprise) on the same server as your BorgWarehouse application, select Local package.
• If you have a stateless API server for Apprise, select Stateless API server and provide an Apprise stateless API URL.

Example of notifications #

• Discord :

  

• Matrix (Element) :

  

Webhook #

Since v3.2.0, BorgWarehouse includes a built-in webhook notification system. This allows you to send alerts to any HTTP endpoint without requiring Apprise or an external notification service.

This is particularly useful for integrating with tools like n8n, Uptime Kuma, Make, chat clients, or any custom receiver.

Webhook alert switch #

By activating the Webhook alert option, BorgWarehouse will send a POST request to your configured URL when one or more repositories have a down status. The same 24-hour rate-limiting as email and Apprise applies.

Webhook URL #

Enter the full URL of the endpoint that should receive the alert. Leave it empty to disable.

Webhook secret (optional) #

If your endpoint requires authentication, you can set a secret. It will be sent as the X-BorgWarehouse-Secret header with every request.

Payload format #

BorgWarehouse sends a POST request with a JSON body:

{
  "status": "down",
  "repos": ["my-server", "my-nas"],
  "timestamp": 1715000000
}

• status : "down" for a real alert, "test" for a test call.
• repos : list of repository names that are currently down.
• timestamp : Unix timestamp (seconds) of when the alert was triggered.

Send a test webhook #

Click the Test button to send a test payload to your configured URL and verify that your endpoint receives it correctly.

Integrations #

Integrations is a new feature with BorgWarehouse v2.4.0 !

This new menu lets you generate and delete API authentication tokens. With these tokens, you can create, modify and delete your repositories, as well as retrieve their information.

BorgWarehouse’s REST APIs enable you to control your application with any other software via these tokens.

Give your token a name, select one or more rights for it and click generate 🪄.

Your token appears. You can copy it with one click. Please note that it will not be possible to display it again.

You can, of course, delete a token by clicking on the red garbage can, then on the “confirm” button. The token will be immediately deleted and unusable.

Sessions #

Since v3.2.0, sessions are stored in a SQLite database. The session lifetime is configured by the administrator via the SESSION_EXPIRY_SECONDS environment variable (default: 1 hour). See environment variables →

To revoke all active sessions (forces every user to log in again), an administrator can run:

# Baremetal
pnpm revoke:sessions

# Docker
docker exec borgwarehouse pnpm --dir /home/borgwarehouse/app revoke:sessions

Linked accounts (OAuth) #

If OAuth providers are configured by the administrator, you can link and unlink external accounts (GitHub, Google, Microsoft, GitLab, OIDC) from Account Settings → Linked accounts.

Linking an account allows you to sign in with that provider in addition to (or instead of) your password. You cannot unlink the last active sign-in method.

See OAuth/OIDC configuration →