1 50794f47 2023-04-04 op .\" This file is in the public domain.
 2 50794f47 2023-04-04 op .Dd April 4, 2023
 3 50794f47 2023-04-04 op .Dt MSEARCHD 8
 4 50794f47 2023-04-04 op .Os
 5 50794f47 2023-04-04 op .Sh NAME
 6 50794f47 2023-04-04 op .Nm msearchd
 7 50794f47 2023-04-04 op .Nd FastCGI mail archive query server
 8 50794f47 2023-04-04 op .Sh SYNOPSIS
 9 50794f47 2023-04-04 op .Nm
10 50794f47 2023-04-04 op .Op Fl dv
11 50794f47 2023-04-04 op .Op Fl j Ar n
12 50794f47 2023-04-04 op .Op Fl p Ar path
13 50794f47 2023-04-04 op .Op Fl s Ar socket
14 50794f47 2023-04-04 op .Op Fl u Ar user
15 50794f47 2023-04-04 op .Op Ar db
16 50794f47 2023-04-04 op .Sh DESCRIPTION
17 50794f47 2023-04-04 op .Nm
18 50794f47 2023-04-04 op is a server which implements the FastCGI Protocol to provide search
19 50794f47 2023-04-04 op facilities for the mail archive.
20 50794f47 2023-04-04 op .Pp
21 50794f47 2023-04-04 op It opens a socket at
22 50794f47 2023-04-04 op .Pa /var/www/run/msearchd.sock ,
23 50794f47 2023-04-04 op owned by www:www with permissions 0660.
24 50794f47 2023-04-04 op It will then
25 50794f47 2023-04-04 op .Xr chroot 8
26 50794f47 2023-04-04 op to
27 50794f47 2023-04-04 op .Pa /var/www
28 50794f47 2023-04-04 op and drop privileges to user
29 50794f47 2023-04-04 op .Dq www .
30 50794f47 2023-04-04 op Three child processes are ran to handle the incoming traffic on the
31 50794f47 2023-04-04 op FastCGI socket.
32 50794f47 2023-04-04 op Upon
33 50794f47 2023-04-04 op .Dv SIGHUP
34 50794f47 2023-04-04 op the database is closed and re-opened.
35 50794f47 2023-04-04 op The default database used is at
36 50794f47 2023-04-04 op .Pa /msearchd/mails.sqlite3
37 50794f47 2023-04-04 op inside the chroot.
38 50794f47 2023-04-04 op .Pp
39 50794f47 2023-04-04 op The options are as follows:
40 50794f47 2023-04-04 op .Bl -tag -width Ds
41 50794f47 2023-04-04 op .It Fl d
42 50794f47 2023-04-04 op Do not daemonize.
43 50794f47 2023-04-04 op If this option is specified,
44 50794f47 2023-04-04 op .Nm
45 50794f47 2023-04-04 op will run in the foreground and log to standard error.
46 50794f47 2023-04-04 op .It Fl j Ar n
47 50794f47 2023-04-04 op Run
48 50794f47 2023-04-04 op .Ar n
49 50794f47 2023-04-04 op child processes.
50 50794f47 2023-04-04 op .It Fl p Ar path
51 50794f47 2023-04-04 op .Xr chroot 2
52 50794f47 2023-04-04 op to
53 50794f47 2023-04-04 op .Ar path .
54 50794f47 2023-04-04 op A
55 50794f47 2023-04-04 op .Ar path
56 50794f47 2023-04-04 op of
57 50794f47 2023-04-04 op .Pa /
58 50794f47 2023-04-04 op effectively disables the chroot.
59 50794f47 2023-04-04 op .It Fl s Ar socket
60 50794f47 2023-04-04 op Create an bind to the local socket at
61 50794f47 2023-04-04 op .Ar socket .
62 50794f47 2023-04-04 op .It Fl u Ar user
63 50794f47 2023-04-04 op Drop privileges to
64 50794f47 2023-04-04 op .Ar user
65 50794f47 2023-04-04 op instead of default user www and
66 50794f47 2023-04-04 op .Xr chroot 8
67 50794f47 2023-04-04 op to their home directory.
68 50794f47 2023-04-04 op .It Fl v
69 50794f47 2023-04-04 op Enable more verbose (debug) logging.
70 50794f47 2023-04-04 op Multiple
71 50794f47 2023-04-04 op .Fl v
72 50794f47 2023-04-04 op options increase the verbosity.
73 50794f47 2023-04-04 op .El
74 50794f47 2023-04-04 op .Sh FILES
75 50794f47 2023-04-04 op .Bl -tag -width /var/www/msearchd/mails.sqlite3 -compact
76 50794f47 2023-04-04 op .It Pa /var/www/msearchd/mails.sqite3
77 50794f47 2023-04-04 op Default database.
78 50794f47 2023-04-04 op .It Pa /var/www/run/msearchd.sock
79 50794f47 2023-04-04 op .Ux Ns -domain socket.
80 50794f47 2023-04-04 op .El
81 50794f47 2023-04-04 op .Sh EXAMPLES
82 50794f47 2023-04-04 op Example configuration for
83 50794f47 2023-04-04 op .Xr httpd.conf 5 :
84 50794f47 2023-04-04 op .Bd -literal -offset -indent
85 50794f47 2023-04-04 op server "localhost" {
86 50794f47 2023-04-04 op 	listen on * port 80
87 50794f47 2023-04-04 op 	root "/marc"
88 50794f47 2023-04-04 op 	location "/search" {
89 50794f47 2023-04-04 op 		fastcgi socket "/run/msearchd.sock"
90 50794f47 2023-04-04 op 	}
91 50794f47 2023-04-04 op }
92 50794f47 2023-04-04 op .Ed
93 50794f47 2023-04-04 op .Sh SEE ALSO
94 50794f47 2023-04-04 op .Xr httpd 8
95 50794f47 2023-04-04 op .Sh AUTHORS
96 50794f47 2023-04-04 op .An Omar Polo Aq Mt op@openbsd.org