You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

47 lines
2.6 KiB

1 year ago
1 year ago
1 year ago
2 years ago
  1. This project is a *fork* of [the original BirdsiteLIVE from NicolasConstant](https://github.com/NicolasConstant/BirdsiteLive). This fork runs in production on [a large BirdsiteLIVE instance](https://twtr.plus). Changes made in this fork include:
  2. * Rework About page entirely - also disclose unlisted accounts and federation restrictions
  3. * Cache Tweets so that, for example, Announces do not hit rate limits
  4. * Allow replacing and redirecting to twitter.com in Tweets to other domains (i.e. Nitter instances)
  5. * Verified checkmarks on [verified](https://twitter.com/verified) Twitter users
  6. * Proper remote follow form on user pages
  7. * Mark individual Tweets as potentially sensitive
  8. * Define and enforce a maximum follow count limit
  9. * Define and enforce a maximum Tweet fetch age using snowflakes
  10. * (Optional) send quote-RTs as Soapbox-style quote posts
  11. This fork is also available as a Docker image as `pasture/birdsitelive`.
  12. The project's original README is as follows:
  13. ![Test](https://github.com/NicolasConstant/BirdsiteLive/workflows/.NET%20Core/badge.svg?branch=master&event=push)
  14. # BirdsiteLIVE
  15. ## About
  16. 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).
  17. ## State of development
  18. 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.
  19. ## Official instance
  20. You can find an official (and temporary) instance here: [beta.birdsite.live](https://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.
  21. ## Installation
  22. I'm providing a [docker build](https://hub.docker.com/r/nicolasconstant/birdsitelive). To install it on your own server, please follow [those instructions](https://github.com/NicolasConstant/BirdsiteLive/blob/master/INSTALLATION.md). More [options](https://github.com/NicolasConstant/BirdsiteLive/blob/master/VARIABLES.md) are also available.
  23. Also a [CLI](https://github.com/NicolasConstant/BirdsiteLive/blob/master/BSLManager.md) is available for adminitrative tasks.
  24. ## License
  25. This project is licensed under the AGPLv3 License - see [LICENSE](https://github.com/NicolasConstant/BirdsiteLive/blob/master/LICENSE) for details.
  26. ## Contact
  27. You can contact me via ActivityPub <a rel="me" href="https://fosstodon.org/@BirdsiteLIVE">here</a>.