docs

env.example

@@ -1,52 +1,82 @@
-#LND
-LND_ADDRESS=127.0.0.1:10009
-LND_CERT_PATH=/root/.lnd/tls.cert
-LND_MACAROON_PATH=/root/.lnd/data/chain/bitcoin/mainnet/admin.macaroon
+# Example configuration for Lightning.Pub
+# Copy this file as .env in the Pub folder and uncomment the desired settings to override defaults
+# Alternatively, these settings can be passed as environment variables at startup
+
+#LND_CONNECTION
+# Defaults typical for straight Linux
+# Containers, Mac and Windows may need more detailed paths
+#LND_ADDRESS=127.0.0.1:10009
+#LND_CERT_PATH=~/.lnd/tls.cert
+#LND_MACAROON_PATH=~/.lnd/data/chain/bitcoin/mainnet/admin.macaroon
 
 #DB
-DATABASE_FILE=db.sqlite
-METRICS_DATABASE_FILE=metrics.sqlite
+#DATABASE_FILE=db.sqlite
+#METRICS_DATABASE_FILE=metrics.sqlite
 
-#LOCAL
-ADMIN_TOKEN=
-PORT=8080
-JWT_SECRET=bigsecrethere
+#LOCALHOST
+#ADMIN_TOKEN=
+#PORT=8080
+#JWT_SECRET=
 
 #LIGHTNING
-OUTBOUND_MAX_FEE_BPS=60
-OUTBOUND_MAX_FEE_EXTRA_SATS=100
+# Maximum amount in network fees passed to LND when it pays an external invoice
+# BPS are basis points, 100 BPS = 1%
+#OUTBOUND_MAX_FEE_BPS=60
+#OUTBOUND_MAX_FEE_EXTRA_SATS=100
 
-#ROOT_FEES 
-INCOMING_CHAIN_FEE_ROOT_BPS=0
-INCOMING_INVOICE_FEE_ROOT_BPS=0 
-OUTGOING_CHAIN_FEE_ROOT_BPS=60 #applied to application debits
-OUTGOING_INVOICE_FEE_ROOT_BPS=60 #applied to application debits
-TX_FEE_INTERNAL_ROOT_BPS=60 #applied to inter-application txns
+#ROOT_FEES
+# Applied to either debits or credits and sent to an admin account
+# BPS are basis points, 100 BPS = 1%
+#INCOMING_CHAIN_FEE_ROOT_BPS=0
+#INCOMING_INVOICE_FEE_ROOT_BPS=0
+# Chain spends are currently unstable and thus disabled, do not use until further notice
+#OUTGOING_CHAIN_FEE_ROOT_BPS=60
+# Outgoing Invoice Fee must be >= Lightning Outbound Max Fee so admins don't incur losses on spends
+#OUTGOING_INVOICE_FEE_ROOT_BPS=60
+# Internal user fees bugged, do not use until further notice
+#TX_FEE_INTERNAL_ROOT_BPS=0 #applied to inter-application txns
 
 #APP_FEES
-INCOMING_INVOICE_FEE_USER_BPS=0 #app default
-OUTGOING_INVOICE_FEE_USER_BPS=60 #app default
-TX_FEE_INTERNAL_USER_BPS=60 #intra-application tx default
+# An extra fee applied at the app level and sent to the application owner
+#INCOMING_INVOICE_FEE_USER_BPS=0
+#OUTGOING_INVOICE_FEE_USER_BPS=0
+#TX_FEE_INTERNAL_USER_BPS=0
 
 #NOSTR
-NOSTR_RELAYS=wss://strfry.shock.network
+# Default relay may become rate-limited without a paid subscription
+#NOSTR_RELAYS=wss://strfry.shock.network
 
 #LNURL
-#Note that a reachable https endpoint for the service to handle lnurl requests is required for lightning address bridges
-SERVICE_URL=https://test.lightning.pub
+# Optional
+# If undefined, LNURLs (including Lightning Address) will be disabled
+# To enable, add a reachable https endpoint for requests (or purchase a subscription)
+# You also need an SSL reverse proxy from the domain to this local host
+# Read more at https://docs.shock.network
+#SERVICE_URL=https://yourdomainhere.xyz
 
-#DEV
-MOCK_LND=false
-ALLOW_BALANCE_MIGRATION=false
-MIGRATE_DB=false
+#SUBSCRIPTION_SERVICES
+# Opt-in to cloud relays for LNURL and Nostr
+# A small monthly fee supports the developers
+# Read more at https://docs.shock.network
+#SUBSCRIBER=1
+
+#DEV_OPTS
+#MOCK_LND=false
+#ALLOW_BALANCE_MIGRATION=false
+#MIGRATE_DB=false
 
 #METRICS
-RECORD_PERFORMANCE=true
-SKIP_SANITY_CHECK=false
-DISABLE_EXTERNAL_PAYMENTS=false
+#RECORD_PERFORMANCE=true
+#SKIP_SANITY_CHECK=false
+# A read-only token that can be used with dashboard to view reports
+#METRICS_TOKEN=
+# Disable outbound payments aka honeypot mode
+#DISABLE_EXTERNAL_PAYMENTS=false
 
-# Max difference between users balance and LND balance since beginning of app execution
-WATCHDOG_MAX_DIFF_SATS=10000
-
-# Max difference between users balance and LND balance after each payment
-WATCHDOG_MAX_UPDATE_DIFF_SATS=1000
+#WATCHDOG SECURITY
+# A last line of defense against 0-day drainage attacks
+# This will monitor LND separately and terminate sends if a balance discrepency is detected
+# This setting defaults to 0 meaning no discrepency will be tolerated
+# Increase this values to add a spending buffer for non-Pub services sharing LND
+# Max difference between users balance and LND balance at Pub startup
+#WATCHDOG_MAX_DIFF_SATS=0