Sphinx Relay

Sphinx Relay is a self-hosted Node.js backend for the Sphinx mobile chat app, routing end-to-end encrypted messages over the Bitcoin Lightning Network.

  • Communication
  • Media Applications
Sphinx Relay is a self-hosted Node.js backend for the Sphinx mobile chat app, routing end-to-end encrypted messages over the Bitcoin Lightning Network. It stores user data such as aliases, messages, invites, and media keys locally, making it ideal for homelab users who want private, decentralised communication without relying on centralised servers.

Platform availability

Available on 1 of 10 platforms

  • Unraid (not listed)
  • TrueNAS (not listed)
  • Umbrel
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

28/100 Low

Maintained
0last commit 858 days ago
Popular
48247 GitHub stars
Easy to install
351 install platform, install notes, Docker image
Light to run
801 GB minimum RAM, runs on ARM
Security check
103 serious findings, 18 minor, CI, tests

Availability: platform listings confirmed today, links checked 16 days ago

GitHub stars
247
Open issues
141
Last commit
2024-07-16
Latest release
v2.5.3
License
MIT
Activity
stale

Checked 13 days ago - source: GitHub (stakwork/sphinx-relay)

Resources & Compatibility

Minimum requirements: 1 GB RAM, 1 GB disk. ARM (e.g. Raspberry Pi) is supported.

Checked 54 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Install the stable version first Run `pip install sphinx-needs` in the Python environment for your docs project. This installs the tested release, which is the easiest and safest starting point for a first-time setup. source
  • Only install from source if you need it If you need the newest unreleased code, clone the repository and run `pip install .` inside it. This can pull in development changes, so it is not the best first step unless you specifically need it. source
  • Put Sphinx-Needs settings in conf.py Add configuration such as `needs_fields` and `needs_layouts` to your Sphinx `conf.py` before building. This is where Sphinx-Needs learns about extra fields and custom display styles, so missing settings can make your custom layouts or options not work as expected. source
  • Prerequisites Your Lightning node must be running LND version 0.10.0 or higher and be accessible via SSH before pairing Sphinx Relay. source

Fetched 39 days ago - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

What setup difficulty have Umbrel users reported for Sphinx Relay?

They have reported that getting Sphinx Relay working is not obvious, even though secure chat and data custody are appealing.

Does enabling port forwarding guarantee that the Sphinx app can reach an Umbrel Sphinx Relay?

In one report, enabling port forwarding did not allow the Sphinx app to reach the Umbrel node with Sphinx Relay installed.

Do Sphinx Relay nodes communicate outside the Lightning Network?

No; communication between Relay nodes takes place entirely on the Lightning Network.

Answers sourced from github.com, www.reddit.com, www.reddit.com

Community

Collected 49 days ago - public community threads