Dotplan Online

What is Dotplan?

Dotplan is an API specification through which the technically capable can express their personalities (or lack thereof) with one another. A modern, decentralized re-imagining of the Unix plan file. It uses minisign to verify authenticity.

What is Dotplan Online?

This site is a free Dotplan provider and relay running the Dotplan reference implementation. If you're incapable of hosting your own (or too lazy), you can point your email domain here via a SRV record and use it as your Dotplan provider.

How does it work?

Dotplan API

Fetch the plan for example@dotplan.online as plain text:

    curl https://dotplan.online/plan/example@dotplan.online

Fetch the plan for example@dotplan.online as JSON:

    curl -H 'Accept: application/json' \
      https://dotplan.online/plan/example@dotplan.online

See the GitHub for more details, such as how to verify signed plans.

Dotplan Online

Register the email address test@example.com with password my-password-123 (an email with further instructions will be sent):

    curl -H 'Content-Type: application/json' \
      -XPOST -d '{"password":"my-password-123"}' \
      https://dotplan.online/users/test@example.com

Retrieve an authentication token for the account created above:

    curl -H 'Accept: application/json' \
      -u 'test@example.com:my-password-123' \
      https://dotplan.online/token

Update the plan for test@example.com with the authentication token retrieved above:

    curl -H 'Content-Type: application/json' \
      -XPUT -d '{"auth":"AUTH_TOKEN","plan":"This is my first plan!"}' \
      https://dotplan.online/plan/test@example.com

See the GitHub for more details, such as how to sign plans for authenticity and how to support service discovery via domain SRV records.

What's the point?

I like the idea of plan files, and wanted one that I could easily update and inject into my static website using javascript. This was the result.