https://github.com/patchwork-hub/content_filters
A Ruby on Rails plugin for filtering content on Mastodon timelines
https://github.com/patchwork-hub/content_filters
Last synced: 7 months ago
JSON representation
A Ruby on Rails plugin for filtering content on Mastodon timelines
- Host: GitHub
- URL: https://github.com/patchwork-hub/content_filters
- Owner: patchwork-hub
- License: mit
- Created: 2024-05-25T09:18:43.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-27T09:52:38.000Z (about 1 year ago)
- Last Synced: 2025-02-27T13:42:12.938Z (about 1 year ago)
- Language: Ruby
- Homepage: https://www.joinpatchwork.org/
- Size: 63.5 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
## Overview
Filter content on your Patchwork enhanced Mastodon server timelines.
To enable this plugin please make sure you have set up a Mastodon server and installed the Patchwork Dashboard, with both running correctly.
[See the full Patchwork ReadMe here.](https://github.com/patchwork-hub/patchwork_dashboard/blob/main/README.md)
### Features
#### Spam & moderation filters
Filter your timelines by blocking posts with defined hashtags and keywords.
#### Federation controls
Easily manage your timelines by blocking or unblocking Threads and Bluesky posts.
## Installation
Before installing this gem, please make sure that below systems are up and running:
- [Set up a Mastodon server](https://docs.joinmastodon.org/admin/install/)
- [Patchwork Dashboard](https://github.com/patchwork-hub/patchwork_dashboard/blob/main/README.md)
1. Add this line to your Mastodon application's Gemfile:
```ruby
gem "content_filters", git: "https://github.com/patchwork-hub/content_filters"
```
2. Execute to install the gem:
```bash
$ bundle install
```
3. After installing the gem, restart your application to load it in your application.
## License
The gem is available as open source under AGPL-3.0.