mirrors/lnbits-legend
1
0
Fork 0
mirror of https://github.com/lnbits/lnbits-legend.git synced 2024-11-19 01:43:42 +01:00
Code Issues Packages Projects Releases Wiki Activity
2d00f4c41c
lnbits-legend/.env.example

183 lines
6.6 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 02:46:19 +01:00
#For more information on .env files, their content and format: https://pypi.org/project/python-dotenv/
Organised env (#2110) * Shuffled env around Env has become bigger, and is a bit disorientating for users * removed whitespace * shuffle * optimised for smaller screen * Made ADMIN UI stuff more prominent
2023-11-21 12:26:53 +01:00
######################################
########## Funding Source ############
######################################
added envs, testing color switch
2021-06-28 23:57:23 +02:00
Wallets: add cln-rest (#1775) * receive and pay works * fix linter issues * import Paymentstatus from core.models * fix test real payment * fix get_payment_status check in lnbits * fix tests? * simplify * refactor AsyncClient * inline import of get_wallet_class fixes the previous cyclic import * invoice stream working * add notes as a reminder to get rid of labels when cln-rest supports payment_hash * create Payment dummy classmethod * remove unnecessary fields from dummy * fixes tests? * fix model * fix cln bug (#1814) * auth header * rename cln to corelightning * add clnrest to admin_ui * add to clnrest allowed sources * add allowed sources to .env.example * allow macaroon files * add corelightning rest to workflow * proper env names * cleanup routine * log wallet connection errors and fix macaroon clnrest * print error on connection fails * clnrest: handle disconnects faster * fix test use of get_payment_status * make format * clnrest: add unhashed_description * add unhashed_description to test * description_hash test * unhashed_description not supported by clnrest * fix checking_id return in api_payments_create_invoice * refactor test to use client instead of api_payments * formatting, some errorlogging * fix test 1 * fix other tests, paid statuses was missing * error handling * revert unnecessary changes (#1854) * apply review of motorina0 --------- Co-authored-by: jackstar12 <jkranawetter05@gmail.com> Co-authored-by: jackstar12 <62219658+jackstar12@users.noreply.github.com> Co-authored-by: dni ⚡ <office@dnilabs.com>
2023-08-23 08:59:39 +02:00
# which fundingsources are allowed in the admin ui
feat: add getalby wallet as funding source (#2086) * initial scaffolding, methods for getalby wallet * Add getAlby to docs and i18n * update alby wallet methods * change names from GetAlbyWallet to AlbyWallet * remove unused variables in AlbyFundingSource in settings.py * rename getalby.py to alby.py * fix method auth and status * resolve rolznz commented issues * rename ALBY_API_KEY to ALBY_ACCESS_TOKEN * fix desc hash in create_invoice --------- Co-authored-by: Pavol Rusnak <pavol@rusnak.io> Co-authored-by: dni ⚡ <office@dnilabs.com>
2023-11-14 20:28:25 +01:00
LNBITS_ALLOWED_FUNDING_SOURCES="VoidWallet, FakeWallet, CoreLightningWallet, CoreLightningRestWallet, LndRestWallet, EclairWallet, LndWallet, LnTipsWallet, LNPayWallet, LNbitsWallet, AlbyWallet, OpenNodeWallet"
Wallets: add cln-rest (#1775) * receive and pay works * fix linter issues * import Paymentstatus from core.models * fix test real payment * fix get_payment_status check in lnbits * fix tests? * simplify * refactor AsyncClient * inline import of get_wallet_class fixes the previous cyclic import * invoice stream working * add notes as a reminder to get rid of labels when cln-rest supports payment_hash * create Payment dummy classmethod * remove unnecessary fields from dummy * fixes tests? * fix model * fix cln bug (#1814) * auth header * rename cln to corelightning * add clnrest to admin_ui * add to clnrest allowed sources * add allowed sources to .env.example * allow macaroon files * add corelightning rest to workflow * proper env names * cleanup routine * log wallet connection errors and fix macaroon clnrest * print error on connection fails * clnrest: handle disconnects faster * fix test use of get_payment_status * make format * clnrest: add unhashed_description * add unhashed_description to test * description_hash test * unhashed_description not supported by clnrest * fix checking_id return in api_payments_create_invoice * refactor test to use client instead of api_payments * formatting, some errorlogging * fix test 1 * fix other tests, paid statuses was missing * error handling * revert unnecessary changes (#1854) * apply review of motorina0 --------- Co-authored-by: jackstar12 <jkranawetter05@gmail.com> Co-authored-by: jackstar12 <62219658+jackstar12@users.noreply.github.com> Co-authored-by: dni ⚡ <office@dnilabs.com>
2023-08-23 08:59:39 +02:00
Changed back to VoidWallet
2022-08-01 09:58:21 +02:00
LNBITS_BACKEND_WALLET_CLASS=VoidWallet
update docs so master is runnable.
2020-10-02 19:53:55 +02: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 17:10:53 +02: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 11:08:40 +01:00
# Invoice expiry for LND, CLN, Eclair, LNbits funding sources
Increase default invoice expiry to 1 hour (#1825) * more reasonable default expiry 600 = 10 minutes which is a pretty short amount of time, for example when using lnbits fundingsource inside lnbits itself it would fail if you do a submarine swap or anything involved with hold invoices i think 3600 = 1 hour should not make a difference in performance and is a way more reasonable expiry * change default in .env.example --------- Co-authored-by: callebtc <93376500+callebtc@users.noreply.github.com>
2023-07-19 13:13:46 +02:00
LIGHTNING_INVOICE_EXPIRY=3600
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 11:08:40 +01:00
update docs so master is runnable.
2020-10-02 19:53:55 +02:00
# Set one of these blocks depending on the wallet kind you chose above:
Works almost Stream needs work
2022-08-01 00:46:42 +02:00
format
2022-08-01 00:51:57 +02:00
# ClicheWallet
CLICHE_ENDPOINT=ws://127.0.0.1:12000
Works almost Stream needs work
2022-08-01 00:46:42 +02:00
update docs so master is runnable.
2020-10-02 19:53:55 +02: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 16:41:50 +02:00
# CoreLightningWallet
CORELIGHTNING_RPC="/home/bob/.lightning/bitcoin/lightning-rpc"
chore: various tweaks
2020-04-16 17:10:53 +02:00
[CORE] Document CoreLightningRestWallet (#1920) * document CoreLightningRestWallet * pushed to comment * fixed base64 comment --------- Co-authored-by: Ben <ben@arc.wales>
2023-09-12 12:14:47 +02:00
# CoreLightningRestWallet
CORELIGHTNING_REST_URL=http://127.0.0.1:8185/
make example paths in .env.example less confusing
2023-10-26 16:48:57 +02:00
CORELIGHTNING_REST_MACAROON="/path/to/clnrest/access.macaroon" # or BASE64/HEXSTRING
[CORE] Document CoreLightningRestWallet (#1920) * document CoreLightningRestWallet * pushed to comment * fixed base64 comment --------- Co-authored-by: Ben <ben@arc.wales>
2023-09-12 12:14:47 +02:00
CORELIGHTNING_REST_CERT="/path/to/clnrest/tls.cert"
update docs so master is runnable.
2020-10-02 19:53:55 +02:00
# LnbitsWallet
Update .env.example
2022-01-14 10:43:30 +01: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 21:03:18 +02:00
LNBITS_KEY=LNBITS_ADMIN_KEY
refactor: a wallet is a wallet is a wallet
2020-03-31 19:05:25 +02:00
add example configuration for connecting LND over grpc (#1364)
2023-01-14 12:31:00 +01:00
# LndWallet
LND_GRPC_ENDPOINT=127.0.0.1
LND_GRPC_PORT=10009
make example paths in .env.example less confusing
2023-10-26 16:48:57 +02:00
LND_GRPC_CERT="/home/bob/.lnd/tls.cert"
LND_GRPC_MACAROON="/home/bob/.lnd/data/chain/bitcoin/mainnet/admin.macaroon" # or HEXSTRING
add example configuration for connecting LND over grpc (#1364)
2023-01-14 12:31:00 +01:00
# To use an AES-encrypted macaroon, set
# LND_GRPC_MACAROON="eNcRyPtEdMaCaRoOn"
update docs so master is runnable.
2020-10-02 19:53:55 +02:00
# LndRestWallet
broken invoice listener on c-lightning and other fixes around wallets.
2020-10-03 22:27:55 +02:00
LND_REST_ENDPOINT=https://127.0.0.1:8080/
make example paths in .env.example less confusing
2023-10-26 16:48:57 +02:00
LND_REST_CERT="/home/bob/.lnd/tls.cert"
LND_REST_MACAROON="/home/bob/.lnd/data/chain/bitcoin/mainnet/admin.macaroon" # or HEXSTRING
Added old admin extension
2022-03-07 06:03:32 +01: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 17:54:05 +01:00
# LND_REST_MACAROON_ENCRYPTED="eNcRyPtEdMaCaRoOn"
Update .env.example
2020-04-25 23:39:30 +02:00
update docs so master is runnable.
2020-10-02 19:53:55 +02:00
# LNPayWallet
Update LNPay endpoint
2021-04-11 22:06:39 +02: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 20:24:14 +02:00
# Secret API Key under developers tab
chore: various tweaks
2020-04-16 17:10:53 +02: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 20:24:14 +02: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 21:03:18 +02:00
LNPAY_WALLET_KEY=LNPAY_ADMIN_KEY
Update .env.example
2020-04-03 12:24:49 +02:00
feat: add getalby wallet as funding source (#2086) * initial scaffolding, methods for getalby wallet * Add getAlby to docs and i18n * update alby wallet methods * change names from GetAlbyWallet to AlbyWallet * remove unused variables in AlbyFundingSource in settings.py * rename getalby.py to alby.py * fix method auth and status * resolve rolznz commented issues * rename ALBY_API_KEY to ALBY_ACCESS_TOKEN * fix desc hash in create_invoice --------- Co-authored-by: Pavol Rusnak <pavol@rusnak.io> Co-authored-by: dni ⚡ <office@dnilabs.com>
2023-11-14 20:28:25 +01:00
# AlbyWallet
ALBY_API_ENDPOINT=https://api.getalby.com/
ALBY_ACCESS_TOKEN=ALBY_ACCESS_TOKEN
update docs so master is runnable.
2020-10-02 19:53:55 +02:00
# OpenNodeWallet
ON credentials
2020-01-12 01:46:09 +01: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 21:03:18 +02:00
OPENNODE_KEY=OPENNODE_ADMIN_KEY
Fake wallet working
2022-01-31 12:07:29 +01:00
# FakeWallet
Removed key for password that generates a key
2022-02-03 13:52:51 +01:00
FAKE_WALLET_SECRET="ToTheMoon1"
add eclair variables to .env example
2022-05-05 16:55:01 +02: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 17:45:16 +02: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 16:12:06 +02:00
# LnTipsWallet
# Enter /api in LightningTipBot to get your key
LNTIPS_API_KEY=LNTIPS_ADMIN_KEY
LNTIPS_API_ENDPOINT=https://ln.tips
Organised env (#2110) * Shuffled env around Env has become bigger, and is a bit disorientating for users * removed whitespace * shuffle * optimised for smaller screen * Made ADMIN UI stuff more prominent
2023-11-21 12:26:53 +01:00
######################################
########### Admin Settings ###########
######################################
# Enable Admin GUI, available for the first user in LNBITS_ADMIN_USERS if available
# 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.
LNBITS_ADMIN_UI=false
# 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 bitcoin, mint, flamingo, freedom, salvador, autumn, monochrome, classic, cyber
LNBITS_THEME_OPTIONS="classic, bitcoin, flamingo, freedom, mint, autumn, monochrome, salvador, cyber"
# LNBITS_CUSTOM_LOGO="https://lnbits.com/assets/images/logo/logo.svg"
HOST=127.0.0.1
PORT=5000
# uvicorn variable, uncomment to allow https behind a proxy
# FORWARDED_ALLOW_IPS="*"
# Server security, rate limiting ips, blocked ips, allowed ips
LNBITS_RATE_LIMIT_NO="200"
LNBITS_RATE_LIMIT_UNIT="minute"
LNBITS_ALLOWED_IPS=""
LNBITS_BLOCKED_IPS=""
# Allow users and admins by user IDs (comma separated list)
# if set new users will not be able to create accounts
LNBITS_ALLOWED_USERS=""
LNBITS_ADMIN_USERS=""
# ID of the super user. The user ID must exist.
# SUPER_USER=""
# Extensions only admin can access
LNBITS_ADMIN_EXTENSIONS="ngrok, admin"
# Disable account creation for new users
# LNBITS_ALLOW_NEW_ACCOUNTS=false
# Enable Node Management without activating the LNBITS Admin GUI
# by setting the following variables to true.
LNBITS_NODE_UI=false
LNBITS_PUBLIC_NODE_UI=false
# Enabling the transactions tab can cause crashes on large Core Lightning nodes.
LNBITS_NODE_UI_TRANSACTIONS=false
LNBITS_DEFAULT_WALLET_NAME="LNbits wallet"
# Ad space description
# LNBITS_AD_SPACE_TITLE="Supported by"
# csv ad space, format "<url>;<img-light>;<img-dark>, <url>;<img-light>;<img-dark>", extensions can choose to honor
# 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"
# Hides wallet api, extensions can choose to honor
LNBITS_HIDE_API=false
# 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
# Path where extensions will be installed (defaults to `./lnbits/`).
# Inside this directory the `extensions` and `upgrades` sub-directories will be created.
# LNBITS_EXTENSIONS_PATH="/path/to/some/dir"
# 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"
# 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_SERVICE_FEE="0.0"
# value in millisats
LNBITS_RESERVE_FEE_MIN=2000
# value in percent
LNBITS_RESERVE_FEE_PERCENT=1.0
# Limit fiat currencies allowed to see in UI
# LNBITS_ALLOWED_CURRENCIES="EUR, USD"
######################################
###### Logging and Development #######
######################################
DEBUG=false
BUNDLE_ASSETS=true
# logging into LNBITS_DATA_FOLDER/logs/
ENABLE_LOG_TO_FILE=true
# https://loguru.readthedocs.io/en/stable/api/logger.html#file
LOG_ROTATION="100 MB"
docs: small cleanup (#2107)
2023-11-21 22:30:52 +01:00
LOG_RETENTION="3 months"
Reference in New Issue Copy Permalink