Webfinger endpoint generator for Jekyll.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSE
README.md
urns.yml
webfinger_generator.rb

README.md

A Webfinger plugin for Jekyll.

An easy Jekyll plugin for adding Webfinger support to your domain.

Note: This won't work with Github Pages, which doesn't allow plugins, unless you're building your site yourself and then committing the rendered pages directly.

What is Webfinger?

It's a way to attach information to your email address.

Take an email address, and ask its domain about it using HTTPS. For example, information about eric@konklone.com is available in JSON at:

https://konklone.com/.well-known/webfinger?resource=acct:eric@konklone.com

See webfinger.net, Paul E. Jones' description, or Webfinger's official standard at RFC 7033 for more information.

Using jekyll-webfinger

Create a _plugins folder in your project if it doesn't exist, and place webfinger_generator.rb into it.

Then, create a _webfinger.yml in the root of your project, that looks something like this:

eric@konklone.com:
  name: Eric Mill
  website: https://konklone.com

When your Jekyll site is built, it will create a URL at /.well-known/webfinger that returns:

{
  "subject": "eric@konklone.com",
  "properties": {
    "http://schema.org/name": "Eric Mill"
  },
  "links": [
    {
      "rel": "http://webfinger.net/rel/profile-page",
      "href": "https://konklone.com"
    }
  ]
}

The response will actually be compact (not indented, like the above example).

Caveats

  • Webfinger requires HTTPS. If you set this up on a non-secure website (http://), be prepared for most Webfinger clients to not find your data.
  • Since this is static file hosting, the query string is being ignored. So all Webfinger requests will return the same data. This in violation of the spec, but I'm not aware of how else to implement Webfinger using static files.
  • It's on you to configure your web server to set the Content-Type to application/jrd+json for /.well-known/webfinger. If you don't, it will probably be set to application/octet-stream, which is in violation of the spec (though most clients will probably still parse it fine).
  • As I said at the top, this won't work on Github Pages unless you pre-build the site yourself. Github blocks all plugins during its build process, so you can only use jekyll-webfinger if you build the site yourself.

MIT License

This project is published under the MIT License.