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