Skip to content
This repository has been archived by the owner on Oct 27, 2024. It is now read-only.

CobyPear/webmention-server

Repository files navigation

Archiving this as I am no longer using it

Webmention Server (TypeScript)

Welcome to the repo!

This project is mostly for learning purposes. It also powers my personal blog's webmentions (https://cobysher.dev/blog).

It should pass almost all of the tests on webmention.rocks save for one of the more edgecase ones (one of the twenties, I forgot exactly which one).

Architecture and Tech Used

  • Node Bull + Redis for the queue
  • Postgres for the RDBMS
  • TypeScript + express.js for the webserver
  • Docker & docker-compose (podman) to glue it all together

Run it Locally

  1. Copy the .env.example to .env
  2. Fill in the vars
  3. podman-compose up -d

If you want to build the image locally with semver tags, use ./podman.build.sh [MAJOR|MINOR|PATCH]. It will build the current Dockerfile and tag the image with latest and the semver bump specified. You don't need to use this, but I think it's neat.

Bug Reports

Feel free to open an issue.

Thanks

Thank you to:

voxpelli for the node-webmention-testpinger which was very helpful in testing this https://github.com/voxpelli/node-webmention-testpinger

Aaron Parecki and all of his content on the IndieWeb such as https://aaronparecki.com/2018/06/30/11/your-first-webmention, as well as https://webmention.rocks