chiark / gitweb /
print sensible failure message
[innduct.git] / debian / inn2.README.Debian
1 Some random notes about the Debian INN 2.X package.  
2
3 If you are upgrading from a previous version, please review the information
4 near the top of the NEWS file to learn what has changed, and what you may
5 need to do to update your system.  
6
7 If you plan to use INN at home you should really consider running INN 1.x,
8 which you can find in the inn package.
9
10 INN 2.X is substantially different in terms of configuration file contents
11 and filesystem layout than previous versions.  The Debian INN package installs
12 a minimal but functional local-only server configuration.  Configuring feeds
13 to/from other servers, and many other details, is up to you.
14
15 You will want to review the information in /usr/share/doc/inn2 to get started
16 on configuring the installation for your needs.  All of the configuration files
17 in /etc/news are flagged as 'conffiles' in the packaging system, so your work
18 should not be overwritten without your permission if/when you upgrade the inn 
19 package in the future.  In particular, make sure to update /etc/news/inn.conf
20 to put in your organization name and related information before you establish
21 any network connections if you don't want to be embarrassed.
22
23 Also, if you are moving over from INN 1.X, please note that the directory 
24 structure under /var/spool/news has changed.  At a minimum, you will need to 
25 move the article database subdirectories from /var/spool/news to 
26 /var/spool/news/articles.  The set of directories that belong in 
27 /var/spool/news for 2.2.2 and later are:
28
29         archive articles incoming innfeed outgoing overview
30
31 Anything else is left over from a previous version, and probably should be 
32 moved or removed.
33
34 It has been pointed out that inn2's use of /etc/cron.d/inn2 instead of 
35 separate files in /etc/cron.daily and so forth poses a problem for users of
36 anacron on boxes that are not run continuously.  Since the primary target
37 for an INN installation is a fully-connected system that might easily need
38 a variety of cron entries with different intervals, I don't intend to change
39 this default.  However, if you're bothered by this, feel free to change the
40 cron configuration to suite your needs.
41
42 If you want to use pgpverify (and you do if you're getting a real feed!),
43 you can use the /usr/lib/news/bin/buildinnkeyring program to download the
44 keys for some hierarchies from ftp.isc.org and add them to the gnupg
45 keyring used by pgpverify.
46 This package does not support the non-free PGP program anymore.
47
48 The program 'compress' is not a part of Debian GNU/Linux due to patent issues
49 with the algorithm.  By default, the innshellvars* files will try to call
50 'compress' if you try to transport compressed batches over UUCP.  This will
51 work if you install the non-free 'ncompress' package.  Since it's non-free, 
52 this might be as unacceptable to you as it is to me!  If you know that all of
53 your neighbors can handle gzip, a better solution might be to edit the 
54 innshellvars* files to use '/bin/gzip -9' for the COMPRESS variable.  I do not
55 intend to change this default to differ from the upstream source.
56
57 Log files in /var/log/news need to be owned by user 'news' for the news 
58 scanlogs tool to be able to rotate them properly.
59
60 If you want to use the ckpasswd program you need to install the libgdbm3
61 package.
62
63
64 SSL
65 ~~~
66 To enable SSL you need to start /usr/lib/news/bin/nnrpd-ssl with the -S
67 flag from inetd or the command line.
68 See nnrpd(8) and sasl.conf(5) for details.
69
70 You need a certificate authority (CA) certificate in
71 /etc/news/nnrpd-ca-cert.pem. You will also need a certificate/key pair,
72 named /etc/news/nnrpd-cert.pem and /etc/news/nnrpd-key.pem respectively.
73
74 If you do not already have a PKI in place, you can create them with a
75 command like:
76
77 openssl req -new -x509 -nodes -days 1825 \
78         -keyout /etc/news/nnrpd-key.pem -out /etc/news/nnrpd-cert.pem
79
80 The private key must have the correct permissions:
81
82 chown root:news /etc/news/nnrpd-key.pem
83 chmod 640 /etc/news/nnrpd-key.pem
84
85
86 STARTTLS
87 ~~~~~~~~
88 STARTTLS support will not work when nnrpd is started by innd using
89 "MODE READER" unless the nnrpd binary is replaced by nnrpd-ssl (e.g.
90 by using dpkg-divert(8)).
91 The upstream maintainer recommends running nnrpd as a standalone process.
92
93
94 Large Files Support
95 ~~~~~~~~~~~~~~~~~~~
96 On 32 bit architectures, the inn2-lfs package is built.
97 There is no transition procedure, so if you want to convert an existing
98 installation (this may or may not be possible depending on your choice
99 of storage and overview formats) then you are on your own.
100 When attempting such conversion do not forget that the package will
101 delete /var/{spool,lib,log}/news/ when removed so they should be renamed.
102