Mirror of https://github.com/ssbc/go-ssb-room/ to add Docker image builds with Drone
Go to file
Henry a249fd8bee fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
.github/workflows fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
LICENSES fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
cmd fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
docs fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
internal fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
muxrpc fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
roomdb fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
roomsrv fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
roomstate fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
web fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
.dockerignore fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
.env_example fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
.gitignore fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
.goreleaser.yml fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
Dockerfile fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
LICENSE add LICENSE file 2021-05-25 12:39:56 +02:00
README.md fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
docker-compose.yml fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
errors.go fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
go.mod fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
go.sum small fixes 2021-06-01 08:03:12 +02:00
go.sum.license fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00
start.sh fix SPDX headers and add reuse API badge 2021-10-08 14:39:31 +02:00

README.md

Go-SSB Room

REUSE status

This repository contains code for a Secure Scuttlebutt Room (v1+v2) server, written in Go.

It includes:

  • secret-handshake+boxstream network transport, sometimes referred to as SHS, using secretstream
  • muxrpc handlers for tunneling connections
  • a fully embedded HTTP server & HTML frontend, for administering the room

Features

  • Rooms v1 (tunnel.connect, tunnel.endpoints, etc.)
  • User management (allow- & denylisting + moderator & administrator roles), all administered via the web dashboard
  • Multiple privacy modes
  • Sign-in with SSB
  • HTTP Invites
  • Alias management

For a comprehensive introduction to rooms 2.0, 🎥 watch this video.

🚀 Deployment

If you want to deploy a room server yourself, follow our deployment.md docs.

🔧 Development

For an in-depth codebase walkthrough, see the development.md file in the docs folder of this repository.

🧑‍🤝‍🧑 Authors

License

MIT