Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-30 12:11:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

restructure docs

Browse Source
This commit is contained in:
Matt Hill
2023-11-06 12:34:37 -07:00
parent 80651a6609
commit fe79d71e7c
150 changed files with 404 additions and 1866 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
site/source/service-guides/lightning/alby-cln.rst Normal file
View File

@@ -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.<configuring-ff>`
#. 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!

87
site/source/service-guides/lightning/alby-lnbits.rst Normal file
View File

@@ -0,0 +1,87 @@
.. _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.<configuring-ff>`
#. 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.<configuring-ff>`
#. 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!
#. In addition to allocating sats to this wallet via the LNbits Superuser Account (see "Funding LNbits section" :ref:`here<connecting-lnbits>`), 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!

45
site/source/service-guides/lightning/alby-lnc.rst Normal file
View File

@@ -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

49
site/source/service-guides/lightning/alby-lnd.rst Normal file
View File

@@ -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.<configuring-ff>`
#. 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.<configuring-ff>` 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!

115
site/source/service-guides/lightning/bluewallet.rst Normal file
View File

@@ -0,0 +1,115 @@
.. _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
#. In addition to allocating sats to this wallet via the LNbits Superuser Account (see "Funding LNbits section" :ref:`here<connecting-lnbits>`), 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.

18
site/source/service-guides/lightning/connecting-cln.rst Normal file
View File

@@ -0,0 +1,18 @@
.. _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
fully-noded-cln
ride-the-lightning
spark
zeus-cln-direct

84
site/source/service-guides/lightning/connecting-lnbits.rst Normal file
View File

@@ -0,0 +1,84 @@
.. _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<configuring-ff>`. This also requires having :ref:`native tor setup<connecting-tor>`.
#. 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
Funding LNbits
--------------
After any of the above wallets has been setup with the corresponding instructions, you can 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
Your newly created LNbits wallet has now been funded and is ready to send sats over the Lightning Network!

18
site/source/service-guides/lightning/connecting-lnd.rst Normal file
View File

@@ -0,0 +1,18 @@
.. _connecting-lnd:
=======================
Connect Directly to LND
=======================
The following wallets can connect directly to LND via LND's REST API.
.. tip:: If you'd like to connect via LNbits instead, click :ref:`here<connecting-lnbits>`.
.. toctree::
:maxdepth: 1
alby-lnd
fully-noded-lnd
ride-the-lightning
zap
zeus-lnd-direct

19
site/source/service-guides/lightning/connecting-lndc.rst Normal file
View File

@@ -0,0 +1,19 @@
.. _connecting-lndc:
===============================================
Connect to LND via Lightning Node Connect (LNC)
===============================================
Lightning Node Connect (LNC) provides a very simple way to connect to an LND node that **does not require the Tor network**.
This is **not** the same as **connecting directly to LND** for which guides can be found :ref:`here<connecting-lnd>`.
.. note:: This requires installing the `Lightning Terminal <https://marketplace.start9.com/marketplace/lightning-terminal>`_ service on your Start9 server.
The following two guides go over how to connect wallets to LND via LNC.
.. toctree::
:maxdepth: 1
alby-lnc
zeus-lnc

26
site/source/service-guides/lightning/fully-noded-cln.rst Normal file
View File

@@ -0,0 +1,26 @@
.. _fully-noded-cln:
===========
Fully Noded
===========
Sovereign, secure, powerful, and easy-to-use wallet that utilizes your own CLN node as a backend.
Available For:
- iOS
- macOS
.. note:: Works with both Core Lightning (CLN) and LND! If you'd like to connect Fully Noded to LND instead - please use :ref:`this guide<fully-noded-lnd>`.
#. Download Fully Noded from the Apple app store.
#. Log into your Start9 server UI and select Services -> Core Lightning -> Properties -> Sparko Properties.
.. note:: Unfortunately Fully Noded does not yet support connecting to Sparko via QR code; Instead the Address and Sparko key will need to be individually scanned/copied and pasted into the respective fields in the Fully Noded app.
#. Click the QR code icon next to "Sparko Address" to display the QR code and scan this with your iPhone/mac, or copy/paste through another channel to your client.
#. In Fully Noded, go to Settings -> Node Manager -> + -> Core Lightning
#. Paste the "Sparko Address" from above into the "Address" field, appending a colon and the port i.e. ``:9737`` after ``.onion``
#. Back in your CLN service page, get your "Sparko key" and scan/copy it into the "Sparko key" field in the Fully Noded app.
#. Press "SAVE"
You can now use Fully Noded with your CLN node to send/receive bitcoin over the lightning network, open/close channels, connect to peers, etc!

20
site/source/service-guides/lightning/fully-noded-lnd.rst Normal file
View File

@@ -0,0 +1,20 @@
.. _fully-noded-lnd:
===========
Fully Noded
===========
Sovereign, secure, powerful, and easy-to-use wallet that utilizes your own LND node as a backend.
Available For:
- iOS
- macOS
.. note:: Works with both Core Lightning (CLN) and LND! If you'd like to connect Fully Noded to CLN instead - please use :ref:`this guide<fully-noded-cln>`.
#. Download Fully Noded from the Apple app store.
#. Log into your Start9 server UI and select Services -> LND -> Properties.
#. Click the QR code icon next to "LND Connect REST URL" to display the QR code and scan/copy this with your iPhone/mac.
#. Press "SAVE"
You can now use Fully Noded with your LND node to send/receive bitcoin over the lightning network, open/close channels, connect to peers, etc!

43
site/source/service-guides/lightning/index.rst Normal file
View File

@@ -0,0 +1,43 @@
.. _lightning-service:
=========
Lightning
=========
The following guide will get you up and running with a lightning node and walk you through opening your first channel.
.. toctree::
:maxdepth: 1
lightning-first-channel
Now that you're up and running, it's time to connect an interface so that you can use your node to make and receive payments from anywhere!
If you're using **Core Lightning (CLN)** and would like a direct connection you can select one of the following options:
.. toctree::
:maxdepth: 2
connecting-cln
If you're using **LND**, you can select one of the following options:
.. toctree::
:maxdepth: 2
connecting-lnd
If you would like to connect to LND via Lightning Node Connect **(LNC)** in order to avoid using Tor, you can do so with Alby and Zeus via the Lightning Terminal service:
.. toctree::
:maxdepth: 2
connecting-lndc
If you'd like to allocate only a portion of your lightning node's liquidity to a wallet or have a wallet that can receive but not make payments, you can use **LNbits** - LNbits allows you to create a wallet that makes use of your node with only an alloted amount of sats and it works with both **Core Lightning** and **LND**.
.. toctree::
:maxdepth: 3
connecting-lnbits

194
site/source/service-guides/lightning/lightning-first-channel.rst Normal file
View File

@@ -0,0 +1,194 @@
.. _lightning-intro:
==========================
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!
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%
:alt: bitcoin-synced
#. Install a lightning node. There are two options we offer on the `Start9 marketplace <https://marketplace.start9.com>`_ - 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%
:alt: two-impls-marketplace
#. 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%
:alt: cln-installing
#. You'll see CLN say **Needs Config**. Click **Configure**:
.. figure:: /_static/images/lightning/cln-needs-config.png
:width: 60%
:alt: cln-needs-config
#. You can leave the settings as their default values and hit **SAVE**.
.. figure:: /_static/images/lightning/cln-save-config.png
:width: 60%
:alt: cln-save-config
#. 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%
:alt: cln-syncing
#. 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%
:alt: cln-green
#. 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%
:alt: rtl-marketplace
#. Install it and click on **Configure** just like with CLN.
.. figure:: /_static/images/lightning/rtl-needs-config.png
:width: 60%
:alt: rtl-needs-config
#. 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%
:alt: rtl-config-lnd
Change to Core Lightning (CLN) and hit OK:
.. figure:: /_static/images/lightning/rtl-change-to-cln.png
:width: 60%
:alt: rtl-change-to-cln
Hit **Save**:
.. figure:: /_static/images/lightning/rtl-config-save.png
:width: 60%
:alt: rtl-config-save
#. Now hit **Start**:
.. figure:: /_static/images/lightning/rtl-start.png
:width: 60%
:alt: rtl-start
#. With RTL started, click **Properties**:
.. figure:: /_static/images/lightning/rtl-click-properties.png
:width: 60%
:alt: rtl-click-properties
#. Copy the automatically generated password:
.. figure:: /_static/images/lightning/rtl-copy-pass.png
:width: 60%
:alt: rtl-copy-pass
#. Head back to the RTL service and click **Launch UI**:
.. figure:: /_static/images/lightning/rtl-launch-ui.png
:width: 60%
:alt: rtl-launch-ui
Enter the copied password and log in:
.. figure:: /_static/images/lightning/rtl-enter-pass.png
:width: 60%
:alt: rtl-enter-pass
.. 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%
:alt: rtl-generate-address
#. Send bitcoin to the generated address to add funds to your lightning wallet:
.. figure:: /_static/images/lightning/rtl-address-generated.png
:width: 60%
:alt: rtl-address-generated
.. 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 <https://donate.start9.com>`_
#. Once your sats confirm on-chain you'll see this:
.. figure:: /_static/images/lightning/rtl-on-chain.png
:width: 60%
:alt: rtl-on-chain
#. 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%
:alt: rtl-peers-channels
#. Click **Peers** then **Add Peer**:
.. figure:: /_static/images/lightning/rtl-peers-add-peer.png
:width: 60%
:alt: rtl-peers-add-peer
#. Enter the details of the lightning node you'd like to open a channel with. Start9's node can be found `here <https://1ml.com/node/025d28dc4c4f5ce4194c31c3109129cd741fafc1ff2f6ea53f97de2f58877b2295>`_ 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%
:alt: rtl-start9-node-info
.. 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 <https://mempool.space>`_ for an idea of current necessary fees):
.. figure:: /_static/images/lightning/rtl-open-channel.png
:width: 60%
:alt: rtl-open-channel
.. 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%
:alt: rtl-pending-inactive
#. 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%
:alt: rtl-open-channels
#. To make a payment head to the **Transactions** tab and press **Send Payment**:
.. figure:: /_static/images/lightning/rtl-transactions-tab.png
:width: 60%
:alt: rtl-transactions-tab
#. 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.
If you want to connect other applications or wallets to your node, please see the guides :ref:`here<lightning-service>`.

10
site/source/service-guides/lightning/ride-the-lightning.rst Normal file
View File

@@ -0,0 +1,10 @@
.. _rtl:
Ride the Lightning
------------------
This can simply be installed by going to your Start9 Server's marketplace, clicking on **Ride The Lightning** and then installing the latest version. Once installed you can configure it to work with either - or both - Core Lightning and LND!
.. figure:: /_static/images/lightning/marketplace-rtl.png
:width: 55%
:alt: rtl-within-marketplace

36
site/source/service-guides/lightning/spark.rst Normal file
View File

@@ -0,0 +1,36 @@
.. _spark:
Spark
-----
.. note:: Compatible with Core Lightning (CLN) only
Available For:
- `Android <https://github.com/shesek/spark-wallet/releases>`_
- `StartOS <https://marketplace.start9.com/marketplace/spark-wallet>`_
- `iOS as a PWA <https://github.com/shesek/spark-wallet#progressive-web-app>`_
.. warning:: Please be careful - there are multiple fake "Spark Wallets" out there. The above links have been verified and can be trusted.
To use Spark, you simply install it as a service on your Start9 Server. You can then use it to operate your CLN node by clicking **Launch UI** within the service:
.. note:: This will act as a server as well, and is required if you want to use the mobile app.
.. figure:: /_static/images/lightning/spark-launch-ui.png
:width: 45%
:alt: spark-launch-ui
If you would like to connect a mobile client you can click **Properties**:
.. figure:: /_static/images/lightning/spark-properties.png
:width: 45%
:alt: spark-properties
and then click on the button below to reveal the **Pairing URL** which you then scan with your mobile device.
.. figure:: /_static/images/lightning/spark-pairing.png
:width: 45%
:alt: spark-pairing
.. tip:: On iOS you cannot scan this QR code due to PWAs being forbidden from using the camera. You can instead simply copy and paste the Pairing URL.

27
site/source/service-guides/lightning/zap.rst Normal file
View File

@@ -0,0 +1,27 @@
.. _zap:
Zap
---
Available on `Android <https://play.google.com/store/apps/details?id=zapsolutions.zap>`_ and `iOS <https://apps.apple.com/us/app/zap-bitcoin-lightning-wallet/id1406311960>`_.
.. note:: Compatible with LND only
#. Install Zap via your phone's app store.
#. Go to Settings and activate Tor.
#. Go to **Add a Wallet**
#. Locate the **LND Connect REST URL** from your LND service page's **Properties** section:
.. figure:: /_static/images/lightning/lnd-properties.png
:width: 55%
:alt: lnd-properties
#. Display the QR code by clicking on the following button:
.. figure:: /_static/images/lightning/lnd-connect-qr-code.png
:width: 55%
:alt: lnd-rest
#. Scan the QR code with your phone.
Zap is now connected to your LND node!

40
site/source/service-guides/lightning/zeus-cln-direct.rst Normal file
View File

@@ -0,0 +1,40 @@
.. _zeus-cln:
Zeus
----
.. note:: You must first :ref:`connect to tor on your device<connecting-tor>`.
Zeus is a powerful mobile wallet that can be connected directly to both LND and Core Lightning. If you'd like to connect via LNbits, which allows allocation of funds, please see :ref:`this guide<connecting-lnbits>`.
Available For:
- Android
- iOS
.. note:: Works with both Core Lightning (CLN) and LND! If you'd like to connect Zeus to LND instead - please use :ref:`this guide<zeus-lnd>`.
#. Download `Zeus <https://zeusln.app/>`_ for your device.
#. Log into StartOS and select Services -> Core Lightning -> Properties.
.. figure:: /_static/images/lightning/zeus-cln-direct-step3.png
:width: 60%
#. Tap the QR code icon for "REST Quick Connect" to display the QR code.
.. figure:: /_static/images/lightning/zeus-cln-direct-step4.png
:width: 60%
#. In Zeus, tap "Scan node config". Allow camera access, scan the QR code, and then tap 'Save node config'.
.. figure:: /_static/images/lightning/zeus-cln-direct-step5.png
:width: 60%
.. note:: If you already have other nodes configured in Zeus, go to Settings.-> Connect a node -> + . Then scan the QR code, and tap "Save node config".
.. figure:: /_static/images/lightning/zeus-cln-direct-step6.png
:width: 40%
#. That's it. You can now use your Core Lightning Node via Zeus.

108
site/source/service-guides/lightning/zeus-lnbits.rst Normal file
View File

@@ -0,0 +1,108 @@
.. _zeus-lnbits:
Zeus
----
.. note:: This is not the same as connecting Zeus directly to your lightning node - using LNbits allows us to allocate a specific amount of funds to Zeus instead of giving it full access to your lightning node. We can also use LNbits to permit Zeus to **just receive** satoshis, or the ability to both **receive and spend** satoshis.
.. 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!**
#. Zeus 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
#. Install `Zeus <https://zeusln.app/>`_.
#. Open it up and click **SCAN NODE CONFIG**.
.. figure:: /_static/images/services/lnbits/scan-node-config.jpg
:width: 25%
:alt: scan-node-config
#. *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
#. Once scanned, name the wallet if you wish, then hit **SAVE NODE CONFIG**.
.. figure:: /_static/images/services/lnbits/save-node-config.jpg
:width: 25%
:alt: save-node-config
#. Zeus will now connect to your node and you'll see this screen:
.. figure:: /_static/images/services/lnbits/new-wallet-screen-zeus.png
:width: 25%
:alt: new-wallet-screen-zeus
.. tip:: If it doesn't work, please manually restart the Zeus app.
#. In addition to allocating sats to this wallet via the LNbits Superuser Account (see "Funding LNbits section" :ref:`here<connecting-lnbits>`), you can also receive funds the normal way by hitting **Request** within Zeus.
.. figure:: /_static/images/services/lnbits/zeus-request.png
:width: 20%
:alt: zeus-request
.. note:: This will only work if your node has inbound liquidity. And you cannot send sats from the LND node LNbits is using as that is not a regular lightning payment - that is a reblanace.
#. Once you have added sats, you can click on this button within Zeus and see your new balance:
.. figure:: /_static/images/services/lnbits/zeus-balance-button.png
:width: 20%
:alt: zeus-balance-button
.. figure:: /_static/images/services/lnbits/zeus-balance.png
:width: 20%
:alt: zeus-balance
Congratulations! Zeus 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.

77
site/source/service-guides/lightning/zeus-lnc.rst Normal file
View File

@@ -0,0 +1,77 @@
.. _zeus-lnc:
====
Zeus
====
Lightning Node Connect (LNC) provides a very simple way to connect to an LND node. In this guide we'll cover how to connect to LND via LNC with Zeus.
Zeus is available for `Android <https://zeusln.app/zeus-v0.7.5-universal.apk>`_ & `iOS <https://apps.apple.com/us/app/zeus-ln/id1456038895>`_.
.. note:: If you'd like to connect to LND using LND REST instead, follow :ref:`this guide<zeus-lnd>`. If you'd like to connect to LND via LNbits which allows allocation of funds, follow :ref:`this guide<connecting-lnbits>`.
#. Install `Lightning Terminal <https://marketplace.start9.com/marketplace/lightning-terminal>`_
#. Click **LAUNCH UI**:
.. figure:: /_static/images/lightning/lit-launch-ui.png
:width: 40%
:alt: lit-launchUI
#. The password can be found in **Properties**:
.. figure:: /_static/images/lightning/lit-properties.png
:width: 40%
:alt: lit-properties
#. Copy it by clicking this square:
.. figure:: /_static/images/lightning/lit-properties-x.png
:width: 40%
:alt: copy-password
#. Paste it into Lightning Terminal and click **Submit**:
.. figure:: /_static/images/lightning/lit-paste-pass.png
:width: 40%
:alt: lit-paste-pass
#. Click on **Lightning Node Connect**:
.. figure:: /_static/images/lightning/lit-lnc1.png
:width: 40%
:alt: lit-lnc1
#. Click **Create a new session**:
.. figure:: /_static/images/lightning/lit-lnc2.png
:width: 40%
:alt: lit-lnc2
#. Name the wallet and click **Submit**:
.. figure:: /_static/images/lightning/lit-lnc3.png
:width: 40%
:alt: lit-lnc3
#. Click on the QR code:
.. figure:: /_static/images/lightning/lit-lnc4.png
:width: 40%
:alt: lit-lnc4
#. Install `Zeus <https://zeusln.app/>`_ if not already installed.
#. Open up Zeus and click **SCAN NODE CONFIG** then scan the QR code.
.. figure:: /_static/images/lightning/zeus-scan-node-config.jpg
:width: 25%
:alt: zeus-scan-node-config
#. Click **SAVE NODE CONFIG**:
.. figure:: /_static/images/lightning/zeus-save-node-config.jpg
:width: 25%
:alt: zeus-save-node-config
Zeus is now setup to connect to your LND node via LNC!

44
site/source/service-guides/lightning/zeus-lnd-direct.rst Normal file
View File

@@ -0,0 +1,44 @@
.. _zeus-lnd:
Zeus
----
Zeus is a powerful mobile wallet that can be connected directly to both LND and Core Lightning (CLN). If you'd like to connect via LNbits which allows allocation of funds, please see :ref:`this guide<connecting-lnbits>`.
Zeus is available for `Android <https://zeusln.app/zeus-v0.7.5-universal.apk>`_ & `iOS <https://apps.apple.com/us/app/zeus-ln/id1456038895>`_.
This guide will go over how to connect Zeus to **LND**. If you'd like to connect Zeus to CLN instead - please use :ref:`this guide<zeus-cln>`.
#. Download the Zeus from your mobile device's application store.
#. In your Start9 server's **services** tab, select **LND**.
.. figure:: /_static/images/lightning/lnd-within-services.png
:width: 40%
:alt: lnd-services
#. Click **Properties**:
.. figure:: /_static/images/lightning/lnd-properties.png
:width: 40%
:alt: lnd-properties
#. Click the QR code icon highlighted below to display the **LND Connect REST URL** QR code:
.. figure:: /_static/images/lightning/lnd-connect-qr-code.png
:width: 40%
:alt: lnd-connect-qrcode
#. Open Zeus on your mobile device and click **SCAN NODE CONFIG**:
.. figure:: /_static/images/services/lnbits/scan-node-config.jpg
:width: 25%
:alt: scan-node-config
#. Scan the QR Code displayed on the server's LND Connect REST URL screen.
#. Zeus will fill in your node details based on the information in the QR code.
#. Click **SAVE NODE CONFIG**
Zeus is now setup to access and control your LND node!