YunoHost-Apps/ssbroom_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/ssbroom_ynh.git synced 2024-09-03 20:26:29 +02:00
Code Issues Activity Actions

Auto-update README

Browse source
This commit is contained in:
Yunohost-Bot 2021-10-08 08:57:06 +00:00 committed by Yunohost-Bot
parent 5d43f58c2d
commit 174abd0d71
1 changed files with 19 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -15,20 +15,15 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
## Overview ## Overview
A Scuttlebutt room is a service for connecting scuttlebutt users. Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
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).
### Features ### Features
- Rooms v1 (tunnel.connect, tunnel.endpoints, etc.) - Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
- User management (allow- & denylisting + moderator & administrator roles), all administered via the web dashboard - Laboris nisi ut aliquip ex ea commodo consequat ;
- Multiple privacy modes - Duis aute irure dolor in reprehenderit in voluptate ;
- Sign-in with SSB - Velit esse cillum dolore eu fugiat nulla pariatur ;
- HTTP Invites - Excepteur sint occaecat cupidatat non proident, sunt in culpa."
- Alias management
**Shipped version:** 2.0.6~ynh1 **Shipped version:** 2.0.6~ynh1
@ -38,13 +33,22 @@ For a comprehensive introduction to rooms 2.0, watch [this video](https://www.yo
## Screenshots ## Screenshots
![](./doc/screenshots/ssbroom-screenshot.png) ![](./doc/screenshots/ssbroom-screenshot.png)
![](./doc/screenshots/example.jpg)
## Disclaimers / important information ## Disclaimers / important information
* Any known limitations, constraints or stuff not working: * Any known limitations, constrains or stuff not working, such as (but not limited to):
* requires a full dedicated domain and does not support sub-paths * requiring a full dedicated domain ?
* currently ony supported on amd64 * architectures not supported ?
* 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 * not-working single-sign on or LDAP integration ?
* the app requires an important amount of RAM / disk / .. to install or to work properly
* etc...
* Other infos that people should be aware of, such as:
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
* how to configure / administrate the application if it ain't obvious
* upgrade process / specificities / things to be aware of ?
* security considerations ?
## Documentation and resources ## Documentation and resources