Regolancer rebalancing tool

[MEdGalo]

Regolancer is an interesting new rebalancing tool that tries to combine the best features from rebalance-lnd and bos rebalance. I installed the tool on raspiblitz by slightly adapting the process described in this raspibolt guide, so I might just share them here.

Step 1. Install requirement: Go.

• Login as admin, then move to the config.scripts folder: "cd config.scripts/"
• Edit the bonus.go.sh script to make sure to install the latest version: "sudo nano bonus.go.sh on
• Edit the goVersion="XXX" to the latest version number found at https://go.dev/dl/ , then save (CTRL+O) and exit (CTRL+X).
• To start the installation: "sudo bash bonus.go.sh on"

Step 2: Installing regolancer:

• Add a new user for regiolancer : "sudo adduser --disabled-password --gecos "" regolancer".
• Add regolancer user to the lndadmin group: "sudo adduser regolancer lndadmin".
• Change active user to regolancer: "sudo su - regolancer"
• Create a symbolic link between the lnd folder on the datadrive and the regolancer user home directory: "ln -s /mnt/hdd/app-data/lnd/ /home/regolancer/.lnd".
• To start the installation of regolancer:
  • For arm64: "GOARCH=arm64 go install github.com/rkfg/regolancer@latest" (I did not try this myself, but it's what described here).
  • For amd64: "go install github.com/rkfg/regolancer@latest".
• To confirm installation: "go/bin/regolancer -v".

3. Configuration:

• You can use either .json or .toml configs, up to your preference. To start you can copy and edit a sample config:
  - For .json: "cp /home/regolancer/go/pkg/mod/github.com/rkfg/regolancer@v1.6.3/config.json.sample /home/regolancer/config.json".
  - For .toml: "cp /home/regolancer/go/pkg/mod/github.com/rkfg/regolancer@v1.6.3/config.toml.sample /home/regolancer/config.toml".
• To make the config file writable: "chmod 644 /home/regolancer/config.json" or "chmod 644 /home/regolancer/config.toml".
• Then edit the config file: "nano /home/regolancer/config.json"
• Make sure you have the following parameters in the beginning:
  macaroon_dir": "/home/regolancer/.lnd/data/chain/bitcoin/mainnet/", "macaroon_filename": "admin.macaroon", "network": "mainnet", "tlscert": "/home/regolancer/.lnd/tls.cert"
• The rest of the config file can be adapted to your liking using the parameters described in the sample configs, or here or here. Then save (CTRL+O) and exit (CTRL+X) nano.

4. Enjoy!

• When you set the parameters to your needs (make sure that the parameters are named exactly as described here in the configParams struct), then you can start your first run: "go/bin/regolancer -f /home/regolancer/config.json".

For upgrading or uninstalling I refer to the steps described in this guide.

If there are issues or improvements on this steps, please let me know!