Mirror of https://github.com/ssbc/go-ssb-room/ to add Docker image builds with Drone
ab664aafc3
When running in open mode invites can be freely generated by accessing /create-invite. This displays an HTML page which creates and displays an invite to the user. This commit adds an additional way of creating invites in open mode. A POST request can be sent to the same /create-invite endpoint with the Accept header set to application/json. This returns a JSON response which contains an invite url. The purpose of this change is to make automatic invite generation easier in SSB clients. |
||
---|---|---|
.github | ||
.reuse | ||
LICENSES | ||
cmd | ||
docs | ||
internal | ||
muxrpc | ||
roomdb | ||
roomsrv | ||
roomstate | ||
web | ||
.dockerignore | ||
.env_example | ||
.gitignore | ||
.goreleaser.yml | ||
Dockerfile | ||
LICENSE | ||
README.md | ||
docker-compose.yml | ||
errors.go | ||
go.mod | ||
go.sum | ||
go.sum.license | ||
start.sh |
README.md
Go-SSB Room
This repository implements the Room (v1+v2) server spec, 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
See this project for current focus.
⭐ 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. For a description of MuxRPC APIs see https://github.com/ssbc/rooms2
🚀 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