LNbits & Zeus guide (#354)

* skeleton guide for lnbits/zeus

* almost finished

* almost finished

* typos

* final edits for review

* rewording

* change format to be just lnbits with two tabs (zeus/alby), update to new LNbits UI

* begin adding blue wallet, rework everything else

* add blue wallet words

* add bluewallet pictures

* alby guide

* finish up alby

* wording

* formatting

* mention firefox/tor for alby guide

* make each integration its own page

* .

* reorder everything, rewriting as necessary

* zeus LNC guide

* more lnc stuff

* almost done, just waiting for new alby

* new alby guides, tweaks

* everything except Zap

* .

* reorder

* deeper tree

* zap

* davids suggestions

* fix alignment

* more formatting errors

* .

* .

* fix build errors

* rename bluewallet header in bitcoin doc

* capitalize a word, remove quotes from bold stuff

* add alts for images

* davids changes

site/source/user-manual/service-guides/bitcoin/bitcoin-integrations.rst

@@ -29,7 +29,7 @@ Blockstream Green
  Follow the `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/blockstreamgreen/guide.md>`__.
 
 
-.. _blue-wallet:
+.. _blue-wallet-bitcoin:
 
 BlueWallet
 ----------

site/source/user-manual/service-guides/lightning/alby-cln.rst

@@ -0,0 +1,73 @@
+.. _alby-cln:
+
+====
+Alby
+====
+
+Alby is a browser extension that can be connected to your lightning node a number of ways. This guide will go over direct connections between Alby and your **Core Lightning** node. 
+
+If you'd like to connect via `LNbits <https://marketplace.start9.com/marketplace/lnbits>`_ which allows allocation of funds, please see :ref:`this guide<connecting-lnbits>`.
+
+.. note:: We are going to connect using Tor so that Alby will be able to connect from anywhere.
+
+#. Make sure you are already :ref:`running Tor<connecting-tor>` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.<tor-firefox>`
+
+#. Download the Alby extension by visiting the `Alby Github <https://github.com/getAlby/lightning-browser-extension#installation>`_, selecting your browser, and installing.
+#. On the Alby welcome screen, select **Get Started**.
+#. Create a strong password and store it somewhere safe, like your Vaultwarden password manager.
+#. On the next screen, select **Other Wallets** and click **Connect**.
+
+
+#. Click **Start9** then **Core Lightning**.
+
+   .. figure:: /_static/images/lightning/alby-start9.png
+      :width: 50%
+      :alt: alby-start9
+
+   .. figure:: /_static/images/lightning/alby-cln-0.png
+      :width: 50%
+      :alt: alby-cln-0
+
+#. You will see the following fields to fill out:
+
+   .. figure:: /_static/images/lightning/alby-cln-empty.png
+      :width: 40%
+      :alt: alby-cln-empty
+
+#. For "Host" this is your Peer Interface - find this at the top of **Interfaces** within the CLN service on your Start9 server. Copy the address shown here but remove the *http://* at the start and paste it into **Host** within Alby:
+
+   .. figure:: /_static/images/lightning/cln-peer-interface.png
+      :width: 40%
+      :alt: cln-peer-interface
+
+#. For **Public key** enter your **Node Id** found at the top of **Properties** within the CLN service on your server.
+
+   .. figure:: /_static/images/lightning/cln-nodeid.png
+      :width: 40%
+      :alt: cln-nodeid
+
+#. For **Rune** you will need to install the `Spark <https://marketplace.start9.com/marketplace/spark-wallet>`_ service on your server, launch the UI, click in the bottom left where you see "v0.3.2" or something similar, and click **Console**. 
+
+   .. figure:: /_static/images/lightning/enable-console-spark.png
+      :width: 40%
+      :alt: enable-console-spark
+
+#. Enter "commando-rune", hit **execute** and then copy what you see after **rune:** and paste it into Alby.
+
+   .. figure:: /_static/images/lightning/commando-rune.png
+      :width: 40%
+      :alt: commando-rune
+
+#. Leave the **Port** as 9735. It should look like this:
+
+   .. figure:: /_static/images/lightning/alby-cln-filled-out.png
+      :width: 40%
+      :alt: alby-cln-filled-out
+
+#. Click **Continue**. Once the connection is completed you will see a success page that displays the balance of your CLN node in Sats. 
+
+   .. figure:: /_static/images/lightning/alby-cln-success.png
+      :width: 40%
+      :alt: alby-cln-success
+
+      Alby is now connected to your CLN node over Tor!

site/source/user-manual/service-guides/lightning/alby-lnbits.rst

@@ -0,0 +1,109 @@
+.. _alby-lnbits:
+
+Alby
+----
+
+.. note:: This guide assumes you have already setup LNbits as per :ref:`this guide <connecting-lnbits>`.
+
+.. note:: This will work with either LND *or* CLN as your underlying node!
+
+Alby is a browser extension that can be connected to your lightning node a number of ways. This guide will go over connecting via LNbits which allows allocation of funds.
+
+Make sure you are already :ref:`running Tor<connecting-tor>` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.<tor-firefox>`
+
+#. Download the Alby extension by visiting the `Alby Github <https://github.com/getAlby/lightning-browser-extension#installation>`_, selecting your browser, and installing.
+#. On the Alby welcome screen, select **Get Started**.
+#. Create a strong password and store it somewhere safe, like your Vaultwarden password manager.
+#. On the next screen, select **Other Wallets** and click **Connect**.
+
+#. Click **Start9** then **LNbits**:
+
+   .. figure:: /_static/images/lightning/alby-start9.png
+      :width: 50%
+      :alt: alby-start9
+
+   .. figure:: /_static/images/services/lnbits/alby-lnbits-select.png
+      :width: 50%
+      :alt: alby-lnbits-select
+
+#. You will be brought to this page:
+
+   .. figure:: /_static/images/services/lnbits/alby-lnbits-fields.png
+      :width: 40%
+      :alt: alby-lnbits-fields
+
+#. Head back to LNbits and select the wallet you created then click on the arrow to the right of **API Info**:
+
+    .. figure:: /_static/images/services/lnbits/lnbits-api-dropdown.png
+        :width: 55%
+        :alt: api-info-dropdown
+
+#. Copy the **Admin key** and paste it into Alby:
+
+    .. figure:: /_static/images/services/lnbits/lnbits-admin-key.png
+        :width: 50%
+        :alt: lnbits-admin-key
+
+    .. figure:: /_static/images/services/lnbits/alby-lnbits-admin-key.png
+        :width: 45%
+        :alt: alby-lnbits-admin-key
+
+#. Head back to your Start9 server's LNbits service page and select **Interfaces**:
+
+    .. figure:: /_static/images/services/lnbits/lnbits-interfaces.png
+        :width: 55%
+        :alt: lnbits-interfaces
+
+#. Copy the Tor Address:
+
+    .. figure:: /_static/images/services/lnbits/lnbits-interfaces-tor-address.png
+        :width: 65%
+        :alt: lnbits-interfaces-tor-address
+
+#. Head back to Alby and paste what you just copied into **LNbits URL**, select **Tor (native)** then hit **Continue**:
+
+    .. figure:: /_static/images/services/lnbits/alby-lnbits-fields-complete.png
+        :width: 45%
+        :alt: alby-lnbits-fields-complete
+
+    .. tip:: Make sure to include the http:// at the start of the address. If it is not working make sure that you are already :ref:`running Tor<connecting-tor>` on your system and that your browser is :ref:`configured to use Tor.<tor-firefox>`
+
+#. Once connected you should see the following success page:
+
+    .. figure:: /_static/images/lightning/alby-cln-success.png
+        :width: 40%
+        :alt: alby-cln-success
+
+    Alby is now connected to your lightning node via LNbits!
+
+#. You can now allocate sats to this wallet within LNbits by clicking the **+** icon here:
+
+    .. figure:: /_static/images/services/lnbits/lnbits-plus-icon-2.png
+        :width: 60%
+        :alt: plus-icon-2
+
+    Let's add 1000 satoshis:
+
+    .. figure:: /_static/images/services/lnbits/lnbits-1000-sats-2.png
+        :width: 40%
+        :alt: add-1000-sats
+
+    .. figure:: /_static/images/services/lnbits/lnbits-1000-sats-added-2.png
+        :width: 40%
+        :alt: sats-added
+
+#. Alby should now show a balance:
+
+    .. figure:: /_static/images/services/lnbits/alby-lnbits-1000-sats.png
+        :width: 25%
+        :alt: alby-balance
+
+#. You can also receive funds the normal way by hitting **Receive** within Alby.
+
+    .. figure:: /_static/images/services/lnbits/alby-receive.png
+        :width: 25%
+        :alt: alby-receive
+
+    .. note:: Funds received this way must be sent from another lightning node, not the node underneath LNbits. A lightning payment that originates and terminates at the same node is technically a rebalance, not a normal payment.
+
+You're now setup with Alby and LNbits!

site/source/user-manual/service-guides/lightning/alby-lnc.rst

@@ -0,0 +1,45 @@
+.. _alby-lnc:
+
+====
+Alby
+====
+
+Alby is a browser extension that can be connected to your lightning node a number of ways. 
+
+This guide will go over **direct connections** between **Alby and LND** using **LNC**. 
+
+.. tip:: If you'd like to connect using LND's REST API see :ref:`here<alby-lnd>`. If you'd like to connect via LNbits which allows allocation of funds, please see :ref:`this guide<connecting-lnbits>`. 
+
+.. note:: Requires the `Lightning Terminal <https://marketplace.start9.com/marketplace/lightning-terminal>`_ service and only possible with LND nodes.
+
+Available For:
+
+- Chrome-based browsers
+- Firefox
+
+#. Download the Alby extension by visiting the `Alby Github <https://github.com/getAlby/lightning-browser-extension#installation>`_, selecting your browser, and installing.
+#. On the Alby welcome screen, select **Get Started**.
+#. Create a strong password and store it somewhere safe, like your Vaultwarden password manager.
+#. On the next screen, select **Other Wallets** and click **Connect**.
+
+#. Click on **Start9** then on **Lightning Terminal (LNC)**.
+
+   .. figure:: /_static/images/lightning/alby-start9.png
+      :width: 50%
+      :alt: alby-start9
+
+   .. figure:: /_static/images/lightning/alby-start9-lnc.png
+      :width: 50%
+      :alt: alby-start9-lnc
+
+#. You will see the following screen. Launch the Lightning Terminal service UI from your Start9 server and do as instructed below:
+
+   .. figure:: /_static/images/lightning/alby-lnc-fields.png
+      :width: 50%
+      :alt: alby-lnd-fields
+
+#. Click **Continue** and you will see this once you successfully connect:
+
+   .. figure:: /_static/images/lightning/alby-success.png
+      :width: 50%
+      :alt: alby-success

site/source/user-manual/service-guides/lightning/alby-lnd.rst

@@ -0,0 +1,49 @@
+.. _alby-lnd:
+
+====
+Alby
+====
+
+Alby is a browser extension that can be connected to your lightning node a number of ways. This guide will go over direct connections between Alby and your **LND node**.
+
+If you'd like to connect via `LNbits <https://marketplace.start9.com/marketplace/lnbits>`_ which allows allocation of funds, please see :ref:`this guide<connecting-lnbits>`.
+
+.. note:: We are going to connect using Tor so that Alby will be able to connect from anywhere.
+
+#. Make sure you are already :ref:`running Tor<connecting-tor>` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.<tor-firefox>`
+
+#. Download the Alby extension by visiting the `Alby Github <https://github.com/getAlby/lightning-browser-extension#installation>`_, selecting your browser, and installing.
+#. On the Alby welcome screen, select **Get Started**.
+#. Create a strong password and store it somewhere safe, like your Vaultwarden password manager.
+#. On the next screen, select **Other Wallets** and click **Connect**.
+
+#. Select **Start9** and then **LND**:
+
+   .. figure:: /_static/images/lightning/alby-start9.png
+      :width: 50%
+      :alt: alby-start9
+
+   .. figure:: /_static/images/lightning/alby-select-lnd.png
+      :width: 50%
+      :alt: alby-select-lnd
+
+#. Copy the **LND Connect REST URL** from your LND service page's **Properties** section and paste it into Alby:
+
+   .. figure:: /_static/images/lightning/lnd-connect-rest-url.png
+      :width: 60%
+      :alt: lnd-connect-rest-url
+
+#. Alby will pick up that you are connecting over Tor and suggest using their Companion App (only needed if your browser isn't setup to use Tor) or using Tor natively which you will be able to do. Select **TOR (native)** and click **Continue**:
+
+   .. figure:: /_static/images/lightning/alby-lnd-rest-entered.png
+      :width: 50%
+      :alt: alby-lnd-rest-entered
+
+   .. note:: If this does not work, please ensure that :ref:`Tor is running on your system<connecting-tor>` and that :ref:`Firefox is configured to use it.<tor-firefox>` If you can't get this to work it's OK to use the Companion App - but you will have a better experience with your Start9 server elsewhere if you take the time to get Tor running on your devices.
+
+#. Once connection is completed you will see a success page that displays the balance of your LND node in Sats.
+
+   .. figure:: /_static/images/lightning/alby-success.png
+      :width: 60%
+
+You are now setup to use your LND node from anywhere using Alby!

site/source/user-manual/service-guides/lightning/bluewallet.rst

@@ -0,0 +1,137 @@
+.. _blue-wallet:
+
+BlueWallet
+----------
+
+.. note:: This guide assumes you have already setup LNbits as per :ref:`this guide <connecting-lnbits>` with **LND** as your underlying node.
+
+.. warning:: **This will not work with CLN as your underlying node!**
+
+#. Bluewallet requires that we use the LnbHub extension in order to connect to LNbits.
+
+#. To do this, click **Manage Extensions**:
+
+   .. figure:: /_static/images/services/lnbits/manage-extensions.png
+      :width: 50%
+      :alt: manage-extensions
+
+#. Click **MANAGE** under the LndHub extension:
+
+   .. figure:: /_static/images/services/lnbits/lndhub-manage.png
+      :width: 40%
+      :alt: lndhub-manage
+
+#. Click the two arrows on the right, then click install:
+
+   .. figure:: /_static/images/services/lnbits/arrows-install.png
+      :width: 40%
+      :alt: arrows-install
+
+#. Now ensure that it says **Activated** underneath LndHub and then click **Extensions** on the left:
+
+   .. figure:: /_static/images/services/lnbits/activated-click-extensions.png
+      :width: 40%
+      :alt: activated-click-extensions
+
+#. Click **ENABLE**:
+
+   .. figure:: /_static/images/services/lnbits/extensions-enable.png
+      :width: 40%
+      :alt: extensions-enable
+
+#. Click **OPEN** *or* **LndHub** under *Extensions*:
+
+   .. figure:: /_static/images/services/lnbits/lndhub-open.png
+      :width: 40%
+      :alt: lndhub-open
+
+#. Make sure the wallet you just created is selected below the two QR codes:
+
+   .. figure:: /_static/images/services/lnbits/lndhub-select-wallet.png
+      :width: 40%
+      :alt: lndhub-select-wallet
+
+#. Open up BlueWallet and click on the three dots in the top right:
+
+    .. figure:: /_static/images/services/lnbits/bluewallet-three-dots.jpg
+        :width: 20%
+
+#. Click "Network" then "Tor settings":
+
+    .. figure:: /_static/images/services/lnbits/bluewallet-network.jpg
+        :width: 20%
+
+    .. figure:: /_static/images/services/lnbits/bluewallet-tor-settings.jpg
+        :width: 20%
+
+#. Click "Start" and it should say "Done" after a short time:
+
+    .. figure:: /_static/images/services/lnbits/bluewallet-tor-start.jpg
+        :width: 20%
+
+    .. figure:: /_static/images/services/lnbits//bluewallet-tor-done.jpg
+        :width: 20%
+
+#. Head back to the main screen and click the **"+"** sign:
+
+    .. figure:: /_static/images/services/lnbits/bluewallet-add-wallet.jpg
+        :width: 20%
+
+#. Click "Import wallet":
+
+    .. figure:: /_static/images/services/lnbits/bluewallet-plus.jpg
+      :width: 20%
+
+#. Click "Scan or import a file"
+
+    .. note:: Screenshots not possible for this step!
+
+#. *If you only want this wallet to be able to RECEIVE PAYMENTS, scan this QR code:*
+
+    .. figure:: /_static/images/services/lnbits/left-qr.png
+      :width: 40%
+      :alt: left-qr
+
+    *If you are happy for this wallet to be able to both receive and MAKE payments scan this QR code:*
+
+        .. figure:: /_static/images/services/lnbits/right-qr.png
+            :width: 40%
+            :alt: right-qr
+
+#. You'll see this once the wallet is added:
+
+    .. figure:: /_static/images/services/lnbits/bluewallet-wallet-added.jpg
+        :width: 30%
+        :alt: bluewallet-with-funds
+
+#. You can now allocate sats to this wallet within LNbits by clicking the **"+"** icon here:
+
+    .. figure:: /_static/images/services/lnbits/plus-icon.png
+        :width: 60%
+        :alt: plus-icon
+
+    Let's add 1000 satoshis:
+
+    .. figure:: /_static/images/services/lnbits/add-1000-sats.png
+        :width: 60%
+        :alt: add-1000-sats
+
+    .. figure:: /_static/images/services/lnbits/1k-sats.png
+        :width: 60%
+        :alt: 1k-sats
+
+#. BlueWallet should now show a balance:
+
+    .. figure:: /_static/images/services/lnbits/blue-wallet-balance.jpg
+        :width: 25%
+        :alt: blue-wallet-balance
+
+#. You can also receive funds the normal way by hitting "Receive" within BlueWallet.
+
+    .. figure:: /_static/images/services/lnbits/blue-wallet-receive.jpg
+        :width: 25%
+        :alt: blue-wallet-receive
+
+    .. note:: Funds received this way must be sent from another lightning node, not the LND node underneath LNbits. A lightning payment that originates and terminates at the same node is technically a rebalance, not a normal payment.
+
+Congratulations! BlueWallet is set up and ready to use lightning via your own lightning node - furthermore it will only be able to use your node in the way you allow it, via LNbits.

site/source/user-manual/service-guides/lightning/connecting-cln.rst

@@ -0,0 +1,17 @@
+.. _connecting-cln:
+
+==================================
+Connect Directly to Core Lightning
+==================================
+
+Core Lightning is one of the two lightning implementations found on Start9 servers. It was created and is maintained by `Blockstream <https://blockstream.com>`_.
+
+If you want to connect a wallet to it, you can do so using one of the following guides:
+
+.. toctree::
+  :maxdepth: 1
+
+  alby-cln
+  ride-the-lightning
+  spark
+  zeus-cln-direct

site/source/user-manual/service-guides/lightning/connecting-lnbits.rst

@@ -0,0 +1,63 @@
+.. _connecting-lnbits:
+
+======
+LNbits
+======
+
+The concept
+-----------
+
+LNbits allows you to create a wallet that makes use of your node with only an alloted amount of sats. This restriction can be very helpful for if you only want to have a small amount for spending on your phone without making your entire lightning balance available. You can even allow other people to have wallets you create for them - think giving your children an allowance. They can start with a set amount (can be zero) and simply spend what you initially make available. They can also earn more for themselves as they will have the freedom to issue their own invoices - all while making use of your node.
+
+.. tip:: All wallets created this way are ultimately bound by the capacity of your node. If one wallet is allocated 10,000 sats but your underlying node only has 9000 sats of outbound capacity, payments will simply fail.
+
+What lightning node should I use?
+---------------------------------
+
+This will work for both **Core Lightning (CLN)** and **LND** *but* if you want to connect :ref:`Zeus<zeus-lnbits>` or :ref:`BlueWallet<blue-wallet>` to LNbits then **this will only work with LND** as the underlying node. This is because the LNDhub plugin will be required. 
+
+If you are looking to connect the `Alby <https://github.com/getAlby/lightning-browser-extension#installation>`_ browser extension to your LNbits wallet, that will work with **both CLN** *and* **LND**.
+
+Setting up LNbits
+-----------------
+
+.. note:: You will need a Tor enabled browser. We suggest using Firefox which will need to have been setup to use Tor - if you have yet to do this please see our guide :ref:`here<tor-firefox>`. This also requires having :ref:`native tor setup<tor-os>`.
+
+#. Start by ensuring that you have LNbits installed already as well as LND or Core Lightning (CLN). You also need your lightning node to have at least one channel set up otherwise payments will not work. If you have not set up a channel yet, please follow :ref:`this guide<lightning-intro>`.
+
+   .. figure:: /_static/images/services/lnbits/lnbits-lnd-cln-installed.png
+      :width: 40%
+      :alt: lnbits-lnd-cln-installed
+
+   .. tip:: Remember - if you intend to connect BlueWallet or Zeus, that will only be possible with LND. Alby can work with both.
+
+#. Head to LNbits on your server, click on **Properties** and copy the address under **(Tor) Superuser Account**:
+
+   .. figure:: /_static/images/services/lnbits/tor-super-user.png
+      :width: 40%
+      :alt: tor-super-user
+
+#. Paste this address into your browser and you'll see the following screen - click **I understand**:
+
+   .. figure:: /_static/images/services/lnbits/superuser-first-open.png
+      :width: 60%
+      :alt: superuser-first-open
+
+   .. note:: This isn't a concern on StartOS as all wallets created will have the address they generated stored within **Properties** within the LNbits serivce.
+
+#. Now a default wallet will have already been generated - highlighted on the top left. We'll rename it by clicking **Rename wallet** entering **android-zeus-wallet** then clicking **UPDATE NAME**:
+
+   .. figure:: /_static/images/services/lnbits/rename-default-wallet.png
+      :width: 60%
+      :alt: rename-default-wallet
+
+   .. note:: I have called the wallet "android-zeus-wallet" but it is fine to use other wallets.
+
+Now you can proceed to connect one of the following wallets to LNbits using the guides below:
+
+.. toctree::
+  :maxdepth: 1
+
+  alby-lnbits
+  bluewallet
+  zeus-lnbits