Debian Codegraph @

doc/html/_sources/imap/reference/manpages/systemcommands/httpd.rst.txt

raw
1 .. cyrusman:: httpd(8)
2
3 .. author: Nic Bernstein (Onlight)
4
5 .. _imap-reference-manpages-systemcommands-httpd:
6
7 =========
8 **httpd**
9 =========
10
11 HTTP server process
12
13 Synopsis
14 ========
15
16 .. parsed-literal::
17
18 **httpd** [ **-C** *config-file* ] [ **-U** *uses* ] [ **-T** *timeout* ] [ **-D** ]
19 [ **-H** ] [ **-s** ] [ **-p** *ssf* ] [ **-q** ]
20
21 Description
22 ===========
23
24 **httpd** is an HTTP server. It accepts commands on its standard input
25 and responds on its standard output. It MUST be invoked by
26 :cyrusman:`master(8)` with those descriptors attached to a remote client
27 connection.
28
29 **httpd** |default-conf-text|
30
31 If the directory ``<configdirectory>/log/``\ *user* exists, then
32 **httpd** will create protocol telemetry logs for sessions
33 authenticating as *user*. The telemetry logs will be stored in the
34 ``log/``\ *user* directory with a filename of the **httpd** process-id.
35
36 Options
37 =======
38
39 .. program:: httpd
40
41 .. option:: -C config-file
42
43 |cli-dash-c-text|
44
45 .. option:: -U uses
46
47 The maximum number of times that the process should be used for new
48 connections before shutting down. The default is 250.
49
50 .. option:: -T timeout
51
52 The number of seconds that the process will wait for a new
53 connection before shutting down. Note that a value of 0 (zero)
54 will disable the timeout. The default is 60.
55
56 .. option:: -D
57
58 Run external debugger specified in debug_command.
59
60 .. option:: -H
61
62 Tell **httpd** to expect a HAProxy protocol header from the sender.
63
64 .. option:: -s
65
66 Serve HTTP over SSL (https). All data to and from **httpd**
67 is encrypted using the Secure Sockets Layer.
68
69 .. option:: -p ssf
70
71 Tell **httpd** that an external layer exists. An *SSF* (security
72 strength factor) of 1 means an integrity protection layer exists.
73 Any higher SSF implies some form of privacy protection.
74
75 .. option:: -q
76
77 Ignore quotas on DAV appends. |v3-new-feature|
78
79 Examples
80 ========
81
82 **httpd** is commonly included in the SERVICES section of
83 :cyrusman:`cyrus.conf(5)` like so:
84
85 .. parsed-literal::
86
87 SERVICES {
88 imap cmd="imapd -U 30" listen="imap" prefork=0
89 imaps cmd="imapd -s -U 30" listen="imaps" prefork=0 maxchild=100
90 lmtpunix cmd="lmtpd" listen="/var/run/cyrus/socket/lmtp" prefork=0 maxchild=20
91 sieve cmd="timsieved" listen="sieve" prefork=0
92 notify cmd="notifyd" listen="/var/run/cyrus/socket/notify" proto="udp" prefork=1
93 **httpd cmd="httpd" listen=8080 prefork=1 maxchild=20**
94 }
95
96 History
97 =======
98
99 A beta release of **httpd** was first introduced in the *caldav* branch
100 of Cyrus in version 2.4.17, and was included in the mainline releases
101 beginning in version 2.5.0.
102
103 The quota override option, **-q**, was introduced with Cyrus version
104 3.0.
105
106 Files
107 =====
108
109 /etc/imapd.conf
110
111 See Also
112 ========
113
114 :cyrusman:`imapd.conf(5)`,
115 :cyrusman:`master(8)`