mirror of
https://github.com/lnbits/lnbits.git
synced 2025-09-18 19:41:11 +02:00
docs: small cleanup (#2107)
This commit is contained in:
@@ -179,4 +179,4 @@ ENABLE_LOG_TO_FILE=true
|
|||||||
|
|
||||||
# https://loguru.readthedocs.io/en/stable/api/logger.html#file
|
# https://loguru.readthedocs.io/en/stable/api/logger.html#file
|
||||||
LOG_ROTATION="100 MB"
|
LOG_ROTATION="100 MB"
|
||||||
LOG_RETENTION="3 months"
|
LOG_RETENTION="3 months"
|
||||||
|
12
README.md
12
README.md
@@ -21,9 +21,17 @@ LNbits is a Python server that sits on top of any funding source. It can be used
|
|||||||
- Fallback wallet for the LNURL scheme
|
- Fallback wallet for the LNURL scheme
|
||||||
- Instant wallet for LN demonstrations
|
- Instant wallet for LN demonstrations
|
||||||
|
|
||||||
LNbits can run on top of any Lightning funding source. It supports LND, CLN, Eclair, Spark, LNpay, OpenNode, Alby, LightningTipBot, and with more being added regularly.
|
LNbits can run on top of any Lightning funding source. It currently supports the following, but more and more are added regularly:
|
||||||
|
- LND (REST and gRPC)
|
||||||
|
- Core Lightning aka CLN (gRPC, REST and Spark)
|
||||||
|
- Eclair
|
||||||
|
- LNPay
|
||||||
|
- LNbits
|
||||||
|
- OpenNode
|
||||||
|
- Alby
|
||||||
|
- LightningTipBot
|
||||||
|
|
||||||
See [LNbits Wiki](https://github.com/lnbits/lnbits/wiki/) for more detailed documentation.
|
See [LNbits manual](https://docs.lnbits.org/guide/wallets.html) for more detailed documentation about each funding source.
|
||||||
|
|
||||||
Checkout the LNbits [YouTube](https://www.youtube.com/playlist?list=PLPj3KCksGbSYG0ciIQUWJru1dWstPHshe) video series.
|
Checkout the LNbits [YouTube](https://www.youtube.com/playlist?list=PLPj3KCksGbSYG0ciIQUWJru1dWstPHshe) video series.
|
||||||
|
|
||||||
|
@@ -21,7 +21,7 @@ mv templates/example templates/mysuperplugin # Rename templates folder.
|
|||||||
- if you are on macOS and having difficulty with 'sed', consider `brew install gnu-sed` and use 'gsed', without -0 option after xargs.
|
- if you are on macOS and having difficulty with 'sed', consider `brew install gnu-sed` and use 'gsed', without -0 option after xargs.
|
||||||
|
|
||||||
1. Edit `manifest.json` and change the organisation name to your GitHub username.
|
1. Edit `manifest.json` and change the organisation name to your GitHub username.
|
||||||
1. Push your changes to GitHub.
|
1. Push your changes to GitHub.
|
||||||
1. In GitHub create a new release for your extension repo. Tag the release with `0.0.1`
|
1. In GitHub create a new release for your extension repo. Tag the release with `0.0.1`
|
||||||
1. Copy the URL of the extension's raw `manifest.json` URL `https://raw.githubusercontent.com/[my-user-name]/mysuperplugin/master/manifest.json`
|
1. Copy the URL of the extension's raw `manifest.json` URL `https://raw.githubusercontent.com/[my-user-name]/mysuperplugin/master/manifest.json`
|
||||||
1. If you are using the LMNbits Admin UI, go to the Admin UI > Server > Extension Sources, click "Add", paste the URL, then click "Save"
|
1. If you are using the LMNbits Admin UI, go to the Admin UI > Server > Extension Sources, click "Add", paste the URL, then click "Save"
|
||||||
|
@@ -34,7 +34,7 @@ allow-self-payment=1
|
|||||||
|
|
||||||
<details><summary>Which funding sources can I use for LNbits?</summary>
|
<details><summary>Which funding sources can I use for LNbits?</summary>
|
||||||
<p>There are several ways to run a LNbits instance funded from different sources. It is important to choose a source that has a good liquidity and good peers connected. If you use LNbits for public services your users´ payments can then flow happily in both directions. If you would like to fund your LNbits wallet via btc please see section Troubleshooting.</p>
|
<p>There are several ways to run a LNbits instance funded from different sources. It is important to choose a source that has a good liquidity and good peers connected. If you use LNbits for public services your users´ payments can then flow happily in both directions. If you would like to fund your LNbits wallet via btc please see section Troubleshooting.</p>
|
||||||
<p>The <a href="http://docs.lnbits.org/guide/wallets.html">LNbits manual</a> shows you which sources can be used and how to configure each: CLN, LND, LNPay, Cliche, OpenNode, Alby as well as bots.</p>
|
<p>The <a href="https://docs.lnbits.org/guide/wallets.html">LNbits manual</a> shows you which sources can be used and how to configure each.</p>
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<!--Later to be added
|
<!--Later to be added
|
||||||
@@ -47,7 +47,7 @@ allow-self-payment=1
|
|||||||
<p>When you run your LNbits in clearnet basically everyone can generate a wallet on it. Since the funds of your node are bound to these wallets you might want to prevent that. There are two ways to do so:</p>
|
<p>When you run your LNbits in clearnet basically everyone can generate a wallet on it. Since the funds of your node are bound to these wallets you might want to prevent that. There are two ways to do so:</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li>Configure allowed users & extensions <a href="https://github.com/lnbits/lnbits/blob/main/.env.example">in the .env file</a></li>
|
<li>Configure allowed users & extensions <a href="https://github.com/lnbits/lnbits/blob/main/.env.example">in the .env file</a></li>
|
||||||
<li>Configure allowed users & extensions <a href="https://github.com/lnbits/usermanager">via the Usermanager-Extension</a>. You can find <a href="http://docs.lnbits.org/guide/admin_ui.html">more info about the superuser and the admin extension here</a></li>
|
<li>Configure allowed users & extensions <a href="https://github.com/lnbits/usermanager">via the Usermanager-Extension</a>. You can find <a href="https://docs.lnbits.org/guide/admin_ui.html">more info about the superuser and the admin extension here</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p>Please note that all entries in the .env file will not be the taken into account once you activated the admin extension.</p>
|
<p>Please note that all entries in the .env file will not be the taken into account once you activated the admin extension.</p>
|
||||||
</details>
|
</details>
|
||||||
@@ -263,6 +263,6 @@ allow-self-payment=1
|
|||||||
|
|
||||||
## Developing for LNbits
|
## Developing for LNbits
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="http://docs.lnbits.org/devs/development.html">Making Estension / how to use Websockets / API reference</a></li>
|
<li><a href="https://docs.lnbits.org/devs/development.html">Making extensions / How to use Websockets / API reference</a></li>
|
||||||
<li><a href="https://t.me/lnbits">Telegram LNbits Support Group</a></li></ul>
|
<li><a href="https://t.me/lnbits">Telegram LNbits Support Group</a></li></ul>
|
||||||
</ul>
|
</ul>
|
||||||
|
@@ -8,7 +8,7 @@ nav_order: 3
|
|||||||
Backend wallets
|
Backend wallets
|
||||||
===============
|
===============
|
||||||
|
|
||||||
LNbits can run on top of many lightning-network funding sources. Currently there is support for CoreLightning, LND, LNbits, LNPay, Alby, and OpenNode, with more being added regularly.
|
LNbits can run on top of many lightning-network funding sources with more being added regularly.
|
||||||
|
|
||||||
A backend wallet can be configured using the following LNbits environment variables:
|
A backend wallet can be configured using the following LNbits environment variables:
|
||||||
|
|
||||||
@@ -19,6 +19,7 @@ A backend wallet can be configured using the following LNbits environment variab
|
|||||||
- `CORELIGHTNING_RPC`: /file/path/lightning-rpc
|
- `CORELIGHTNING_RPC`: /file/path/lightning-rpc
|
||||||
|
|
||||||
### CoreLightning REST
|
### CoreLightning REST
|
||||||
|
|
||||||
- `LNBITS_BACKEND_WALLET_CLASS`: **CoreLightningRestWallet**
|
- `LNBITS_BACKEND_WALLET_CLASS`: **CoreLightningRestWallet**
|
||||||
- `CORELIGHTNING_REST_URL`: http://127.0.0.1:8185/
|
- `CORELIGHTNING_REST_URL`: http://127.0.0.1:8185/
|
||||||
- `CORELIGHTNING_REST_MACAROON`: /file/path/admin.macaroon or Base64/Hex
|
- `CORELIGHTNING_REST_MACAROON`: /file/path/admin.macaroon or Base64/Hex
|
||||||
@@ -70,7 +71,6 @@ For the invoice listener to work you have a publicly accessible URL in your LNbi
|
|||||||
- `LNPAY_API_KEY`: sak_apiKey
|
- `LNPAY_API_KEY`: sak_apiKey
|
||||||
- `LNPAY_WALLET_KEY`: waka_apiKey
|
- `LNPAY_WALLET_KEY`: waka_apiKey
|
||||||
|
|
||||||
|
|
||||||
### OpenNode
|
### OpenNode
|
||||||
|
|
||||||
For the invoice to work you must have a publicly accessible URL in your LNbits. No manual webhook setting is necessary.
|
For the invoice to work you must have a publicly accessible URL in your LNbits. No manual webhook setting is necessary.
|
||||||
@@ -83,7 +83,6 @@ For the invoice to work you must have a publicly accessible URL in your LNbits.
|
|||||||
|
|
||||||
For the invoice to work you must have a publicly accessible URL in your LNbits. No manual webhook setting is necessary. You can generate an alby access token here: https://getalby.com/developer/access_tokens/new
|
For the invoice to work you must have a publicly accessible URL in your LNbits. No manual webhook setting is necessary. You can generate an alby access token here: https://getalby.com/developer/access_tokens/new
|
||||||
|
|
||||||
|
|
||||||
- `LNBITS_BACKEND_WALLET_CLASS`: **AlbyWallet**
|
- `LNBITS_BACKEND_WALLET_CLASS`: **AlbyWallet**
|
||||||
- `ALBY_API_ENDPOINT`: https://api.getalby.com/
|
- `ALBY_API_ENDPOINT`: https://api.getalby.com/
|
||||||
- `ALBY_ACCESS_TOKEN`: AlbyAccessToken
|
- `ALBY_ACCESS_TOKEN`: AlbyAccessToken
|
||||||
|
Reference in New Issue
Block a user