mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-30 12:11:57 +00:00
6ffcfeedcb
* update zeus instructions * update RTL too * Update site/source/user-manual/service-guides/lightning/lightning-integrations.rst Co-authored-by: kn0wmad <39687477+kn0wmad@users.noreply.github.com> * Update site/source/user-manual/service-guides/lightning/lightning-integrations.rst Co-authored-by: kn0wmad <39687477+kn0wmad@users.noreply.github.com> * don't call it an embassy * add a (CLN) abbrev) --------- Co-authored-by: kn0wmad <39687477+kn0wmad@users.noreply.github.com>
187 lines
6.6 KiB
ReStructuredText
187 lines
6.6 KiB
ReStructuredText
======================
|
|
Lightning Integrations
|
|
======================
|
|
|
|
Below is a list of lightning wallets and clients along with instructions on how to use them with your Embassy.
|
|
|
|
Alby
|
|
----
|
|
|
|
Available For
|
|
.............
|
|
- Chrome-based browsers
|
|
- Firefox
|
|
|
|
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".
|
|
#. Now follow the appropriate guide for your lightning implementation:
|
|
|
|
.. tabs::
|
|
|
|
.. group-tab:: Core Lightning
|
|
|
|
#. Click Core Lightning.
|
|
|
|
.. figure:: /_static/images/lightning/cln-in-alby.png
|
|
:width: 60%
|
|
|
|
#. For "Host" this is your Peer Interface - find this at the top of "Interfaces" within the CLN service on your Embassy. Remove the *http://* at the start.
|
|
|
|
.. figure:: /_static/images/lightning/cln-peer-interface.png
|
|
:width: 60%
|
|
|
|
#. For "Public key" enter your "Node Id" found at the top of "Properties" (also within the CLN service on your Embassy).
|
|
|
|
.. figure:: /_static/images/lightning/cln-nodeid.png
|
|
:width: 60%
|
|
|
|
#. For "Rune" you will need to install the `Spark <https://marketplace.start9.com/marketplace/spark-wallet>`_ service on your Embassy, 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: 60%
|
|
|
|
#. 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: 60%
|
|
|
|
#. Leave the Port as 9735. It should look like this:
|
|
|
|
.. figure:: /_static/images/lightning/alby-cln.png
|
|
:width: 60%
|
|
|
|
#. Click Continue. Once the connection is completed you will see a success page that displays the balance of your CLN node in Sats. You can now launch the tutorial and learn how to use Alby!
|
|
|
|
.. group-tab:: LND
|
|
|
|
#. Select "Start9":
|
|
|
|
.. figure:: /_static/images/lightning/start9-lnd-in-alby.png
|
|
:width: 60%
|
|
|
|
#. You'll now need to enter your LND Connect REST URL from your LND service page's "Properties" section:
|
|
|
|
.. figure:: /_static/images/lightning/lnd-connect-rest-url.png
|
|
:width: 60%
|
|
|
|
#. 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):
|
|
|
|
.. figure:: /_static/images/lightning/alby-tor-native.png
|
|
:width: 60%
|
|
|
|
.. 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.
|
|
|
|
#. Click "Continue" and once connection is completed you will see a success page that displays the balance of your LND node in Sats. You can now launch the tutorial and learn how to use Alby!
|
|
|
|
.. figure:: /_static/images/lightning/alby-success.png
|
|
:width: 60%
|
|
|
|
|
|
.. _blue-wallet-lightning:
|
|
|
|
BlueWallet
|
|
----------
|
|
|
|
.. note:: Not available at this time - LNDHub is required
|
|
|
|
.. _rtl:
|
|
|
|
Ride the Lightning
|
|
------------------
|
|
|
|
Available For
|
|
.............
|
|
- embassyOS
|
|
|
|
This can simply be installed by going to your Start9 Server's marketplace clicking on "Ride The Lightning" then installing the latest version. Once installed you can configure it to work with either - or both - Core Lightning and LND!
|
|
|
|
.. _spark:
|
|
|
|
Spark
|
|
-----
|
|
|
|
.. note:: Compatible with Core Lightning (CLN) only
|
|
|
|
Available For
|
|
.............
|
|
- Android
|
|
- embassyOS
|
|
- iOS
|
|
|
|
To use a Spark client, you still first need to have Spark installed as a service on your Start9 Server. The Spark service is both a server (background service) and a client (the :ref:`Web UI<web-ui>`). Under Properties, there is a "Pairing URL". The first part of this is the server URL, and the end portion of it is the access key.
|
|
|
|
.. _thunderhub:
|
|
|
|
Thunderhub
|
|
----------
|
|
|
|
Available For
|
|
.............
|
|
- embassyOS
|
|
|
|
Download from your Embassy's Marketplace and follow the included Instructions.
|
|
|
|
.. _zap:
|
|
|
|
Zap
|
|
---
|
|
|
|
Available For
|
|
.............
|
|
- Android
|
|
- iOS
|
|
|
|
.. note:: Compatible with LND only
|
|
|
|
#. Download from your device's application store.
|
|
#. Go to Settings and activate Tor.
|
|
#. Go to Add a Wallet and scan the LND REST connection QR code found in your Embassy's LND service page -> Properties.
|
|
|
|
.. _zeus:
|
|
|
|
Zeus
|
|
----
|
|
|
|
Available For
|
|
.............
|
|
- Android
|
|
- iOS
|
|
|
|
.. note:: Works with both LND and Core Lightning (CLN)
|
|
|
|
.. tabs::
|
|
|
|
.. group-tab:: Core Lightning
|
|
|
|
#. Download the Zeus: Bitcoin and Lightning wallet from your mobile device's application store.
|
|
#. Open your Embassy's web interface and log in
|
|
#. Select Services -> Core Lightning
|
|
#. Select "Properties"
|
|
#. Click the QR code next to "REST API Quick Connect" to display the QR code
|
|
#. Open Zeus on your mobile device and go to Settings / Get Started -> Connect a node -> +
|
|
#. Select "Use Tor"
|
|
#. Change "Node interface" to "Core Lightning (c-lightning-REST)"
|
|
#. Press "SCAN C-LIGHTNING-REST QR"
|
|
#. Press "SAVE NODE CONFIG"
|
|
|
|
.. group-tab:: LND
|
|
|
|
#. Download the Zeus: Bitcoin and Lightning wallet from your mobile device's application store.
|
|
#. Open your Embassy's web interface and log in
|
|
#. Select Services -> Lightning Network Daemon
|
|
#. Select "Properties"
|
|
#. Click the QR code icon next to "LND Connect REST URL" to display the QR code
|
|
#. Open Zeus on your mobile device and go to Settings / Get Started -> Connect a node -> +
|
|
#. Select "Use Tor"
|
|
#. Press the "SCAN LNDCONNECT CONFIG" button
|
|
#. Scan the QR Code displayed on the Embassy's LND Connect REST URL screen
|
|
|
|
.. note:: If you have trouble scanning it, bring your phone very close to the QR code until it fills the entire target square on your mobile device's QR code camera.
|
|
#. Zeus will fill in your node details based on the information in the QR code
|
|
#. Click "SAVE NODE CONFIG"
|
|
|