Dead simple finger daemon for Mastodon

This repository has been archived on 2024-07-22. You can view files and clone it, but cannot push or open issues or pull requests.

Go to file

Kay Faraday 07f0e27a9c improve user not found error message		2023-09-22 06:40:35 +00:00
.gitignore	initial commit	2023-09-21 07:23:34 +00:00
LICENSE.txt	add documentation	2023-09-21 07:31:18 +00:00
README.md	update README	2023-09-21 07:34:31 +00:00
fingerd.example.toml	initial commit	2023-09-21 07:23:34 +00:00
fingerd.py	improve user not found error message	2023-09-22 06:40:35 +00:00
fingerd.service	add documentation	2023-09-21 07:31:18 +00:00
fingerd.toml	initial commit	2023-09-21 07:23:34 +00:00
requirements.txt	support fingering the instance	2023-09-22 02:41:13 +00:00

README.md

Mastodon Finger Daemon

A dead simple finger daemon for Mastodon. Returns the given user's profile bio. Written as a joke.

Installation

$ python -m venv .venv
$ . .venv/bin/activate
$ pip install -r requirements.txt
$ cp fingerd.example.toml fingerd.toml
$ # edit fingerd.toml as appropriate
$ # note: port defaults to 79 which requires privileges (see systemd unit file, fingerd.service) or running as root (not recommended)
$ PORT=4000 ./fingerd.py

$ sudo cp fingerd.service /etc/systemd/system/fingerd.service
$ sudo systemctl enable --now fingerd

License

BSD 2-clause + Patent, see LICENSE.txt. This license was chosen because it is simple and permissive, unlike the AGPLv3 which would be hard to comply with on a finger daemon, it has a patent grant, and it's easier to comply with than the Apache 2.0 license.