The project is in a healthy, maintained state
A consolidated Rails engine gem that extends Mastodon with Newsmast features: custom registration flows, push notifications, content filtering, custom feeds, draft management, ALT text generation, local-only posts, and extended timelines.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Runtime

~> 4.13
~> 11.1
~> 1.13, >= 1.13.1
~> 0.23.1
>= 7.1, < 9.0
 Project Readme

newsmast-mastodon

The Newsmast Mastodon gem extends a Mastodon server to provide functionality for content filters, posts management, account management, content channels and more. The gem interacts with the Newsmast Apps for Change mobile apps - customised mobile apps for Newsmast Communities, and the Newsmast Dashboard, which allows extended customisation of Mastodon server features and settings.

Versioning

This project uses compatibility-first versioning: X.Y.Z.N.

  • X.Y.Z tracks the target Mastodon version.
  • N is the gem patch level for that exact Mastodon line.

Examples:

  • 4.5.11 is for Mastodon 4.5.11.
  • 4.5.11.0 is the first gem release for Mastodon 4.5.11.
  • 4.5.11.1 is a gem-only patch release, still for Mastodon 4.5.11.
  • 4.6.3 is for Mastodon 4.6.3.
  • 4.6.3.0 is the first gem release for Mastodon 4.6.3.
  • 4.6.4.0 starts support for the next Mastodon compatibility line.

Prerequisites

The plugin requires Ruby >= 3.3.0, < 4.1.0, a matching Mastodon service version, and (depending on intended use) may also require Newsmast Dashboard.

Installation

See https://github.com/TheNewsmastFoundation/documentation/tree/main/newsmast-mastodon

How the gem overrides Mastodon

The gem is a standard Rails engine. It changes Mastodon behavior at runtime by:

  • prepending modules into Mastodon services, serializers, validators, and controllers (see config/initializers/prepend_concerns.rb);
  • including model concerns into Account, Status, User, and other host models;
  • replacing Mastodon's core Chewy search indexes (AccountsIndex, StatusesIndex, PublicStatusesIndex) with its own namespaced definitions while preserving the upstream Elasticsearch index names;
  • shipping additional migrations, frontend components, and API controllers that mount onto the host.

This lets any Mastodon host install the gem and receive the same behavior that was previously maintained as inline fork patches.

Documentation

See https://github.com/TheNewsmastFoundation/documentation/blob/main/newsmast-mastodon/configuration.md

Contributing

Our governance policies and contributor guides are located in our main documentation repo: