GlcoinCore/lndg
1
0
Fork 0
mirror of https://github.com/cryptosharks131/lndg.git synced 2026-08-15 12:50:30 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
171 commits 43 branches 29 tags 4.7 MiB
Find a file
cryptosharks131 ea90b2bcfe Move remaining files to parent folder to access settings variables and update docs
2021-09-22 23:26:05 -04:00
gui Move remaining files to parent folder to access settings variables and update docs 2021-09-22 23:26:05 -04:00
lndg Remove unused code and small clean up 2021-09-17 10:23:18 -04:00
.gitignore Make the migrations folder part of the repo, users no longer need to do this step 2021-09-21 16:45:05 -04:00
delete_payments.py Move remaining files to parent folder to access settings variables and update docs 2021-09-22 23:26:05 -04:00
initialize.py Update allowed hosts for settings file and add variable for path to lnddir 2021-09-22 22:41:32 -04:00
jobs.py Move remaining files to parent folder to access settings variables and update docs 2021-09-22 23:26:05 -04:00
keysend.py Move remaining files to parent folder to access settings variables and update docs 2021-09-22 23:26:05 -04:00
LICENSE Create LICENSE 2021-09-15 13:34:15 -04:00
manage.py Initial push 2021-03-13 18:06:59 -05:00
nginx.sh Add 2 shell files to aid installation of systemd timers and nginx webserver 2021-09-22 01:05:53 -04:00
README.md Move remaining files to parent folder to access settings variables and update docs 2021-09-22 23:26:05 -04:00
rebalancer.py Move remaining files to parent folder to access settings variables and update docs 2021-09-22 23:26:05 -04:00
requirements.txt Update requirements.txt 2021-09-18 11:17:29 -04:00
systemd.md Move remaining files to parent folder to access settings variables and update docs 2021-09-22 23:26:05 -04:00
systemd.sh Move remaining files to parent folder to access settings variables and update docs 2021-09-22 23:26:05 -04:00

README.md

lndg

Lite GUI web interface to analyze lnd data and manage your node with automation.

Setup

  1. Clone respository git clone https://github.com/cryptosharks131/lndg.git
  2. Change directory into the repo cd lndg
  3. Make sure you have python virtualenv installed apt install virtualenv
  4. Setup a python3 virtual environment virtualenv -p python3 .venv
  5. Install required dependencies .venv/bin/pip install -r requirements.txt
  6. Initialize a settings.py file for your django site .venv/bin/python initialize.py
  7. Migrate all database objects .venv/bin/python manage.py migrate
  8. Run the server via chosen webserver or via python development server .venv/bin/python manage.py runserver <your_node_ip>:80
  9. Generate some initial data for your web GUI .venv/bin/python jobs.py

Note: If you are not using the default path for LND ~/.lnd you can add a custom path in the django settings file lndg/settings.py

Updating

  1. Make sure you are in the lndg folder cd lndg
  2. Pull the new files git pull
  3. Migrate any database changes .venv/bin/python manage.py migrate

Backend Data Refreshes and Automated Rebalancing

The files jobs.py and rebalancer.py inside lndg/gui/ serve to update the backend database with the most up to date information and rebalance any channels based on your lndg dashboard settings and requests. A refresh interval of at least 15-30 seconds is recommended for the best user experience.

You can find instructions on settings these files up to run in the background via systemd here.
If you are familiar with crontab, this is also an option for setting up these files to run on a frequent basis, however it only has a resolution of 1 minute.
A bash script has also been included to install the systemd setup. sudo bash systemd.sh

Nginx Webserver

If you would like to serve the dashboard at all times, it is recommended to setup a proper production webserver to host the site.
A bash script has been included to help aide in the setup of a nginx webserver. sudo bash nginx.sh

API Backend

The following data can be accessed at the /api endpoint: payments, invoices, forwards, channels, and rebalancer

Preview Screens

Main Dashboard

image image image image image

Peers, Balances and Routes All Open In Separate Screens

image image

Browsable API at /api (json format available with url appended with ?format=json)

image

New! View Keysend Messages (you can only receive these if you have accept-keysend=true in lnd.conf)

image