docs: refocus Alby Hub deployment guides on self-hosting#10
Open
reneaaron wants to merge 4 commits into
Open
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughDocumentation was updated across Alby Hub guides and FAQs to replace Alby Cloud references with cloud hosting, self-hosted, and Alby Pro wording. Redirects, navigation labels, setup instructions, backup/migration flows, and recovery guidance were adjusted accordingly. ChangesAlby Cloud phase-out docs
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
reneaaron
force-pushed
the
chore/remove-alby-cloud
branch
from
cb1518e to
48803e2
Compare
reneaaron
changed the title
reneaaron
force-pushed
the
chore/remove-alby-cloud
branch
2 times, most recently
from
d517d77 to
09d05e0
Compare
reneaaron
force-pushed
the
chore/remove-alby-cloud
branch
from
09d05e0 to
f603291
Compare
Section 2 delegated to the Hosted Hub -> Self-hosted procedure, which tells users to unsubscribe (deleting a hosted Hub they don't have) and omits the shut-down-the-old-instance step. Spell out the correct self-hosted-to- self-hosted flow instead.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
hub/alby-hub-flavors/updating.md (1)
49-59: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winFix grammar error in cloud hosting update instructions.
Line 57 has a verb tense error: "you can also updated them manually" should be "you can also update them manually".
Additionally, this section mentions Digital Ocean as a recommended deployment option, but the Cloud Hosting guide Overview only lists Fly.io, Nodana, and Render. Verify whether Digital Ocean is still supported or if this reference is stale.
📝 Proposed grammar fix
-Those instances are using docker images, so if needed you can also updated them manually just like you would for a [docker image](updating.md#docker). +Those instances are using docker images, so if needed you can also update them manually just like you would for a [docker image](updating.md#docker).🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@hub/alby-hub-flavors/updating.md` around lines 49 - 59, Fix the cloud hosting update instructions in updating.md by correcting the verb tense in the sentence about Docker images so it says users can “update” them manually, and verify whether the “Cloud Hosting” section in the updating guide should still mention Digital Ocean. Compare this reference with the deployment options listed in other-cloud-options.md and either update the wording to match the supported providers or remove the stale Digital Ocean mention.
🧹 Nitpick comments (2)
hub/bitcoin-wallet-glossary.md (1)
140-142: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winClarify "DI Pro" terminology consistency.
The glossary defines "DI Pro" at line 140, but all other updated references use "Alby Pro" (lines 148, 232, 465). If "DI Pro" is meant to be the same product, align the terminology to "Alby Pro" (or "DIY Pro" if that's the intended self-hosted-specific branding). If "DI Pro" is a distinct term, add a cross-reference explaining its relationship to "Alby Pro."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@hub/bitcoin-wallet-glossary.md` around lines 140 - 142, The glossary entry for DI Pro uses terminology that is inconsistent with the rest of the document, where the same subscription is referred to as Alby Pro. Update the DI Pro section in bitcoin-wallet-glossary.md to match the chosen product name used elsewhere, or if DI Pro is intentionally different, add a clear cross-reference in that glossary entry explaining how it relates to Alby Pro. Use the DI Pro glossary heading and the Alby Pro references elsewhere in the glossary to verify consistency.hub/faq/how-can-i-migrate-alby-hub-to-a-different-machine.md (1)
64-64: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueClarify awkward phrasing and tighten wording.
The phrase "with enabled dynamic channels backup" is grammatically awkward. Consider "with dynamic channel backups enabled" or "with an active Pro subscription." Also, per style guidance, replace "at the moment" with "currently" for conciseness.
- **Note**, at the moment it is not possible to migrate a self-hosted Alby Hub with a Pro subscription with enabled dynamic channels backup to a self-hosted Alby Hub without a subscription. + **Note:** Currently, it is not possible to migrate a self-hosted Alby Hub with an active Pro subscription (with dynamic channel backups enabled) to a self-hosted Alby Hub without a subscription.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@hub/faq/how-can-i-migrate-alby-hub-to-a-different-machine.md` at line 64, Revise the migration note in the FAQ entry to use clearer, tighter wording: replace the awkward “with enabled dynamic channels backup” phrasing with a more natural construction like “with dynamic channel backups enabled” or “with an active Pro subscription,” and change “at the moment” to “currently” for conciseness while keeping the same meaning.Source: Linters/SAST tools
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@account/faq/embrace-alby-hub-phasing-out-albys-shared-wallet.md`:
- Line 26: The markdown link text in this FAQ entry is too generic and should be
made descriptive to satisfy MD059. Update the sentence in the Fee Credits
paragraph so the linked words themselves describe the destination, using the
existing Fee Credits reference in this content rather than a standalone “here”
link, and keep the rest of the paragraph unchanged.
- Line 194: The markdown link text in the FAQ content uses a non-descriptive
“here” label, which violates the link-text style requirement. Update the
sentence in this FAQ entry so the link to the pricing page uses descriptive text
that clearly names the destination, while keeping the existing Alby Pro and
pricing references intact.
In `@hub/backups-and-recover.md`:
- Line 122: The backup/recovery doc uses inconsistent product naming for the
subscription feature, so standardize the terminology across the page. Update the
copy in the cards section and the other references in backu ps-and-recover
content to use one official name consistently, matching the existing
subscription link; check the strings around the Alby Pro/Pro mentions in this
document and make them uniform.
In `@hub/faq/how-to-restart-alby-hub-after-my-subscription-was-cancelled.md`:
- Line 3: The page has a spelling inconsistency between “cancelled” and
“canceled”; make the wording consistent throughout the FAQ entry by choosing one
variant and updating the sentence in the markdown content to match the title.
Locate the text in the restart-after-subscription-cancelled article and ensure
the body uses the same spelling convention everywhere in that document.
- Around line 7-17: The recovery steps in the “how-to-restart” guide omit the
required prerequisite of using the same Alby Account before restoring the Hub.
Update the onboarding flow instructions to explicitly tell users to connect to
their existing Alby Account first, then proceed to “Advanced Setup” and “Import
Existing Recovery Phrase.” Use the existing onboarding/recovery guidance in this
page to insert the new step in the right sequence so it matches the recovery
contract and migration flow.
---
Outside diff comments:
In `@hub/alby-hub-flavors/updating.md`:
- Around line 49-59: Fix the cloud hosting update instructions in updating.md by
correcting the verb tense in the sentence about Docker images so it says users
can “update” them manually, and verify whether the “Cloud Hosting” section in
the updating guide should still mention Digital Ocean. Compare this reference
with the deployment options listed in other-cloud-options.md and either update
the wording to match the supported providers or remove the stale Digital Ocean
mention.
---
Nitpick comments:
In `@hub/bitcoin-wallet-glossary.md`:
- Around line 140-142: The glossary entry for DI Pro uses terminology that is
inconsistent with the rest of the document, where the same subscription is
referred to as Alby Pro. Update the DI Pro section in bitcoin-wallet-glossary.md
to match the chosen product name used elsewhere, or if DI Pro is intentionally
different, add a clear cross-reference in that glossary entry explaining how it
relates to Alby Pro. Use the DI Pro glossary heading and the Alby Pro references
elsewhere in the glossary to verify consistency.
In `@hub/faq/how-can-i-migrate-alby-hub-to-a-different-machine.md`:
- Line 64: Revise the migration note in the FAQ entry to use clearer, tighter
wording: replace the awkward “with enabled dynamic channels backup” phrasing
with a more natural construction like “with dynamic channel backups enabled” or
“with an active Pro subscription,” and change “at the moment” to “currently” for
conciseness while keeping the same meaning.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 5529e0e3-70e9-4314-bba5-8863245c7521
📒 Files selected for processing (20)
account/faq/embrace-alby-hub-phasing-out-albys-shared-wallet.mdaccount/link-wallet/link-alby-hub.mdhub/.gitbook.yamlhub/SUMMARY.mdhub/alby-hub-flavors/README.mdhub/alby-hub-flavors/alby-cloud.mdhub/alby-hub-flavors/desktop.mdhub/alby-hub-flavors/other-cloud-options.mdhub/alby-hub-flavors/updating.mdhub/app-connections/btcpay-server.mdhub/backups-and-recover.mdhub/bitcoin-wallet-glossary.mdhub/faq/how-can-i-access-alby-hub-from-my-phone.mdhub/faq/how-can-i-migrate-alby-hub-to-a-different-machine.mdhub/faq/how-to-restart-alby-hub-after-my-subscription-was-cancelled.mdhub/faq/what-happens-if-i-lose-access-to-my-hub-while-a-swap-is-in-progress.mdhub/faq/where-is-alby-hub-physically-located.mdhub/faq/why-is-my-channel-offline-and-what-should-i-do-now.mdhub/faq/why-was-my-lightning-channel-closed-and-what-to-do-next.mdhub/wallet/README.md
💤 Files with no reviewable changes (1)
- hub/alby-hub-flavors/alby-cloud.md
| {% endhint %} | ||
|
|
||
| <table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Get a subscription to Pro Cloud! ☁️</strong><br><br>Unlock 24/7 availability for your self-hosted wallet by subscribing to Pro Cloud. Never worry about downtime again!</td><td></td><td></td><td><a href="https://getalby.com/subscription/new">https://getalby.com/subscription/new</a></td></tr><tr><td><strong>Learn more about your on-chain balance! 💰</strong><br><br>Discover the on-chain side of your self-custodial wallet. Click here to learn more about managing your Savings Balance securely.</td><td></td><td></td><td><a href="node/on-chain-balance.md">on-chain-balance.md</a></td></tr><tr><td><strong>Migrate your Hub! 🔄</strong><br><br>Planning to move your Alby Hub? The migration process is similar to a backup in many ways. Click here to explore more on how to migrate your hub seamlessly!</td><td></td><td></td><td><a href="faq/how-can-i-migrate-alby-hub-to-a-different-machine.md">how-can-i-migrate-alby-hub-to-a-different-machine.md</a></td></tr></tbody></table> | ||
| <table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Encrypted channel backups with Alby Pro 🔐</strong><br><br>Recover your lightning channels from just your recovery phrase. Enable dynamic backups by subscribing to Alby Pro.</td><td></td><td></td><td><a href="https://getalby.com/subscription/pro">https://getalby.com/subscription/pro</a></td></tr><tr><td><strong>Learn more about your on-chain balance! 💰</strong><br><br>Discover the on-chain side of your self-custodial wallet. Click here to learn more about managing your Savings Balance securely.</td><td></td><td></td><td><a href="node/on-chain-balance.md">on-chain-balance.md</a></td></tr><tr><td><strong>Migrate your Hub! 🔄</strong><br><br>Planning to move your Alby Hub? The migration process is similar to a backup in many ways. Click here to explore more on how to migrate your hub seamlessly!</td><td></td><td></td><td><a href="faq/how-can-i-migrate-alby-hub-to-a-different-machine.md">how-can-i-migrate-alby-hub-to-a-different-machine.md</a></td></tr></tbody></table> |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify the subscription URL responds
curl -s -o /dev/null -w "%{http_code}" https://getalby.com/subscription/proRepository: getAlby/docs
Length of output: 153
Clarify branding consistency for "Alby Pro" vs "Pro".
The subscription link https://getalby.com/subscription/pro is active (redirects successfully). However, the documentation uses inconsistent terminology: line 122 uses "Alby Pro", while lines 34 and 79 refer to "Pro" (e.g., "Pro subscriber", "Pro Subscription"). Standardize these references to use a single, official product name (either consistently "Alby Pro" or "Pro") throughout the document to avoid confusion.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@hub/backups-and-recover.md` at line 122, The backup/recovery doc uses
inconsistent product naming for the subscription feature, so standardize the
terminology across the page. Update the copy in the cards section and the other
references in backu ps-and-recover content to use one official name
consistently, matching the existing subscription link; check the strings around
the Alby Pro/Pro mentions in this document and make them uniform.
- Use descriptive link text instead of 'here' (MD059) in the shared-wallet FAQ - Standardize 'canceled' -> 'cancelled' to match the page title
Restoring encrypted (VSS) channel backups requires connecting the new self-hosted Hub to the same Alby Account before importing the recovery phrase; on-chain alone recovers from the seed. Matches the migration doc.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Housekeeping pass over the Alby Hub guides to put self-hosting front and centre and tidy up some links.
Mostly copy and link tidying — no behavioural docs changes.
Summary by CodeRabbit