An open API service indexing awesome lists of open source software.

https://github.com/FriendsOfFlarum/byobu

Well integrated, advanced private discussions for your Flarum forum.
https://github.com/FriendsOfFlarum/byobu

flagrow flarum flarum-extension hacktoberfest private-discussions

Last synced: 21 days ago
JSON representation

Well integrated, advanced private discussions for your Flarum forum.

Awesome Lists containing this project

README

        

# Byōbu by FriendsOfFlarum

[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/FriendsOfFlarum/byobu/blob/master/LICENSE)
[![Latest Stable Version](https://img.shields.io/packagist/v/fof/byobu.svg)](https://packagist.org/packages/fof/byobu)
[![Total Downloads](https://img.shields.io/packagist/dt/fof/byobu.svg)](https://packagist.org/packages/fof/byobu)
[![Donate](https://img.shields.io/badge/opencollective-support-blue.svg)](https://opencollective.com/fof)

Private discussions for your forum. Allows you to select specific recipients for your discussions.

## Goals

- Create discussions only specific users or groups can participate in.
- Force new posts in these private discussions to show real-time.

## Installation
```php
composer require fof/byobu:"*"
```

## Updating
```php
composer update fof/byobu
php flarum migrate
php flarum cache:clear
```

## Configuration

Enable the extension under the extensions tab in the admin area.

Make sure you configure the private discussions permission on the Admin Permissions tab to your needs;

- Create private discussions with users
- Create private discussions with groups
- Create private discussions with blockers
- Edit recipient users of private discussions
- Edit recipient groups of private discussions

## Notifications

Browser alert and email notifications are available for `user` recipients of private discussions for:

- Private discussion started
- Private discussion replied
- User added to private discussion
- User left the private discussion

Notifications for `group` recipients are available for:

- Private discussion started
- Private discussion replied

(More notification types are planned for `groups` soon)

## Support our work

We prefer to keep our work available to everyone.
In order to do so we rely on voluntary contributions on [OpenCollective](https://opencollective.com/fof).

## Links

- [Discuss](https://discuss.flarum.org/d/4762)
- [GitHub](https://github.com/FriendsOfFlarum/byobu)
- [Issues](https://github.com/FriendsOfFlarum/byobu/issues)
- [Packagist](https://packagist.org/packages/fof/byobu)

An extension by FriendsOfFlarum.