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 dc9c699d4f
/inbox: wait until later to load user from datastore
optimizes Accepts and Deletes sent to individual inbox that don't need the user
2022-12-08 09:00:53 -08:00
.circleci bump circle cache version 2022-10-22 20:00:55 -07:00
.github dependabot auto-merge workflow: message when we skip major versions 2022-04-25 11:49:10 -07:00
static minor style tweak, increase left/right margins on phones 2022-12-07 09:53:00 -08:00
templates remove indent on opening rule 2022-12-07 13:00:06 -08:00
tests Model.verify: minor redirect error message tweak 2022-12-06 22:41:55 -08:00
.gcloudignore webmention => AP: handle multiple in-reply-to links 2020-06-06 08:40:07 -07:00
.gitignore flask: move app to app.py, get templates working, port /responses 2021-07-07 08:07:20 -07:00
README.md bug fix for custom username in fediverse address on user page UI 2022-11-26 16:05:02 -08:00
activitypub.py /inbox: wait until later to load user from datastore 2022-12-08 09:00:53 -08:00
add_webmention.py sign HTTP GET requests for AS2 objects 2022-11-24 09:41:14 -08:00
app.py first pass at remote follow UI on user page 2022-11-27 07:20:08 -08:00
app.yaml turn on App Engine warmup requests 2022-11-15 11:36:38 -08:00
appengine_config.py unify request handler classes and handle_exception; move away from HOST[_URL] 2020-01-31 14:40:11 -08:00
common.py user page: redirect www-stripped users to non-www user pages 2022-12-02 11:08:24 -08:00
config.py extract Flask app config out of app.py into config.py 2022-11-21 18:43:50 -08:00
follow.py user verification: follow multiple redirects 2022-11-28 13:10:51 -08:00
index.yaml add timeline feeds for posts from fediverse followings 2022-11-17 12:59:09 -08:00
models.py Model.verify: minor redirect error message tweak 2022-12-06 22:41: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
pages.py omit boosts from feeds 2022-12-07 09:32:00 -08:00
redirect.py noop, rename Domain => User 2022-11-15 22:00:28 -08:00
render.py rename MagicKey => Domain, Response => Activity 2022-11-12 15:27:59 -08:00
requirements.txt build(deps): bump certifi from 2022.9.24 to 2022.12.7 2022-12-08 04:04:33 -08:00
salmon.py minor noop comment tweaks 2022-10-08 08:18:25 -07:00
superfeedr.py logging: use separate loggers for each module with their names 2022-02-11 22:38:56 -08:00
webfinger.py add remote follow link rel to webfinger 2022-12-01 10:09:57 -08:00
webmention.py handle new multi-valued url field in AS2 objects 2022-11-30 21:04:41 -08:00

README.md

Bridgy Fed Circle CI Coverage Status

Bridgy Fed connects your web site to Mastodon and the fediverse via ActivityPub, OStatus, 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 for more details.

https://fed.brid.gy/

Original design docs:

License: This project is placed in the public domain.

Development

You'll need Python 3. Install the Google Cloud SDK (aka gcloud) with the gcloud-appengine-python and gcloud-appengine-python-extras components. Then, run:

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 --no-store-on-disk --consistency=1.0 --host-port=:8089 < /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. For searchability, here are a handful of error messages that have solutions there:

bash: ./bin/easy_install: ...bad interpreter: No such file or directory

ImportError: cannot import name certs

ImportError: No module named dev_appserver

ImportError: cannot import name tweepy

File ".../site-packages/tweepy/auth.py", line 68, in _get_request_token
  raise TweepError(e)
TweepError: must be _socket.socket, not socket

error: option --home not recognized

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

Compatibility

Here are in progress notes on how I'm testing interoperability with various federated social networks.

ActivityPub

OStatus / Salmon

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,Response
    

    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 Response; 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.