diff --git a/site/source/_static/images/lightning/bitcoin-synced.png b/site/source/_static/images/lightning/bitcoin-synced.png new file mode 100644 index 0000000..db79777 Binary files /dev/null and b/site/source/_static/images/lightning/bitcoin-synced.png differ diff --git a/site/source/_static/images/lightning/cln-green.png b/site/source/_static/images/lightning/cln-green.png new file mode 100644 index 0000000..f1c138f Binary files /dev/null and b/site/source/_static/images/lightning/cln-green.png differ diff --git a/site/source/_static/images/lightning/cln-installing.png b/site/source/_static/images/lightning/cln-installing.png new file mode 100644 index 0000000..9919637 Binary files /dev/null and b/site/source/_static/images/lightning/cln-installing.png differ diff --git a/site/source/_static/images/lightning/cln-needs-config.png b/site/source/_static/images/lightning/cln-needs-config.png new file mode 100644 index 0000000..ba45ee6 Binary files /dev/null and b/site/source/_static/images/lightning/cln-needs-config.png differ diff --git a/site/source/_static/images/lightning/cln-save-config.png b/site/source/_static/images/lightning/cln-save-config.png new file mode 100644 index 0000000..b0b129a Binary files /dev/null and b/site/source/_static/images/lightning/cln-save-config.png differ diff --git a/site/source/_static/images/lightning/rtl-address-generated.png b/site/source/_static/images/lightning/rtl-address-generated.png new file mode 100644 index 0000000..d8b09ae Binary files /dev/null and b/site/source/_static/images/lightning/rtl-address-generated.png differ diff --git a/site/source/_static/images/lightning/rtl-change-to-cln.png b/site/source/_static/images/lightning/rtl-change-to-cln.png new file mode 100644 index 0000000..0188d17 Binary files /dev/null and b/site/source/_static/images/lightning/rtl-change-to-cln.png differ diff --git a/site/source/_static/images/lightning/rtl-click-properties.png b/site/source/_static/images/lightning/rtl-click-properties.png new file mode 100644 index 0000000..8f3a6bd Binary files /dev/null and b/site/source/_static/images/lightning/rtl-click-properties.png differ diff --git a/site/source/_static/images/lightning/rtl-config-lnd.png b/site/source/_static/images/lightning/rtl-config-lnd.png new file mode 100644 index 0000000..0fe6239 Binary files /dev/null and b/site/source/_static/images/lightning/rtl-config-lnd.png differ diff --git a/site/source/_static/images/lightning/rtl-config-save.png b/site/source/_static/images/lightning/rtl-config-save.png new file mode 100644 index 0000000..df733fd Binary files /dev/null and b/site/source/_static/images/lightning/rtl-config-save.png differ diff --git a/site/source/_static/images/lightning/rtl-copy-pass.png b/site/source/_static/images/lightning/rtl-copy-pass.png new file mode 100644 index 0000000..b99fd18 Binary files /dev/null and b/site/source/_static/images/lightning/rtl-copy-pass.png differ diff --git a/site/source/_static/images/lightning/rtl-enter-pass.png b/site/source/_static/images/lightning/rtl-enter-pass.png new file mode 100644 index 0000000..309fb71 Binary files /dev/null and b/site/source/_static/images/lightning/rtl-enter-pass.png differ diff --git a/site/source/_static/images/lightning/rtl-generate-address.png b/site/source/_static/images/lightning/rtl-generate-address.png new file mode 100644 index 0000000..426e84d Binary files /dev/null and b/site/source/_static/images/lightning/rtl-generate-address.png differ diff --git a/site/source/_static/images/lightning/rtl-in-marketplace1.png b/site/source/_static/images/lightning/rtl-in-marketplace1.png new file mode 100644 index 0000000..0c8db03 Binary files /dev/null and b/site/source/_static/images/lightning/rtl-in-marketplace1.png differ diff --git a/site/source/_static/images/lightning/rtl-launch-ui.png b/site/source/_static/images/lightning/rtl-launch-ui.png new file mode 100644 index 0000000..0117452 Binary files /dev/null and b/site/source/_static/images/lightning/rtl-launch-ui.png differ diff --git a/site/source/_static/images/lightning/rtl-needs-config.png b/site/source/_static/images/lightning/rtl-needs-config.png new file mode 100644 index 0000000..99b88c3 Binary files /dev/null and b/site/source/_static/images/lightning/rtl-needs-config.png differ diff --git a/site/source/_static/images/lightning/rtl-on-chain.png b/site/source/_static/images/lightning/rtl-on-chain.png new file mode 100644 index 0000000..71690b2 Binary files /dev/null and b/site/source/_static/images/lightning/rtl-on-chain.png differ diff --git a/site/source/_static/images/lightning/rtl-open-channel.png b/site/source/_static/images/lightning/rtl-open-channel.png new file mode 100644 index 0000000..45777a7 Binary files /dev/null and b/site/source/_static/images/lightning/rtl-open-channel.png differ diff --git a/site/source/_static/images/lightning/rtl-open-channels.png b/site/source/_static/images/lightning/rtl-open-channels.png new file mode 100644 index 0000000..25ae842 Binary files /dev/null and b/site/source/_static/images/lightning/rtl-open-channels.png differ diff --git a/site/source/_static/images/lightning/rtl-peers-add-peer.png b/site/source/_static/images/lightning/rtl-peers-add-peer.png new file mode 100644 index 0000000..80ad931 Binary files /dev/null and b/site/source/_static/images/lightning/rtl-peers-add-peer.png differ diff --git a/site/source/_static/images/lightning/rtl-peers-channels.png b/site/source/_static/images/lightning/rtl-peers-channels.png new file mode 100644 index 0000000..5ea822b Binary files /dev/null and b/site/source/_static/images/lightning/rtl-peers-channels.png differ diff --git a/site/source/_static/images/lightning/rtl-pending-inactive.png b/site/source/_static/images/lightning/rtl-pending-inactive.png new file mode 100644 index 0000000..2d494ff Binary files /dev/null and b/site/source/_static/images/lightning/rtl-pending-inactive.png differ diff --git a/site/source/_static/images/lightning/rtl-start.png b/site/source/_static/images/lightning/rtl-start.png new file mode 100644 index 0000000..536d95f Binary files /dev/null and b/site/source/_static/images/lightning/rtl-start.png differ diff --git a/site/source/_static/images/lightning/rtl-start9-node-info.png b/site/source/_static/images/lightning/rtl-start9-node-info.png new file mode 100644 index 0000000..44ce4f8 Binary files /dev/null and b/site/source/_static/images/lightning/rtl-start9-node-info.png differ diff --git a/site/source/_static/images/lightning/rtl-started.png b/site/source/_static/images/lightning/rtl-started.png new file mode 100644 index 0000000..1a454a0 Binary files /dev/null and b/site/source/_static/images/lightning/rtl-started.png differ diff --git a/site/source/_static/images/lightning/rtl-transactions-tab.png b/site/source/_static/images/lightning/rtl-transactions-tab.png new file mode 100644 index 0000000..ed26b6f Binary files /dev/null and b/site/source/_static/images/lightning/rtl-transactions-tab.png differ diff --git a/site/source/_static/images/lightning/two-impls-marketplace.png b/site/source/_static/images/lightning/two-impls-marketplace.png new file mode 100644 index 0000000..bab9a38 Binary files /dev/null and b/site/source/_static/images/lightning/two-impls-marketplace.png differ diff --git a/site/source/user-manual/service-guides/index.rst b/site/source/user-manual/service-guides/index.rst index 5698f86..5518b1c 100644 --- a/site/source/user-manual/service-guides/index.rst +++ b/site/source/user-manual/service-guides/index.rst @@ -10,7 +10,7 @@ These guides will help you to setup external tools to connect or interact with s :maxdepth: 2 bitcoin/index - lightning + lightning/index matrix nextcloud/index vaultwarden/index diff --git a/site/source/user-manual/service-guides/lightning/index.rst b/site/source/user-manual/service-guides/lightning/index.rst new file mode 100644 index 0000000..d16c62c --- /dev/null +++ b/site/source/user-manual/service-guides/lightning/index.rst @@ -0,0 +1,13 @@ +.. _lightning-service: + +========= +Lightning +========= + +These guides will help get you started with Lightning. + +.. toctree:: + :maxdepth: 1 + + lightning + lightning-integrations \ No newline at end of file diff --git a/site/source/user-manual/service-guides/lightning.rst b/site/source/user-manual/service-guides/lightning/lightning-integrations.rst similarity index 86% rename from site/source/user-manual/service-guides/lightning.rst rename to site/source/user-manual/service-guides/lightning/lightning-integrations.rst index 02faa35..67f9430 100644 --- a/site/source/user-manual/service-guides/lightning.rst +++ b/site/source/user-manual/service-guides/lightning/lightning-integrations.rst @@ -1,17 +1,8 @@ -.. _lightning-service: +====================== +Lightning Integrations +====================== -========= -Lightning -========= - -.. contents:: - :depth: 2 - :local: - -Check out our `Getting Started with Lightning video `_ for an introduction to the Lightning Network using LND and RTL on Embassy! - - .. youtube:: KhU_sTiaN8w - :width: 100% +Below is a list of lightning wallets and clients along with instructions on how to use them with your Embassy. .. _blue-wallet-lightning: diff --git a/site/source/user-manual/service-guides/lightning/lightning.rst b/site/source/user-manual/service-guides/lightning/lightning.rst new file mode 100644 index 0000000..85e8343 --- /dev/null +++ b/site/source/user-manual/service-guides/lightning/lightning.rst @@ -0,0 +1,167 @@ +.. _lightning-intro: + +===================================== +Lightning: Opening Your First Channel +===================================== + +.. contents:: + :depth: 2 + :local: + +Here we'll show you how to install a lightning node and how to open a channel with Start9! + +Further below you can find instructions on how to use other additional lightning software either on or external to your Embassy. + +Running a Node and Making a Channel with Start9 +_______________________________________________ + +#. First, ensure that you have Bitcoin Core installed, running, and synced: + + .. figure:: /_static/images/lightning/bitcoin-synced.png + :width: 60% + +#. Install a lightning node. There are two options we offer on the `Start9 marketplace `_ - LND and Core Lightning. In this guide we're going to use Core Lightning (CLN). Though you can use LND and the process will be almost exactly the same. + + .. figure:: /_static/images/lightning/two-impls-marketplace.png + :width: 60% + +#. Install one of the above lightning implementations - as mentioned in this guide we'll use CLN. + + .. figure:: /_static/images/lightning/cln-installing.png + :width: 60% + +#. You'll see CLN say **"Needs Config"**. Click "**Configure**": + + .. figure:: /_static/images/lightning/cln-needs-config.png + :width: 60% + +#. You can leave the settings as their default values and hit **"save"**. + + .. figure:: /_static/images/lightning/cln-save-config.png + :width: 60% + +#. Now hit **"Start"** and wait for CLN to sync up to the network. This may take a few hours. + + .. figure:: /_static/images/lightning/cln-syncing.png + :width: 60% + +#. Once the **"Synced"** health check turns green (as below) you can proceed to the next step. + + .. figure:: /_static/images/lightning/cln-green.png + :width: 60% + +#. To interact with your node we will use Ride The Lightning (RTL) - this is a service that provides a graphical user interface for our lightning node. + + This will work with either (or both!) lightning implementations. + + .. figure:: /_static/images/lightning/rtl-in-marketplace1.png + :width: 60% + +#. Install it and click on **"Configure"** just like with CLN. + + .. figure:: /_static/images/lightning/rtl-needs-config.png + :width: 60% + +#. It will default to LND. In this case we are using a CLN node instead, so we will change the default setting as shown: + + .. figure:: /_static/images/lightning/rtl-config-lnd.png + :width: 60% + + Change to Core Lightning (CLN) and hit OK + + .. figure:: /_static/images/lightning/rtl-change-to-cln.png + :width: 60% + + Hit **"Save"** + + .. figure:: /_static/images/lightning/rtl-config-save.png + :width: 60% + +#. Now hit **"Start"** + + .. figure:: /_static/images/lightning/rtl-start.png + :width: 60% + +#. With RTL started, click **"Properties"** + + .. figure:: /_static/images/lightning/rtl-click-properties.png + :width: 60% + +#. Copy the automatically generated password + + .. figure:: /_static/images/lightning/rtl-copy-pass.png + :width: 60% + +#. Head back to the RTL service and click **"Launch UI"** + + .. figure:: /_static/images/lightning/rtl-launch-ui.png + :width: 60% + + Enter the copied password and log in: + + .. figure:: /_static/images/lightning/rtl-enter-pass.png + :width: 60% + + .. note:: You can add the password to your password manager for convenience. + +#. Once in RTL, click **"On-chain"** then click **"Generate Address"** + + .. figure:: /_static/images/lightning/rtl-generate-address.png + :width: 60% + +#. Send bitcoin to the generated address to add funds to your lightning wallet: + + .. figure:: /_static/images/lightning/rtl-address-generated.png + :width: 60% + + .. note:: Please do not send money to the address pictured above as we will not receive it. If you are intent on sending us money please `head here `_ + +#. Once your sats confirm on-chain you'll see this: + + .. figure:: /_static/images/lightning/rtl-on-chain.png + :width: 60% + +#. Now we must add a peer with which to make channels. In this example we will be opening a channel with Start9 so we will add Start9's node as a peer. Click **"Peers/Channels"**: + + .. figure:: /_static/images/lightning/rtl-peers-channels.png + :width: 60% + +#. Click **"Peers"** then **"Add Peer"**: + + .. figure:: /_static/images/lightning/rtl-peers-add-peer.png + :width: 60% + +#. Enter the details of the lightning node you'd like to open a channel with. Start9's node can be found `here `_ and is what we'll use in this example. You can use another node if you like - ideally one that is well connected. Once chosen and added as below, click **"Add Peer"**: + + .. figure:: /_static/images/lightning/rtl-start9-node-info.png + :width: 60% + + .. note:: The syntax is as follows **NodePublicKey@ipaddress:port** - If it's a Tor node it will be **PublicKey.onion:port** instead. + +#. Then you can enter an amount (the size of the channel), select Private Channel (unless you want a public channel - see below), and a Fee Rate (check a `block explorer `_ for an idea of current necessary fees): + + .. figure:: /_static/images/lightning/rtl-open-channel.png + :width: 60% + + .. note:: Here we are creating a very small channel with a capacity for payments of only a few dollars. You will likely want your channel to be larger than this so that it's actually usable for reasonably sized payments. Channels this small may well get closed by the remote peer. + + .. note:: Using a private channel is what we advise as a default. You may wish for the channel to be public if you intend on becoming a routing node or for other reasons. + +#. You will now see your channel in **"Channels"** -> **"Pending/Inactive"**: + + .. figure:: /_static/images/lightning/rtl-pending-inactive.png + :width: 60% + +#. Once the transaction opening the channel gets added to a block your channel will soon appear here under **"Open"**: + + .. figure:: /_static/images/lightning/rtl-open-channels.png + :width: 60% + +#. To make a payment head to the **"Transactions"** tab and press **"Send Payment"**: + + .. figure:: /_static/images/lightning/rtl-transactions-tab.png + :width: 60% + +#. That's it! You now have a lightning node running with a channel open ready to send payments on the lightning network! + +.. note:: You will not be able to receive payments until you have inbound liquidity in your channel. After completing the above process you will only have outbound liquidity. Inbound liquidity can be created by making payments, having someone open a channel to you or via more sophisticated channel creation.