A small and configurable WebFinger server.

A Docker image is provided, and can be run like so:

docker run --rm -it \
    -v ./config:/etc/carpal \
    -p 8008:8008 \
    peeley/carpal:latest

TODO

The configuration file defaults to /etc/carpal/config.yml, and looks like so by default:

# /etc/carpal/config.yml

driver: file
file:
  directory: /etc/carpal/resources/

Resource files should be named after the resource they describe. For example, the data for a resource named acct:[email protected] should reside in /etc/carpal/resources/acct:[email protected]. The resource file might look like the following:

# /etc/carpal/resources/acct:[email protected]

aliases:
  - "mailto:[email protected]"
  - "https://mastodon/bob"
properties:
  'http://webfinger.example/ns/name': 'Bob Smith'
links:
  - rel: "http://webfinger.example/rel/profile-page"
    href: "https://www.example.com/~bob/"
  - rel: "http://webfinger.example/rel/businesscard"
    href: "https://www.example.com/~bob/bob.vcf"

The aliases, properties, and links fields describe the corresponding fields of the resource as described in Section 4.4 of the RFC.

• Serve WebFinger resources over HTTP
• Serve resources from static YAML files
• Serve resources from an SQL database
• Serve resources from LDAP