Developing an Umbrel app for LN

btc_ln · April 30, 2022, 4:26pm

Do you have advice, tutorials or other resources I can look through to learn how to make an Umbrel app?

DarthCoin · April 30, 2022, 4:32pm

Just make the app and prepare it to be “dockerized”. All apps in Umbrel are dockerized.
Done. Then propose it to Umbrel devs to be added to the next release.

mayank · April 30, 2022, 4:49pm

Ooooh it’s @btc_ln! Can’t wait to learn about your app idea!

Meanwhile, here’s our one-page doc that goes over packaging and submitting an existing app for Umbrel. We used BTC RPC Explorer as the example app in the doc.

If you’ve any questions, feel free to lay them down here!

louneskmt · May 2, 2022, 7:39pm

If you need any help packaging your app, don’t hesitate!

btc_ln · May 3, 2022, 7:26am

Thanks a lot! The app idea is simple. Same as https://lightningnetwork.plus but easier within the app, because the app will login and open channel for you based on your settings.

btc_ln · August 20, 2022, 5:52am

Updated link in case someone is looking for instructions:

github.com

getumbrel/umbrel-apps/blob/master/README.md

# Umbrel App Framework

If you can code in any language, you already know how to develop an app for Umbrel. There is no restriction on the kind of programming languages, frameworks or databases that you can use. Apps run inside isolated Docker containers, and the only requirement (for now) is that they should have a web-based UI.

> Some server apps might not have a UI at all. In that case, the app should serve a simple web page listing the connection details, QR codes, setup instructions, and anything else needed for the user to connect. The user is never expected to have CLI access on Umbrel.

To keep this document short and easy, we won't go into the app development itself, and will instead focus on packaging an existing app.

Let's straightaway jump into action by packaging [BTC RPC Explorer](https://github.com/janoside/btc-rpc-explorer), a Node.js based blockchain explorer, for Umbrel.

There are 4 steps:

1. [🛳 Containerizing the app using Docker](#1-containerizing-the-app-using-docker)
1. [☂️ Packaging the app for Umbrel](#2-%EF%B8%8Fpackaging-the-app-for-umbrel)
1. [🛠 Testing the app on Umbrel](#3-testing-the-app-on-umbrel)
    1. [Testing on Umbrel development environment (Linux or macOS)](#31-testing-the-app-on-umbrel-development-environment)
    1. [Testing on Umbrel OS (Raspberry Pi 4)](#32-testing-on-umbrel-os-raspberry-pi-4)
1. [🚀 Submitting the app](#4-submitting-the-app)

___

This file has been truncated. show original