add documentation

LICENSE.txt

@@ -0,0 +1,19 @@
+© 2023 Kay Faraday <kay@faraday.quest>
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+Subject to the terms and conditions of this license, each copyright holder and contributor hereby grants to those receiving rights under this license a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except for failure to satisfy the conditions of this license) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer this software, where such license applies only to those patent claims, already acquired or hereafter acquired, licensable by such copyright holder or contributor that are necessarily infringed by:
+
+(a) their Contribution(s) (the licensed copyrights of copyright holders and non-copyrightable additions of contributors, in source or binary form) alone; or
+
+(b) combination of their Contribution(s) with the work of authorship to which such Contribution(s) was added by such copyright holder or contributor, if, at the time the Contribution is added, such addition causes such combination to be necessarily infringed. The patent license shall not apply to any other combinations which include the Contribution.
+
+Except as expressly stated above, no rights or licenses from any copyright holder or contributor is granted under this license, whether expressly, by implication, estoppel or otherwise.
+
+DISCLAIMER
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,24 @@
+# Mastodon Finger Daemon
+
+A dead simple finger daemon for Mastodon. 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

fingerd.service

@@ -0,0 +1,13 @@
+[Unit]
+Description=Mastodon fingerd
+After=network.target postgresql.service
+
+[Service]
+User=mastodon
+WorkingDirectory=/home/mastodon/mastodon-fingerd-py/
+ExecStart=/home/mastodon/mastodon-fingerd-py/.venv/bin/python fingerd.py
+
+AmbientCapabilities=CAP_NET_BIND_SERVICE
+
+[Install]
+WantedBy=default.target