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 520b2fd3b0
User.ap_address() => handle_as(ActivityPub)
2023-11-29 21:06:55 -08:00
.circleci circle: deploy queue.yaml 2023-10-31 13:31:58 -07:00
.github make dependabot update indirect as well as direct dependency pins 2023-09-01 18:26:54 -07:00
docs more docstring formatting tweaks 2023-10-06 08:22:50 -07:00
scripts misc cleanup 2023-11-15 14:23:08 -08:00
static robots.txt: add /render 2023-11-02 14:11:10 -07:00
templates User.ap_address() => handle_as(ActivityPub) 2023-11-29 21:06:55 -08:00
tests User.ap_address() => handle_as(ActivityPub) 2023-11-29 21:06:55 -08:00
.gcloudignore webmention => AP: handle multiple in-reply-to links 2020-06-06 08:40:07 -07:00
.gitignore add manual opt-out list 2023-11-29 10:25:45 -08:00
.readthedocs.yaml add readthedocs config 2023-08-07 10:42:00 -07:00
LICENSE add CC0 license 2023-11-09 14:09:44 -08:00 add CC0 license 2023-11-09 14:09:44 -08:00 User.ap_address() => handle_as(ActivityPub) 2023-11-29 21:06:55 -08:00 misc cleanup 2023-11-15 14:23:08 -08:00
app.yaml point atproto at federation sandbox, fix notif poll by importing all protocols 2023-10-18 11:03:21 -07:00 noop, lint fixes from flake8 2023-06-20 11:29:31 -07:00 drop a lot of g.user 2023-11-25 20:23:19 -08:00 make unit tests run without manual opt outs file 2023-11-29 10:39:13 -08:00 hub: implement atproto-commit task handler, other misc setup 2023-09-09 14:02:19 -07:00 pass user to Protocol.send/convert instead of using g.user 2023-11-25 20:07:14 -08:00
dispatch.yaml hub dispatch: route /queue/atproto-poll-posts 2023-11-14 14:07:56 -08:00 drop the rest of g.user! 2023-11-25 20:38:28 -08:00 User.ap_address() => handle_as(ActivityPub) 2023-11-29 21:06:55 -08:00 ATProto: first pass at polling posts (timelines) 2023-11-14 12:30:14 -08:00
hub.yaml ATProto: prod BGS moved to! 2023-10-05 10:29:48 -07:00 ids.translate_handle: add enhanced kwarg 2023-11-29 16:41:09 -08:00
index.yaml one more datastore index for 57350ab81a 2023-07-19 19:39:29 -10:00
indieauth_client_id add follow UI to user/[domain]/following 2023-01-07 09:34:55 -08:00 User.ap_address() => handle_as(ActivityPub) 2023-11-29 21:06:55 -08:00
oauth_dropins_fonts lots of UI tweaks 2022-11-12 23:19:09 -08:00
oauth_dropins_static switch oauth_dropins symlink to oauth_dropins_static, drop it from repo 2021-08-06 11:19:33 -07:00 genericize user handles on UI follower/following pages 2023-11-27 21:40:01 -08:00 stop clearing Object data properties 2023-11-28 06:39:34 -08:00
queue.yaml delivery: switch from threads to tasks, one per send 2023-10-31 12:49:27 -07:00 drop a lot of g.user 2023-11-25 20:23:19 -08:00
requirements.txt deps: use mf2py metaformats branch 2023-11-29 10:45:49 -08:00 noop: misc minor doc tweaks 2023-09-26 14:47:26 -07:00 rename Web.LABEL from 'webmention' to 'web' 2023-05-30 12:15:36 -07:00 User.ap_address() => handle_as(ActivityPub) 2023-11-29 21:06:55 -08:00 User.ap_address() => handle_as(ActivityPub) 2023-11-29 21:06:55 -08:00

Bridgy Fed Circle CI Coverage Status

Bridgy Fed connects your web site to Mastodon and the fediverse via ActivityPub, webmentions, and microformats2. Your site gets its own fediverse profile, posts and avatar and header and all. Bridgy Fed translates likes, reposts, mentions, follows, and more back and forth. See the user docs and developer docs for more details.

Also see the original design blog posts.

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


Development reference docs are at 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 beta cloud-datastore-emulator to install the datastore 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

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

gcloud beta emulators datastore start --use-firestore-in-datastore-mode --no-store-on-disk --host-port=localhost:8089 --quiet < /dev/null >& /dev/null &
python3 -m unittest discover

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

GAE_ENV=localdev FLASK_ENV=development flask 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
  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 and 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.


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:// --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://$kind/all_namespaces_kind_$kind.export_metadata
  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.