diff --git a/env.example b/env.example index 0f06522f..edeecb32 100644 --- a/env.example +++ b/env.example @@ -2,6 +2,7 @@ # 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 @@ -17,14 +18,14 @@ # A trusted peer that will hold a node-level account until channel automation becomes affordable # The developer is used by default or you may specify your own # To disable this feature entirely overwrite the env with "null" -# LIQUIDITY_PROVIDER_PUB=null -# DISABLE_LIQUIDITY_PROVIDER=false -# PROVIDER_RELAY_URL= +#LIQUIDITY_PROVIDER_PUB=null +#DISABLE_LIQUIDITY_PROVIDER=false +#PROVIDER_RELAY_URL= #SWAPS -# BOLTZ_HTTP_URL= -# BOLTZ_WEBSOCKET_URL= -# ENABLE_SWAPS=false +#BOLTZ_HTTP_URL= +#BOLTZ_WEBSOCKET_URL= +#ENABLE_SWAPS=false #DB #DATABASE_FILE=db.sqlite @@ -40,13 +41,17 @@ #LOCALHOST +# For REST Management #ADMIN_TOKEN= #PORT=1776 #JWT_SECRET= +#PUSH_SERVICE +# For Wallet notifs via FCM #SHOCK_PUSH_URL= -#Lightning Address Bridge +#LNA Bridge +# Tell wallets where they can get a noffer-based Lightning Address #BRIDGE_URL=https://shockwallet.app #LIGHTNING @@ -54,39 +59,26 @@ # Routing Fee Limit: What Pub allows LND to spend (max of BPS*amount or floor) # Routing fee limit must be <= service fee (validated at startup to ensure spread) # BPS are basis points, 100 BPS = 1% -#OUTGOING_INVOICE_FEE_USER_BPS=0 -#OUTBOUND_FEE_FLOOR_SATS=10 -#ROUTING_FEE_LIMIT_BPS=0 -#ROUTING_FEE_FLOOR_SATS=10 +#SERVICE_FEE_BPS=60 +#ROUTING_FEE_LIMIT_BPS=50 +#SERVICE_FEE_FLOOR_SATS=10 +#ROUTING_FEE_FLOOR_SATS=5 -# If the back-end doesn't have adequate channel capacity, buy one from an LSP -# Will execute when it costs less than 1% of balance and uses a trusted peer -#BOOTSTRAP=1 -#LSP -OLYMPUS_LSP_URL=https://lsps1.lnolymp.us/api/v1 -VOLTAGE_LSP_URL=https://lsp.voltageapi.com/api/v1 -FLASHSATS_LSP_URL=https://lsp.flashsats.xyz/lsp/channel -LSP_CHANNEL_THRESHOLD=1000000 -LSP_MAX_FEE_BPS=100 #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 +# Internal transaction fees (placeholder, bugged, do not use) +#TX_FEE_INTERNAL_ROOT_BPS=0 -#APP_FEES -# 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 +#LSP +# If the back-end doesn't have adequate channel capacity, buy one from an LSP +#OLYMPUS_LSP_URL=https://lsps1.lnolymp.us/api/v1 +#FLASHSATS_LSP_URL=https://lsp.flashsats.xyz/lsp/channel +#LSP_CHANNEL_THRESHOLD=1000000 +#LSP_MAX_FEE_BPS=100 + +# Use trusted peer until LSP costs less than ~1% of balance or threshold +#BOOTSTRAP=1 #NOSTR # Default relay may become rate-limited without a paid subscription @@ -96,9 +88,9 @@ LSP_MAX_FEE_BPS=100 #LNURL # 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 +# If undefined, LNURLs will be disabled but wallets may still use bridge for Lightning Addresses +# To enable, add a reachable https endpoint for requests +# You also need an SSL reverse proxy from the domain to the Pub # Read more at https://docs.shock.network #SERVICE_URL=https://yourdomainhere.xyz #LNURL_META_TEXT=LNURL via Lightning.Pub @@ -109,7 +101,7 @@ LSP_MAX_FEE_BPS=100 # Read more at https://docs.shock.network #SUBSCRIBER=1 -#DEV_OPTS +#DEV #MOCK_LND=false #ALLOW_BALANCE_MIGRATION=false #MIGRATE_DB=false @@ -121,10 +113,8 @@ LSP_MAX_FEE_BPS=100 #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 #ALLOW_RESET_METRICS_STORAGES=false -ALLOW_HTTP_UPGRADE=false +#ALLOW_HTTP_UPGRADE=false #WATCHDOG SECURITY # A last line of defense against 0-day drainage attacks @@ -133,3 +123,5 @@ ALLOW_HTTP_UPGRADE=false # 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 +# Disable outbound payments aka honeypot mode +#DISABLE_EXTERNAL_PAYMENTS=false \ No newline at end of file