This repository has been archived on 2023-05-27. You can view files and clone it, but cannot push or open issues or pull requests.
BirdsiteLIVE/README.md

2.6 KiB

This project is a fork of the original BirdsiteLIVE from NicolasConstant. This fork runs in production on a large BirdsiteLIVE instance. Changes made in this fork include:

  • Rework About page entirely - also disclose unlisted accounts and federation restrictions
  • Cache Tweets so that, for example, Announces do not hit rate limits
  • Allow replacing and redirecting to twitter.com in Tweets to other domains (i.e. Nitter instances)
  • Verified checkmarks on verified Twitter users
  • Proper remote follow form on user pages
  • Mark individual Tweets as potentially sensitive
  • Define and enforce a maximum follow count limit
  • Define and enforce a maximum Tweet fetch age using snowflakes

This fork is also available as a Docker image as pasture/birdsitelive.

The project's original README is as follows:

Test

BirdsiteLIVE

About

BirdsiteLIVE is an ActivityPub bridge from Twitter, it's mostly a pet project/playground for me to handle ActivityPub concepts. Feel free to deploy your own instance (especially if you plan to follow a lot of users) since it use a proper Twitter API key and therefore will have limited calls ceiling (it won't scale, and it's by design).

State of development

The code is pretty messy and far from a good state, since it's a playground for me the aim was to understand some AP concepts, not provide a good state-of-the-art codebase. But I might refactor it to make it cleaner.

Official instance

You can find an official (and temporary) instance here: beta.birdsite.live. This instance can disapear at any time, if you want a long term instance you should install your own or use another one.

Installation

I'm providing a docker build. To install it on your own server, please follow those instructions. More options are also available.

Also a CLI is available for adminitrative tasks.

License

This project is licensed under the AGPLv3 License - see LICENSE for details.

Contact

You can contact me via ActivityPub here.