From 0e5be92f08a0b22ff5d9cff2b6df1373947a7846 Mon Sep 17 00:00:00 2001 From: Ryan Barrett Date: Mon, 29 Apr 2024 07:10:06 -0700 Subject: [PATCH] docs for Bluesky! fixes #823 --- templates/docs.html | 345 +++++++++++++++++++++++++++++--------------- 1 file changed, 226 insertions(+), 119 deletions(-) diff --git a/templates/docs.html b/templates/docs.html index 6dabb2c..b6c3a55 100644 --- a/templates/docs.html +++ b/templates/docs.html @@ -43,7 +43,44 @@
  • How do I update my profile?
  • Can I see my account's status and recent activity?
  • I tried it, and it didn't work!
    • -
  • The *.brid.gy domain in my bridged account is ugly. Can I get rid of it and use my own domain/web site instead?
    • + + +
    + +

    From the fediverse

    + +
  • How do I get started?
    • +
  • How do I find a bridged Bluesky account?
    • +
  • I can't find @bsky.brid.gy@bsky.brid.gy on the fediverse!
    • +
  • How do I find a bridged web site?
    • +
  • What is this DM I got from a *.brid.gy account?
    • +
  • Someone requested to follow me, but I never got the DM!
    • +
  • Which stuff of mine from the fediverse will get bridged into Bluesky?
    • + +
    + +

    To the fediverse

    + +
  • Which fediverse servers are supported?
    • +
  • How do I verify my profile links (ie get green checks) in Mastodon?
    • +
  • Can I use my own domain as my fediverse handle?
    • +
  • Could other networks' instances get their own brid.gy subdomains, so that fediverse admins can federate with or block them individually?
    • + +
    + +

    From Bluesky

    + +
  • How do I get started?
    • +
  • How do I find a bridged fediverse account?
    • +
  • I followed @ap.brid.gy, or followed someone else or posted or did something else in Bluesky, but it hasn't shown up in the fediverse yet!
    • +
  • Which stuff of mine from Bluesky will get bridged into the fediverse? +
  • Can I use Bluesky's reply controls?
    • + +
    + +

    To Bluesky

    + +
  • What happens when I report a bridged Bluesky user?

    • @@ -75,23 +112,7 @@
    -

    From the fediverse

    - -
  • How do I get started?
    • -
  • How do I follow someone from the fediverse?
    • - -
    - -

    To the fediverse

    - -
  • Which fediverse servers are supported?
    • -
  • How do I verify my profile links (ie get green checks) in Mastodon?
    • -
  • Can I use my own domain as my fediverse handle?
    • -
  • Could other networks' instances get their own brid.gy subdomains, so that fediverse admins can federate with or block them individually?
    • - -
    - -

    About

    +

    Background

  • Who are you? Why did you make this?
  • How much does it cost?
  • What do you do with my data?
    • @@ -121,13 +142,13 @@
  • Which networks are supported?
  • -

    Bridgy Fed currently supports the fediverse and the web. We plan to add Bluesky/AT Protocol and Nostr in 2024.

    +

    Bridgy Fed currently supports the web, fediverse, and Bluesky. We're considering adding more networks, including Nostr and Farcaster.

    All bridging is fully bidirectional. If you're on a supported network, you can use Bridgy Fed to follow and interact with anyone on any other supported network.

  • Who can see me and my stuff?
  • -

    Only the people who can already see you and your stuff, as is. Bridgy Fed only bridges fully public data, so if your account is private or protected or followers-only, it won't (can't!) bridge your account at all. Same with DMs and private/followers-only posts; it ignores those.

    +

    Only the people who can already see you and your stuff, without bridging. Bridgy Fed only bridges fully public data, so if your account is private or protected or followers-only, it won't (can't!) bridge your account at all. Same with DMs and private/followers-only posts; it ignores those.

  • What about other bridges?
    • @@ -141,8 +162,8 @@
  • What's the difference between this and Bridgy classic, ie non-Fed?

  • Bridgy Fed and Bridgy classic are separate services. They both connect web sites and social networks and translate posts and interactions back and forth, but they each do it very differently.

    -Bridgy Fed - this service - bridges accounts on decentralized social networks like the fediverse, Bluesky/AT Protocol, Nostr, and the IndieWeb directly across those networks.

    -

    Bridgy classic, on the other hand, connects IndieWeb web sites to existing accounts on social networks, both centralized and decentralized, and provides backfeed and POSSE (aka cross-posting) as a service.

    +Bridgy Fed - this service - bridges accounts on decentralized social networks like the fediverse, Bluesky/AT Protocol, Nostr, and the IndieWeb directly across those networks.

    +

    Bridgy classic, on the other hand, connects IndieWeb web sites to existing accounts on social networks, both centralized and decentralized, and provides backfeed and POSSE (aka cross-posting) as a service.

    As an example, here's a visualization of how they each connect web sites to the fediverse:


    @@ -206,6 +227,7 @@
  • How do I opt out and remove my site or account?

  • If you're on the fediverse or Bluesky, and you've opted in but now want to opt out, block the Bridgy Fed bot user for the network you want to opt out of. For example, on the fediverse, block @bsky.brid.gy@bsky.brid.gy. On Bluesky, block @ap.brid.gy.

    +

    Also, if you're on Bluesky and you've hidden your account in the logged out view, Bridgy Fed interprets that as opting out and won't bridge your account.

    If you're on the web, feel free to email me, or you can put the text #nobridge in the profile on your home page and then update your profile on your user page.

    • @@ -254,12 +276,191 @@ -
  • The *.brid.gy domain in my bridged account's handle is ugly. Can I get rid of it and use my own domain/web site instead?
    • + + + + + + + +
    + +

    From the fediverse

    + +
  • How do I get started?
  • -

    Yes! All supported networks let you use your own domain as your handle in various ways. This takes a bit of technical setup with DNS and/or a web server, but it's very doable. Here are instructions for web sites bridged into the fediverse.

    +

    To bridge your fediverse account into Bluesky and interact with people there, search for and follow @bsky.brid.gy@bsky.brid.gy.

    +

    If your fediverse account is @[user]@[instance], your bridged account will have the handle [user].[instance].ap.brid.gy in Bluesky. For example, @snarfed@indieweb.social is bridged into Bluesky as @snarfed.indieweb.social.ap.brid.gy.

    +

    Bluesky limits profile bios to 256 characters, so if yours is longer in the fediverse, it will be truncated and ellipsized.

    +

    Alternatively, you can find and follow bridged Bluesky accounts without bridging your own account, but they won't see your posts or interactions.

    • +
  • How do I find a bridged Bluesky account?
    • +
  • +

    Bridged Bluesky accounts appear in the fediverse as @[handle]@bsky.brid.gy. For example, @snarfed.bsky.social on Bluesky is bridged into the fediverse as @snarfed.bsky.social@bsky.brid.gy.

    +
    • + + +
  • I can't find @bsky.brid.gy@bsky.brid.gy on the fediverse!
    • +
  • +

    If you search for @bsky.brid.gy@bsky.brid.gy on your fediverse instance and you don't see any results, your server may be blocking Bridgy Fed. Check your server's About page to see if bsky.brid.gy or brid.gy are in the Moderated serverssection. If they are, you can ask your server admin to reconsider, and include a link to this page for more details.

    +
    • + + +
  • How do I find a bridged web site?
    • +
  • +

    You can follow any web site, eg example.com, by searching for @example.com@web.brid.gy in your fediverse instance.

    +

    Bridged web sites appear in the fediverse as either @[domain]@[domain], @[domain]@web.brid.gy, or @[domain]@fed.brid.gy, depending on the fediverse server and whether the web site owner has connected their domain to Bridgy Fed. All bridged web sites behave the same in the fediverse; the different instances in their handles are purely cosmetic.

    +
    • + + +
  • What is this DM I got from a *.brid.gy account?
    • +
  • +

    In the future, if you haven't opted into the bridge, and someone wants to follow you from a different network, they can request to follow you from the Bridgy Fed home page. The first time this happens, Bridgy Fed will send you a DM to introduce itself and ask if you want to opt into bridging your account. If you reply yes, or follow the Bridgy Fed account that DMed you, your account will be bridged. If you do nothing, or reply no or block the Bridgy Fed account, you won't be bridged.

    +
    • + + +
  • Someone requested to follow me, but I never got the DM!
    • +
  • +

    Does your fediverse instance support DMs? Only some do. Otherwise, if your instance is blocking Bridgy Fed, you won't receive the DM. Or if it's limiting Bridgy Fed, or you're filtering notifications (this is sometimes on by default!), check the Filtered notifications section of your mention notifications.

    +

    Having said that, if you want to bridge your account, you don't need the DM! Just follow or DM yes to @bsky.brid.gy@bsky.brid.gy.

    +
    • + +
  • Which stuff of mine from the fediverse will get bridged into Bluesky?
    • +
  • +

    Anything that interacts with Bluesky users. This includes replies, @-mentions, likes, reposts, and if you have any Bluesky followers, your own posts. Posts on Bluesky are limited to 300 characters, so longer posts from the fediverse are truncated and ellipsized. Hashtags, links, link previews, images, and even alt text are also included, but not videos since Bluesky itself doesn't support them.

    +
    • + + +
    + + +

    To the fediverse

    + +
  • Which fediverse servers are supported?
    • +
  • +

    Lots! Mastodon, Friendica, Misskey, PeerTube, Hubzilla, and more. We're working on interoperation with others; see GitHub issues with the app label for details.

    +
    • + + +
  • +

    Mastodon's verified profile links with ✅ green checks are fun! Follow these steps to get one on your Bridgy Fed profile:

    + + + +

    When you're logged into a Mastodon instance, searching for your Bridgy Fed user triggers that instance to check and verify its profile link(s) in the background. This only works when you're logged in with a native Mastodon account. Also, each instance does this independently; verified links are not synched across instances.

    +
    • + +
  • Can I use my own domain as my fediverse handle?
    • +
  • +

    Yes! By default, bridged fediverse handles use a subdomain of brid.gy as their instance, eg @mysite.com@web.brid.gy, but you can change the instance part to your own domain. It takes a bit of setup and technical know-how, but it's very doable.

    +

    First, your domain needs to serve HTTP requests. You don't need an actual web site, but you do need a minimal web server.

    +

    Second, your web server needs to support SSL. Bridgy Fed uses your domain as your identity, so it depends on SSL to prove that you own it.

    +

    Lastly, your web server needs to redirect a couple URL paths, including query parameters, to the same paths on https://fed.brid.gy/:

    • +
    +/.well-known/host-meta
+/.well-known/webfinger
+
    + +

    Here are instructions for a few common web servers:

    + + + + + +
    + +

    From Bluesky

    + +
  • How do I get started?
    • +
  • +

    To bridge your Bluesky account into the fediverse and interact with people there, follow @ap.brid.gy on Bluesky.

    +

    Your Bluesky account will appear in the fediverse as @[handle]@bsky.brid.gy. For example, @snarfed.bsky.social on Bluesky is bridged into the fediverse as @snarfed.bsky.social@bsky.brid.gy.

    +

    Alternatively, you can find and follow bridged fediverse accounts without bridging your own account, but they won't see your posts or interactions.

    +

    • + + +
  • How do I find a bridged fediverse account?
    • +
  • +

    Bridged fediverse accounts appear in Bluesky as @[user].[instance].ap.brid.gy. For example, @snarfed@indieweb.social is bridged into Bluesky as @snarfed.indieweb.social.ap.brid.gy.

    +
    • + + +
  • I followed @ap.brid.gy, or followed someone else or posted or did something else in Bluesky, but it hasn't shown up in the fediverse yet!
    • +
  • +

    Bluesky uses a pull-based event architecture, so we have to poll every bridged user's notifications to discover and bridge interactions, including your initial follow of @ap.brid.gy. We currently do this every 5 minutes. Sorry for the delay! +

    • + + +
  • Which stuff of mine from Bluesky will get bridged into the fediverse?
    • +
  • +

    Anything that interacts with fediverse users. This includes replies, @-mentions, likes, reposts, and if you have any fediverse followers, your own posts. Hashtags, links, link previews, images, and even alt text are also included.

    + + +
  • Can I use Bluesky's reply controls?
    • +
  • +

    Yes! Bluesky's reply controls apply to accounts bridged from the fediverse as well as to native Bluesky accounts..

    +
    • + + + +
    + +

    To Bluesky

    + +
  • What happens when I report a bridged Bluesky user?
    • +
  • +

    Bridgy Fed sends your report to the Bluesky team's official moderation service, which handles it, and takes action if necessary, just like with native Bluesky accounts.

    +

    Also see Bridgy Fed's moderation policy and functionality.

    +
    • + + + + +
    @@ -549,105 +750,11 @@ To receive likes, reposts, replies, @-mentions, and follows from the fediverse,

    Another difficulty is that accounts on Bluesky and Nostr have long-lived, server-independent ids. If we used a Bluesky user's PDS domain in their fediverse handle, that handle would change every time they migrated to a new PDS, and they'd lose all of their followers and followings, even though their Bluesky account ID itself hadn't changed.

    -
    - -

    From the fediverse

    - -
  • How do I get started?
    • -
  • -

    To bridge your fediverse account into Bluesky and interact with people there, search for and follow @bsky.brid.gy@bsky.brid.gy.

    -

    Alternatively, you can find and follow bridged Bluesky accounts without bridging your own account, but they won't see your posts or interactions.

    -

    • - -Then, you can find and follow Bluesky accounts as @[handle]@bsky.brid.gy, where @[handle] is their Bluesky handle. - - -
  • How do I follow a bridged account.
    • -
  • -

    You can follow any web site, eg example.com, by searching for @example.com@web.brid.gy in your fediverse instance.

    -

    Bridged web sites appear in the fediverse as either @[domain]@[domain], @[domain]@web.brid.gy, or @[domain]@fed.brid.gy, depending on the fediverse server and whether the web site owner has connected their domain to Bridgy Fed. All bridged web sites behave the same in the fediverse; the different instances in their handles are purely cosmetic.

    -
    • - -
    - -

    To the fediverse

    - -
  • Which fediverse servers are supported?
    • -
  • -

    Lots! Mastodon, Friendica, Misskey, PeerTube, Hubzilla, and more. We're working on interoperation with others; see GitHub issues with the app label for details.

    -
    • - - -
  • -

    Mastodon's verified profile links with ✅ green checks are fun! Follow these steps to get one on your Bridgy Fed profile:

    - - - -

    When you're logged into a Mastodon instance, searching for your Bridgy Fed user triggers that instance to check and verify its profile link(s) in the background. This only works when you're logged in with a native Mastodon account. Also, each instance does this independently; verified links are not synched across instances.

    -
    • - -
  • Can I use my own domain as my fediverse handle?
    • -
  • -

    Yes! By default, bridged fediverse handles use a subdomain of brid.gy as their instance, eg @mysite.com@web.brid.gy, but you can change the instance part to your own domain. It takes a bit of setup and technical know-how, but it's very doable.

    -

    First, your domain needs to serve HTTP requests. You don't need an actual web site, but you do need a minimal web server.

    -

    Second, your web server needs to support SSL. Bridgy Fed uses your domain as your identity, so it depends on SSL to prove that you own it.

    -

    Lastly, your web server needs to redirect a couple URL paths, including query parameters, to the same paths on https://fed.brid.gy/:

    • -
    -/.well-known/host-meta
-/.well-known/webfinger
-
    - -

    Here are instructions for a few common web servers:

    - - -
    -

    About

    +

    Background

  • Who are you? Why did you make this?