mirror of https://github.com/YunoHost-Apps/ssbroom_ynh.git synced 2024-09-03 20:26:29 +02:00

Secure Scuttlebutt room server package for YunoHost.

Find a file

mhfowler f3436bcb8b Update readme		2021-09-16 17:33:19 +02:00
.github	Initial commit	2021-09-08 10:52:58 +02:00
conf	Working on single install	2021-09-15 08:17:28 +02:00
doc	Update readme	2021-09-16 17:33:19 +02:00
scripts	Fix version number	2021-09-16 17:18:00 +02:00
sources	Initial commit	2021-09-08 10:52:58 +02:00
.gitignore	Initial commit	2021-09-08 10:52:58 +02:00
check_process	Initial commit	2021-09-08 10:52:58 +02:00
LICENSE	Initial commit	2021-09-08 10:52:58 +02:00
manifest.json	Fix version number	2021-09-16 17:18:00 +02:00
README.md	Update readme	2021-09-16 17:33:19 +02:00
README_fr.md	Auto-update README	2021-09-10 12:41:37 +00:00

README.md

Scuttlebutt Room for YunoHost

Lire ce readme en français.

This package allows you to install Scuttlebutt Room quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

This is an SSB room server built in Go, packaged for yunohost. A room server is used to make connecting with friends easier on SSB apps. Room servers also makes it easy for any member to invite new folks, allowing the network to expand on its own.

A more extensive document explaining how ssb room servers technically work can be found here: https://ssb-ngi-pointer.github.io/rooms2/

Features

SSB users can connect to the room and then create tunneled connections between each other.
Admins of the SSB room can create invitations to invite new members.
It is also possible, through settings, to allow new members to also invite new members (community mode).

Shipped version: 2.0.6~ynh1

Demo: https://hermies.club/

Screenshots

Disclaimers / important information

Current limitations:
- requires a dedicated domain and can only run on the / path.
- requires HTTPS
- currently only supports amd64 architecture (hopefully getting more binaries from upstream soon)
- uses own authentication mechanism (not SSO LDAP)
- currently only supports one installation per server, and requires port 8008 specifically, but hopefully getting flexibility for other ports from upstream soon

Documentation and resources

Official app website: https://github.com/ssb-ngi-pointer/go-ssb-room
Official user documentation: https://github.com/ssb-ngi-pointer/go-ssb-room/blob/master/README.md
Official admin documentation: https://github.com/ssb-ngi-pointer/go-ssb-room/blob/master/README.md
Upstream app code repository: https://github.com/ssb-ngi-pointer/go-ssb-room
YunoHost documentation for this app: https://yunohost.org/app_ssbroom
Report a bug: https://github.com/YunoHost-Apps/ssbroom_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/ssbroom_ynh/tree/testing --debug
or
sudo yunohost app upgrade ssbroom -u https://github.com/YunoHost-Apps/ssbroom_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps