umbrel-apps icon indicating copy to clipboard operation
umbrel-apps copied to clipboard

App Submission: AlbyHub v1.8.0

Open bumi opened this issue 1 year ago • 8 comments

AlbyHub is Alby's new self-custodial wallet. It is build around the NWC protocol to allow users connect their Umbrel lightning nodes to the growing number applications supporting NWC for payments. Most known are the various nostr apps to enable zapping. Alby Hub is also the continuation of the Nostr Wallet Connect application with is already in the store.

Links:

  • https://nwc.dev/
  • https://albyhub.com/

App Submission

App name

Alby Hub

256x256 SVG icon

https://svgur.com/s/19oF

Gallery images

PNG:

connections wallet node store

JPG:

connections wallet node store

I have tested my app on:

  • [x] umbrelOS on a Raspberry Pi
  • [ ] umbrelOS on an Umbrel Home
  • [x] umbrelOS on Linux VM

bumi avatar Aug 30 '24 18:08 bumi

what is the warning with the container user? The app needs to be able to write to the data directory. for this root is needed, isn't it?

bumi avatar Aug 31 '24 08:08 bumi

Have been looking forward to this one @bumi! I will review and test tomorrow.

what is the warning with the container user?

Ideally, we want containers to run as non-root as part of app sandboxing measures, but it is not a strict requirement right now which is why the github actions linter is showing a severity indicator of "info" here. If the getalby/hub container requires a root user then this is fine for now.

The app needs to be able to write to the data directory. for this root is needed, isn't it?

On app install, umbrelOS will create any host bind mounts that are committed to this directory (in this case ${APP_DATA_DIR}/data) with user:group 1000:1000 ownership. So if getalby/hub were to run as 1000:1000 it could write to the data directory.

nmfretz avatar Sep 03 '24 13:09 nmfretz

Hey @bumi, just pinging you again in case you missed the above review from last week.

nmfretz avatar Sep 11 '24 04:09 nmfretz

@bumi - I forgot to ask: with the addition of Alby Hub should we be removing Nostr Wallet Connect from the app store? https://github.com/getumbrel/umbrel-apps/tree/master/alby-nostr-wallet-connect

If so, what I can do is add disabled: true to the umbrel-app.yml of nostr wallet connect and it will make it so that existing installs can continue to use the app, but users will no longer see the app as available in the app store.

nmfretz avatar Sep 16 '24 11:09 nmfretz

@nmfretz thanks a lot for the feedback and improvements.

should we be removing Nostr Wallet Connect from the app store?

I am not sure what's best here. We are not actively working on it anymore and for us Alby Hub is the successor of that old NWC app. We recommend people to update to Alby Hub. So to me disabled: true sounds good - but some people also still liked the original NWC app it seemed.

bumi avatar Sep 16 '24 15:09 bumi

fyi. we have one patch release coming this week which I would like to have in this release.

bumi avatar Sep 16 '24 15:09 bumi

I am not sure what's best here. We are not actively working on it anymore and for us Alby Hub is the successor of that old NWC app. We recommend people to update to Alby Hub. So to me disabled: true sounds good - but some people also still liked the original NWC app it seemed.

If you'd like to keep NWC available for new users still then perhaps for now we can just add a note at the top of NWC's app description saying that it is recommended to use the successor app Alby Hub instead. Although I imagine that since you're not working on NWC anymore, there will come a time when you'd want the app retired (e.g., it's not receiving security updates, etc).

fyi. we have one patch release coming this week which I would like to have in this release.

Great, thanks for letting me know. Ping me when it's ready and I'll give it a final test before we go live!

nmfretz avatar Sep 16 '24 23:09 nmfretz

Here's a checklist for us:

  • [x] Update ghcr.io/getalby/hub image tag and digest in docker-compose.yml with latest patch release (@bumi)
  • [x] Update the version in the umbrel-app.yml to match the patch release version (@bumi)
  • [x] Test user 1000:1000 (@nmfretz)
  • [x] Check gallery assets resolution (@nmfretz)

nmfretz avatar Sep 16 '24 23:09 nmfretz

Hey @bumi, I see that hub is now on v1.10.1. Would you like to go live with that version?

nmfretz avatar Sep 27 '24 00:09 nmfretz

@nmfretz yes, v1.10.1 is it! so if you could help or decide on the user 1000:1000 then I think we're good to go. 🙏

bumi avatar Sep 28 '24 15:09 bumi

Excellent, thanks again for all your work bringing Alby Hub to the Umbrel app store @bumi!

I have tested the new image with user 1000:1000 and everything is working well (e.g., app install, sending/receiving, connection to alby go, connection to apps, etc). If at some point it becomes apparent that there is a permissions issue for something (very unlikely) then the fix is very simple in this direction (i.e., going from user 1000 back to root). All we would need to do is remove this line from the compose file: user: 1000:1000

I don't have permissions to push a commit to getAlby/umbrel-apps.git so I'll add user: 1000:1000 as a suggestion below. Once it is committed we can go live.

image

nmfretz avatar Oct 01 '24 00:10 nmfretz

Perfect, thanks @bumi. Going live 🐝

nmfretz avatar Oct 01 '24 00:10 nmfretz

Amazing. Thanks for publishing Alby Hub, @nmfretz. We have a few users asking if they can simply update their Alby Hub installed from the community app store with the version listed on the official app store. Are all NWC connections available? Can they update using the official app store listing? Should they know something before doing an update?

Would appreciate any hints.

MoritzKa avatar Oct 02 '24 10:10 MoritzKa

I don't think people can update from the community store actually. it's a different app

bumi avatar Oct 02 '24 11:10 bumi