From 3b31d3925e49c8ae2b59b312f03280a5f37921a4 Mon Sep 17 00:00:00 2001 From: Kukks Date: Mon, 25 Mar 2024 13:43:40 +0100 Subject: [PATCH] plugin readme --- Plugins/BTCPayServer.Plugins.Breez/README.md | 31 +++++++++++++++++++ .../BTCPayServer.Plugins.Bringin/README.md | 19 ++++++++++++ 2 files changed, 50 insertions(+) create mode 100644 Plugins/BTCPayServer.Plugins.Breez/README.md create mode 100644 Plugins/BTCPayServer.Plugins.Bringin/README.md diff --git a/Plugins/BTCPayServer.Plugins.Breez/README.md b/Plugins/BTCPayServer.Plugins.Breez/README.md new file mode 100644 index 0000000..16ab6f0 --- /dev/null +++ b/Plugins/BTCPayServer.Plugins.Breez/README.md @@ -0,0 +1,31 @@ +# Breez lightning support plugin + +## BETA RELEASE + +Allows you to enable lightning on your stores using [Breez SDK](https://breez.technology/sdk/), powered by [Blockstream Greenlight](https://blockstream.com/lightning/greenlight/). + +Breez SDK and Greenlight enables you to have a non-custodial lightning experience, without hosting any of of the infrastructure yourself. + +Additionally, Breez SDK comes with built-in liquidity and channel automation, reducing the complexity of managing your lightning node. + +If you have used any other wallet that uses Breez SDK, you can import it directly into BTCPay Server and continue using it in parallel. + +## Usage + +1. Install the plugin from the BTCPay Server > Settings > Plugin > Available Plugins, and restart +2. In your store > Wallets > Lightning, Configure Breez +3. You will be on a page asking for: + - Mnemonic: This is your 12 word seed phrase. YOU SHOULD GENERATE THIS SAFELY AND KEEP IT SAFE. If you have used Breez before, you can use the same seed phrase you used in Breez. This SEED PHRASE will be stored on BTCPAY SERVER. IF YOU USE A SHARED BTCPAY SERVER, YOU ARE EXPOSING YOUR SEED PHRASE TO THE SERVER ADMINISTRATOR. + - Greenlight credentials: In the case of a new seed, you'll need to acquire certificates for issuing new nodes from Blockstream. You can get these for free at https://greenlight.blockstream.com. + - Invite Code: Alternatively, you may have an invite code which can be used instead of the Greenlight credentials. +4. Click Save +5. Your new lightning node will be created. +6. Your first lightning invoice will have a relatively high minimum amount limit. This is because Breez SDK requires a minimum amount to be able to open a channel. +7. You can now use your lightning node to receive payments. + +NOTE: In the future, Blockstream Greenlight will offer a way to generate read-only access keys for your already issued node, so that you can use these instead of exposing your mnemonic phrase to BTCPay Server, allowing a lightweight, non-custodial lightning experience, even on shared BTCPay Server instances. + +## Additional features + +* Swap-in: Send and convert onchain funds to your Breez lightning nodes. +* Swap-out: Send and convert lightning funds to your onchain wallet. \ No newline at end of file diff --git a/Plugins/BTCPayServer.Plugins.Bringin/README.md b/Plugins/BTCPayServer.Plugins.Bringin/README.md new file mode 100644 index 0000000..8c1d982 --- /dev/null +++ b/Plugins/BTCPayServer.Plugins.Bringin/README.md @@ -0,0 +1,19 @@ +# Bringing Euro offramp plugin + +Allows you to automatically forward received funds to Bringin, a Euro offramp provider. + +## Usage + +1. Install the plugin from the BTCPay Server > Settings > Plugin > Available Plugins, and restart +2. In the dashboard, or the side navigation, click on "Bringin" tostart configuring the plugin +3. You will need an API key, click on the onboarding link to start getting your account set up. +4. Once your account is set up, click on Integrations on the Bringin dashboard and get the API Key under BTCPay Server +5. Paste the API Key in the BTCPay Server plugin configuration, and new options should appear to configure the plugin +6. You can configure the available payment method options supported by Bringin, such as Lightning and On-chain. +7. Click Save +8. Make sure to configure payout processors so that payments to Bringin are automatically created. + +## Flow +When an invoice on your store is paid and settled, every payment is counted per payment type (on-chain, lightning), relative to the "percentage" configured (set to 0 to not enable this payment). +Once the threshold is reached, an order is created on Bringin, and a payout paying this order is created. A payout processor then picks this payout and sends it to Bringin. Once the payment settles, the funds are automatically converted to Euro and the balance is reflected in your Bringin account and the BTCPay Server Bringin widget. +