| README.md - fingered - Fingerd protocol daemon, allowing custom responses. | |
| git clone git://jay.scot/fingered | |
| Log | |
| Files | |
| Refs | |
| README | |
| LICENSE | |
| --- | |
| README.md (1813B) | |
| --- | |
| 1 # FINGERED | |
| 2 | |
| 3 [: | |
| 13 ```shell | |
| 14 git clone https://git.sr.ht/~jayscott/fingered | |
| 15 cd fingered | |
| 16 make | |
| 17 sudo make install | |
| 18 ``` | |
| 19 | |
| 20 Pre-compiled binaries are available on the latest build artifacts: | |
| 21 | |
| 22 | |
| 23 ## Running | |
| 24 | |
| 25 From your terminal: | |
| 26 ```shell | |
| 27 fingered | |
| 28 ``` | |
| 29 | |
| 30 | |
| 31 ## Usage | |
| 32 | |
| 33 ```shell | |
| 34 Usage: | |
| 35 -d: Directory containing user files (default: /srv/fingered) | |
| 36 -f: Filename for empty requests (default: default) | |
| 37 -p: Port for incoming connections (default: 79) | |
| 38 -t: Number of worker threads (default: 10) | |
| 39 ``` | |
| 40 | |
| 41 | |
| 42 ## Examples | |
| 43 | |
| 44 Check the `./examples` for a demo data directory. | |
| 45 | |
| 46 Run FINGERED on port 7000, using files from /srv/fingered/example, with | |
| 47 'info' as the default file: | |
| 48 | |
| 49 ```shell | |
| 50 fingered -p 7000 -d /srv/fingered/example -f info | |
| 51 ``` | |
| 52 | |
| 53 | |
| 54 ## Issue tracker | |
| 55 | |
| 56 For issues, [visit the tracker](https://todo.sr.ht/~jayscott/fingered). | |
| 57 | |
| 58 | |
| 59 ## Contributing | |
| 60 | |
| 61 Sending patches is done [by | |
| 62 email](https://lists.sr.ht/~jayscott/fingered-dev), this is simple and | |
| 63 built-in to Git. | |
| 64 | |
| 65 Set up your system once by following the steps Installation and | |
| 66 Configuration of [git-send-email.io](https://git-send-email.io/) | |
| 67 | |
| 68 Then, run once in this repository: | |
| 69 ```shell | |
| 70 git config sendemail.to "~jayscott/[email protected]" | |
| 71 ``` | |
| 72 | |
| 73 Then, to send a patch, make your commit, then run: | |
| 74 ```shell | |
| 75 git send-email --base=HEAD~1 --annotate -1 -v1 | |
| 76 ``` | |
| 77 | |
| 78 Your patch will appear on the [the mailing list](https://lists.sr.ht/~ja… | |
| 79 | |
| 80 | |
| 81 ## License | |
| 82 | |
| 83 This is open source! Please use it under the ISC License. |