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
Sam Therapy 652434c42a
[SKIP CI] fix(docs): update README
Signed-off-by: Sam Therapy <sam@samtherapy.net>
2022-11-15 22:38:27 +01:00

1.9 KiB

BirdsiteLIVE: Twitter -> ActivityPub

Build Status

This project is a fork of Pasture's fork of the original BirdsiteLIVE from NicolasConstant. This fork runs in production on bird.froth.zone. Changes made in this fork include:

  • Rebasing the forks together.
  • (this space intentionally left blank)

This fork is also available as a Docker image as git.froth.zone/sam/birdsitelive.

The project's original README is below:

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 to provide a good state-of-the-art codebase. But I might refactor it to make it cleaner.

Official instance

There's none! Please read here why I've stopped it.

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 (likely broken) CLI is available for administrative tasks.

License

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

Contact

You can contact me via ActivityPub here.