# Scuttlebutt Room for YunoHost
[![Integration level](https://dash.yunohost.org/integration/ssbroom.svg)](https://dash.yunohost.org/appci/app/ssbroom) ![Working status](https://ci-apps.yunohost.org/ci/badges/ssbroom.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/ssbroom.maintain.svg)
[![Install Scuttlebutt Room with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ssbroom)
*[Read this README in other languages.](./ALL_README.md)*
> *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.*
## 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](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
**Shipped version:** 2.0.6~ynh7
**Demo:**
## Screenshots
![Screenshot of Scuttlebutt Room](./doc/screenshots/screenshot.png)
## Documentation and resources
- Official user documentation:
- Official admin documentation:
- Upstream app code repository:
- YunoHost Store:
- Report a bug:
## Developer info
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/ssbroom_ynh/tree/testing).
To try the `testing` branch, please proceed like that:
```bash
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:**