Debian Codegraph @

doc/html/_sources/imap/reference/admin/ports/sockets.rst.txt

raw
1 .. _imap-admin-sockets:
2
3 Cyrus Socket Locations
4 ======================
5
6 .. _imap-admin-sock:
7
8 The Cyrus IMAP server provides service interfaces via either TCP/IP
9 ports or Unix domain sockets. For the later, Cyrus requires the parent
10 directory exist prior to initialization.
11
12 The following sockets may be required for any host providing local Unix
13 domain access for the listed services, where ``<rundir>`` is the base
14 directory for Cyrus sockets. This defaults to
15 ``{configdirectory}/socket/`` where {configdirectory} is as defined in
16 :cyrusman:`imapd.conf(5)`, but is often redefined as
17 ``/var/run/cyrus/socket/`` or more recently ``/run/cyrus/socket/``:
18
19 ::
20
21 lmtp <rundir>/lmtp # Lightweight Mail Transport Protocol service
22 idle <rundir>/idle # idled daemon socket
23 notify <rundir>/notify # Notification daemon socket
24 ptloader <rundir>/ptsock # PT Loader socket (alternative authorization)
25
26 .. _imap-admin-sock-end:
27
28 Controlling Socket Locations
29 ----------------------------
30
31 Locations of sockets may be tailored to the needs of different
32 sites, via the use of several settings in :cyrusman:`imapd.conf(5)`:
33
34 .. include:: /imap/reference/manpages/configs/imapd.conf.rst
35 :start-after: startblob idlesocket
36 :end-before: endblob idlesocket
37
38 .. include:: /imap/reference/manpages/configs/imapd.conf.rst
39 :start-after: startblob lmtpsocket
40 :end-before: endblob lmtpsocket
41
42 .. include:: /imap/reference/manpages/configs/imapd.conf.rst
43 :start-after: startblob notifysocket
44 :end-before: endblob notifysocket
45
46 .. include:: /imap/reference/manpages/configs/imapd.conf.rst
47 :start-after: startblob ptloader_sock
48 :end-before: endblob ptloader_sock