heierbtc/lnbits
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
c960f718f5
lnbits/.env.example

132 lines
5.1 KiB
Plaintext
Raw Normal View History

Additional information 1. Link to details on what and how to include information in a .env file 2. Clarify how to activate the FORWARDED_ALLOW_IPS environment variable for those situations where the proxy is not at the default 127.0.0.1 (most often inside a Docker container.
2023-01-15 01:46:19 +00:00
#For more information on .env files, their content and format: https://pypi.org/project/python-dotenv/
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
Additional information 1. Link to details on what and how to include information in a .env file 2. Clarify how to activate the FORWARDED_ALLOW_IPS environment variable for those situations where the proxy is not at the default 127.0.0.1 (most often inside a Docker container.
2023-01-15 01:46:19 +00:00
# uvicorn variable, uncomment to allow https behind a proxy
add FORWARDED_ALLOW_IPS variable to .example.env (#1077)
2022-10-26 11:07:34 +00:00
# FORWARDED_ALLOW_IPS="*"
Uvicorn loguru format (#741) * use loguru formatting for uvicorn logs * remove depth from logging interceptor * format for uvicorn * black * isort * black again * python3-dev * python3-dev * leaner pipeline Co-authored-by: dni <dni.khr@gmail.com>
2022-07-15 17:54:12 +00:00
DEBUG=false
Logging with loguru (#708) * logging * requirements * add loguru dependency * restore it * add loguru * set log level in .env file * remove service fee print * set log level * more logging * more logging * more logging * pyament.checking_id * fix
2022-07-07 12:30:16 +00:00
revert to PR #1125
2022-11-24 14:43:39 +00:00
# Allow users and admins by user IDs (comma separated list)
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=""
change comments to use multiple lines
2022-09-26 14:54:19 +00:00
LNBITS_ADMIN_USERS=""
# Extensions only admin can access
merge main
2022-12-01 11:37:08 +00:00
LNBITS_ADMIN_EXTENSIONS="ngrok, admin"
fix super_user check, fixes #1250
2023-01-04 09:41:56 +00:00
change comments to use multiple lines
2022-09-26 14:54:19 +00:00
# Enable Admin GUI, available for the first user in LNBITS_ADMIN_USERS if available
fix super_user check, fixes #1250
2023-01-04 09:41:56 +00:00
# Warning: Enabling this will make LNbits ignore this configuration file. Your settings will
# be stored in your database and you will be able to change them only through the Admin UI.
# Disable this to make LNbits use this config file again.
merge main
2022-12-01 11:37:08 +00:00
LNBITS_ADMIN_UI=false
Added old admin extension
2022-03-07 05:03:32 +00:00
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
Improved ad space function
2022-11-20 17:29:07 +00:00
# Ad space description
Defaulted to null in env.example
2022-11-20 17:41:57 +00:00
# LNBITS_AD_SPACE_TITLE="Supported by"
Improved ad space function
2022-11-20 17:29:07 +00:00
# csv ad space, format "<url>;<img-light>;<img-dark>, <url>;<img-light>;<img-dark>", extensions can choose to honor
make ad space as a CSV formatted string
2022-12-01 22:16:55 +00:00
# LNBITS_AD_SPACE="https://shop.lnbits.com/;https://raw.githubusercontent.com/lnbits/lnbits/main/lnbits/static/images/lnbits-shop-light.png;https://raw.githubusercontent.com/lnbits/lnbits/main/lnbits/static/images/lnbits-shop-dark.png"
Updates and fixes (#912) * feat: add support for python 3.10 * fix: move all in-line comments to their own line On some systems the environs package was uable to parse values as it tried read the comments as code...
2022-09-23 08:02:23 +00:00
# Hides wallet api, extensions can choose to honor
Added old admin extension
2022-03-07 05:03:32 +00:00
LNBITS_HIDE_API=false
Added ad space and option to turn off api docs
2022-02-23 13:51:30 +00:00
doc: add `LNBITS_EXT_GITHUB_TOKEN`
2023-01-18 15:19:45 +00:00
# LNBITS_EXTENSIONS_MANIFESTS="https://raw.githubusercontent.com/lnbits/lnbits-extensions/main/extensions.json,https://raw.githubusercontent.com/lnbits/lnbits-extensions/main/extensions-trial.json"
# GitHub has rate-limits for its APIs. The limit can be increased specifying a GITHUB_TOKEN
# LNBITS_EXT_GITHUB_TOKEN=github_pat_xxxxxxxxxxxxxxxxxx
Organised .env
2022-02-07 20:48:48 +00:00
feat: add default extension install (`LNBITS_EXTENSIONS_DEFAULT_INSTALL`)
2023-02-16 08:48:12 +00:00
# Extensions to be installed by default. If an extension from this list is uninstalled then it will be re-installed on the next restart.
# The extension must be removed from this list in order to not be re-installed.
LNBITS_EXTENSIONS_DEFAULT_INSTALL="tpos"
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
feat: remove FEE_RESERVE
2020-04-21 13:44:02 +00:00
LNBITS_SERVICE_FEE="0.0"
Updates and fixes (#912) * feat: add support for python 3.10 * fix: move all in-line comments to their own line On some systems the environs package was uable to parse values as it tried read the comments as code...
2022-09-23 08:02:23 +00:00
# value in millisats
LNBITS_RESERVE_FEE_MIN=2000
# value in percent
LNBITS_RESERVE_FEE_PERCENT=1.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 cyber theme Because we all liked the theme from this pr https://github.com/lnbits/lnbits/pulls?page=2&q=is%3Apr+is%3Aopen
2023-02-20 22:41:11 +00:00
# Choose from bitcoin, mint, flamingo, freedom, salvador, autumn, monochrome, classic, cyber
LNBITS_THEME_OPTIONS="classic, bitcoin, flamingo, freedom, mint, autumn, monochrome, salvador, cyber"
Allow for custom image logo (#642) * first test * add custom URL logo * some styling * fixed typo, wrong import * Update .env.example Co-authored-by: calle <93376500+callebtc@users.noreply.github.com> Co-authored-by: calle <93376500+callebtc@users.noreply.github.com>
2022-06-08 14:23:36 +00:00
# LNBITS_CUSTOM_LOGO="https://lnbits.com/assets/images/logo/logo.svg"
added envs, testing color switch
2021-06-28 21:57:23 +00:00
LNtxbot mentioned in a few more places
2023-02-23 11:46:29 +00:00
# Choose from LNPayWallet, OpenNodeWallet, ClicheWallet,
add example configuration for connecting LND over grpc (#1364)
2023-01-14 11:31:00 +00:00
# LndWallet, LndRestWallet, CoreLightningWallet, EclairWallet,
# LnTipsWallet, LNbitsWallet, SparkWallet, FakeWallet,
Changed back to VoidWallet
2022-08-01 07:58:21 +00:00
LNBITS_BACKEND_WALLET_CLASS=VoidWallet
update docs so master is runnable.
2020-10-02 17:53:55 +00:00
# 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
Wallets: add custom invoice expiry (#1396) * expiry for fakewallet * expiry for lnd * lnbits backend * fix: eclair descriptionHash fixed and expiry added * cln and sparko * test expiry * Eclair from AdminUI and bugfix for nonexistent payments * add to settings and .env and remove lntxbot * remove duplicate and format * add invoice expiry * add min max and step * UI works now * test should fail, sanity check, will revert * revert, ready for merge Co-authored-by: Tiago Vasconcelos <talvasconcelos@gmail.com>
2023-01-26 10:08:40 +00:00
# Invoice expiry for LND, CLN, Eclair, LNbits funding sources
LIGHTNING_INVOICE_EXPIRY=600
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:
Works almost Stream needs work
2022-07-31 22:46:42 +00:00
format
2022-07-31 22:51:57 +00:00
# ClicheWallet
CLICHE_ENDPOINT=ws://127.0.0.1:12000
Works almost Stream needs work
2022-07-31 22:46:42 +00:00
update docs so master is runnable.
2020-10-02 17:53:55 +00:00
# SparkWallet
SPARK_URL=http://localhost:9737/rpc
SPARK_TOKEN=myaccesstoken
Mega-merge 3: CLN update client lib with descriptionhash support (WIP) (#792) * CoreLightningWallet
2022-08-01 14:41:50 +00:00
# CoreLightningWallet
CORELIGHTNING_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
add example configuration for connecting LND over grpc (#1364)
2023-01-14 11:31:00 +00:00
# LndWallet
LND_GRPC_ENDPOINT=127.0.0.1
LND_GRPC_PORT=10009
LND_GRPC_CERT="/home/bob/.config/Zap/lnd/bitcoin/mainnet/wallet-1/data/chain/bitcoin/mainnet/tls.cert"
LND_GRPC_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_GRPC_MACAROON="eNcRyPtEdMaCaRoOn"
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"
Added old admin extension
2022-03-07 05:03:32 +00:00
# To use an AES-encrypted macaroon, set
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
# 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
# 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
Adding missing theme options in conf file Missing bitcoin theme in comment. Missing flamingo theme in list of values for LNBITS_THEME_OPTIONS.
2022-10-02 15:45:16 +00:00
ECLAIR_PASS=eclairpw
Add backend: ln.tips (LightningTipBot) wallet (#921) * add ln.tips * add wallet * revert lnbits * make format * .env.example * listener fix * reconnect fixed * make format * make format
2022-10-10 14:12:06 +00:00
# LnTipsWallet
# Enter /api in LightningTipBot to get your key
LNTIPS_API_KEY=LNTIPS_ADMIN_KEY
LNTIPS_API_ENDPOINT=https://ln.tips
restore 7f64f426c226977530bc983650efd5dbcd4afa84
2022-11-30 15:24:13 +00:00
# Cashu Mint
merge main
2022-12-01 11:37:08 +00:00
# Use a long-enough random (!) private key.
restore 7f64f426c226977530bc983650efd5dbcd4afa84
2022-11-30 15:24:13 +00:00
# Once set, you cannot change this key as for now.
CASHU_PRIVATE_KEY="SuperSecretPrivateKey"
Reference in New Issue Copy Permalink