From 670ece3fc62197a2bd587bc169b9dd69c6f5bb18 Mon Sep 17 00:00:00 2001 From: Ryan Barrett Date: Mon, 8 Mar 2021 17:23:32 -0800 Subject: [PATCH] revise docs for activitypub vs ostatus, etc --- README.md | 10 ++----- static/index.html | 74 +++++++++++++++++++++++------------------------ 2 files changed, 40 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 1a44afc..c5ce07c 100644 --- a/README.md +++ b/README.md @@ -88,8 +88,10 @@ Here are in progress notes on how I'm testing interoperability with various fede * Tried posting a bunch of ways, couldn't get any to work :/ * [Kroeg](https://github.com/puckipedia/Kroeg) * Not open to other users yet. Seems to be running at [puckipedia.com/social](https://puckipedia.com/social). +* [Pleroma](https://pleroma.social/) + * [snarfed@cawfee.club](https://cawfee.club/snarfed) -### Salmon +### OStatus / Salmon * [Friendica](http://friendi.ca/) * [snarfed@libranet.de](https://libranet.de/profile/snarfed) @@ -105,12 +107,6 @@ Here are in progress notes on how I'm testing interoperability with various fede * Only has Atom `link rel="alternate"` for [full feed](https://lastauth.com/feed/snarfed?f=&top=1), not individual post :/ * Atom feed has Salmon link rels inside top level `feed`, not in individual `entry`s * Atom entries have `author.name` as username (snarfed) -* [Mastodon](https://joinmastodon.org/) - * [snarfed@mastodon.technology](https://mastodon.technology/@snarfed) - * Example post: [HTML](https://mastodon.technology/@snarfed/2604611), [Atom](https://mastodon.technology/users/snarfed/updates/73978.atom) - * Profile HTML/Atom have Salmon link rel. Individual post HTML/Atom don't. `author.email` is snarfed@mastodon.technology -* [Pleroma](https://pleroma.social/) - * [snarfed@cawfee.club](https://cawfee.club/snarfed) Stats --- diff --git a/static/index.html b/static/index.html index f09af83..4a203f0 100644 --- a/static/index.html +++ b/static/index.html @@ -48,8 +48,8 @@ and the rest of the fediverse< +
  • How do I use it?
    • +
  • + +

    +Federated social network identities take the form @username@example.com, like an email address with a leading @. Your site's identity via Bridgy Fed will be @yourdomain.com@yourdomain.com. Once you've set up Atom on your site, people can follow you at that address. +

    + +

    +Most fedsocnets also publish Atom themselves, so you can add profile URLs like mastodon.technology/@snarfed to your reader and see their posts there too. +

    + +

    +To use it, first set up your site, then create an IndieWeb post, like, repost, reply, or follow as usual, and include a link to https://fed.brid.gy/ in that post. Your web server should then send Bridgy Fed a webmention, which it will translate to a Salmon slap or ActivityPub activity and forward to the destination. For example: +

    + +
    <div class="h-entry">
+  Regarding <a class="u-in-reply-to" href="https://mastodon.technology/@snarfed/3194674">this post</a>:
+  <p class="e-content">Highly entertaining. Please subscribe me to your newsletter.</p>
+  <a href="https://fed.brid.gy/"></a>
+</div>
+
    + +

    +To receive likes, reposts, replies, and follows from fedsocnets, just make sure your site accepts webmentions! Bridgy translates incoming Salmon slaps and ActivityPub activities to webmentions and sends them to your site.

    + +

    +The webmention source URL will usually be a proxy page on fed.brid.gy. For best results, make sure your webmention handler detects and handles u-url links! +

    +
    • +
  • How do I set it up?

  • @@ -116,10 +146,6 @@ Next, add an Atom fe 

    <link rel="alternate" type="application/atom+xml"
       href="https://granary.io/url?url=http://[DOMAIN]/&input=html&output=atom&hub=https://bridgy-fed.superfeedr.com/" />
    -

    -If you want people on fedsocnets to see your posts, your site will also need to support WebSub (née PubSubHubbub). Specifically, your Atom feed needs to advertise it. Example details for Mastodon. If you're on a CMS, it may already have a plugin! WordPress has a couple, and Known has it built in. Or you can use Superfeedr or Switchboard. -

    -

    Finally, configure your web site to redirect these URL paths to the same paths on https://fed.brid.gy/, including query parameters:

    @@ -175,39 +201,13 @@ https://en.support.wordpress.com/site-redirect/ +

    +If you want people on OStatus sites like Hubzilla to see your posts, your web site will also need to support WebSub (née PubSubHubbub). Specifically, your Atom feed needs to advertise it. Example details for Mastodon. If you're on a CMS, it may already have a plugin! WordPress has a couple, and Known has it built in. Or you can use Superfeedr or Switchboard. +

    +
    • -
  • How do I use it?
    • -
  • - -

    -Federated social network identities take the form @username@example.com, like an email address with a leading @. Your site's identity via Bridgy Fed will be @yourdomain.com@yourdomain.com. Once you've set up Atom and WebSub on your site, people can follow you at that address. -

    - -

    -Most fedsocnets also publish Atom themselves, so you can add profile URLs like mastodon.technology/@snarfed to your reader and see their posts there too. -

    - -

    -To use it, create an IndieWeb post, like, repost, reply, or follow as usual, and include a link to https://fed.brid.gy/ in that post. Your web server should then send Bridgy Fed a webmention, which it will translate to a Salmon slap or ActivityPub activity and forward to the destination. For example: -

    - -
    <div class="h-entry">
-  Regarding <a class="u-in-reply-to" href="https://mastodon.technology/@snarfed/3194674">this post</a>:
-  <p class="e-content">Highly entertaining. Please subscribe me to your newsletter.</p>
-  <a href="https://fed.brid.gy/"></a>
-</div>
-
    - -

    -To receive likes, reposts, replies, and follows from fedsocnets, just make sure your site accepts webmentions! Bridgy translates incoming Salmon slaps and ActivityPub activities to webmentions and sends them to your site.

    - -

    -The webmention source URL will usually be a proxy page on fed.brid.gy. For best results, make sure your webmention handler detects and handles u-url links! -

    -
    • -
  • How do I include an image in a post?

  • @@ -246,7 +246,7 @@ I love scotch. Scotchy scotchy scotch.

  • I'm Ryan Barrett. I'm just a guy who -likes the web and likes owning my data. +likes the web and owning my data.