Skip to content

Commit

Permalink
Update descriptions (#1)
Browse files Browse the repository at this point in the history
* Update getConfig.ts

* Update instructions.md
  • Loading branch information
MattDHill authored Sep 18, 2024
1 parent e58b105 commit 4903f7a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
1. **Configure Alby Hub**
In the Alby Hub configuration settings, select your preferred Lightning implementation:

- **LND on this node**: This is the default and preferred method, offering full control over your node. Use the LND (Lightning Network Daemon) implementation for increased sovereignty and security.
- **Alby embedded node (LDK)**: Use the built-in Alby's Lightning Development Kit (LDK) implementation for convenience. This option doesn't require running your own LND node and might be a good choice for low-powered devices.
- **LND on this 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.

2. **Start the Service**
After configuring, start the Alby Hub service.
Expand All @@ -16,7 +16,7 @@
On the Alby Welcome screen, click the **Get Started** button. The button will display either (LND) or (LDK) based on your chosen configuration.

5. **Create a Strong Password**
Set a strong password for your Alby Hub account. It's recommended to store this password securely in your self-hosted Vaultwarden.
Set a strong password for your Alby Hub account. It's recommended to store this password securely in your self-hosted Vaultwarden. If you are using the Alby Hub embedded light node, it is critical you do not lose your password, as it will result in loss of funds.

6. **Connect Your Alby Account**
Follow the on-screen instructions to connect your Alby account.
Expand Down
6 changes: 3 additions & 3 deletions scripts/procedures/getConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ export const getConfig: T.ExpectedExports.getConfig = compat.getConfig({
lightning: {
name: "Lightning Implementation",
description:
"Choose the Lightning implementation to use with Alby Hub.<br><br><strong>LND on this node</strong>: Use the LND (Lightning Network Daemon) implementation. This is the more sovereign and secure option, allowing full control over your node.<br><br><strong>Alby embedded node (LDK)</strong>: Use the built-in Lightning Development Kit (LDK) implementation. This option is convenient but offers less control over your node.",
"Choose the Lightning implementation to use with Alby Hub.<br><br><strong>LND on this server</strong>: 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.<br><br><strong>Alby embedded light node</strong>: This option tells Alby Hub to use its own, built-in light node. This option is convenient but offers less control over your node.",
type: "enum",
values: ["lnd", "alby"],
"value-names": {
lnd: "LND on this node",
alby: "Alby embedded node (LDK)",
lnd: "LND on this server",
alby: "Alby Hub embedded light node",
},
default: "lnd",
// "warning": "The Alby embedded node (LDK) is a convenient starting option, but for increased sovereignty and security, it's recommended to switch to LND when possible."
Expand Down

0 comments on commit 4903f7a

Please sign in to comment.