1NNTPD(8)                          Cyrus IMAP                          NNTPD(8)
2
3
4

NAME

6       nntpd - Cyrus IMAP documentation
7
8       NNTP server process
9

SYNOPSIS

11          nntpd [ -C config-file ] [ -U uses ] [ -T timeout ] [ -D ]
12              [ -s ] [ -r ] [ -f ] [ -p ssf ]
13

DESCRIPTION

15       nntpd  is an NNTP server. It accepts commands on its standard input and
16       responds on its standard output. It  MUST  invoked  by  master(8)  with
17       those descriptors attached to a remote client connection.
18
19       nntpd reads its configuration options out of the imapd.conf(5) file un‐
20       less specified otherwise by -C.  The optional newsprefix setting speci‐
21       fies  a  prefix  to  be prepended to newsgroup names to make the corre‐
22       sponding IMAP mailbox names.  The optional newspostuser setting  speci‐
23       fies the special userid to be used when constructing the To: header ad‐
24       dress for following up to articles when read via  IMAP.   The  optional
25       newspeer setting specifies the fully qualified hostname of the upstream
26       news server to which articles are fed.  The optional allownewnews  set‐
27       ting enables the NNTP NEWNEWS command.
28
29       NOTE:
30          For servers with a large volume of articles, the NEWNEWS command can
31          be expensive.
32
33       If the directory <configdirectory>/log/user  exists,  then  nntpd  will
34       create protocol telemetry logs for sessions authenticating as user. The
35       telemetry logs will be stored in the log/user directory with a filename
36       of the nntpd process-id.
37

OPTIONS

39       -C config-file
40              Use the specified configuration file config-file rather than the
41              default imapd.conf(5).
42
43       -U uses
44              The maximum number of times that the process should be used  for
45              new connections before shutting down.  The default is 250.
46
47       -T timeout
48              The  number of seconds that the process will wait for a new con‐
49              nection before shutting down.  Note that a  value  of  0  (zero)
50              will disable the timeout.  The default is 60.
51
52       -D     Run external debugger specified in debug_command.
53
54       -s     Serve  NNTP over SSL (https).  All data to and from nntpd is en‐
55              crypted using the Secure Sockets Layer.
56
57       -r     Only allow NNTP reader commands.  Permitted clients will only be
58              allowed to read/post articles.
59
60       -f     Only allow NNTP feeder commands.  Permitted clients will only be
61              allowed to feed articles (no reading).
62
63       -p ssf Tell nntpd that an external  layer  exists.   An  SSF  (security
64              strength  factor)  of  1 means an integrity protection layer ex‐
65              ists.  Any higher SSF implies some form of privacy protection.
66

FILES

68       /etc/imapd.conf
69

SEE ALSO

71       imapd.conf(5), master(8)
72

AUTHOR

74       The Cyrus Team, Nic Bernstein (Onlight)
75

77       1993–2023, The Cyrus Team
78
79
80
81
823.8.1                            Sep 11, 2023                         NNTPD(8)
Impressum