# sphinx-relay

> Self-hosted Lightning Network relay that connects Sphinx chat clients to an LND node for decentralized, encrypted messaging over the Lightning Network.

- **Category:** Chat
- **Licence:** MIT
- **Latest version:** v2.5.3
- **Open source:** oss
- **Languages:** Typescript
- **Platforms:** Docker Compose, Linux
- **Tags:** Messaging, Decentralized, Qr Code, Bitcoin, Lightning Network, Node.js, Self Hosted, Lnd, Encrypted Messaging, Sphinx Chat

## Description

Sphinx Relay is a Node.js service that wraps LND to provide connectivity and data storage for the Sphinx chat app. It lets anyone operate their own relay node so messages travel over the Lightning Network in a decentralized, encrypted fashion. The relay persists aliases, messages, recurring payment setups, contact invites, and media decryption keys. Deployment options include Docker, Docker Compose, plain Linux, myNode, and Raspiblitz. An LND instance (v0.10.0+) with funded channels is required. Clients connect by scanning a QR code the relay prints at startup, which opens a WebSocket link on port 3001 (or 3300 in Docker).

## Links

- [Homepage](https://github.com/stakwork/sphinx-relay)
- [Docker](sphinxlightning/sphinx-relay)
- [GitHub Repository](https://github.com/stakwork/sphinx-relay)
- [Docker Deployment Guide](https://github.com/stakwork/sphinx-relay/blob/master/docs/docker_deployment.md)
- [Linux Deployment Guide](https://github.com/stakwork/sphinx-relay/blob/master/docs/linux_deployment.md)
- [myNode Deployment Guide](https://github.com/stakwork/sphinx-relay/blob/master/docs/myNode_deployment.md)
- [Raspiblitz Deployment Guide](https://github.com/stakwork/sphinx-relay/blob/master/docs/raspiblitz_deployment.md)

---
Source: https://selfhost.directory/project/sphinx-relay