selfhost.directory

The index of self-hostable projects — ranked, categorized and served with live updates.
Own your data and stop giving it to big tech.

GitHub
satdress logo

Self-host satdress

v0.8.0

Federated Lightning Address server for self-hosting

BetaOpen SourceMIT
Updated3 years ago
LanguageGo
Setup difficultyModerate
Stars
168
Port
17422 (HTTP server for Lightning Address API and web UI)
Install with Docker Compose

What is satdress?

Satdress is a self-hosted Federated Lightning Address server that enables users to create human-readable Lightning addresses (like user@yourdomain.com) connected to their own Lightning Network nodes. It supports multiple Lightning node backends including LND, CLN (via Commando or Sparko), Eclair, LNPay, and LNbits. The server uses an embedded Pebble database for storage and requires no external database. It can serve multiple domains from a single instance and provides a web UI for users to claim and manage their addresses. Configuration is done entirely through environment variables. The project is written in Go and can be run as a binary, via Docker, or with Docker Compose.

Should you self-host satdress?

satdress scores 40/100 on selfhost.directory (how scoring works) and ranks #35 of 42 in Cryptocurrency. It has 168 GitHub stars.

There was no stable release in the past 12 months, so check the repository's recent activity before you rely on it.

Setup is moderate: expect some configuration beyond a single command. It is MIT-licensed and written mostly in Go.

Its closest alternative on selfhost.directory is Bitcoin Core (86/100, 90 528 stars). It scores higher overall, so compare the two before you pick. See satdress vs Bitcoin Core side by side.

Features

  • Embedded Database
  • Lightning Address Support
  • LNURL-pay support
  • Multiple Domain Support
  • Multiple Lightning node backends
  • Tor Support
  • Web-based address claiming

satdress README

How to install satdress

Install satdress with Docker Compose

Environment variables
PORT, DOMAIN, SECRET, SITE_OWNER_URL, SITE_OWNER_NAME, SITE_NAME

version: "3.7"

services: satdress: build: . container_name: satdress environment: - PORT=17422 - DOMAIN=satdress.com - SECRET=askdbasjdhvakjvsdjasd - SITE_OWNER_URL=https://t.me/fiatjaf - SITE_OWNER_NAME=@fiatjaf - SITE_NAME=Satdress ports: - 17422:17422 volumes: - satdress-data:/satdress.com

volumes: satdress-data: name: satdress-data

Builds from local Dockerfile; replace environment variables with your own values

How to configure satdress

  • DOMAINDomain(s) for Lightning addresses (comma-separated for multiple)

    Domain(s) for Lightning addresses (comma-separated for multiple)

  • FORCE_MIGRATEfalseForce database migration on startup

    Force database migration on startup

    values: true,false

  • GLOBAL_USERSfalseMake user@ part unique across all domains (breaks existing users when enabled)

    Make user@ part unique across all domains (breaks existing users when enabled)

    values: true,false

  • HOST0.0.0.0Host address to bind to

    Host address to bind to

  • PORT17422Port the server listens on

    Port the server listens on

  • SECRETSecret key for encryption/signing

    Secret key for encryption/signing

  • SITE_NAMEName of the service displayed in the UI

    Name of the service displayed in the UI

  • SITE_OWNER_NAMEName of the site owner displayed in the UI

    Name of the site owner displayed in the UI

  • SITE_OWNER_URLURL linking to the site owner (e.g., Telegram, website)

    URL linking to the site owner (e.g., Telegram, website)

  • TOR_PROXY_URLTor proxy URL for making invoice requests over Tor

    Tor proxy URL for making invoice requests over Tor

satdress releases & version history

More in Fintech

Rate this project

Click to rate — no account needed.

0 comments

Posting as guest
Loading comments…