2021-09-08 10:52:58 +02:00
|
|
|
<!--
|
2024-03-29 07:24:17 +01:00
|
|
|
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
2021-09-08 10:52:58 +02:00
|
|
|
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
|
|
|
|
2023-08-17 19:40:03 +02:00
|
|
|
[](https://dash.yunohost.org/appci/app/ssbroom)  
|
|
|
|
|
|
2021-09-10 14:41:37 +02:00
|
|
|
[](https://install-app.yunohost.org/?app=ssbroom)
|
2021-09-08 10:52:58 +02:00
|
|
|
|
2024-03-29 07:24:17 +01:00
|
|
|
*[Read this README is other languages.](./ALL_README.md)*
|
2021-09-08 10:52:58 +02:00
|
|
|
|
2024-03-29 07:24:17 +01:00
|
|
|
> *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](https://yunohost.org/install) to learn how to install it.*
|
2021-09-08 10:52:58 +02:00
|
|
|
|
|
|
|
|
## 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
|
|
|
|
2024-01-06 11:36:05 +01:00
|
|
|
**Shipped version:** 2.0.6~ynh7
|
2021-09-08 10:52:58 +02:00
|
|
|
|
2024-03-29 07:24:17 +01: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
|
|
|
|
2023-08-17 21:08:10 +02:00
|
|
|
|
2021-09-08 10:52:58 +02:00
|
|
|
|
|
|
|
|
## Documentation and resources
|
|
|
|
|
|
2024-03-29 07:24:17 +01:00
|
|
|
- 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>
|
2021-09-08 10:52:58 +02:00
|
|
|
|
|
|
|
|
## Developer info
|
|
|
|
|
|
2024-03-29 07:24:17 +01: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
|
|
|
|
2024-03-29 07:24:17 +01:00
|
|
|
To try the `testing` branch, please proceed like that:
|
2022-07-02 19:06:07 +02:00
|
|
|
|
2024-03-29 07:24:17 +01:00
|
|
|
```bash
|
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
|
|
|
```
|
|
|
|
|
|
2024-03-29 07:24:17 +01:00
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
