Skip to content

Throwaway clone for mucking around with the Skybridge proxy. Do not use

License

Notifications You must be signed in to change notification settings

automatonica/SkyBridge

 
 

Repository files navigation

SkyBridge

SkyBridge

style: very good analysis License: MIT Powered by Dart Frog

A work in progress bridge/proxy that allows you to use Mastodon apps with Bluesky.

SkyBridge attempts to convert Mastodon API calls to Bluesky API calls, and tries to implement enough of the Mastodon API that apps will be happy connecting to it.

Functionality is very basic at the moment, and there's bound to be a few bugs. Don't expect this to be your daily driver just yet!

Currently only being tested with Ivory on iOS and macOS, your mileage may vary with other apps at the moment. PRs and issues are welcome, we want to support as many apps as possible.

If you find this project useful please consider donating, it really helps a lot!

ko-fi

Getting Started

In order to run SkyBridge you will need the Dart SDK installed on your system.

You will also need the Dart Frog CLI installed to run a development server. You can install it with the following command:

# 📦 Install the dart_frog cli from pub.dev
dart pub global activate dart_frog_cli

Some environment variables need to be set before you can run SkyBridge. You can set them in a .env file in the root of the project. You can copy the .env.example file to get started.

# 📝 Copy and edit the example .env file
cp .env.example .env
open .env

Once that's done you can start a development server with the following command:

# 📥 Clone the repo
git clone https://github.com/videah/skybridge.git
cd skybridge
dart pub get

# 🏁 Start the dev server
dart_frog dev

Self Hosting

The instance of SkyBridge hosted at skybridge.fly.dev is provided as a free public service but currently faces heavy rate limiting from Bluesky due to all the requests coming from a single IPv4 address. If you want a more consistent experience you can host your own instance to avoid this.

Docker

The easiest way to run SkyBridge yourself is with Docker. The image videah/skybridge is kept up to date with the main branch of this repo.

You can use the docker-compose.yml file in the root of the project to get started. Simply change the environment variables in the file, and tweak it to suit your setup. You probably want to stick a reverse proxy like nginx or caddy in front of it.

Fly.io

The public instance of SkyBridge is hosted on Fly.io. For a single user it is likely possible to host an instance here for free. A fly.toml file is included in the root of the project to help you get started.

Credits

Huge thanks to Ninji for their BirdBridge project which was a big help and inspiration for this project!

Thank you to Shinya Kato for atproto.dart which powers this project!

About

Throwaway clone for mucking around with the Skybridge proxy. Do not use

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Dart 98.0%
  • HTML 1.6%
  • Other 0.4%