mirror of
https://github.com/YunoHost-Apps/ssbroom_ynh.git
synced 2024-09-03 20:26:29 +02:00
62 lines
No EOL
2.8 KiB
Markdown
62 lines
No EOL
2.8 KiB
Markdown
# Scuttlebutt Room pour YunoHost
|
||
|
||
[![Niveau d'intégration](https://dash.yunohost.org/integration/ssbroom.svg)](https://dash.yunohost.org/appci/app/ssbroom) ![](https://ci-apps.yunohost.org/ci/badges/ssbroom.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/ssbroom.maintain.svg)
|
||
[![Installer Scuttlebutt Room avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ssbroom)
|
||
|
||
*[Read this readme in english.](./README.md)*
|
||
*[Lire ce readme en français.](./README_fr.md)*
|
||
|
||
> *Ce package vous permet d'installer Scuttlebutt Room rapidement et simplement sur un serveur YunoHost.
|
||
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||
|
||
## Vue d'ensemble
|
||
|
||
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](https://www.youtube.com/watch?v=W5p0y_MWwDE).
|
||
|
||
### 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
|
||
|
||
**Version incluse :** 2.0.6~ynh3
|
||
|
||
**Démo :** https://hermies.club/
|
||
|
||
## Captures d'écran
|
||
|
||
![](./doc/screenshots/ssbroom-screenshot.png)
|
||
|
||
## Avertissements / informations importantes
|
||
|
||
* 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
|
||
## Documentations et ressources
|
||
|
||
* Site officiel de l'app : https://github.com/ssb-ngi-pointer/go-ssb-room
|
||
* Documentation officielle utilisateur : https://github.com/ssb-ngi-pointer/go-ssb-room/blob/master/README.md
|
||
* Documentation officielle de l'admin : https://github.com/ssb-ngi-pointer/go-ssb-room/blob/master/README.md
|
||
* Dépôt de code officiel de l'app : https://github.com/ssb-ngi-pointer/go-ssb-room
|
||
* Documentation YunoHost pour cette app : https://yunohost.org/app_ssbroom
|
||
* Signaler un bug : https://github.com/YunoHost-Apps/ssbroom_ynh/issues
|
||
|
||
## Informations pour les développeurs
|
||
|
||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/ssbroom_ynh/tree/testing).
|
||
|
||
Pour essayer la branche testing, procédez comme suit.
|
||
```
|
||
sudo yunohost app install https://github.com/YunoHost-Apps/ssbroom_ynh/tree/testing --debug
|
||
ou
|
||
sudo yunohost app upgrade ssbroom -u https://github.com/YunoHost-Apps/ssbroom_ynh/tree/testing --debug
|
||
```
|
||
|
||
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps |