Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
clarkwinkelmann committed Oct 15, 2021
1 parent 32fe03c commit 8750bb8
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,24 @@

[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/clarkwinkelmann/flarum-ext-shadow-ban/blob/master/LICENSE.md) [![Latest Stable Version](https://img.shields.io/packagist/v/clarkwinkelmann/flarum-ext-shadow-ban.svg)](https://packagist.org/packages/clarkwinkelmann/flarum-ext-shadow-ban) [![Total Downloads](https://img.shields.io/packagist/dt/clarkwinkelmann/flarum-ext-shadow-ban.svg)](https://packagist.org/packages/clarkwinkelmann/flarum-ext-shadow-ban) [![Donate](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.me/clarkwinkelmann)

This extension implements shadow ban and content deletion for Flarum.
This extension implements shadow-ban and shadow content deletion for Flarum.

When a discussion or post is shadow hidden, only the author and users with permission "Shadow hide discussions and posts" will see it.

A user can be shadow banned for a given duration via their profile.
When a user is shadow banned, all their new discussions and posts are automatically shadow hidden.
They are **not restored** when the shadow ban ends.
A user can be shadow-banned for a given duration via their profile.
When a user is shadow-banned, all their new discussions and posts are automatically shadow hidden.
They are **not restored** when the shadow-ban ends.

Optionally you can enable the users to be shadow hidden when shadow banned.
When a user is shadow hidden, their profile will no longer be accessible by direct link and they won't be offered in search and mention auto-completion.
Follow notifications (`flarum/subscriptions`) and mentions (`flarum/mentions`) are automatically silenced.
However, notifications of new discussions or posts by other extensions might not honour the shadow hide.

Optionally you can enable the users to be shadow hidden when shadow-banned.
When a user is shadow hidden, their profile will no longer be accessible by direct link, and they won't be offered in search and mention auto-completion.
However, their name is still visible on their previous non-hidden content and the user card/profile can be seen from there.

For the shadow-banned/hidden user, their content continues to be visible to them with no difference, including the REST API payload being completely identical to regular non-shadow-hidden content.
They can of course notice the shadow-ban by visiting the forum as guest or with a different account.
It's also possible to notice the shadow-ban due to the discussion meta not taking into account the user posts, including the last reply not reflecting their username and discussions not rising to the top of the homepage with their new reply.

## Installation

Expand Down

0 comments on commit 8750bb8

Please sign in to comment.