readme
This commit is contained in:
shocknet-justin
parent
ff5d7ec283
commit
0deb063cee
1 changed files with 295 additions and 280 deletions
575
README.md
575
README.md
|
|
@ -1,280 +1,295 @@
|
||||||
# Lightning.Pub
|
# Lightning.Pub
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[](http://makeapullrequest.com)
|
[](http://makeapullrequest.com)
|
||||||
[](https://t.me/ShockBTC)
|
[](https://t.me/ShockBTC)
|
||||||
|
|
||||||
|
|
||||||
### Don't just run a Lightning Node, run a Lightning Pub.
|
### Don't just run a Lightning Node, run a Lightning Pub.
|
||||||
|
|
||||||
"Pub" is a [Nostr](https://nostr.info)-native account system designed to make running Lightning infrastructure for your friends/family/customers easier than previously thought possible.
|
"Pub" is a [Nostr](https://nostr.info)-native account system designed to make running Lightning infrastructure for your friends/family/customers easier than previously thought possible.
|
||||||
|
|
||||||
Lightning payments open the door to a new internet, but because of UX challenges with sovereignty we've seen a much slower uptake than we should for something so amazing.
|
Lightning payments open the door to a new internet, but because of UX challenges with sovereignty we've seen a much slower uptake than we should for something so amazing.
|
||||||
|
|
||||||
It may come as a surprise that the biggest hurdle to more adoption via Family and SMB Lightning nodes hasn't been with Bitcoin/Lightning node management itself, as we've seen that liquidity is easily automated, but rather the legacy baggage of traditional Client-Server web infrastructure. Things like IP4, Reverse Proxies, DNS, Firewalls and SSL certificates, all require a personal configuration that is a hurdle for most.
|
It may come as a surprise that the biggest hurdle to more adoption via Family and SMB Lightning nodes hasn't been with Bitcoin/Lightning node management itself, as we've seen that liquidity is easily automated, but rather the legacy baggage of traditional Client-Server web infrastructure. Things like IP4, Reverse Proxies, DNS, Firewalls and SSL certificates, all require a personal configuration that is a hurdle for most.
|
||||||
|
|
||||||
Tor as a workaround has proven too slow and unreliable, and a dead-end for clearnet-web usecases.
|
Tor as a workaround has proven too slow and unreliable, and a dead-end for clearnet-web usecases.
|
||||||
|
|
||||||
Mobile nodes are easy to use for spending, but channels for every device is expensive and unscalable. UX suffers from the limitations of the node not being an always-online server, which also makes them largely useless for merchants and routing services that earn revenue while you sleep.
|
Mobile nodes are easy to use for spending, but channels for every device is expensive and unscalable. UX suffers from the limitations of the node not being an always-online server, which also makes them largely useless for merchants and routing services that earn revenue while you sleep.
|
||||||
|
|
||||||
Pub solves these challenges with a P2P-like design that is also web-friendly, by implementing a full RPC that is Nostr-native. Being Nostr-native eliminates the complexity of configuring your node like a server by using commodity Nostr relays. These relays, unlike LNURL proxies, are trustless by nature of Nostr's own encryption spec (NIP44).
|
Pub solves these challenges with a P2P-like design that is also web-friendly, by implementing a full RPC that is Nostr-native. Being Nostr-native eliminates the complexity of configuring your node like a server by using commodity Nostr relays. These relays, unlike LNURL proxies, are trustless by nature of Nostr's own encryption spec (NIP44).
|
||||||
|
|
||||||
Additionally, support for optional services are integrated into Pub for operators seeking backward compatibility with legacy LNURLs and Lightning Addresses.
|
Additionally, support for optional services are integrated into Pub for operators seeking backward compatibility with legacy LNURLs and Lightning Addresses.
|
||||||
|
|
||||||
By solving the networking and programability hurdles, Pub provides Lightning with a 3rd Layer that enables node-runners, Busineses, and Uncle Jims to more easily bring their personal network into Bitcoin's permissionless economy. In doing so, Pub runners can keep the Lightning Network decentralized, with custodial scaling that is free of fiat rails, large banks, and other forms of high-time-preference shitcoinery.
|
By solving the networking and programability hurdles, Pub provides Lightning with a 3rd Layer that enables node-runners, Busineses, and Uncle Jims to more easily bring their personal network into Bitcoin's permissionless economy. In doing so, Pub runners can keep the Lightning Network decentralized, with custodial scaling that is free of fiat rails, large banks, and other forms of high-time-preference shitcoinery.
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
- [Features](#features)
|
- [Features](#features)
|
||||||
- [Planned Features](#planned-features)
|
- [Planned Features](#planned-features)
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [One-Line Deployment](#one-line-deployment)
|
- [One-Line Deployment](#one-line-deployment)
|
||||||
- [Docker Installation](#docker-installation)
|
- [Docker Installation](#docker-installation)
|
||||||
- [Manual CLI Installation](#manual-cli-installation)
|
- [Manual CLI Installation](#manual-cli-installation)
|
||||||
- [Usage Notes](#usage-notes)
|
- [Usage Notes](#usage-notes)
|
||||||
- [Connecting to ShockWallet](#connecting-to-shockwallet)
|
- [Connecting to ShockWallet](#connecting-to-shockwallet)
|
||||||
- [Lightning Address](#lightning-address)
|
- [Lightning Address](#lightning-address)
|
||||||
- [Node Type](#node-type)
|
- [Advanced Configuration](#advanced-configuration)
|
||||||
- [Running Your Own Nostr Relay](#running-your-own-nostr-relay)
|
- [Custom Nostr Relay](#custom-nostr-relay)
|
||||||
- [Bootstrap vs Self-Hosted Mode](#bootstrap-vs-self-hosted-mode)
|
- [Bootstrap Liquidity Provider](#bootstrap-liquidity-provider)
|
||||||
- [Configuration](#configuration)
|
- [Custom Lightning Address Domain](#custom-lightning-address-domain)
|
||||||
- [Support Development](#support-development)
|
- [Support Development](#support-development)
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **Zero Network Configuration Required** - No port forwarding, Tor setup, firewall rules, or DNS configuration needed! Pub uses Nostr relays for all communication, making it perfect for users who want sovereignty without networking complexity.
|
- **Zero Network Configuration Required** - No port forwarding, Tor setup, firewall rules, or DNS configuration needed! Pub uses Nostr relays for all communication, making it perfect for users who want sovereignty without networking complexity.
|
||||||
- Wrapper for [`LND`](https://github.com/lightningnetwork/lnd/releases) that can serve accounts over LNURL and NOSTR
|
- Wrapper for [`LND`](https://github.com/lightningnetwork/lnd/releases) that can serve accounts over LNURL and NOSTR
|
||||||
- A growing number of [methods](https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md)
|
- A growing number of [methods](https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md)
|
||||||
- Automated Channels
|
- Automated Channels
|
||||||
- Receives quotes from multiple LSPs including Zeus, Voltage, and Flashsats
|
- Receives quotes from multiple LSPs including Zeus, Voltage, and Flashsats
|
||||||
- Bootstrap Peering
|
- Bootstrap Peering
|
||||||
- A pub node may trust another pub node until it can afford a channel
|
- A pub node may trust another pub node until it can afford a channel
|
||||||
- Can be disabled via environment variable for full sovereignty
|
- Can be disabled via environment variable for full sovereignty
|
||||||
- Accounting SubLayers for Application Pools and Users
|
- Accounting SubLayers for Application Pools and Users
|
||||||
- A fee regime allows applications owners to monetize users, or node operators to host distinctly monetized applications.
|
- A fee regime allows applications owners to monetize users, or node operators to host distinctly monetized applications.
|
||||||
- **Complete Lightning Solution** - No additional LN node or Bitcoin full node required (uses Neutrino)
|
- **Complete Lightning Solution** - No additional LN node or Bitcoin full node required (uses Neutrino)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
- Connecting via ShockWallet is as easy as pasting an nprofile
|
- Connecting via ShockWallet is as easy as pasting an nprofile
|
||||||
- Or use a link to share your nprofile with friends and family
|
- Or use a link to share your nprofile with friends and family
|
||||||
|
|
||||||
<img src="https://cdn.shockwallet.app/add_src_sm.png" height="20%" alt="Connect Wallet"> <img src="https://cdn.shockwallet.app/src_invite_sm.png" height="20%" alt="Invite Guests">
|
<img src="https://cdn.shockwallet.app/add_source.png" height="20%" alt="Connect Wallet"> <img src="https://cdn.shockwallet.app/invites.png" height="20%" alt="Invite Guests">
|
||||||
|
|
||||||
## Planned Features
|
## Planned Features
|
||||||
|
|
||||||
- [x] A management dashboard is actively being integrated into [ShockWallet](https://github.com/shocknet/wallet2)
|
- [x] A management dashboard is actively being integrated into [ShockWallet](https://github.com/shocknet/wallet2)
|
||||||
- [x] Nostr native [CLINK](https://clinkme.dev) "offers"
|
- [x] Nostr native [CLINK](https://clinkme.dev) "offers"
|
||||||
- [x] Encrypted Push Notifications
|
- [x] Encrypted Push Notifications
|
||||||
- [ ] P2P "LSP" coordination for channel batching over Nostr
|
- [ ] Swap integration
|
||||||
- [ ] Swap integration
|
- [ ] P2P "LSP" coordination for channel batching over Nostr
|
||||||
- [ ] High-Availabilty / Clustering
|
- [ ] High-Availabilty / Clustering
|
||||||
|
|
||||||
Dashboard Wireframe:
|
Dashboard Wireframe:
|
||||||
|
|
||||||
<img src="https://shockwallet.b-cdn.net/pub_home_ss.png" alt="Pub Dashboard" width="240">
|
<img src="https://shockwallet.b-cdn.net/pub_home_ss.png" alt="Pub Dashboard" width="240">
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### One-Line Deployment
|
### One-Line Deployment
|
||||||
|
|
||||||
Paste one-line and have a Pub node in under 2 minutes. It uses neutrino so you can run it on a $5 VPS or old laptop.
|
Paste one-line and have a Pub node in under 2 minutes. It uses neutrino so you can run it on a $5 VPS or old laptop.
|
||||||
|
|
||||||
This method installs all dependencies and creates user-level systemd services.
|
This method installs all dependencies and creates user-level systemd services.
|
||||||
|
|
||||||
**Platform Support:**
|
**Platform Support:**
|
||||||
- ✅ **Debian/Ubuntu**: Fully tested and supported
|
- ✅ **Debian/Ubuntu**: Fully tested and supported
|
||||||
- ✅ **Arch/Fedora**: Fully tested and supported
|
- ✅ **Arch/Fedora**: Fully tested and supported
|
||||||
- 🚧 **macOS**: Basic support stubbed in, but untested. Help wanted.
|
- 🚧 **macOS**: Basic support stubbed in, but untested. Help wanted.
|
||||||
|
|
||||||
> [!IMPORTANT]
|
> [!IMPORTANT]
|
||||||
> **System Requirements:**
|
> **System Requirements:**
|
||||||
> - **RAM**: Minimum 2GB burstable in headless containers or VPS. 4+GB recommended for full Linux Desktop OS.
|
> - **RAM**: Minimum 2GB burstable in headless containers or VPS. 4+GB recommended for full Linux Desktop OS.
|
||||||
> - **Storage**: 20GB of space for compact blocks.
|
> - **Storage**: 20GB of space for compact blocks.
|
||||||
> - **Network**: No port forwarding, Tor, or firewall configuration needed! Pub uses Nostr relays for communication to eliminate traditional server networking requirements.
|
> - **Network**: No port forwarding, Tor, or firewall configuration needed! Pub uses Nostr relays for communication to eliminate traditional server networking requirements.
|
||||||
|
|
||||||
> [!TIP]
|
> [!TIP]
|
||||||
> **Bundled Node**: The Lightning.Pub install script provides a complete Lightning solution. You do NOT need to a full Bitcoin or other node, perfect small devices like Raspberry Pi.
|
> **Bundled Node**: The Lightning.Pub install script provides a complete Lightning solution. You do NOT need to a full Bitcoin or other node, perfect small devices like Raspberry Pi.
|
||||||
|
|
||||||
To start, run the following command:
|
To start, run the following command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
wget -qO- https://deploy.lightning.pub | bash
|
wget -qO- https://deploy.lightning.pub | bash
|
||||||
```
|
```
|
||||||
|
|
||||||
It should look like this in a minute or so
|
It should look like this in a minute or so
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Note:** The installation is now confined to user-space, meaning:
|
**Note:** The installation is now confined to user-space, meaning:
|
||||||
- No sudo required for installation
|
- No sudo required for installation
|
||||||
- All data stored in `$HOME/lightning_pub/`
|
- All data stored in `$HOME/lightning_pub/`
|
||||||
|
|
||||||
**After Installation:**
|
**After Installation:**
|
||||||
- The installer will display an admin connection string (nprofile and secret separated by a colon) and a **QR code** for easy mobile setup
|
- The installer will display an admin connection string (nprofile and secret separated by a colon) and a **QR code** for easy mobile setup
|
||||||
- You can also access the connection info via web browser on Start9 and Umbrel appliances (releases forthcoming)
|
- You can also access the connection info via web browser on Start9 and Umbrel appliances (releases forthcoming)
|
||||||
- Copy the connection string or scan the QR code with ShockWallet to connect as administrator
|
- Copy the connection string or scan the QR code with ShockWallet to connect as administrator
|
||||||
|
|
||||||
**⚠️ Migration from Previous Versions:**
|
**⚠️ Migration from Previous Versions:**
|
||||||
Previous system-wide installations (as of 8.27.2025) need some manual intervention:
|
Previous system-wide installations (as of 8.27.2025) need some manual intervention:
|
||||||
1. Stop existing services: `sudo systemctl stop lnd lightning_pub`
|
1. Stop existing services: `sudo systemctl stop lnd lightning_pub`
|
||||||
2. Disable services: `sudo systemctl disable lnd lightning_pub`
|
2. Disable services: `sudo systemctl disable lnd lightning_pub`
|
||||||
3. Remove old systemd units: `sudo rm /etc/systemd/system/lnd.service /etc/systemd/system/lightning_pub.service`
|
3. Remove old systemd units: `sudo rm /etc/systemd/system/lnd.service /etc/systemd/system/lightning_pub.service`
|
||||||
4. Reload systemd: `sudo systemctl daemon-reload`
|
4. Reload systemd: `sudo systemctl daemon-reload`
|
||||||
5. Run the new installer: `wget -qO- https://deploy.lightning.pub | bash`
|
5. Run the new installer: `wget -qO- https://deploy.lightning.pub | bash`
|
||||||
|
|
||||||
Please report any issues to the [issue tracker](https://github.com/shocknet/Lightning.Pub/issues).
|
Please report any issues to the [issue tracker](https://github.com/shocknet/Lightning.Pub/issues).
|
||||||
|
|
||||||
#### Automatic updates
|
#### Automatic updates
|
||||||
|
|
||||||
These are controversial, so we don't include them. You can however add a line to your crontab to re-run the installer on your time preference and it will gracefully handle updating:
|
These are controversial, so we don't include them. You can however add a line to your crontab to re-run the installer on your time preference and it will gracefully handle updating:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Add to user's crontab (crontab -e) - runs weekly on Sunday at 2 AM
|
# Add to user's crontab (crontab -e) - runs weekly on Sunday at 2 AM
|
||||||
0 2 * * 0 wget -qO- https://deploy.lightning.pub | bash
|
0 2 * * 0 wget -qO- https://deploy.lightning.pub | bash
|
||||||
```
|
```
|
||||||
|
|
||||||
**Note:** The installer will only restart services if version checks deem necessary.
|
**Note:** The installer will only restart services if version checks deem necessary.
|
||||||
|
|
||||||
#### Troubleshooting
|
#### Troubleshooting
|
||||||
|
|
||||||
If the installation fails or services don't start properly, use these commands to diagnose:
|
If the installation fails or services don't start properly, use these commands to diagnose:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check service status
|
# Check service status
|
||||||
systemctl --user status lnd
|
systemctl --user status lnd
|
||||||
systemctl --user status lightning_pub
|
systemctl --user status lightning_pub
|
||||||
|
|
||||||
# View logs
|
# View logs
|
||||||
journalctl --user-unit lnd -f
|
journalctl --user-unit lnd -f
|
||||||
journalctl --user-unit lightning_pub -f
|
journalctl --user-unit lightning_pub -f
|
||||||
|
|
||||||
# Restart services if needed
|
# Restart services if needed
|
||||||
systemctl --user restart lnd
|
systemctl --user restart lnd
|
||||||
systemctl --user restart lightning_pub
|
systemctl --user restart lightning_pub
|
||||||
|
|
||||||
# Retrieve admin connection string (if installation completed but you need to find it again)
|
# Retrieve admin connection string (if installation completed but you need to find it again)
|
||||||
cat ~/lightning_pub/admin.connect
|
cat ~/lightning_pub/admin.connect
|
||||||
|
|
||||||
# Reset admin access (generates new admin.connect automatically)
|
# Reset admin access (generates new admin.connect automatically)
|
||||||
rm ~/lightning_pub/admin.npub
|
rm ~/lightning_pub/admin.npub
|
||||||
sleep 1 # Wait briefly for new admin.connect to re-generate
|
sleep 1 # Wait briefly for new admin.connect to re-generate
|
||||||
cat ~/lightning_pub/admin.connect
|
cat ~/lightning_pub/admin.connect
|
||||||
```
|
```
|
||||||
|
|
||||||
### Docker Installation
|
### Docker Installation
|
||||||
|
|
||||||
See the [Docker Installation Guide](DOCKER.md).
|
See the [Docker Installation Guide](DOCKER.md).
|
||||||
|
|
||||||
### Manual CLI Installation
|
### Manual CLI Installation
|
||||||
|
|
||||||
1. Run [LND](https://github.com/lightningnetwork/lnd/releases) if you aren't already:
|
1. Run [LND](https://github.com/lightningnetwork/lnd/releases) if you aren't already:
|
||||||
|
|
||||||
```ssh
|
```ssh
|
||||||
./lnd --bitcoin.active --bitcoin.mainnet --bitcoin.node=neutrino --neutrino.addpeer=neutrino.shock.network --feeurl=https://nodes.lightning.computer/fees/v1/btc-fee-estimates.json
|
./lnd --bitcoin.active --bitcoin.mainnet --bitcoin.node=neutrino --neutrino.addpeer=neutrino.shock.network --feeurl=https://nodes.lightning.computer/fees/v1/btc-fee-estimates.json
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Download and Install Lightning.Pub:
|
2. Download and Install Lightning.Pub:
|
||||||
|
|
||||||
```ssh
|
```ssh
|
||||||
git clone https://github.com/shocknet/Lightning.Pub && cd Lightning.Pub && npm i
|
git clone https://github.com/shocknet/Lightning.Pub && cd Lightning.Pub && npm i
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Configure values in the env file:
|
3. Configure values in the env file:
|
||||||
|
|
||||||
```ssh
|
```ssh
|
||||||
cp env.example .env && nano .env
|
cp env.example .env && nano .env
|
||||||
```
|
```
|
||||||
|
|
||||||
4. Start the service:
|
4. Start the service:
|
||||||
|
|
||||||
```ssh
|
```ssh
|
||||||
npm start
|
npm start
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage Notes
|
## Usage Notes
|
||||||
|
|
||||||
### Connecting to ShockWallet
|
### Connecting to ShockWallet
|
||||||
|
|
||||||
**For Administrators:**
|
**For Administrators:**
|
||||||
1. After installation, you'll see an admin connection string (format: `nprofile1...:token`) and a QR code
|
1. After installation, you'll see an admin connection string (format: `nprofile1...:token`) and a QR code
|
||||||
2. **Option 1**: Scan the QR code with ShockWallet mobile app
|
2. **Option 1**: Scan the QR code with ShockWallet mobile app
|
||||||
3. **Option 2**: Copy/paste the connection string into ShockWallet's node connection screen
|
3. **Option 2**: Copy/paste the connection string into ShockWallet's node connection screen
|
||||||
|
|
||||||
**For Guest Users:**
|
**For Guest Users:**
|
||||||
- The nprofile of the node (without the admin token) can be used to send invitation links to guests via the web version of ShockWallet
|
- The nprofile of the node (without the admin token) can be used to send invitation links to guests via the web version of ShockWallet
|
||||||
- The nprofile is stored in `$HOME/lightning_pub/app.nprofile` or the administrator can copy a link from the "Invite" page in ShockWallet
|
- The nprofile is stored in `$HOME/lightning_pub/app.nprofile` or the administrator can copy a link from the "Invite" page in ShockWallet
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> Connecting with wallet will create an account on the node, it will not show or have access to the full LND balance. Allocating existing funds to the admin user will be added to the operator dashboard in a future release.
|
> Connecting with wallet will create an account on the node, it will not show or have access to the full LND balance. Allocating existing funds to the admin user will be added to the operator dashboard in a future release.
|
||||||
|
|
||||||
### Lightning Address
|
### Lightning Address
|
||||||
|
|
||||||
When you run your own Lightning Pub, obtaining a Lightning Address is fully automated in ShockWallet. The wallet automatically:
|
When you run your own Lightning Pub, obtaining a Lightning Address is fully automated in ShockWallet. The wallet automatically:
|
||||||
1. Takes the CLINK offer from your Pub
|
1. Takes the CLINK offer from your Pub
|
||||||
2. Enrolls it at a LNURL bridge (creates a `@shockwallet.app` address)
|
2. Enrolls it at a LNURL bridge (creates a `@shockwallet.app` address)
|
||||||
3. This makes the Lightning Address trustless when payers support CLINK as it uses Nostr for communication instead of trusting the bridge to serve the correct invoice.
|
3. This makes the Lightning Address trustless when payers support CLINK as it uses Nostr for communication instead of trusting the bridge to serve the correct invoice.
|
||||||
|
|
||||||
> [!TIP]
|
> [!TIP]
|
||||||
> **CLINK Integration**: Your Pub's CLINK offers enable ShockWallet to connect to CLINK-compatible services, like [Stacker News](https://stacker.news), allowing you to send and receive payments without additional setup.
|
> **CLINK Integration**: Your Pub's CLINK offers enable ShockWallet to connect to CLINK-compatible services, like [Stacker News](https://stacker.news), allowing you to send and receive payments without additional setup.
|
||||||
|
|
||||||
**Alternative Options for Custom Lightning Addresses:**
|
For custom Lightning Address domains, see the [Advanced Configuration](#advanced-configuration) section.
|
||||||
|
|
||||||
1. **Run your own [Bridgelet](https://github.com/shocknet/bridgelet)**: A minimalist LNURL-P and Lightning Address bridge service that uses CLINK Offers. This gives you full control over your Lightning Address domain without trusting third-party bridges.
|
## Advanced Configuration
|
||||||
|
|
||||||
2. **Enable LNURL directly on Pub**: Set `SERVICE_URL` to your domain (e.g., `https://yourdomain.com`). Pub will serve LNURL callbacks directly. Requires an SSL reverse proxy pointing your domain to Pub's port.
|
Copy `env.example` to `.env` and customize settings:
|
||||||
|
```bash
|
||||||
### Running Your Own Nostr Relay
|
cp env.example .env
|
||||||
|
nano .env # or use your preferred editor
|
||||||
By default, Lightning.Pub uses the ShockNet relay. To use your own Nostr relay:
|
```
|
||||||
|
|
||||||
1. Set the `NOSTR_RELAYS` environment variable in your `.env` file:
|
> [!IMPORTANT]
|
||||||
```bash
|
> Environment variables set in `.env` will override any settings configured via the wizard or stored in the settings database table.
|
||||||
NOSTR_RELAYS=wss://your-relay-url.com
|
|
||||||
```
|
### Custom Nostr Relay
|
||||||
2. Multiple relays can be specified (space-separated):
|
|
||||||
```bash
|
By default, Lightning.Pub uses the ShockNet relay. To use your own:
|
||||||
NOSTR_RELAYS="wss://relay1.com wss://relay2.com wss://relay3.com"
|
|
||||||
```
|
```bash
|
||||||
3. The wizard interface (coming soon for Start9/Umbrel) will make this graphical
|
# Single relay
|
||||||
|
NOSTR_RELAYS=wss://your-relay-url.com
|
||||||
See `env.example` for all available configuration options.
|
|
||||||
|
# Multiple relays (space-separated)
|
||||||
### Bootstrap Liquidity Provider
|
NOSTR_RELAYS="wss://relay1.com wss://relay2.com wss://relay3.com"
|
||||||
|
```
|
||||||
By default, Lightning.Pub uses a bootstrap liquidity provider that provides initial channel funding as a service credit until you can afford your own channels. Pub compares rates from top LSPs and automatically requests a channel when needed.
|
|
||||||
|
The wizard interface (coming soon for Start9/Umbrel) will make this graphical.
|
||||||
You can disable this for full sovereignty via `DISABLE_LIQUIDITY_PROVIDER=true` in `.env`, or re-point to any other Lightning Pub (not just ShockNet's) via `LIQUIDITY_PROVIDER_PUB`.
|
|
||||||
|
### Bootstrap Liquidity Provider
|
||||||
### Configuration
|
|
||||||
|
By default, Lightning.Pub uses a bootstrap liquidity provider that provides initial channel funding as a service credit until you can afford your own channels. Pub compares rates from top LSPs and automatically requests a channel when needed.
|
||||||
Copy `env.example` to `.env` and customize settings:
|
|
||||||
```bash
|
```bash
|
||||||
cp env.example .env
|
# Disable for full sovereignty
|
||||||
nano .env # or use your preferred editor
|
DISABLE_LIQUIDITY_PROVIDER=true
|
||||||
```
|
|
||||||
|
# Or point to a different Pub instance
|
||||||
> [!IMPORTANT]
|
LIQUIDITY_PROVIDER_PUB=nprofile1...
|
||||||
> Environment variables set in `.env` will override any settings configured via the wizard or stored in the settings database table.
|
```
|
||||||
|
|
||||||
Key settings:
|
### Custom Lightning Address Domain
|
||||||
- `NOSTR_RELAYS`: Custom Nostr relay(s) to use
|
|
||||||
- `DISABLE_LIQUIDITY_PROVIDER`: Set to `true` to disable bootstrap liquidity provider (alternatively, set `LIQUIDITY_PROVIDER_PUB=null` or to the nprofile of a preferred Pub instance)
|
By default, ShockWallet automatically enrolls your CLINK offer at `@shockwallet.app`. For custom domains, you have two options:
|
||||||
- `BRIDGE_URL`: Configure which CLINK -> Suggets a LNURL bridge to wallets to use for Lightning Address enrollment (default: `https://shockwallet.app`)
|
|
||||||
- `SERVICE_URL`: Your domain URL for enabling LNURL directly on Pub (requires SSL via a reverse-proxy pointing to Pub's port)
|
**Option 1: Run your own [Bridgelet](https://github.com/shocknet/bridgelet)**
|
||||||
- See `env.example` for complete documentation
|
|
||||||
|
A minimalist LNURL-P and Lightning Address bridge service that uses CLINK Offers. This gives you full control over your Lightning Address domain without trusting third-party bridges.
|
||||||
Additional docs are WIP at [docs.shock.network](https://docs.shock.network)
|
|
||||||
|
**Option 2: Enable LNURL directly on Pub**
|
||||||
## Support Development
|
|
||||||
|
```bash
|
||||||
> [!IMPORTANT]
|
# Configure which LNURL bridge to suggest to wallets (default: https://shockwallet.app)
|
||||||
> ShockWallet and Lightning.Pub are free software. If you would like to see continued development, please show your [**support**](https://github.com/sponsors/shocknet) 😊
|
BRIDGE_URL=https://your-bridge.com
|
||||||
|
|
||||||
<img src="https://www.gnu.org/graphics/agplv3-with-text-162x68.png" alt="License">
|
# Enable LNURL callbacks directly on Pub (requires SSL reverse proxy pointing to Pub's port)
|
||||||
|
SERVICE_URL=https://yourdomain.com
|
||||||
## Warning
|
```
|
||||||
|
|
||||||
> [!WARNING]
|
### Complete Reference
|
||||||
> While this software has been used in a high-profile production environment for several years, it should still be considered bleeding edge. Special care has been taken to mitigate the risk of drainage attacks, which is a common risk to all Lightning APIs. An integrated Watchdog service will terminate spends if it detects a discrepancy between LND and the database, for this reason **IT IS NOT RECOMMENDED TO USE PUB ALONGSIDE OTHER ACCOUNT SYSTEMS** such as AlbyHub, LNBits, or BTCPay - this watchdog may however be disabled. While we give the utmost care and attention to security, **the internet is an adversarial environment and SECURITY/RELIABILITY ARE NOT GUARANTEED- USE AT YOUR OWN RISK**.
|
|
||||||
|
See `env.example` for complete documentation of all available settings.
|
||||||
|
|
||||||
|
Additional docs are WIP at [docs.shock.network](https://docs.shock.network)
|
||||||
|
|
||||||
|
## Support Development
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> ShockWallet and Lightning.Pub are free software. If you would like to see continued development, please show your [**support**](https://github.com/sponsors/shocknet) 😊
|
||||||
|
|
||||||
|
<img src="https://www.gnu.org/graphics/agplv3-with-text-162x68.png" alt="License">
|
||||||
|
|
||||||
|
## Warning
|
||||||
|
|
||||||
|
> [!WARNING]
|
||||||
|
> While this software has been used in a high-profile production environment for several years, it should still be considered bleeding edge. Special care has been taken to mitigate the risk of drainage attacks, which is a common risk to all Lightning APIs. An integrated Watchdog service will terminate spends if it detects a discrepancy between LND and the database, for this reason **IT IS NOT RECOMMENDED TO USE PUB ALONGSIDE OTHER ACCOUNT SYSTEMS** such as AlbyHub, LNBits, or BTCPay - this watchdog may however be disabled. While we give the utmost care and attention to security, **the internet is an adversarial environment and SECURITY/RELIABILITY ARE NOT GUARANTEED- USE AT YOUR OWN RISK**.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue