Skip to content

Start9Labs/nostr-rs-relay-startos

Repository files navigation

Project Logo

Nostr RS Relay for StartOS

Nostr RS Relay is a nostr relay, written in Rust. It currently supports the entire relay protocol, and persists data with SQLite. This repository creates the s9pk package that is installed to run Nostr RS Relay on StarOS.

Dependencies

Install the system dependencies below 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:

git clone --recursive git@github.com:Start9Labs/nostr-rs-relay-startos.git
cd nostr-rs-relay-startos

Building

After setting up your environment, build the nostr package by running:

make

To build the nostr package for a single platform, run:

# 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 nostr.s9pk by sideloading it under the StartOS > System > Sideload a Service section.

Verify Install

Via the StartOS web-UI, select Services > Nostr RS Relay, configure and start the service. Then, verify its interfaces are accessible.

Done!