clams-tech / Remote

Remote control your Core Lightning node
https://remote.clams.tech
GNU General Public License v3.0
39 stars 7 forks source link

EmbassyOS Support #221

Closed cryptoquick closed 1 month ago

cryptoquick commented 6 months ago

It'd be really cool if Clams could be used on EmbassyOS/StartOS... I think this requires some packaging.

Now that Spark Wallet no longer works on StartOS, Clams could be a viable replacement, and it could have a bit of a moment.

lnbc1QWFyb24 commented 6 months ago

Yeah great suggestion. We'll look in to what is involved to package it up for the node projects and post an update here.

k0gen commented 6 months ago

@cryptoquick, thank you for opening this issue/suggestion. I’ve recently discovered Clams and I really like it!

@aaronbarnardsound, check out the Developer Docs which contain all the necessary information for packaging a service for StartOS. In a nutshell, the steps are:

Don’t hesitate to reach out if you need any help or assistance. Let’s make this fantastic software accessible to all sovereign node runners using StartOS!

farscapian commented 6 months ago

I will work on this issue. Standing up a start9 VM today.

lnbc1QWFyb24 commented 6 months ago

@k0gen thanks for the links and helpful steps on how to get started. @farscapian you are an absolute legend. Thanks for taking this on. Let me know if you need any assistance as well.

k0gen commented 5 months ago

@farscapian , I hope you're doing well. Just checking in to see how the progress is going with the Clams packaging for StartOS?

As a reference, you might find it useful to visit the commit history of the Primal project. It's a great example of going from a hello-world template to a working service for StartOS.

Also, remember that you can always reach out in our matrix room #community-dev for any assistance or discussions.

farscapian commented 5 months ago

Hey sorry about that. Unfortunately this project is competing with my other projects, so I may be a tad slow on implementing this.

My embassy is all synced and I've started going through the documents and creating the required repos. I should have an update in a week hopefully. I already have a working dockerfile, just gotta get everything wired up correctly I think.

farscapian commented 5 months ago

@aaronbarnardsound question: This project can be approached in one of two ways IMO. You can 1) compile Clams Remote and put all the static output in nginx, or 2) enable a long-running server-side process that is capable of handling the connection URLs AND enable nginx caching. What is your preferred model for Embassy OS? Do you want users to be able to use the connection URL functionality?

lnbc1QWFyb24 commented 5 months ago

@farscapian I think whatever is simplest to start off with would be my preference, so probably serving static output from nginx. We can see how that goes and take feedback from there I reckon.

farscapian commented 3 months ago

Just posting an update on this one. I have a pull request on Start9 to update CLN to enable the websocket interface as a torv3 onion endpoint. This would enable any Clams Remote PWA running in Tor Browser to directly connect to their CLN node via native (i.e., not CLNRest) websocket, assuming they have the service onion endpoint.

This clams-startos repo works in conjunction with the above pull request. clams-startos is a simple (nginx) web server that serves Clams Remote static build output. The node-based server process performance was not sufficient for Tor Browser, so i went with static build output instead which has significantly better performance in Tor Browser. This means that we don't get URL handling, but I'm hoping we can get that functionality back by implementing query parameter reflection.

johngribbin commented 1 month ago

Remote is now in the community registry. Cheers to @farscapian for leading the efforts on this one!!

Screenshot 2024-05-23 at 9 12 59 PM