LibrePortal/LibrePortal-Connect
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages 1 Wiki Activity Actions
Reach your home server from anywhere — no port forwarding, no exposed IP. A self-hostable relay that only ever sees encrypted traffic and keeps no logs. https://libreportal.org
17 commits 1 branch 2 tags 408 KiB
  • Go 92%
  • Shell 4.3%
  • HTML 3.3%
  • Dockerfile 0.4%
Find a file
Exact
LibrePortal 716daae45f Point the README at the new relay guide 
Assisted-by: Claude Opus 5 <noreply@anthropic.com>
2026-10-25 14:03:39 +00:00
cmd Let the operator set up and test BTCPay from a shell without a secret on the command line 2026-10-20 22:48:03 +01:00
docs Rewrite the README in plain words: what it is, who it is for, what you get, and where to learn more 2026-10-25 13:58:21 +00:00
internal Merge payments: hosted Connect payments through BTCPay, server linking and pausing 2026-10-20 22:44:12 +01:00
scripts Document the relay's new commands and add the release script 2026-10-20 22:54:26 +01:00
.dockerignore Start LibrePortal Connect: a relay that forwards only encrypted WireGuard 2026-09-17 12:46:34 +01:00
.gitignore Keep release builds out of the repository 2026-10-20 23:02:24 +01:00
Dockerfile Carry the account service in the same image as the relay 2026-10-20 22:46:07 +01:00
go.mod Give hosted Connect an account that is a number and nothing else 2026-09-20 13:14:28 +01:00
go.sum Give hosted Connect an account that is a number and nothing else 2026-09-20 13:14:28 +01:00
LICENSE Start LibrePortal Connect: a relay that forwards only encrypted WireGuard 2026-09-17 12:46:34 +01:00
README.md Point the README at the new relay guide 2026-10-25 14:03:39 +00:00

README.md

LibrePortal Connect

Reach your home server from anywhere. No port forwarding and no exposed IP address. Connect is a self-hostable relay that only ever sees encrypted traffic and keeps no logs.

It is for people whose server sits behind a home router or a mobile connection with no public address, and who still want to reach it from their phone or laptop. Think of a courier carrying a sealed box: it moves your traffic along, but only you hold the key.

What you get

  • It just works from outside. Your server makes an outbound connection to the relay, so you do not open anything at home.
  • Private by design. The relay carries traffic that is already encrypted by your own VPN. It never holds a key, so it cannot read or change anything.
  • No logs. It does not write down anyone's address or keep traffic records.
  • Nothing special on your devices. Use the normal WireGuard app, pointed at the relay.
  • Run your own for free, or use the hosted relay at libreportal.org. Everything the hosted service does, you can do yourself.

Get started

  • With LibrePortal: open the control panel, go to the VPN page and turn on "Reachable remotely via Connect". See Connect on the wiki.
  • Run your own relay: install the LibrePortal Connect app from the LibrePortal catalogue on a small public server (a cheap VPS is plenty). See Run your own Connect relay.
  • Without LibrePortal: any Linux server with WireGuard can use it; see docs/operators.md.

Learn more

Building from source: see docs/operators.md.

Contributing and reporting problems

Found a bug or have an idea? Open an issue. Please never post passwords, keys or other secrets in an issue; describe the problem and we will say what to share. Security problems: use the report a bug page rather than a public issue. Pull requests are welcome.

Licence

GNU AGPL-3.0-or-later.