2018/microsub

From IndieWeb
Jump to: navigation, search

Microsub: how to build servers and clients was a session at IndieWeb Summit 2018.

Notes archived from: https://etherpad.indieweb.org/microsub



IndieWeb Summit 2018
Session: Microsub
When: 2018-06-26 16:45

Participants

Notes


  • Jack Jamieson wrote a feed reader and wants to put this in ine with the Micropub spec. Goal is to learn.
  • Several people wanted to install an existing client, but not building one
  • Grant Richmond built together
  • Jonathan LaCour is Interested in adjacent services that might
  • Tantek Çelik wants to know how easy it is, and to create a one-click follow button for Microsub
  • Chris Aldrich is here because whatever is built, he'll dogfood the heck out of it and evangelize it to others
  • Malcolm Blaney is interested because he implements feed readers, specifically channels
  • Manton Reece has been following Microsub and thinks micro.blog should support it someday, if it is a good fit.

Aaron wants feedback on the spec.

The main idea is an api doc, that you look at if you are building a reader. Servers read the api to learn what to return. Template:mblanet suggests "microchannels" as a name.

Servers could proxy or cache images. It is not required. Server defines its own polling schedule, should accept websub for realtime updates


The API describes methods for actions that clients are likely going to need for interacting with feeds: adding them to the server (subscribing/following), getting the items inside of them, etc.

A server’s job is to read feeds and normalise them. So they can answer over the Microsub specified methods with a normalised data structure that the reader is expecting.

Question from David Shanske: how do we share extra properties? My server does not know what a reader will expect. My website might offer a property, but a server may filter it out. Etc. Response: clients fall back to summary if there are no other fields they can understand, servers should always return summary

It is a JSON based API.

To get access to the server from the client, you send along an Access Token (OAuth). These can be generated through the IndieAuth flow. At the end of the flow the client has a token to send along.

Note there there isn’t actually a requirement (in spec) for IndieAuth. What is required is the access token for authentication. How you source it, and how you validate it, does not matter.

There is a special reserved channel (“notifications”) that is meant to be kept separate by the client. Items coming in to this channel could be handled differently by a client, e.g. showing a bell icon or some other way. (Think the notifications UI on Twitter and Facebook.)button

Universal follow button is needed for the web. But, in the client, there should be follow buttons in the app for reposted content. How does rel-subscribe fit in?

  • Spec feedback:
    • Currently the spec requires a notifications channel from all servers. A server should be able to chose not to send them.
    • There is consensus amongst reader implementers (aaronpk, grantcodes, eddie) that this should and can be completely optional.
    • The spec currently doesn't say anything about locking channels down. Some servers may want to not let users add channels, fixed list of channels, but this may cause issues in readers that support creating channels & feeds
    • Scope for adding/removing channels?
      • Allowing channels to be marked as not deletable by the server expressly
      • Should be specced scopes so clients can check them and change the UI accordingly. This is in the spec, server can choose which scopes to return

Getting Started

See Also