Like an email address, but for your Bitcoin! A massively simpler way for anyone to send you Bitcoin instantly on the Lightning Network.
git clone https://github.com/dolu89/ligess
cd ligess && yarn install
cp .env.example .env
# Edit .env with your info
yarn dev
git clone https://github.com/dolu89/ligess
# Edit `docker-compose.yml` with your details.
docker-compose up -d
You should be able to access to https://YOURDOMAIN.COM/.well-known/lnurlp/USERNAME and get a valid LUD-06 JSON response.
Now your Lightning address is configured as follow USERNAME@YOURDOMAIN.COM
In .env
config file or docker-compose
environment:
LIGESS_LN_BACKEND=LND
LIGESS_LND_REST=https://yourLNDRestAPI.com # can be an onion url
LIGESS_LND_MACAROON=hex string macaroon with invoice:create # should be a long (~265 character) string that you generate either on a CLI or in a UI.
The macaroon is what gives ligess the permissions to create invoices on behalf of your LND node.
The act of generating a macaroon is called "baking". If you're paying for hosting an LND node, there should be a UI. On Voltage, it's Connect > Other Macaroons > "Bake Other Macaroon". For self-hosted, there is a CLI tool to generate it.
More information on macaroons can be found here.
In .env
config file or docker-compose
environment:
LIGESS_LN_BACKEND=Eclair
LIGESS_ECLAIR_REST=http://eclair_rest_api # can be an onion url
LIGESS_ECLAIR_LOGIN=login
LIGESS_ECLAIR_PASSWORD=password
In .env
config file or docker-compose
environment:
LIGESS_LN_BACKEND=LNbits
LIGESS_LNBITS_DOMAIN=https://lnbits.com # can be replaced by your own LNbits isntance url
LIGESS_LNBITS_API_KEY=this1is2an3example # can be found at the right of your wallet page, under "API info" > "Invoice/read key"
For the standalone install, be sure to have Tor running on your computer.
For the Docker install, add (or uncomment) the following lines in 'docker-compose.yml` in order to run Tor as a Docker container:
tor:
image: lncm/tor:latest
restart: on-failure
command: --SocksPort 0.0.0.0:9050
expose:
- 9050
Then specify the Tor proxy URL in .env
config file or docker-compose
environment:
LIGESS_TOR_PROXY_URL=socks5h://127.0.0.1:9050 # standalone installation
# or
LIGESS_TOR_PROXY_URL=socks5h://tor:9050 # docker installation
For sending zap notes on Nostr, you have to supply a Nostr private Key in .env
that acts as the zap sender, in hex format.
LIGESS_NOSTR_ZAPPER_PRIVATE_KEY=this1is2an3example
To have zap requests working from web clients, and prevent CORS errors, make sure to add the following header to the web server configuration:
Access-Control-Allow-Origin "*";
You can help me by contributing to this project or by donating to my Lightning address dolu@bips.xyz
Other donation methods are avaible here https://bips.xyz/support