Mirror of https://github.com/ssbc/go-ssb-room/ to add Docker image builds with Drone
Go to file
Henry 4d3610e2fb prepare v2 release 2021-05-31 14:51:05 +02:00
.github/workflows auto-commit updated style.css via github action 2021-05-19 11:59:14 +02:00
cmd prepare v2 release 2021-05-31 14:51:05 +02:00
docs docs/README.md is an actual table of contents 2021-05-31 15:27:47 +03:00
internal prepare v2 release 2021-05-31 14:51:05 +02:00
muxrpc prepare v2 release 2021-05-31 14:51:05 +02:00
roomdb prepare v2 release 2021-05-31 14:51:05 +02:00
roomsrv prepare v2 release 2021-05-31 14:51:05 +02:00
roomstate prepare v2 release 2021-05-31 14:51:05 +02:00
web prepare v2 release 2021-05-31 14:51:05 +02:00
.gitignore use goreleaser for packaging .deb release 2021-05-24 16:31:20 +02:00
.goreleaser.yml fix maintainer email 2021-05-31 14:39:46 +02:00
LICENSE add LICENSE file 2021-05-25 12:39:56 +02:00
README.md reorganize the docs into deployment & development 2021-05-31 15:24:10 +03:00
errors.go room sever skeleton 2021-01-25 13:50:51 +01:00
go.mod prepare v2 release 2021-05-31 14:51:05 +02:00
go.sum dependency updates 2021-05-25 12:40:00 +02:00

README.md

Go-SSB Room

FOSSA 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

🚀 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

FOSSA Status