coop-cloud-chaos-patchs/go-ssb-room
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Mirror of https://github.com/ssbc/go-ssb-room/ to add Docker image builds with Drone
545 Commits 1 Branch 1 Tag 3.1 MiB
Go 96.1%
JavaScript 3.3%
CSS 0.3%
Shell 0.2%
f83bf65bb9
Go to file
Henry f83bf65bb9 don't block dasboard rendering for too long 
updates #210
2021-05-31 07:38:52 +02:00
.github/workflows auto-commit updated style.css via github action 2021-05-19 11:59:14 +02:00
cmd dependency updates 2021-05-25 12:40:00 +02:00
docs update READMEs 2021-05-25 12:40:55 +02:00
internal dependency updates 2021-05-25 12:40:00 +02:00
muxrpc dependency updates 2021-05-25 12:40:00 +02:00
roomdb Support open invites (fixes #102) 2021-05-17 10:16:26 +02:00
roomsrv dependency updates 2021-05-25 12:40:00 +02:00
roomstate dependency updates 2021-05-25 12:40:00 +02:00
web don't block dasboard rendering for too long 2021-05-31 07:38:52 +02:00
.gitignore use goreleaser for packaging .deb release 2021-05-24 16:31:20 +02:00
.goreleaser.yml use goreleaser for packaging .deb release 2021-05-24 16:31:20 +02:00
errors.go room sever skeleton 2021-01-25 13:50:51 +01:00
go.mod dependency updates 2021-05-25 12:40:00 +02:00
go.sum dependency updates 2021-05-25 12:40:00 +02:00
LICENSE add LICENSE file 2021-05-25 12:39:56 +02:00
README.md update READMEs 2021-05-25 12:40:55 +02:00

README.md

Go-SSB Room

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
  • Alias management

Getting started

For an architecture and instructions on setting up a webserver to use with go-ssb-room, read the documentation.

Installation

See the releases page for packaged linux releases.

We currently only distributed pre-packaged releases for debian-compatible distributions. See Issue #79 for the details. If this doesn't work for you, we ask you to read the Development notes and build from source.

After running sudo dpkg -i go-ssb-room_v1.2.3_Linux_x86_64.deb pay special attention to the postinstall notes for how to configure the systemd file and webserver.

Development

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

Authors

License

MIT