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
112 commits 43 branches 29 tags 4.7 MiB
Find a file
cryptosharks131 ca2d92c30c Add new api serializers to replace forms and few updates to rebalancer and html forms
2021-06-07 11:02:03 -04:00
gui Add new api serializers to replace forms and few updates to rebalancer and html forms 2021-06-07 11:02:03 -04:00
lndg Initial push 2021-03-13 18:06:59 -05:00
.gitignore Initial push for rebalancer tool - still needs work 2021-03-30 21:52:13 -04:00
manage.py Initial push 2021-03-13 18:06:59 -05:00
README.md Update README.md 2021-05-14 18:20:31 -04:00

README.md

lndg

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

Setup

  1. Run bitcoind
  2. Run lnd
  3. Build required py file for your system to interact with lnd grpc: https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md#setup-and-installation
  4. Clone respository
  5. Place the 2 ouput files from step 3 inside the repository at: lndg/gui/
  6. A settings file is required at lndg/settings.py (default django setting file + 'gui' + 'rest_framework' + 'qr_code' added to your installed apps inside the file)
  7. Make migrations and migrate all database objects (python manage.py makemigrations && python manage.py migrate)
  8. Run the server via chosen webserver or via python development server (python manage.py runserver IP:PORT)

Backend Data Refreshes

The file jobs.py inside lndg/gui/ serves to update the backend database with the most up to date information. This reduces the amount of calls made when a user refreshes the front end and enables the rest api usage to fetch data from your lnd node.

You will need to setup a crontab (linux) or task scheduler (windows) to run this file at your specified refresh interval. A refresh of 15-60 seconds is advisable for the best experience and may depend on how quickly your machine is capable of handling the file execution.

Automated Rebalancing

The file rebalancer.py inside lndg/gui/ serves to rebalance any channels that meet the specifications set on your lndg dashboard. Default values are set upon the first run of the rebalancer file. You can review this file to find the default values.

You will need to setup a crontab (linux) or task scheduler (windows) to run this file at your specified refresh interval. A refresh of 15-60 seconds is advisable for the best experience and may depend on how quickly your machine is capable of handling the file execution.