lnbits/.env.example

QUART_APP=lnbits.app:create_app()
QUART_ENV=development
QUART_DEBUG=true

HOST=127.0.0.1
PORT=5000

LNBITS_ALLOWED_USERS=""
LNBITS_ADMIN_USERS=""
# Extensions only admin can access
LNBITS_ADMIN_EXTENSIONS="ngrok"
LNBITS_DEFAULT_WALLET_NAME="LNbits wallet"

LNBITS_AD_SPACE="" # csv ad image filepaths or urls, extensions can choose to honor
LNBITS_HIDE_API=false # Hides wallet api, extensions can choose to honor

# Disable extensions for all users, use "all" to disable all extensions
LNBITS_DISABLED_EXTENSIONS="amilk"

# Database: to use SQLite, specify LNBITS_DATA_FOLDER
#           to use PostgreSQL, specify LNBITS_DATABASE_URL=postgres://...
#           to use CockroachDB, specify LNBITS_DATABASE_URL=cockroachdb://...
# for both PostgreSQL and CockroachDB, you'll need to install
#   psycopg2 as an additional dependency
LNBITS_DATA_FOLDER="./data"
# LNBITS_DATABASE_URL="postgres://user:password@host:port/databasename"

LNBITS_FORCE_HTTPS=true
LNBITS_SERVICE_FEE="0.0"

# Change theme
LNBITS_SITE_TITLE="LNbits"
LNBITS_SITE_TAGLINE="free and open-source lightning wallet"
LNBITS_SITE_DESCRIPTION="Some description about your service, will display if title is not 'LNbits'"
# Choose from mint, flamingo, freedom, salvador, autumn, monochrome, classic
LNBITS_THEME_OPTIONS="classic, bitcoin, freedom, mint, autumn, monochrome, salvador"

# Choose from LNPayWallet, OpenNodeWallet, LntxbotWallet,
#             LndRestWallet, CLightningWallet, LNbitsWallet, SparkWallet, FakeWallet, EclairWallet
LNBITS_BACKEND_WALLET_CLASS=VoidWallet
# VoidWallet is just a fallback that works without any actual Lightning capabilities,
# just so you can see the UI before dealing with this file.

# Set one of these blocks depending on the wallet kind you chose above:
# SparkWallet
SPARK_URL=http://localhost:9737/rpc
SPARK_TOKEN=myaccesstoken

# CLightningWallet
CLIGHTNING_RPC="/home/bob/.lightning/bitcoin/lightning-rpc"

# LnbitsWallet
LNBITS_ENDPOINT=https://legend.lnbits.com
LNBITS_KEY=LNBITS_ADMIN_KEY

# LndRestWallet
LND_REST_ENDPOINT=https://127.0.0.1:8080/
LND_REST_CERT="/home/bob/.config/Zap/lnd/bitcoin/mainnet/wallet-1/data/chain/bitcoin/mainnet/tls.cert"
LND_REST_MACAROON="/home/bob/.config/Zap/lnd/bitcoin/mainnet/wallet-1/data/chain/bitcoin/mainnet/admin.macaroon or HEXSTRING"
# To use an AES-encrypted macaroon, set 
# LND_REST_MACAROON_ENCRYPTED="eNcRyPtEdMaCaRoOn"

# LNPayWallet
LNPAY_API_ENDPOINT=https://api.lnpay.co/v1/
# Secret API Key under developers tab
LNPAY_API_KEY=LNPAY_API_KEY
# Wallet Admin in Wallet Access Keys
LNPAY_WALLET_KEY=LNPAY_ADMIN_KEY

# LntxbotWallet
LNTXBOT_API_ENDPOINT=https://lntxbot.com/
LNTXBOT_KEY=LNTXBOT_ADMIN_KEY

# OpenNodeWallet
OPENNODE_API_ENDPOINT=https://api.opennode.com/
OPENNODE_KEY=OPENNODE_ADMIN_KEY

# FakeWallet
FAKE_WALLET_SECRET="ToTheMoon1"
LNBITS_DENOMINATION=sats

# EclairWallet
ECLAIR_URL=http://127.0.0.1:8283
ECLAIR_PASS=eclairpw
fix: lnbits.com deploy 2020-09-28 21:49:11 +00:00			`QUART_APP=lnbits.app:create_app()`
quart run settings and hypercorn on docker/Procfile. 2020-09-15 02:28:10 +00:00			`QUART_ENV=development`
change 1 to true on env vars because that is supported now. 2020-09-15 20:19:11 +00:00			`QUART_DEBUG=true`
quart run settings and hypercorn on docker/Procfile. 2020-09-15 02:28:10 +00:00
			`HOST=127.0.0.1`
			`PORT=5000`
refactor: abstract wallets 2019-12-14 09:13:27 +00:00
Update .env.example due to recent changes (#91) The name of the flask app has changed and the word "all" has been eliminated as unnecessary because allowing anyone to use lnbits is the default. 2020-09-07 14:05:50 +00:00			`LNBITS_ALLOWED_USERS=""`
Added admin users to .env 2022-01-31 12:04:12 +00:00			`LNBITS_ADMIN_USERS=""`
Organised .env 2022-02-07 20:48:48 +00:00			`# Extensions only admin can access`
			`LNBITS_ADMIN_EXTENSIONS="ngrok"`
refactor: breaking bad 2020-03-08 22:00:41 +00:00			`LNBITS_DEFAULT_WALLET_NAME="LNbits wallet"`
postgres support. 2021-06-22 02:22:52 +00:00
Added ad space and option to turn off api docs 2022-02-23 13:51:30 +00:00			`LNBITS_AD_SPACE="" # csv ad image filepaths or urls, extensions can choose to honor`
			`LNBITS_HIDE_API=false # Hides wallet api, extensions can choose to honor`

Organised .env 2022-02-07 20:48:48 +00:00			`# Disable extensions for all users, use "all" to disable all extensions`
			`LNBITS_DISABLED_EXTENSIONS="amilk"`

add more db instructions to .env.example. 2021-07-02 22:10:57 +00:00			`# Database: to use SQLite, specify LNBITS_DATA_FOLDER`
			`# to use PostgreSQL, specify LNBITS_DATABASE_URL=postgres://...`
			`# to use CockroachDB, specify LNBITS_DATABASE_URL=cockroachdb://...`
			`# for both PostgreSQL and CockroachDB, you'll need to install`
			`# psycopg2 as an additional dependency`
changes configuration of environment for Dockerfile and adds the installation procedure to the documentation 2021-03-19 11:27:41 +00:00			`LNBITS_DATA_FOLDER="./data"`
add more db instructions to .env.example. 2021-07-02 22:10:57 +00:00			`# LNBITS_DATABASE_URL="postgres://user:password@host:port/databasename"`
postgres support. 2021-06-22 02:22:52 +00:00
change 1 to true on env vars because that is supported now. 2020-09-15 20:19:11 +00:00			`LNBITS_FORCE_HTTPS=true`
feat: remove FEE_RESERVE 2020-04-21 13:44:02 +00:00			`LNBITS_SERVICE_FEE="0.0"`
refactor: breaking bad 2020-03-08 22:00:41 +00:00
added envs, testing color switch 2021-06-28 21:57:23 +00:00			`# Change theme`
Easier to customise title/tagline Also added description that can replace frontpage blurb 2021-07-02 11:31:05 +00:00			`LNBITS_SITE_TITLE="LNbits"`
			`LNBITS_SITE_TAGLINE="free and open-source lightning wallet"`
			`LNBITS_SITE_DESCRIPTION="Some description about your service, will display if title is not 'LNbits'"`
Added .env for theme 2022-04-20 10:20:39 +00:00			`# Choose from mint, flamingo, freedom, salvador, autumn, monochrome, classic`
			`LNBITS_THEME_OPTIONS="classic, bitcoin, freedom, mint, autumn, monochrome, salvador"`
added envs, testing color switch 2021-06-28 21:57:23 +00:00
Removes LNDRPC, if someone wants to fix we can implement again 2022-03-11 14:13:28 +00:00			`# Choose from LNPayWallet, OpenNodeWallet, LntxbotWallet,`
add eclair variables to .env example 2022-05-05 14:55:01 +00:00			`# LndRestWallet, CLightningWallet, LNbitsWallet, SparkWallet, FakeWallet, EclairWallet`
update docs so master is runnable. 2020-10-02 17:53:55 +00:00			`LNBITS_BACKEND_WALLET_CLASS=VoidWallet`
			`# VoidWallet is just a fallback that works without any actual Lightning capabilities,`
			`# just so you can see the UI before dealing with this file.`
chore: various tweaks 2020-04-16 15:10:53 +00:00
update docs so master is runnable. 2020-10-02 17:53:55 +00:00			`# Set one of these blocks depending on the wallet kind you chose above:`
			`# SparkWallet`
			`SPARK_URL=http://localhost:9737/rpc`
			`SPARK_TOKEN=myaccesstoken`

			`# CLightningWallet`
chore: minor tweaks 2020-04-21 21:47:16 +00:00			`CLIGHTNING_RPC="/home/bob/.lightning/bitcoin/lightning-rpc"`
chore: various tweaks 2020-04-16 15:10:53 +00:00
update docs so master is runnable. 2020-10-02 17:53:55 +00:00			`# LnbitsWallet`
Update .env.example 2022-01-14 09:43:30 +00:00			`LNBITS_ENDPOINT=https://legend.lnbits.com`
simplify environment variables required. instead of multiple keys/macaroons with different permissions we request only one. if someone wants to use lnbits with an invoice macaroon they're free to do it and we will just fail on 'pay' methods, as before. this also grandfathers the previous environment variables names so everything keeps working without people having to change their setups. in the meantime some bugs with lntxbot and c-lightning were fixed and the `requests` dependency was eliminated because I can't organize myself into meaningful chunks of changes. 2020-10-08 19:03:18 +00:00			`LNBITS_KEY=LNBITS_ADMIN_KEY`
refactor: a wallet is a wallet is a wallet 2020-03-31 17:05:25 +00:00
update docs so master is runnable. 2020-10-02 17:53:55 +00:00			`# LndRestWallet`
broken invoice listener on c-lightning and other fixes around wallets. 2020-10-03 20:27:55 +00:00			`LND_REST_ENDPOINT=https://127.0.0.1:8080/`
Update .env.example 2020-04-25 21:39:30 +00:00			`LND_REST_CERT="/home/bob/.config/Zap/lnd/bitcoin/mainnet/wallet-1/data/chain/bitcoin/mainnet/tls.cert"`
Update .env.example 2021-07-07 10:06:11 +00:00			`LND_REST_MACAROON="/home/bob/.config/Zap/lnd/bitcoin/mainnet/wallet-1/data/chain/bitcoin/mainnet/admin.macaroon or HEXSTRING"`
Support for encrypted macaroons (#521) * encrypted macaroons * fix GRPC env entry * example config entry * add pycryptodomex to requirements * documentation * Added pycryptodomex to pip file Co-authored-by: Ben Arc <ben@arc.wales> 2022-02-14 16:54:05 +00:00			`# To use an AES-encrypted macaroon, set`
			`# LND_REST_MACAROON_ENCRYPTED="eNcRyPtEdMaCaRoOn"`
Update .env.example 2020-04-25 21:39:30 +00:00
update docs so master is runnable. 2020-10-02 17:53:55 +00:00			`# LNPayWallet`
Update LNPay endpoint 2021-04-11 20:06:39 +00:00			`LNPAY_API_ENDPOINT=https://api.lnpay.co/v1/`
Adding comment for LNPay Adding what they are called in the website to add clarity 2021-06-04 18:24:14 +00:00			`# Secret API Key under developers tab`
chore: various tweaks 2020-04-16 15:10:53 +00:00			`LNPAY_API_KEY=LNPAY_API_KEY`
Adding comment for LNPay Adding what they are called in the website to add clarity 2021-06-04 18:24:14 +00:00			`# Wallet Admin in Wallet Access Keys`
simplify environment variables required. instead of multiple keys/macaroons with different permissions we request only one. if someone wants to use lnbits with an invoice macaroon they're free to do it and we will just fail on 'pay' methods, as before. this also grandfathers the previous environment variables names so everything keeps working without people having to change their setups. in the meantime some bugs with lntxbot and c-lightning were fixed and the `requests` dependency was eliminated because I can't organize myself into meaningful chunks of changes. 2020-10-08 19:03:18 +00:00			`LNPAY_WALLET_KEY=LNPAY_ADMIN_KEY`
Update .env.example 2020-04-03 10:24:49 +00:00
update docs so master is runnable. 2020-10-02 17:53:55 +00:00			`# LntxbotWallet`
lntxbot.bigsun.xyz will expire soon, use lntxbot.com instead See: https://twitter.com/lntxbot/status/1457341136918482945 2021-11-12 06:05:59 +00:00			`LNTXBOT_API_ENDPOINT=https://lntxbot.com/`
simplify environment variables required. instead of multiple keys/macaroons with different permissions we request only one. if someone wants to use lnbits with an invoice macaroon they're free to do it and we will just fail on 'pay' methods, as before. this also grandfathers the previous environment variables names so everything keeps working without people having to change their setups. in the meantime some bugs with lntxbot and c-lightning were fixed and the `requests` dependency was eliminated because I can't organize myself into meaningful chunks of changes. 2020-10-08 19:03:18 +00:00			`LNTXBOT_KEY=LNTXBOT_ADMIN_KEY`
fee reserve defaults to 0. 2019-12-18 13:44:58 +00:00
update docs so master is runnable. 2020-10-02 17:53:55 +00:00			`# OpenNodeWallet`
ON credentials 2020-01-12 00:46:09 +00:00			`OPENNODE_API_ENDPOINT=https://api.opennode.com/`
simplify environment variables required. instead of multiple keys/macaroons with different permissions we request only one. if someone wants to use lnbits with an invoice macaroon they're free to do it and we will just fail on 'pay' methods, as before. this also grandfathers the previous environment variables names so everything keeps working without people having to change their setups. in the meantime some bugs with lntxbot and c-lightning were fixed and the `requests` dependency was eliminated because I can't organize myself into meaningful chunks of changes. 2020-10-08 19:03:18 +00:00			`OPENNODE_KEY=OPENNODE_ADMIN_KEY`
Fake wallet working 2022-01-31 11:07:29 +00:00
			`# FakeWallet`
Removed key for password that generates a key 2022-02-03 12:52:51 +00:00			`FAKE_WALLET_SECRET="ToTheMoon1"`
add eclair variables to .env example 2022-05-05 14:55:01 +00:00			`LNBITS_DENOMINATION=sats`

			`# EclairWallet`
			`ECLAIR_URL=http://127.0.0.1:8283`
			`ECLAIR_PASS=eclairpw`