https://github.com/yunohost-apps/ssbroom_ynh

Secure Scuttlebutt room server package for YunoHost.
https://github.com/yunohost-apps/ssbroom_ynh

scuttlebutt ssbroom yunohost yunohost-apps

Last synced: 6 months ago
JSON representation

Secure Scuttlebutt room server package for YunoHost.

• Host: GitHub
• URL: https://github.com/yunohost-apps/ssbroom_ynh
• Owner: YunoHost-Apps
• License: agpl-3.0
• Created: 2021-09-08T08:52:56.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-02T07:10:05.000Z (about 1 year ago)
• Last Synced: 2025-04-23T15:12:34.087Z (6 months ago)
• Topics: scuttlebutt, ssbroom, yunohost, yunohost-apps
• Language: Shell
• Homepage:
• Size: 352 KB
• Stars: 12
• Watchers: 6
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


# Scuttlebutt Room for YunoHost

[![Integration level](https://dash.yunohost.org/integration/ssbroom.svg)](https://ci-apps.yunohost.org/ci/apps/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~ynh9

**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:**