README.md

Satdress

Lightning Address Server

How to run

Before you begin you'll want to setup a Lightning backend, for example phoenixd.

1. Compile satdress and satdress-cli by running make. This will run go build and go build ./cli/satdress-cli.go.
2. Copy and edit the sample config at config-sample.yml, you can create keys and output wallet connection strings with satdress-cli.
3. Start the app with ./satdress --conf <path/to/config.yml>.
4. Copy satdress to the system (e.g. /var/local/bin/satdress).
5. Configure, install and enable the daemon scripts (e.g. scripts/lightning-address.service to /etc/systemd/system/lightning-address.service).

Features

• Lightning Address
• NIP-57 (Nostr Lightning Zaps)
• NIP-47 (Nostr Wallet Connect)

Backends

Full support:

• Phoenix (phoenixd)

Limited support:

• Commando (Core Lightning)
• Sparko
• LND
• LNBits
• LNPay
• Eclair

Docker Build

Build the image:

docker build -t satdress .

Notes:

• The datadir is a docker volume and is mounted at /var/lib/satdress.
• The configuration file is a docker secret and is expected to be mounted at /run/secrets/satdress.yml.

Create a secret for the service:

docker secret create satdress.yml ./config.yml

Create and start the service using the secret config:

docker service create --name satdress --secret satdress.yml satdress:latest

Screenshots