README.md

Wrapper for Core Lightning (CLN)

This project wraps Core Lightning for StartOS. Core Lightning is a lightweight, highly customizable and standard compliant implementation of the Lightning Network protocol.

Dependencies

• docker
• docker-buildx
• yq
• start-sdk
• make
• deno
• md-packer

Cloning

Clone the project locally.

git clone git@github.com:Start9Labs/cln-startos.git
cd cln-startos

Building

To build the project for all supported platforms, run the following command:

make

To build the project for a single platform, run:

# for amd64
make x86

or

# for arm64
make arm

Installing (on Start9 server)

Run the following commands to determine successful install:

ℹ️ Change server-name.local to your Start9 server address

start-cli auth login
# Enter your StartOS password
start-cli --host https://server-name.local package install c-lightning.s9pk

If you already have your start-cli config file setup with a default host, you can install simply by running:

make install

Tip: You can also install the c-lightning.s9pk using Sideload Service under the System > Manage section.