A minimalistic Go-powered jamstack-augmented microservice for webmentions etc
Go to file
Wouter Groeneveld bacc66872d first jab at mf2 parsing and testing 2021-04-08 16:37:04 +02:00
.github/workflows added logging, refactored in webmention struct, use async after validation 2021-04-07 17:31:23 +02:00
.idea first jab at mf2 parsing and testing 2021-04-08 16:37:04 +02:00
app first jab at mf2 parsing and testing 2021-04-08 16:37:04 +02:00
common first jab at mf2 parsing and testing 2021-04-08 16:37:04 +02:00
jsfork first jab at mf2 parsing and testing 2021-04-08 16:37:04 +02:00
mocks first jab at mf2 parsing and testing 2021-04-08 16:37:04 +02:00
rest attempt at primitive DI, mock own rest client 2021-04-08 09:54:47 +02:00
.DS_Store move js stuff to fork subdir to delete later, init go mod 2021-04-07 09:24:25 +02:00
.gitignore refactor out mocks in separate package 2021-04-08 12:16:33 +02:00
README.md move js stuff to fork subdir to delete later, init go mod 2021-04-07 09:24:25 +02:00
go-jamming.sublime-project move js stuff to fork subdir to delete later, init go mod 2021-04-07 09:24:25 +02:00
go.mod found a microformat go parser 2021-04-08 12:50:15 +02:00
go.sum found a microformat go parser 2021-04-08 12:50:15 +02:00
main.go added logging, refactored in webmention struct, use async after validation 2021-04-07 17:31:23 +02:00
playground.go added logging, refactored in webmention struct, use async after validation 2021-04-07 17:31:23 +02:00

README.md

go-jammin' 🥞

A minimalistic Go-powered jamstack-augmented microservice for webmentions etc

⚠️ This is a fork of https://github.com/wgroeneveld/serve-my-jams, the Node-powered original microservice, which is no longer being maintained.

Are you looking for a way to DO something with this? See https://github.com/wgroeneveld/jam-my-stack !

This is a set of minimalistic Go-based microservices that aid you in your IndieWeb Jamstack coolness 😎 (name-dropping). While jam-my-stack is a set of scripts used to run at checkin-time, this is a dymamic service that handles requests.

Inspect how it's used on https://brainbaking.com/ - usually, a <link/> in your <head/> suffices:

<link rel="webmention" href="https://jam.brainbaking.com/webmention" />
<link rel="pingback" href="https://webmention.io/webmention?forward=https://jam.brainbaking.com/webmention" />

If you want to support the older pingback protocol, you can leverage webmenton.io's forward capabilities. Although I developed this primarily because webmention.io is not reliable - you've been warned.

What's in it?

1. Webmentions

1.1 POST /webmention

Receive a webmention. Includes a lot of cross-checking and validating to guard against possible spam. See the W3C WebMention spec - or the source - for details.

Accepted form format:

    POST /webmention-endpoint HTTP/1.1
    Host: aaronpk.example
    Content-Type: application/x-www-form-urlencoded

    source=https://waterpigs.example/post-by-barnaby&
    target=https://aaronpk.example/post-by-aaron

Will result in a 202 Accepted - it handles things async. Stores in .json files in data/domain.

1.2 GET /webmention/:domain/:token

Retrieves a JSON array with relevant webmentions stored for that domain. The token should match. See config.js to fiddle with it yourself. Environment variables are supported, although I haven't used them yet.

1.3 PUT /webmention/:domain/:token

Sends out both webmentions and pingbacks, based on the domain's index.xml RSS feed, and optionally, a since request query parameter that is supposed to be a string, fed through Dayjs to format. (e.g. 2021-03-16T16:00:00.000Z).

This does a couple of things:

  1. Fetch RSS entries (since x, or everything)
  2. Find outbound hrefs (starting with http)
  3. Check if those domains have a webmention link endpoint installed, according to the w3.org rules. If not, check for a pingback endpoint. If not, bail out.
  4. If webmention/pingback found: POST for each found href with source the own domain and target the outbound link found in the RSS feed, using either XML or form data according to the protocol.

As with the POST call, will result in a 202 Accepted and handles things async/in parallel.

Does this thing take updates into account?

Yes and no. It checks the <pubDate/> <item/> RSS tag by default, but if a <time datetime="..."/> tag is present in the <description/>, it treats that date as the "last modified" date. There is no such thing in the RSS 2.0 W3.org specs, so I had to come up with my own hacks! Remember that if you want this to work, you also need to include a time tag in your RSS feed (e.g. .Lastmod gitinfo in Hugo).

2. Pingbacks

Pingbacks are in here for two reasons:

  1. I wanted to see how difficult it was to implement them. Turns out to be almost exactly the same as webmentions. This means the "new" W3 standards for webmentions are just as crappy as pingbacks... What's the difference between a form POST and an XML POST? Form factor?
  2. Much more blogs (Wordpress-alike) support only pingbacks.

2.1 POST /pingback

Receive a pingback. Includes a lot of cross-checking and validating to guard against possible spam. Internally, converts it into a webmention and processes it just like that.

Accepted XML body:

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
    <methodName>pingback.ping</methodName>
    <params>
        <param>
            <value><string>https://brainbaking.com/kristien.html</string></value>
        </param>
        <param>
            <value><string>https://kristienthoelen.be/2021/03/22/de-stadia-van-een-burn-out-in-welk-stadium-zit-jij/</string></value>
        </param>
    </params>
</methodCall>

Will result in a 200 OK - that returns XML according to The W3 pingback XML-RPC spec. Processes async.

2.2 Sending pingbacks

Happens automatically through PUT /webmention/:domain/:token! Links that are discovered as rel="pingback" that do not already have a webmention link will be processed as XML-RPC requests to be send.

TODOs

  • published date is not well-formatted and blindly taken over from feed
  • Implement a Brid.gy-like system that converts links from domains in the config found on public Mastodon timelines into webmentions. (And check if it's ok to only use the public line)