Skip to content

Start9Labs/phoenixd-startos

Repository files navigation

Project Logo

phoenixd for StartOS

phoenixd is a minimal, specialized Lightning node designed for sending and receiving Lightning payments. phoenixd makes it very easy to develop any application that needs to interact with Lightning, by abstracting away all the complexity, without compromising on self-custody. This repository creates the s9pk package that is installed to run phoenixd on StartOS.

Dependencies

Prior to building the phoenixd package, it's essential to configure your build environment for StartOS services. You can find instructions on how to set up the appropriate build environment in the Developer Docs.

Cloning

Clone the phoenixd package repository locally.

git clone https://github.com/Start9Labs/phoenixd-startos.git
cd phoenixd-startos

Building

To build the phoenixd service as a universal package, run the following command:

make

Alternatively the package can be built for individual architectures by specifying the architecture as follows:

# for amd64
make x86

or

# for arm64
make arm

Installing (on StartOS)

Before installation, define host: https://server-name.local in your ~/.embassy/config.yaml config file then 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
make install

Tip: You can also install the phoenixd.s9pk by sideloading it under the StartOS > System > Sideload a Service section.

Verify Install

Go to your StartOS Services page, select phoenixd and start the service.

Done!

About

phoenixd for StartOS is a minimal, specialized Lightning node designed for sending and receiving Lightning payments

Resources

License

Stars

Watchers

Forks

Packages

No packages published