Connect Accounts

Hosted Connect Accounts

Networking LibrePortal Works with 3 apps

Run the account site for a hosted LibrePortal Connect relay: sign-ups, paid time through BTCPay, and linked servers

On this page

At a glance
Addresses and ports
Settings
In its config file
Tools
Works with
Privacy and security
What leaves this server
What LibrePortal turns off
Sources
Under the hood

Good to know before you install

Taking payments needs a public https domain and a BTCPay store, and pepper.key and box.key in its data cannot be recreated, so keep a copy of them elsewhere.

At a glance#

What it is: Hosted Connect Accounts Networking · made by the LibrePortal project
Where it opens: Account site On its own port at http://your-server:port, or account.your-domain once you have a domain
Updates: When you choose New versions wait for you to press Update
Backups: Included Part of the daily backup when that's switched on
Copies: One per server

There's no step-by-step guide for Connect Accounts here yet. Everything below comes straight from the app catalogue, so it's what LibrePortal really does when you install it. For using Connect Accounts itself, its own documentation is the place to go: git.libreportal.org/LibrePortal/LibrePortal-Connect.

Addresses and ports#

Connect Accounts has 2 ports. LibrePortal picks a free port number for each when you install, so yours will differ from anyone else's. The Config tab's Network section shows them, and the app's Open button uses the right one. "Anyone" means it's reachable from wherever your server is reachable; you can make it private later.

What it is	Who can reach it	With a domain
Account site	Anyone	`account.your-domain`
Operator API (BTCPay settings; keep private) TCP	Trusted places only	Port only

Settings#

In its config file#

Connect Accounts's own settings aren't on the Config tab yet. They live in the app's config file, described here so you know they exist. How to change them.

Setting	What it does	Starts as
Name `CFG_CONNECT_ACCOUNTS_DISPLAY_NAME`	What this app is called on your dashboards. Leave empty to use its usual name	Empty
Show on the LibrePortal Dashboard `CFG_CONNECT_ACCOUNTS_SHOW_ON_DASHBOARD`	Whether this app gets a shortcut on the front page of the LibrePortal WebUI, separate from any Dashy dashboard Choices: true, false	`false`
Relay Admin Address `CFG_CONNECT_ACCOUNTS_RELAY_ADMIN`	The relay's admin API, so accounts can link and pause servers; empty turns linking off	Empty
Relay Address `CFG_CONNECT_ACCOUNTS_RELAY_HOST`	Where servers are told to join, such as connect.example.org:51900	Empty

Tools#

Connect Accounts's Tools tab has 9 buttons for jobs you'd otherwise need a terminal for. Each one runs as a task, so you can watch it on the Tasks page and read what it did. More about Tools.

Connect BTCPay

Save your BTCPay server address, store id, API key and webhook secret. Leave a box empty to keep what is saved.

Asks for: BTCPay server address (optional), Store id (optional), API key (optional), Webhook secret (optional)

Test Connection

Ask BTCPay for your store with the saved key, to check the address, store id and key work.

Payment Settings

What is saved (secrets masked), the webhook address to paste into BTCPay, and whether the service is taking payments.

Prices

The prices, free trial and grace period the service uses, and whether you have confirmed them.

Confirm Prices

Say that the prices shown under Prices are right. Going live needs this.

Go Live

Start or stop taking payments. Turning it on is refused until BTCPay is connected and the prices are confirmed.

Asks for: Taking payments (optional)

List Accounts

Every account, when it was made and how many days it has left.

Add Time To Account

Give an account some days by hand, for a trial or to make up for a problem.

Asks for: Account id (from List Accounts), Days to add, Reason (optional)

Link To The Relay

Copy the connect relay's address and admin token from the connect app on this server, so accounts can link and pause servers. Restarts this app.

Works with#

These are the other apps Connect Accounts knows how to work with. Once it's installed, its page shows the same list with whether each one is connected. How this works.

Grafana: Shows dashboards for the apps that have one. works with every app
Prometheus: Collects metrics from the apps that can export them. works with every app
Uptime Kuma: Watches your apps and shows when one goes down. works with every app

Privacy and security#

All clear Connect Accounts is the sign-up site for a hosted LibrePortal Connect relay. It contacts only the BTCPay store you connect for payments.

What leaves this server#

Payments go through the BTCPay store you connect
Whoever runs a relay can see connection details such as addresses and timing, not contents

What LibrePortal turns off#

Nothing needed switching off.

Licence: AGPL-3.0-or-later. Audited: 21 October 2026. See the privacy of every app and the Promise.

Sources#

git.libreportal.org/LibrePortal/LibrePortal/src/branch/main/containers/connect_accounts

Under the hood#

It runs this image: git.libreportal.org/libreportal/libreportal-connect:0.2.0@sha256:7d4312a3446cf1a5c057d17635019995e39e0f5675fe9f271561a61c6992d886. The version is pinned, and moves only when you update it.
It can sit behind Authelia's sign-in once Authelia is installed.
Its own project and documentation: git.libreportal.org/LibrePortal/LibrePortal-Connect

Ports, settings, tools and connections on this page are read from LibrePortal v0.10.97's app catalogue each time the guide is built.

Next steps

Every appAll the apps in the App Center, with search and categories.App settingsEvery app page has the same tabs for settings, tools and backups.Tools and add-onsButtons for each app's everyday jobs, like adding users.