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

yunohost-bot a2d0a761cd Auto-update README		2024-03-29 07:24:17 +01:00
.github	Initial commit	2021-09-08 10:52:58 +02:00
compile_binaries	Clean-up python script	2021-10-19 12:57:07 +02:00
conf	Fix ssbport -> port_ssb	2024-01-06 11:50:25 +01:00
doc	fix	2024-01-14 20:55:43 +01:00
scripts	Fix restore	2024-01-06 12:09:07 +01:00
.gitignore	Initial commit	2021-09-08 10:52:58 +02:00
ALL_README.md	Auto-update README	2024-03-29 07:24:17 +01:00
LICENSE	Add license	2021-09-16 17:39:59 +02:00
manifest.toml	Fix autoupdate	2024-02-24 21:27:08 +01:00
README.md	Auto-update README	2024-03-29 07:24:17 +01:00
README_fr.md	Auto-update README	2024-03-29 07:24:17 +01:00
README_gl.md	Auto-update README	2024-03-29 07:24:17 +01:00
README_it.md	Auto-update README	2024-03-29 07:24:17 +01:00
tests.toml	Add missing ssb_admin_id tests arg	2024-01-06 11:35:59 +01:00

README.md

Scuttlebutt Room for YunoHost

Read this README is other languages.

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

A Scuttlebutt room is a service for connecting scuttlebutt users.

It includes a web interface for managing who is in the room, creating invites, and creating a code of conduct for the room.

For a comprehensive introduction to rooms 2.0, watch this video.

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

Shipped version: 2.0.6~ynh7

Demo: https://hermies.club/

Screenshots

Documentation and resources

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 Store: https://apps.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