2021-09-08 10:52:58 +02:00
|
|
|
<!--
|
|
|
|
|
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
|
|
|
|
It shall NOT be edited by hand.
|
|
|
|
|
-->
|
|
|
|
|
|
2021-09-10 14:41:37 +02:00
|
|
|
# Scuttlebutt Room for YunoHost
|
2021-09-08 10:52:58 +02:00
|
|
|
|
2021-09-10 14:41:37 +02:00
|
|
|
[](https://dash.yunohost.org/appci/app/ssbroom)  
|
|
|
|
|
[](https://install-app.yunohost.org/?app=ssbroom)
|
2021-09-08 10:52:58 +02:00
|
|
|
|
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
|
|
2021-09-10 14:41:37 +02:00
|
|
|
> *This package allows you to install Scuttlebutt Room quickly and simply on a YunoHost server.
|
2021-09-08 10:52:58 +02:00
|
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
|
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
|
2021-10-08 11:26:29 +02:00
|
|
|
A Scuttlebutt room is a service for connecting scuttlebutt users.
|
2021-09-08 10:52:58 +02:00
|
|
|
|
2021-10-08 11:26:29 +02:00
|
|
|
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](https://www.youtube.com/watch?v=W5p0y_MWwDE).
|
2021-09-08 10:52:58 +02:00
|
|
|
|
2021-10-08 11:26:29 +02:00
|
|
|
### Features
|
2021-09-08 10:52:58 +02:00
|
|
|
|
2021-10-08 11:26:29 +02:00
|
|
|
- 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
|
2021-09-08 10:52:58 +02:00
|
|
|
|
2021-09-16 17:33:19 +02:00
|
|
|
**Shipped version:** 2.0.6~ynh1
|
2021-09-08 10:52:58 +02:00
|
|
|
|
2021-09-10 14:41:37 +02:00
|
|
|
**Demo:** https://hermies.club/
|
2021-09-08 10:52:58 +02:00
|
|
|
|
2021-09-08 10:53:00 +02:00
|
|
|
## Screenshots
|
2021-09-08 10:52:58 +02:00
|
|
|
|
2021-09-16 17:33:19 +02:00
|
|
|
|
2021-09-08 10:52:58 +02:00
|
|
|
|
|
|
|
|
## Disclaimers / important information
|
|
|
|
|
|
2021-10-09 09:25:47 +02:00
|
|
|
* requires a full dedicated domain and does not support sub-paths
|
|
|
|
|
* currently ony supported on amd64 architecture (until more binaries are built upstream)
|
|
|
|
|
* ssb rooms work best when the app is in public mode. ssb-room has its own user and authentication system, and doesn't need yunohost SSO
|
2021-09-08 10:52:58 +02:00
|
|
|
## Documentation and resources
|
|
|
|
|
|
2021-09-10 14:41:37 +02:00
|
|
|
* 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
|
2021-09-08 10:52:58 +02:00
|
|
|
|
|
|
|
|
## Developer info
|
|
|
|
|
|
2021-09-10 14:41:37 +02:00
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/ssbroom_ynh/tree/testing).
|
2021-09-08 10:52:58 +02:00
|
|
|
|
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
|
```
|
2021-09-10 14:41:37 +02:00
|
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/ssbroom_ynh/tree/testing --debug
|
2021-09-08 10:52:58 +02:00
|
|
|
or
|
2021-09-10 14:41:37 +02:00
|
|
|
sudo yunohost app upgrade ssbroom -u https://github.com/YunoHost-Apps/ssbroom_ynh/tree/testing --debug
|
2021-09-08 10:52:58 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
