Skip to content

Start9Labs/sphinx-relay-startos

Repository files navigation

Wrapper for sphinx-relay

Sphinx Chat is a messaging service built on top of the Lightning Network. Each message sent and received on Sphinx is actually a transaction on Lightning. This serves to protect against spam and provides a means of monetizing content without trusted third parties. This repository creates the s9pk package that is installed to run sphinx-relay on embassyOS.

Dependencies

Install the following system dependencies to build this project by following the instructions in the provided links. You can also find detailed steps to setup your environment in the service packaging documentation.

Cloning

Clone the project locally. Note the submodule link to the original project.

git clone [email protected]:Start9Labs/sphinx-relay-wrapper.git
cd sphinx-relay-wrapper

Installing (on embassyOS)

Run the following commands to install:

ℹ️ Change embassy-server-name.local to your Embassy address

embassy-cli auth login
# Enter your embassy password
embassy-cli --host https://embassy-server-name.local package install sphinx-relay.s9pk

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

make install

Tip: You can also install the sphinx-relay.s9pk using Sideload Service under the Embassy > Settings section.

Verify Install

Go to your Embassy Services page, select Sphinx Relay, configure and start the service. Then, verify its interfaces are accessible.

Done!