Merge pull request #630 from Start9Labs/add/albyhub

Integration of AlbyHub guide(s)
This commit is contained in:
StuPleb
2024-09-27 17:42:18 +02:00
committed by GitHub
34 changed files with 293 additions and 26 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 77 KiB

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 161 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 139 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 150 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 124 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 136 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 106 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 121 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 101 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 143 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 106 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 104 KiB

View File

@@ -1,30 +1,41 @@
.. _alby-cln: .. _alby-cln:
==== ======================
Alby Alby Browser Extension
==== ======================
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. Alby provides a browser extension that can be connected to your lightning node a number of ways. This guide will go over direct connections between the Alby browser extension 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:: If you are looking for AlbyHub, this is not it. To use :ref:`AlbyHub<albyhub>` you must instead run :ref:`LND<lightning-intro>`.
.. note:: If you'd like to connect via `LNbits <https://marketplace.start9.com/marketplace/lnbits>`_ which allows allocation of funds (rather than spend limits within the extention), 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. .. 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-ff>` #. 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-ff>`
#. Download the Alby extension by visiting the `Alby Github <https://github.com/getAlby/lightning-browser-extension#installation>`_, selecting your browser, and installing. #. 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. .. figure:: /_static/images/lightning/alby-unlock-passcode.png
#. On the next screen, select **Other Wallets** and click **Connect**. :width: 20%
:alt: alby-passcode
#. Set an unlock passcode and store it somewhere safe, like your Vaultwarden password manager.
.. figure:: /_static/images/lightning/alby-bring-your-own.png
:width: 50%
:alt: alby-own
#. On the next screen, select **Find Your Wallet**.
#. Click **Start9** then **Core Lightning**. #. Click **StartOS** then **Core Lightning**.
.. figure:: /_static/images/lightning/alby-start9.png .. figure:: /_static/images/lightning/alby-select-startos.png
:width: 50% :width: 50%
:alt: alby-start9 :alt: alby-start9
.. figure:: /_static/images/lightning/alby-cln-0.png .. figure:: /_static/images/lightning/alby-select-cln.png
:width: 50% :width: 50%
:alt: alby-cln-0 :alt: alby-cln-0

View File

@@ -1,7 +1,7 @@
.. _alby-lnbits: .. _alby-lnbits:
Alby Alby Browser Extension
---- -----------------------
.. note:: This guide assumes you have already setup LNbits as per :ref:`this guide <connecting-lnbits>`. .. note:: This guide assumes you have already setup LNbits as per :ref:`this guide <connecting-lnbits>`.

View File

@@ -1,8 +1,8 @@
.. _alby-lnc: .. _alby-lnc:
==== ======================
Alby Alby Browser Extension
==== ======================
Alby is a browser extension that can be connected to your lightning node a number of ways. Alby is a browser extension that can be connected to your lightning node a number of ways.

View File

@@ -1,25 +1,36 @@
.. _alby-lnd: .. _alby-lnd:
==== ======================
Alby Alby Browser Extension
==== ======================
.. warning:: This is NOT the guide for setting up **AlbyHub** this is for a direct connection to LND. If you'd like to connect via AlbyHub instead (recommended), click :ref:`here<albyhub>`.
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**. 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:: If you'd like to connect via `LNbits <https://marketplace.start9.com/marketplace/lnbits>`_ which allows allocation of funds (rather than spend limits within the extension), 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. .. 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-ff>` #. 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-ff>`
#. Download the Alby extension by visiting the `Alby Github <https://github.com/getAlby/lightning-browser-extension#installation>`_, selecting your browser, and installing. #. 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. .. figure:: /_static/images/lightning/alby-unlock-passcode.png
#. On the next screen, select **Other Wallets** and click **Connect**. :width: 20%
:alt: alby-passcode
#. Select **Start9** and then **LND**: #. Set an unlock passcode and store it somewhere safe, like your Vaultwarden password manager.
.. figure:: /_static/images/lightning/alby-start9.png .. figure:: /_static/images/lightning/alby-bring-your-own.png
:width: 50%
:alt: alby-own
#. On the next screen, select **Find Your Wallet**.
#. Select **StartOS** and then **LND**:
.. figure:: /_static/images/lightning/alby-select-startos.png
:width: 50% :width: 50%
:alt: alby-start9 :alt: alby-start9

View File

@@ -0,0 +1,219 @@
.. _albyhub:
=======
AlbyHub
=======
Alby Hub is the open-source, self-custodial Lightning wallet that puts you in control. Connect to your LND or to an integrated node, it's more than just a wallet—it's your gateway to Bitcoin. Manage channels, run apps, and take charge of your funds, all through one sleek, user-friendly interface. Empower your Bitcoin journey with simplicity and sovereignty.
Usage options
--------------
- **LND already on your server**: This option tells Alby Hub to use the LND node installed on this StartOS server. It is the more sovereign and secure option, allowing full control over your node.
- **Alby Hub embedded light node**: This option tells Alby Hub to use its own, built-in *light node*. This option is convenient but offers less control over your node.
Getting Started
---------------
#. Once you'de made your decision on how to use AlbyHub, install it from the marketplace.
.. figure:: /_static/images/lightning/albyhub-install.png
:width: 70%
:alt: Installing AlbyHub
#. Click **Configure**
.. figure:: /_static/images/lightning/albyhub-config-0.png
:width: 50%
:alt: Configure
#. And select your prefered usage type…
.. figure:: /_static/images/lightning/albyhub-config-1.png
:width: 50%
:alt: Configure
#. Hit **Save** and then start the service.
LND on your server
------------------
You will be running AlbyHub on your server, and it will be connecting to LND on your server.
#. `Launch` the AlbyHub UI for the first time.
#. Cycle through the introduction to arrive at the setup screen.
.. figure:: /_static/images/lightning/albyhub-setup-0.png
:width: 70%
:alt: Setup
#. Click on the **Get Started (LND)** button.
.. figure:: /_static/images/lightning/albyhub-setup-1.png
:width: 70%
:alt: Setup
#. Enter a password and keep it somewhere safe, like in your personal :ref:`Vaultwarden<vaultwarden-service>` instance.
.. figure:: /_static/images/lightning/albyhub-setup-2.png
:width: 70%
:alt: Setup
#. Select whether you will create an Alby account now or later (i.e. not at all).
.. note:: An Alby Account gives your hub a lightning address, Nostr address and zaps, email notifications, fiat topups, priority support, automatic channel backups, access to podcasting apps & more. If you choose not to create an account, your setup will be complete.
.. figure:: /_static/images/lightning/albyhub-setup-3.png
:width: 70%
:alt: Setup
#. Connect your Alby account by clicking to request and authorization code. This will open a new tab.
.. figure:: /_static/images/lightning/albyhub-albyaccount.png
:width: 70%
:alt: Setup
#. If you have a pre-existing Alby account your can log in here, otherwise you can sign up.
.. figure:: /_static/images/lightning/albyhub-setup-4.png
:width: 70%
:alt: Setup
.. figure:: /_static/images/lightning/albyhub-setup-5.png
:width: 70%
:alt: Setup
#. You will get an authorization code to add back into the previous tab hosted on your server. Paste that auth code and hit **Submit**.
.. figure:: /_static/images/lightning/albyhub-success.png
:width: 70%
:alt: Setup
#. Your self-hosted AlbyHub is ready and connected to your self-hosted LND!
Alby Hub embedded light node
----------------------------
You will be running AlbyHub on your server, and it will be connecting to LDK light node on your server.
#. `Launch` the AlbyHub UI for the first time.
#. Cycle through the introduction to arrive at the setup screen.
.. figure:: /_static/images/lightning/albyhub-ldk-setup-1.png
:width: 70%
:alt: Setup
#. Click on the **Get Started (LDK)** button.
.. figure:: /_static/images/lightning/albyhub-setup-1.png
:width: 70%
:alt: Setup
#. Enter a password and keep it somewhere save, like in your personal Vaultwarden.
.. figure:: /_static/images/lightning/albyhub-setup-2.png
:width: 70%
:alt: Setup
#. Select whether you will create an Alby account now or later (i.e. not at all).
.. note:: An Alby Account gives your hub a lightning address, Nostr address and zaps, email notifications, fiat topups, priority support, automatic channel backups, access to podcasting apps & more. If you choose not to create an account, your setup will be complete.
.. figure:: /_static/images/lightning/albyhub-setup-3.png
:width: 70%
:alt: Setup
#. Connect your Alby account by clicking to request and authorization code. This will open a new tab.
.. figure:: /_static/images/lightning/albyhub-albyaccount.png
:width: 70%
:alt: Setup
#. If you have a pre-existing Alby account your can log in here, otherwise you can sign up.
.. figure:: /_static/images/lightning/albyhub-setup-4.png
:width: 70%
:alt: Setup
.. figure:: /_static/images/lightning/albyhub-setup-5.png
:width: 70%
:alt: Setup
#. You will get an authorization code to add back into the previous tab hosted on your server. Paste that auth code and hit **Submit**.
.. figure:: /_static/images/lightning/albyhub-ldk-success.png
:width: 70%
:alt: Setup
#. Your self-hosted AlbyHub is ready and connected to your self-hosted LDK light node!
Connecting Apps
----------------------------
Two of the more important apps you may want to install are:
- **Alby Web** (a simple wallet interface that connects to your AlbyHub and can be saved as a PWA (app-like) on your phone)
- **Alby Extension** (companion for accessing Bitcoin and Nostr apps, payments across the globe and passwordless logins)
Alby Web
=========
#. If you have connected your AlbyHub to an Alby account during setup, Alby Web will appear connected by default. (If you have not, you can go to **Settings** > **Alby Account** to add an account).
.. figure:: /_static/images/lightning/albyhub-albyweb-0.png
:width: 70%
:alt: Alby Web Setup
.. figure:: /_static/images/lightning/albyhub-albyweb-1.png
:width: 70%
:alt: Alby Web Setup
This wallet interface allows you to interact with your AlbyHub-connected LND over clearnet with a easy to use interface.
Alby Extension
==============
#. Visit the App Store from your AlbyHub.
.. figure:: /_static/images/lightning/albyhub-appstore-extension-0.png
:width: 70%
:alt: Alby Extension Setup
#. Click **Connect**.
.. figure:: /_static/images/lightning/albyhub-appstore-extension-1.png
:width: 70%
:alt: Alby Extension Setup
#. Give the connection to your Alby Extenions a name and decide what access and limitations you give it.
.. note:: The settings are fairly self explanatory. Typically you'll want your browser extension to be able to have full access to your lightning node and funds since you will be the only one using it and will want to both make and receive payments. Payments you make have to be confirmed and authorized through the extension, but if you are worried about overspending, the advanced **Budget** option sets monthly limits on how much can be spent. This is useful in case you get carried away zapping or if you ever misread a payment request that's higher than you expect.
.. figure:: /_static/images/lightning/albyhub-appstore-extension-2.png
:width: 70%
:alt: Alby Extension Setup
#. Download the extension for your browser if you don't have it already. Install it. Open it if you do already have it installed.
#. If the extenstion is installed on the same browser, click the newly appeared icon in the menu bar while on the screen above. Click to connect.
.. figure:: /_static/images/lightning/albyhub-appstore-extension-success.png
:width: 70%
:alt: Alby Extension Setup
#. You can now spend sats and generate invoices from your browser! Test it out by running your own :ref:`noStrudel<nostrudel>` instance.
Resources and Guides
--------------------
**Alby** have extensive users guides `available here <https://guides.getalby.com/user-guide/v/alby-account-and-browser-extension/alby-hub/introduction>`_. Learn how to connect other apps and use the advanced features available to those who set up Alby accounts.
**BTC Sesstions** has created an Alby Hub `tutorial here <https://www.youtube.com/watch?v=2Z1BzwxdP4I>`_. While this focuses on the cloud hosted variety of AlbyHub, the interface and features are the same, and the Start9 hosted variety gets a mention in the last segment.

View File

@@ -0,0 +1,14 @@
.. _connecting-albyhub:
===========================
Connect to LND with AlbyHub
===========================
.. note:: Connecting to LND via **AlbyHub** is a very powerful way to interact with LND in a self sovereign way by running AlbyHub on your *own server* and not on external servers outside of your control.
But to connect to LND *without* AlbyHub, see :ref:`here<connecting-lnd>`.
.. toctree::
:maxdepth: 1
albyhub

View File

@@ -6,6 +6,8 @@ Connect Directly to LND
The following wallets can connect directly to LND via LND's REST API. The following wallets can connect directly to LND via LND's REST API.
.. tip:: If you'd like to connect via AlbyHub instead (recommended), click :ref:`here<albyhub>`.
.. tip:: If you'd like to connect via LNbits instead, click :ref:`here<connecting-lnbits>`. .. tip:: If you'd like to connect via LNbits instead, click :ref:`here<connecting-lnbits>`.
.. toctree:: .. toctree::

View File

@@ -6,7 +6,11 @@ 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**. 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>`. .. warning:: This is NOT the guide for setting up **AlbyHub** this is for a direct connection to LND. If you'd like to connect via AlbyHub instead (recommended), click :ref:`here<albyhub>`.
.. warning:: 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. .. note:: This requires installing the `Lightning Terminal <https://marketplace.start9.com/marketplace/lightning-terminal>`_ service on your Start9 server.

View File

@@ -22,6 +22,12 @@ If you're using **Core Lightning (CLN)** and would like a direct connection you
If you're using **LND**, you can select one of the following options: If you're using **LND**, you can select one of the following options:
.. toctree::
:maxdepth: 2
connecting-albyhub
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2