1 8d1b399b 2021-07-22 op # kamid -- 9p file server daemon
3 6ddbfa0c 2021-08-04 op kamid is a FREE, easy-to-use and portable implementation of a 9p file
4 6ddbfa0c 2021-08-04 op server daemon for UNIX-like systems.
9 bb2b5c65 2022-01-10 op When building from a release tarball:
13 bb2b5c65 2022-01-10 op # make install # eventually
15 bb2b5c65 2022-01-10 op to build from a git checkout:
17 bb2b5c65 2022-01-10 op $ ./autogen.sh
24 3b1814ed 2022-01-09 op In order to run, the `_kamid` user must exists, with `/var/empty` as
25 3b1814ed 2022-01-09 op home directory. A valid configuration file `/etc/kamid.conf` is also
26 3b1814ed 2022-01-09 op needed. kamid must be started with root privileges.
28 647db0bb 2021-07-22 op A sample configuration file:
31 3b1814ed 2022-01-09 op # /etc/kamid.conf
32 1ad6dc42 2021-12-15 op pki localhost cert "/etc/ssl/localhost.crt"
33 1ad6dc42 2021-12-15 op pki localhost key "/etc/ssl/private/localhost.key"
35 647db0bb 2021-07-22 op table users { "SHA256:..." => "op" }
37 afb31195 2021-08-04 op listen on localhost port 1337 tls pki localhost auth <users>
41 ab513264 2022-06-11 op ## Contributing
43 ab513264 2022-06-11 op Every form of contribution is well accepted! Just send an email or
44 ab513264 2022-06-11 op open a pull request (either on Codeberg or GitHub.)
46 ab513264 2022-06-11 op Don't know where to start? Take a look at the [TODO](./TODO) file!
51 ab513264 2022-06-11 op kamid is developed primarly on OpenBSD, but it's known to work on
52 ab513264 2022-06-11 op Debian, Devuan and NixOS.
54 ab513264 2022-06-11 op Have you ported / compiled kamid on other systems? Cool, I'd be happy
55 ab513264 2022-06-11 op to hear about it! I'm particularly interested in the difficulties in
56 ab513264 2022-06-11 op doing so to ease the portability.
61 bb2b5c65 2022-01-10 op The regression suite uses sudo (or doas) because it needs root
62 bb2b5c65 2022-01-10 op privileges for certain operations. To run the test suite:
66 bb2b5c65 2022-01-10 op The regression are written using a custom DSL, ninepscript.
67 a98552e5 2021-08-07 op `contrib/9ps-mode.el` is the major mode for Emacs.
69 d74b9ff1 2021-12-21 op There's another regression suite written in common lisp in
70 bb2b5c65 2022-01-10 op `regress/lisp/9p-test`; it depends on other lisp libraries available
71 bb2b5c65 2022-01-10 op through quicklisp. Make sure to have sbcl and the relevant lisp
72 bb2b5c65 2022-01-10 op dependencies installed, then run
74 bb2b5c65 2022-01-10 op $ make HAVE_LISP=yes test
79 8d1b399b 2021-07-22 op kamid is released under a BSD-like license. The bulk of the code is
80 8d1b399b 2021-07-22 op under the ISC license, but some file are BSD2 or BSD3.
82 a2c73237 2021-12-18 op `regress/lisp/9p-test/` (the common lisp regression suite) is released
83 a2c73237 2021-12-18 op under the GNU GPLv3+.
