go-ssb-room/README.md

# Go-SSB Room
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fssb-ngi-pointer%2Fgo-ssb-room.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fssb-ngi-pointer%2Fgo-ssb-room?ref=badge_shield)


This repository contains code for a [Secure Scuttlebutt](https://ssb.nz) [Room (v1+v2) server](https://github.com/ssb-ngi-pointer/rooms2), written in Go.

It includes:
* secret-handshake+boxstream network transport, sometimes referred to as SHS, using [secretstream](https://github.com/cryptoscope/secretstream)
* muxrpc handlers for tunneling connections
* a fully embedded HTTP server & HTML frontend, for administering the room

![](./docs/screenshot.png)

## Features

* [x] Rooms v1 (`tunnel.connect`, `tunnel.endpoints`, etc.)
* [x] User management (allow- & denylisting + moderator & administrator roles), all administered via the web dashboard
* [x] Multiple [privacy modes](https://ssb-ngi-pointer.github.io/rooms2/#privacy-modes)
* [x] [Sign-in with SSB](https://ssb-ngi-pointer.github.io/ssb-http-auth-spec/)
* [x] Alias management

## Getting started

For an architecture and instructions on setting up a webserver to use with `go-ssb-room`, [read the documentation](./docs).

## Installation

See the [releases page](https://github.com/ssb-ngi-pointer/go-ssb-room/releases) for packaged linux releases.

We currently only distributed pre-packaged releases for debian-compatible distributions. See [Issue #79](https://github.com/ssb-ngi-pointer/go-ssb-room/issues/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](./docs/debian/postinstall.sh) for how to configure the systemd file and webserver.

## Development

For an in-depth walkthrough, see the [development.md](./docs/development.md) in the `docs` folder of this repository.

## Authors

* [cryptix](https://github.com/cryptix) (`@p13zSAiOpguI9nsawkGijsnMfWmFd5rlUNpzekEE+vI=.ed25519`)
* [staltz](https://github.com/staltz)
* [cblgh](https://github.com/cblgh)

## License

MIT


[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fssb-ngi-pointer%2Fgo-ssb-room.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fssb-ngi-pointer%2Fgo-ssb-room?ref=badge_large)
change name to go-ssb-room It has been brought to my attention that "gossb" reads like "gossip..?" to the untrained eye. That's just confusing. Also the project hosts a single room so the plural was just wrong. 2021-02-09 16:38:51 +00:00			`# Go-SSB Room`
Add license scan report and status Signed off by: fossabot <badges@fossa.com> 2021-05-20 07:35:44 +00:00			`[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fssb-ngi-pointer%2Fgo-ssb-room.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fssb-ngi-pointer%2Fgo-ssb-room?ref=badge_shield)`

some cleanup and a Readme 2021-02-04 13:13:52 +00:00
Update README.md 2021-03-12 09:48:42 +00:00			`This repository contains code for a [Secure Scuttlebutt](https://ssb.nz) [Room (v1+v2) server](https://github.com/ssb-ngi-pointer/rooms2), written in Go.`
some cleanup and a Readme 2021-02-04 13:13:52 +00:00
Update README.md 2021-03-12 09:48:42 +00:00			`It includes:`
Apply suggestions from code review Co-authored-by: Henry <111202+cryptix@users.noreply.github.com> 2021-03-12 10:33:01 +00:00			`* secret-handshake+boxstream network transport, sometimes referred to as SHS, using [secretstream](https://github.com/cryptoscope/secretstream)`
Update README.md 2021-03-12 09:48:42 +00:00			`* muxrpc handlers for tunneling connections`
Apply suggestions from code review Co-authored-by: Henry <111202+cryptix@users.noreply.github.com> 2021-03-12 10:33:01 +00:00			`* a fully embedded HTTP server & HTML frontend, for administering the room`
some cleanup and a Readme 2021-02-04 13:13:52 +00:00
update documentation, add screenshot 2021-04-26 12:38:00 +00:00			`![](./docs/screenshot.png)`

some cleanup and a Readme 2021-02-04 13:13:52 +00:00			`## Features`

			* [x] Rooms v1 (`tunnel.connect`, `tunnel.endpoints`, etc.)
update documentation, add screenshot 2021-04-26 12:38:00 +00:00			`* [x] User management (allow- & denylisting + moderator & administrator roles), all administered via the web dashboard`
			`* [x] Multiple [privacy modes](https://ssb-ngi-pointer.github.io/rooms2/#privacy-modes)`
			`* [x] [Sign-in with SSB](https://ssb-ngi-pointer.github.io/ssb-http-auth-spec/)`
			`* [x] Alias management`

			`## Getting started`
update contribution guideline for style css 2021-05-19 10:17:37 +00:00
update READMEs 2021-05-25 07:40:12 +00:00			For an architecture and instructions on setting up a webserver to use with `go-ssb-room`, [read the documentation](./docs).
sqlite and auth setup 2021-02-08 16:47:42 +00:00
update READMEs 2021-05-25 07:40:12 +00:00			`## Installation`
add insert-user steps to README 2021-02-09 12:02:51 +00:00
update READMEs 2021-05-25 07:40:12 +00:00			`See the [releases page](https://github.com/ssb-ngi-pointer/go-ssb-room/releases) for packaged linux releases.`
add insert-user steps to README 2021-02-09 12:02:51 +00:00
update READMEs 2021-05-25 07:40:12 +00:00			`We currently only distributed pre-packaged releases for debian-compatible distributions. See [Issue #79](https://github.com/ssb-ngi-pointer/go-ssb-room/issues/79) for the details. If this doesn't work for you, we ask you to read the Development notes and build from source.`
some cleanup and a Readme 2021-02-04 13:13:52 +00:00
update READMEs 2021-05-25 07:40:12 +00:00			After running `sudo dpkg -i go-ssb-room_v1.2.3_Linux_x86_64.deb` pay special attention to the [postinstall notes](./docs/debian/postinstall.sh) for how to configure the systemd file and webserver.
some cleanup and a Readme 2021-02-04 13:13:52 +00:00
update READMEs 2021-05-25 07:40:12 +00:00			`## Development`
some cleanup and a Readme 2021-02-04 13:13:52 +00:00
update READMEs 2021-05-25 07:40:12 +00:00			For an in-depth walkthrough, see the [development.md](./docs/development.md) in the `docs` folder of this repository.
some cleanup and a Readme 2021-02-04 13:13:52 +00:00
			`## Authors`

			* [cryptix](https://github.com/cryptix) (`@p13zSAiOpguI9nsawkGijsnMfWmFd5rlUNpzekEE+vI=.ed25519`)
update documentation, add screenshot 2021-04-26 12:38:00 +00:00			`* [staltz](https://github.com/staltz)`
			`* [cblgh](https://github.com/cblgh)`
some cleanup and a Readme 2021-02-04 13:13:52 +00:00
			`## License`

update readme with typo fixes 2021-03-04 13:17:01 +00:00			`MIT`
Add license scan report and status Signed off by: fossabot <badges@fossa.com> 2021-05-20 07:35:44 +00:00

			`[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fssb-ngi-pointer%2Fgo-ssb-room.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fssb-ngi-pointer%2Fgo-ssb-room?ref=badge_large)`