Blame


1 8d1b399b 2021-07-22 op # kamid -- 9p file server daemon
2 8d1b399b 2021-07-22 op
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.
5 8d1b399b 2021-07-22 op
6 8d1b399b 2021-07-22 op
7 8d1b399b 2021-07-22 op ## Building
8 8d1b399b 2021-07-22 op
9 8d1b399b 2021-07-22 op kamid depends on libtls, libevent and yacc/GNU bison. To build from a
10 8d1b399b 2021-07-22 op release tarball:
11 8d1b399b 2021-07-22 op
12 8d1b399b 2021-07-22 op ./configure
13 8d1b399b 2021-07-22 op make
14 8d1b399b 2021-07-22 op sudo make install # eventually
15 8d1b399b 2021-07-22 op
16 8d1b399b 2021-07-22 op to build from a git checkout:
17 8d1b399b 2021-07-22 op
18 8d1b399b 2021-07-22 op ./bootstrap
19 8d1b399b 2021-07-22 op ./configure
20 8d1b399b 2021-07-22 op make
21 8d1b399b 2021-07-22 op
22 8d1b399b 2021-07-22 op
23 d06671b5 2021-07-22 op ## Usage
24 d06671b5 2021-07-22 op
25 d06671b5 2021-07-22 op In order to run, a `_kamid` user must exists. The home directory of
26 d06671b5 2021-07-22 op `_kamid` should be `/var/empty` or similar. A configuration file is
27 d06671b5 2021-07-22 op also needed. kamid must be started with root privileges.
28 d06671b5 2021-07-22 op
29 647db0bb 2021-07-22 op A sample configuration file:
30 d06671b5 2021-07-22 op
31 647db0bb 2021-07-22 op ```
32 647db0bb 2021-07-22 op pki localhost cert "/path/to/localhost.crt"
33 647db0bb 2021-07-22 op pki localhost key "/path/to/localhost.key"
34 647db0bb 2021-07-22 op
35 647db0bb 2021-07-22 op table users { "SHA256:..." => "op" }
36 647db0bb 2021-07-22 op
37 647db0bb 2021-07-22 op # should be <users> but there's currently a bug in the parser so...
38 647db0bb 2021-07-22 op listen on localhost port 1337 tls pki localhost auth < users >
39 647db0bb 2021-07-22 op ```
40 647db0bb 2021-07-22 op
41 647db0bb 2021-07-22 op
42 6ddbfa0c 2021-08-04 op ## Testing
43 6ddbfa0c 2021-08-04 op
44 6ddbfa0c 2021-08-04 op `ninepscript` is a custom DSL used to tests kamid. It's a fairly
45 6ddbfa0c 2021-08-04 op simple scripting language built to simulate various scenarios.
46 6ddbfa0c 2021-08-04 op
47 6ddbfa0c 2021-08-04 op
48 8d1b399b 2021-07-22 op ## License
49 8d1b399b 2021-07-22 op
50 8d1b399b 2021-07-22 op kamid is released under a BSD-like license. The bulk of the code is
51 8d1b399b 2021-07-22 op under the ISC license, but some file are BSD2 or BSD3.