webmnt

webmnt (all lowercase) is an easy to set up Webmention endpoint for your website to receive IndieWeb responses with.

It's very much a hacked together work in progress but can be used if you are fine with that.

Installation

To install this on your server, simply build the binary with go build and copy it somewhere on your server to start it as a service with your init system of choice.
Configuration is detailed in the next section.

Dependencies

For ease of use, all dependencies are vendored in the vendor folder.
The following dependencies are in use:

• willnorris.com/go/microformats

Configuration

webmnt takes the path to your config file as an argument.

./webmnt config.json

{
  "blogHost": "localhost",
  "outdir": "/tmp",
  "listenAddr": "127.0.0.1:8080",
  "maxLength": 200,
  "blockList": [
    "evil.example.com"
  ]
}

The options do the following:

• blogHost: Domain under which your site is hosted. Used to reject mentions for other sites.
• outdir: Directory to write received and validated replies to.
• listenAddr: Address and port the server will listen on.
• maxLength: Length after which fields in a response will be cut off.
• blockList: List of domains to reject mentions from.

Usage

The server offers the receiver endpoint under the path /webmention using the source and target values that make up a mention to validate the response using the following criteria:

• target and source are valid URLS.
• source is not on the blocklist.
• target is on the same domain as the blogHost variable.
• target is a page on our website and is the canonical URL for that page.
• source exists.
• source has the necessary markup to form a response.
• source is the canonical URL of the page.

After these steps of validation, the reply will be saved in a file in the folder set in outdir.
Alternatively: If source returns HTTP 410 Gone, the response will get deleted from its file if it exists.

The name of the file is made up of your domain name and the subpath of the target, with slashes and dots replaced by underscores.

If a mention is sent multiple times it will be saved once, or if changes are detected since the previous send it will get updated.

The format in which responses are saved is as JSON objects separated by newlines meant to be read and processed further by additional software.

License

webmnt's code is under the GNU Affero General Public License v3.0 license.

The vendored modules in the vendor directory are under their original licenses.