From e65ec5627692b41ef7710a71a4d7950bc4481eeb Mon Sep 17 00:00:00 2001 From: Arc <33088785+arcbtc@users.noreply.github.com> Date: Tue, 21 Nov 2023 11:26:53 +0000 Subject: [PATCH] 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 --- .env.example | 206 ++++++++++++++++++++++++++------------------------- 1 file changed, 106 insertions(+), 100 deletions(-) diff --git a/.env.example b/.env.example index e02608907..838a915a5 100644 --- a/.env.example +++ b/.env.example @@ -1,105 +1,8 @@ #For more information on .env files, their content and format: https://pypi.org/project/python-dotenv/ -HOST=127.0.0.1 -PORT=5000 - -# uvicorn variable, uncomment to allow https behind a proxy -# FORWARDED_ALLOW_IPS="*" - -DEBUG=false - -# 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" -LOG_RETENTION="3 months" - -# 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 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 - -# 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 ";;, ;;", 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" - -# Value in percent -LNBITS_SERVICE_FEE=0.0 -# Max fee to charge per transaction (in satoshi), 0 will leave no max and use LNBITS_SERVICE_FEE % -LNBITS_SERVICE_FEE_MAX=0 -# The wallet where the service fee will be sent to -LNBITS_SERVICE_FEE_WALLET="" - -# 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" - -# 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" +###################################### +########## Funding Source ############ +###################################### # which fundingsources are allowed in the admin ui LNBITS_ALLOWED_FUNDING_SOURCES="VoidWallet, FakeWallet, CoreLightningWallet, CoreLightningRestWallet, LndRestWallet, EclairWallet, LndWallet, LnTipsWallet, LNPayWallet, LNbitsWallet, AlbyWallet, OpenNodeWallet" @@ -174,3 +77,106 @@ ECLAIR_PASS=eclairpw # Enter /api in LightningTipBot to get your key LNTIPS_API_KEY=LNTIPS_ADMIN_KEY LNTIPS_API_ENDPOINT=https://ln.tips + +###################################### +########### 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 ";;, ;;", 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" +LOG_RETENTION="3 months" \ No newline at end of file