Got an IndieWeb site? Want to interact with federated social networks like Mastodon, Hubzilla, and more? Bridgy Fed is for you.
 
 
 
 
Go to file
Ryan Barrett ae27c5c727
activitypub: fix test_convert_pinned_post_featured_collection_ids
2025-05-17 09:08:49 -07:00
.circleci circle: uninstall brevity at beginning 2025-03-22 11:54:21 -07:00
.github build(deps): bump dependabot/fetch-metadata from 2.3.0 to 2.4.0 2025-05-12 05:35:07 -07:00
docs docs: design: minor language tweak 2025-02-06 14:29:25 -08:00
scripts drop firehose-server/consumer, merge back into atproto-hub 2025-05-13 20:37:34 -07:00
static web UI: add CSS view transitions 2025-04-07 13:55:18 -07:00
templates docs: we now support Bluesky handle changes 2025-05-16 11:29:16 -07:00
tests activitypub: fix test_convert_pinned_post_featured_collection_ids 2025-05-17 09:08:49 -07:00
.gcloudignore
.gitignore add .claude/ to .gitignore 2025-05-11 12:06:45 -07:00
.readthedocs.yaml readthedocs config: add sphinx configuration key 2025-01-20 15:10:03 -08:00
FEDERATION.md first pass at FEDERATION.md file 2024-05-05 13:52:27 -07:00
LICENSE add CC0 license 2023-11-09 14:09:44 -08:00
README.md readme: dev instructions: update command to run locally 2025-04-13 20:26:32 -07:00
SECURITY.md Create SECURITY.md 2025-05-15 15:29:05 -07:00
activitypub.py AP: add split domain support via full webfinger resolution 2025-05-16 11:12:15 -07:00
ap.brid.gy.as2.json activitypub: handle granary as2 adding https://purl.archive.org/miscellany to @context 2025-03-05 11:53:00 -08:00
app.py don't serve subscribeRepos on default (fed.brid.gy) 2025-04-29 17:33:35 -07:00
app.yaml atproto: set PDS_HOST to atproto.brid.gy in default app 2025-02-28 11:12:24 -08:00
atproto.py re-enable stop-following for ATProto 🤞🤞🤞 2025-05-16 10:09:51 -07:00
atproto_firehose.py atproto_firehose.handle: send actor (profile) updates for #identity events 2025-05-16 13:14:26 -07:00
atproto_hub.py atproto-hub: start firehose collector after consumer, add faulthandler 2025-05-13 15:51:22 -07:00
atproto_hub.yaml atproto-hub, firehose-server: 6G memory, not 6.5G 2025-05-13 16:12:45 -07:00
bsky.brid.gy.as2.json ActivityPub.postprocess_as2_actor: set manuallyApprovesFollowers to false 2025-04-21 16:34:06 -07:00
common.py stop caching users and other sensitive kinds locally in memory 2025-05-16 16:30:58 -07:00
config.py config: arroba.firehose logging back to INFO 2025-05-12 16:19:50 -07:00
convert.py cache /convert/ and /r/ endpoints in memcache 2025-01-29 11:57:50 -08:00
cron.yaml turn on atproto-chat-poll cron job 2024-09-10 19:57:38 -07:00
dispatch.yaml drop firehose-server/consumer, merge back into atproto-hub 2025-05-13 20:37:34 -07:00
dms.py dms: add published field to note object and create activity 2025-05-14 19:53:44 -07:00
eefake.brid.gy.as2.json AS2: change Application actor types to Person for users, Service for bots 2024-12-03 21:16:11 -08:00
fa.brid.gy.as2.json AS2: change Application actor types to Person for users, Service for bots 2024-12-03 21:16:11 -08:00
fed.brid.gy.as2.json ActivityPub.postprocess_as2_actor: set manuallyApprovesFollowers to false 2025-04-21 16:34:06 -07:00
flask_app.py move ndb monkey patch for memcache bug from flask_app.py to memcache.py 2025-04-18 15:56:06 -07:00
follow.py drop Object.labels 2025-01-31 14:57:56 -08:00
ids.py ids.translate_user_id: handle our own subdomain-wrapped ids 2025-04-17 16:53:39 -07:00
index.yaml temporarily add Object index on type + updated 2025-01-22 14:51:59 -08:00
indieauth_client_id
memcache.py move ndb monkey patch for memcache bug from flask_app.py to memcache.py 2025-04-18 15:56:06 -07:00
models.py drop transactions from User.enable/disable_protocol 2025-05-16 16:36:19 -07:00
oauth_dropins_fonts
oauth_dropins_static
other.brid.gy.as2.json AS2: change Application actor types to Person for users, Service for bots 2024-12-03 21:16:11 -08:00
pages.py AP: add split domain support via full webfinger resolution 2025-05-16 11:12:15 -07:00
protocol.py Protocol.translate_ids: preserve items/orderedItems as lists 2025-05-17 08:48:28 -07:00
queue.yaml don't retry atproto-commit tasks 2025-05-13 22:07:13 -07:00
redirect.py /r/: don't serve actors unless they're enabled for AP 2025-05-15 14:59:17 -07:00
requirements.txt Revert "build(deps): bump certifi from 2025.1.31 to 2025.4.26" 2025-05-15 19:55:29 -07:00
router.py remove /memcache_command and /python_eval 2025-01-14 12:48:45 -08:00
router.yaml Revert "temporarily turn on ndb debugging for lookups" 2025-01-26 22:35:49 -08:00
ui.py rename Web.LABEL from 'webmention' to 'web' 2023-05-30 12:15:36 -07:00
web.py Revert "use Protocol.create_for for all protocols, not just HAS_COPIES ones" 2025-05-13 13:43:08 -07:00
webfinger.py /.well-known/host-meta: add the Cache-Control header 2025-01-26 20:30:01 -08:00

README.md

Bridgy Fed Circle CI Coverage Status

Bridgy Fed connects different decentralized social network protocols. It currently supports the fediverse (eg Mastodon) via ActivityPub, Bluesky via the AT Protocol, and the IndieWeb via webmentions and microformats2. Farcaster and Nostr are under consideration. Bridgy Fed translates profiles, likes, reposts, mentions, follows, and more from any supported network to any other. See the user docs and developer docs for more details.

https://fed.brid.gy/

License: This project is placed in the public domain. You may also use it under the CC0 License.

Development

Development reference docs are at bridgy-fed.readthedocs.io. Pull requests are welcome! Feel free to ping me in #indieweb-dev with any questions.

First, fork and clone this repo. Then, install the Google Cloud SDK and run gcloud components install cloud-firestore-emulator to install the Firestore emulator. Once you have them, set up your environment by running these commands in the repo root directory:

gcloud config set project bridgy-federated
python3 -m venv local
source local/bin/activate
pip install -r requirements.txt
# needed to serve static files locally
ln -sf local/lib/python3*/site-packages/oauth_dropins/static oauth_dropins_static

Now, run the tests to check that everything is set up ok:

gcloud emulators firestore start --host-port=:8089 --database-mode=datastore-mode < /dev/null >& /dev/null &
python3 -m unittest discover

Finally, run this in the repo root directory to start the web app locally:

env FLASK_ENV=development APPVIEW_HOST=api.bsky.app PLC_HOST=plc.directory BGS_HOST=bsky.network PDS_HOST=atproto.brid.gy flask --debug run -p 8080

If you send a pull request, please include (or update) a test for the new functionality!

If you hit an error during setup, check out the oauth-dropins Troubleshooting/FAQ section.

You may need to change granary, oauth-dropins, mf2util, or other dependencies as well as as Bridgy Fed. To do that, clone their repo locally, then install them in "source" mode with e.g.:

pip uninstall -y granary
pip install -e <path to granary>

To deploy to the production instance on App Engine - if @snarfed has added you as an owner - run:

gcloud -q beta app deploy --no-cache --project bridgy-federated *.yaml

How to add a new protocol

  1. Determine how you'll map the new protocol to other existing Bridgy Fed protocols, specifically identity, protocol inference, events, and operations. Add those to the existing tables in the docs in a PR. This is an important step before you start writing code.
  2. Implement the id and handle conversions in ids.py.
  3. If the new protocol uses a new data format - which is likely - add that format to granary in a new file with functions that convert to/from ActivityStreams 1 and tests. See nostr.py and test_nostr.py for examples.
  4. Implement the protocol in a new .py file as a subclass of both Protocol and User. Implement the send, fetch, serve, and target_for methods from Protocol and handle and web_url from User .
  5. TODO: add a new usage section to the docs for the new protocol.
  6. TODO: does the new protocol need any new UI or signup functionality? Unusual, but not impossible. Add that if necessary.
  7. Protocol logos may be emoji or image files. If this one is a file, add it static/. Then add the emoji or file <img> tag in the Protocol subclass's LOGO_HTML constant.

Stats

I occasionally generate stats and graphs of usage and growth via BigQuery, like I do with Bridgy. Here's how.

  1. Export the full datastore to Google Cloud Storage. Include all entities except MagicKey. Check to see if any new kinds have been added since the last time this command was run.

    gcloud datastore export --async gs://bridgy-federated.appspot.com/stats/ --kinds Follower,Object
    

    Note that --kinds is required. From the export docs:

    Data exported without specifying an entity filter cannot be loaded into BigQuery.

  2. Wait for it to be done with gcloud datastore operations list | grep done.

  3. Import it into BigQuery:

    for kind in Follower Object; do
      bq load --replace --nosync --source_format=DATASTORE_BACKUP datastore.$kind gs://bridgy-federated.appspot.com/stats/all_namespaces/kind_$kind/all_namespaces_kind_$kind.export_metadata
    done
    
  4. Check the jobs with bq ls -j, then wait for them with bq wait.

  5. Run the full stats BigQuery query. Download the results as CSV.

  6. Open the stats spreadsheet. Import the CSV, replacing the data sheet.

  7. Check out the graphs! Save full size images with OS or browser screenshots, thumbnails with the Download Chart button.