💬🧠A self-hosted and easily hackable websockets relay server built for Zen Client and Zen Bridge –
- Open source and built upon well-established JS libraries.
- Easy to deploy, modify and customize for any needs.
- Runs on any operating system (with Node v.12.16.3 installed).
- Entirely transparent.
- See releases for a detailed version history.
- Please open an issue if anything is missing or unclear in this documentation.
Table of Contents (click to expand)
This gif shows a dev installing and running this project from scratch on macOS 10.15.3's Terminal.app, with Node v.12.16.3 pre-installed –
A public instance, which always mirrors this repository's master branch, is available at relay.amnesia.software (wss://relay.amnesia.software). Feel free to use and test on this instance.
Use the package manager npm to install Zen Relay's dependencies.
git clone https://github.com/AmnesiaLabs/zen-relay
cd zen-relay
npm inode index.js <port>Returns a health report and basic statistics (demo) in a 200 response.
{"connected_clients":6,"health":"ok"}Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.