@blitzbank/dashboard0.1.1 • Public • Published
⚡️ Blitzbank Dashboard 🏦
Here‘s to the #reckless! ⚡️ Dashboard for your Bitcoind/LND full node.
This is an early stage project. Right now this is my personal playground for figuring out how to approach Lightning node management from an UX perspective. Potentially everything is subject to change.
Nevertheless: As we are all figuring stuff out, I am putting this project out here and invite feedback. Let me know in case I can help setting up the dashboard – that's how we can improve the documentation too. 😉
The app requires at least Node.js 10.13 (tracking the latest active Node.js LTS version). This guarantees a reasonable level of backwards compatibility.
Here are some example screenshots:
I will make this easier at some point, but for now … SSH into your full node and execute the following commands:
# create a new directory for the dashboardmkdir dashboardcd dashboard# initialize an empty project and install the appnpm init @blitzbank/dashboard# edit the .env file in your favorite editor# (see the list of variables below)vim .env# start the appnpx blitzbank
You will most likely need to setup a process manager to keep the app running. See the start script section below.
✨ Environment variables
These env variables should be set:
LND_CERT_BASE64- the base64 encoded string of the
LND_MACAROON_BASE64- the base64 encoded string of the macaroon file
PUBLIC_HOST- public host name that is used for connecting via Zap, Joule, etc.
You also need to define the credentials for the dashboard and API requests:
🚀 Start Script
On a Linux system you can use the service manager Systemd.
Add the following service configuration to a file named
[Unit]Description=Full Node Dashboard[Service]Type=simple# YOUR ADJUSTMENT START HERE:ExecStart=/usr/bin/npx blitzbank # the npx path might need adjustment: use `which npx` to find the locationWorkingDirectory=/home/admin/dashboard # absolute path to the dashboard folderUser=admin # your userGroup=admin # your group# YOUR ADJUSTMENT END HERE.Environment=NODE_ENV=productionStandardInput=nullStandardOutput=syslogStandardError=syslogRestart=always[Install]WantedBy=multi-user.target
Note that you have to set the values in the
YOUR ADJUSTMENT part.
After having created the file you can enable the service using the following command:
# one time enabling of the servicesudo systemctl enable dashboard.service# after that you can use commands like start, stop, restart or statussudo systemctl start dashboard.service
To install the latest version use the following command:
npm install @blitzbank/dashboard@latest
🛠 Development Setup
Dependencies are managed via Yarn. Once you have Yarn installed and this repo cloned, you can setup the packages:
Use mkcert to setup the SSL certificates.
Create a build and rebuild on file change.
👛 Tip jar
Here are some other projects with similar goals, you might want to have a look at those too: