Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blckbx/lnd_postgres
⚡ Guide: How to setup LND with PostgreSQL DB
https://github.com/blckbx/lnd_postgres
lightning lnd postgres postgresql
Last synced: 3 months ago
JSON representation
⚡ Guide: How to setup LND with PostgreSQL DB
- Host: GitHub
- URL: https://github.com/blckbx/lnd_postgres
- Owner: blckbx
- License: mit
- Created: 2022-04-23T08:39:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-09T16:24:35.000Z (about 1 year ago)
- Last Synced: 2023-11-09T17:33:33.435Z (about 1 year ago)
- Topics: lightning, lnd, postgres, postgresql
- Homepage: https://blckbx.github.io/lnd_postgres
- Size: 46.9 KB
- Stars: 17
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ⚡ Guide: How to setup LND with PostgreSQL
## 📄 Prelude and Objective
A short guide on how to setup and configure a **_new_** lightning node using LND with recently released PostgreSQL support as database backend. The approach was done by creating a new lightning node. To date, backend data migrations are still being developed. A brief write-up for PostgreSQL support was released by Lightning Labs here: [postgres.md](https://github.com/lightningnetwork/lnd/blob/master/docs/postgres.md). Nevertheless it lacks important parts which this guide wants to cover step by step.
## 📜 Table of Content
- [Preconditions](#-preconditions)
- [Install and setup PostgreSQL](#-install-and-setup-postgresql)
- [Configure LND](#-configure-lnd)
- [Upgrade PostgreSQL](#-upgrade-postgresql)
- [Addendum](#-addendum)
## 🔎 Preconditions
The guide is based on the following setup and components. It may be different for Umbrel / Raspiblitz / MyNode installations as it was established on a bolt / bare metal setup running Ubuntu.
- OS: Ubuntu 22.04
- Setup: bare metal / [bolt setup](https://raspibolt.org/)
- Lightning Implementation: [lnd-0.14.3-beta +](https://github.com/lightningnetwork/lnd/releases/tag/v0.14.3-beta)
- Database Backend: PostgreSQL 14.2 or latest version in ubuntu's repository
- **node state: new node without funds and channels (⚠)**
It's important to emphasize that this setup is built as a new lightning node without existing funds or channels. As said, data migrations between different backends (bbolt, postgres, etcd) are not yet supported (as of v0.14.3).
## 🛠 Install and setup PostgreSQL
Installation process of LND is omitted in this guide as this is widely described on the internet. So I assume a valid installation here and continue to setup the backend:
```sh
# Install postgresql-14
$ sudo apt install postgresql-14
# Configure postgresql to your needs (port, datadir, logging, etc.) or use default values.
$ sudo nano /etc/postgresql/14/main/postgresql.conf
# Setup postgres user
$ sudo -i -u postgres
$ psql
postgres=# \password
# Enter password and take note of it!
# Quit PSQL
\q
```
Create user and database for LND:
```sh
# As postgres user
$ sudo -i -u postgres
# Create user 'lnd' and set a password
$ createuser --createdb --pwprompt lnd
# Enter password and take note of it!
# Create database 'lndb'
$ createdb -O lnd lndb
# Exit user postgres
$ exit
```
## 🛠 Configure LND
Configure your `lnd.conf`:
```sh
$ sudo nano /home/lnd/.lnd/lnd.conf
```
Edit and add your postgresql config and credentials, like so: `postgresql://:@:/`
```ini
[db]
db.backend=postgres
[postgres]
db.postgres.dsn=postgresql://lnd:[email protected]:5432/lndb?sslmode=disable
db.postgres.timeout=0
```
Add postgres as a requirement to LND's systemd service:
```sh
[Unit]
Description=...
[email protected] bitcoind.service
[email protected] bitcoind.service
```
If everything went fine, you can see this in the `lnd.log`:
```
[INF] LTND: Opening the main database, this might take a few minutes...
[INF] LTND: Using remote postgres database! Creating graph and channel state DB instances
```
## ♻ Upgrade PostgreSQL
Upgrading PostgreSQL should be easy using Postgres' own tool `pg_upgrade`. Install and setup next version in parallel. Upgrade to new datadir, dry-run before doing the command (`--check` = dry-run) from v13 to v14:
```
/usr/lib/postgresql/14/bin/pg_upgrade \
--old-datadir=/var/lib/postgresql/13/main \
--new-datadir=/var/lib/postgresql/14/main \
--old-bindir=/usr/lib/postgresql/13/bin \
--new-bindir=/usr/lib/postgresql/14/bin \
--old-options '-c config_file=/etc/postgresql/13/main/postgresql.conf' \
--new-options '-c config_file=/etc/postgresql/14/main/postgresql.conf' \
--check
```
For more details on this topic, see link in addendum part below.
## ✴ Addendum
- [System optimization for Postgres](https://pgtune.leopard.in.ua)
- [Upgrading PostgreSQL 13 to 14](https://www.kostolansky.sk/posts/upgrading-to-postgresql-14/)
- [Advanced setup with replication (two instances)](https://github.com/gabridome/docs/blob/master/c-lightning_with_postgresql_reliability.md)
- [Future data migration between backends](https://github.com/lightningnetwork/lnd/blob/7702c90503abf88011e3d436f52926f2a5aa32a7/docs/data-migration.md)