mirrors/catstodon
1
0
Fork 0
mirror of https://git.kescher.at/CatCatNya/catstodon.git synced 2024-11-29 02:51:37 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
catstodon/README.md
Jeremy Kescher 1a0ea16128
README.md: Add note about MASTODON_USE_LIBVIPS
2024-06-18 01:55:35 +02:00

3.5 KiB
Raw Blame History

Catstodon

Introduction

This Mastodon fork is based on the glitch-soc Fork of Mastodon, with changes made to suit CatCatNya~. I intend to contribute some useful differences back to glitch-soc and vanilla Mastodon.

To install, take a look at glitch-soc.github.io/docs/. The instructions and features are the same, except for the differences outlined below.

Contributing guidelines are available here.

Note: Use the main branch only for forks. develop branch may, at times, be force-pushed to (mostly for undoing cherry-picking of vanilla commits when upstream adopts them). I highly suggest only ever running the main branch in production, as is done for CatCatNya~! I also highly suggest not rebasing on this if you are maintaining a fork, instead, use merge (fast-forward, if possible, with merge commit otherwise).

Differences

  • Some files are adjusted specifically for the CatCatNya~ instance. Specifically, these:
    • sounds/boop.mp3
    • sounds/boop.ogg
      You might want to revert these to the upstream files (or your own versions!) if you decide to use this fork for your own instance.
  • The rate limits for authenticated users have been relaxed a bit.
  • The API endpoint /api/v1/custom_emojis is no longer affected by AUTHORIZED_FETCH, allowing anyone to copy custom emojis.
  • Allow higher resolution images. (4096x4096 instead of the previous limit of 3840x2160)
  • Allow posting polls with only one poll option (if MIN_POLL_OPTIONS is set to 1 on your instance).
  • Emoji reactions on statuses (with both Unicode and custom emojis, same as for announcements), a feature originally developed for Nyastodon. Ended up as a Catstodon-maintained patch after its initial two Pull Requests to glitch-soc, but was handed over to Essem's fork, Chuckya and is now pending its fourth attempt of merging into glitch-soc.
  • Lifts the "only federate local favourites" restriction on favourites/likes and emoji reactions.
  • Cherry-picks the activity filter branch from Sakurajima Mastodon.
  • Adds the ability to disable the suspicious sign in detection entirely.
    • Useful for situations where the instance may not have up-to-date IP information, such as when the period of IP address retention is set to a low value (see Previous differences now merged into vanilla Mastodon)
  • Environment variable MASTODON_USE_LIBVIPS is true by default.
    • This is a minor change, but it requires all systems running Catstodon to run a recent libvips version (8.13+).
    • Vanilla Mastodon intends to deprecate ImageMagick anyway, so sooner or later, this change will cease being one.

Previous differences now merged into glitch-soc

  • Fixed incorrect upload size limit display when adding new a new custom emoji. (Pull request)
  • Everything merged into vanilla Mastodon

Previous differences now merged into vanilla Mastodon

  • The period of retention of IP addresses and sessions was made configurable. (Pull request)