mentionee

Documentation

Overview

Provides a service that listens for and processes incoming Webmentions. After some preliminary (synchronous) validation, Webmention requests are queued and then processed asynchronously.

This application can be run (for example) as a daemon. A systemd service configuration is provided together with the source code.

Configuration is read from a .env file (or just the env vars directly). An .env file must be present in either the process working directory `$PWD/.env`, or in `/etc/webmention/mentioner.env`.

Configurable values are:

• SHUTDOWN_TIMEOUT=Seconds: How long to wait for a clean shutdown after SIGINT or SIGTERM (default 20)
• ENDPOINT=URL Path: On which path to listen for Webmentions (default /api/webmention)
• LISTEN_ADDR=Domain with Port: Bind listener to this domain:port (default :8080)
• NOTIFY_BY_MAIL=yes or no: Whether or not to enable notifications by mail (default no)
• MAIL_HOST=Domain: Domain of the outgoing mail server (no default, required by NOTIFY_BY_MAIL)
• MAIL_PORT=Port: Port of the outgoing mail server (no default, required by NOTIFY_BY_MAIL)
• MAIL_USER=Username: User to authenticate to the outgoing mail server (no default, required by NOTIFY_BY_MAIL)
• MAIL_PASS=Password: Password to authenticate to the outgoing mail server (no default, required by NOTIFY_BY_MAIL)
• MAIL_FROM=E-Mail address: Address used in the FROM header (default same as MAIL_USER)
• MAIL_TO=E-Mail address: Address used in the TO header (default same as MAIL_FROM or MAIL_USER)
• NOTIFY_BY_MATRIX=yes or no: Whether or not to enable notifications by a Matrix bot (default no)

Configuration is reloaded on SIGHUP.