satdress/README.md

38 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2022-10-08 01:53:33 +00:00
<a href="https://nbd.wtf"><img align="right" height="196" src="https://user-images.githubusercontent.com/1653275/194609043-0add674b-dd40-41ed-986c-ab4a2e053092.png" /></a>
2021-08-14 23:52:16 +00:00
# Satdress
Federated Lightning Address Server
2021-08-15 00:07:13 +00:00
## How to run
1. Download the binary from the releases page (or compile with `go build` or `go get`)
2. Set the following environment variables somehow (using example values from bitmia.com):
```
PORT=17422
DOMAIN=bitmia.com
SECRET=askdbasjdhvakjvsdjasd
SITE_OWNER_URL=https://t.me/qecez
SITE_OWNER_NAME=@qecez
SITE_NAME=Bitmia
```
3. Start the app with `./satdress`
4. Serve the app to the world on your domain using whatever technique you're used to
2022-01-20 12:25:30 +00:00
## Multiple domains
2022-10-17 11:48:22 +00:00
Note that `DOMAIN` can be a single domain or a comma-separated list. When using multiple domains
2022-01-20 12:25:30 +00:00
you need to make sure "Host" HTTP header is forwarded to satdress process if you have some reverse-proxy).
If you come from an old installation everything should get migrated in a seamless way, but there is also a
2022-10-17 11:48:22 +00:00
`FORCE_MIGRATE` environment variable to force a migration (else this is done just the first time).
2022-01-20 12:25:30 +00:00
2022-10-17 11:48:22 +00:00
There is also a `GLOBAL_USERS` to make sure the user@ part is unique across all domains. But be warned that when enabling
2022-01-20 12:25:30 +00:00
this option, existing users won't work anymore (which is by design).
2021-08-15 00:07:13 +00:00
## Get help
Maybe ask for help on https://t.me/lnurl if you're in trouble.