mastodon-fingerd/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.