1 Explanation of configuration files options for katie
2 ====================================================
7 Essential. List of database details, e.g.
16 If the database is local, Host should be blank. If the port is the
17 default (5432), it should be set to -1.
19 ================================================================================
24 Mandatory. List of directory locations, e.g.
28 | RootDir "/org/ftp.debian.org/ftp/";
29 | PoolDir "/org/ftp.debian.org/ftp/pool/";
30 | TemplatesDir "/org/ftp.debian.org/katie/templates/";
32 | IncomingDir "/org/ftp.debian.org/incoming/";
33 | OverrideDir "/org/ftp.debian.org/scripts/override/";
34 | ListsDir "/org/ftp.debian.org/database/dists/";
35 | LogDir "/org/ftp.debian.org/log/";
36 | Morgue "/org/ftp.debian.org/morgue/";
39 ================================================================================
44 Mandatory. List of all suites, e.g.
60 | Announce "debian-devel-changes@lists.debian.org";
62 | Description "Debian Unstable - Not Released";
64 | OverrideCodeName "sid";
69 Announce controls where "Installed foo" mails are sent; leave empty to
70 not send any. CodeName, Origin and Description are used by ziyi and
71 put in the Release files. OverrideCodeName is used by Denise.
72 Priority determines which suite is used for the Maintainers file as
73 generated by charisma/da_mkmaintainers (highest wins).
75 ================================================================================
80 Mandatory. List of dinstall options, e.g.:
84 | PGPKeyring "/org/keyring.debian.org/keyrings/debian-keyring.pgp";
85 | GPGKeyring "/org/keyring.debian.org/keyrings/debian-keyring.gpg";
86 | SigningKeyring "/org/ftp.debian.org/s3kr1t/dot-gnupg/secring.gpg";
87 | MyEmailAddress "Debian Installer <installer@ftp-master.debian.org>";
88 | MyAdminAddress "ftpmaster@debian.org";
89 | MyHost "debian.org"; // used for generating user@my_host addresses in e.g. manual_reject()
90 | MyDistribution "Debian";
91 | BugServer "bugs.debian.org";
92 | PackagesServer "packages.debian.org";
93 | TrackingServer "packages.qa.debian.org";
94 | NewAckList "/org/ftp.debian.org/katie/log";
95 | LockFile "/org/ftp.debian.org/katie/lock";
96 | Bcc "archive@ftp-master.debian.org";
97 | GroupOverrideFilename "override.group-maint";
100 PGPKeyring and GPGKeyring are mandatory fields which are filenames of
101 the PGP and GnuPG keyrings to be used by katie respectively.
103 SigningKeyring is the private keyring used by ziyi.
105 MyEmailAddress is used as the From: line for sending mails as a
106 script/daemon. MyAdminAddress is used as a contact address in mails.
108 MyDistribution is used in emails sent out by katie and others.
110 BugServer is used by katie and melanie when closing bugs.
112 PackagesServer is used by melanie when carbon-copying a bug close mail
113 to a package maintainer.
115 TrackingServer is used by katie and melanie to send messages for the
116 maintainer also to an alias for people tracking a specific source
119 NewAckList is a mandatory field and contains the filename of list of
120 NEW packages dinstall knows about and is used when dinstall is running
121 in -k/--ack-new mode (usually in the daily cron run).
123 LockFile is a mandatory field and contains the filename of the
124 lockfile used by dinstall when in action mode (i.e. not using
127 All sent mail is blind carbon copied to the email
128 address in Bcc if it's not blank.
130 GroupOverrideFilename, if non-blank, is the override file which
131 contains the list of email addresses which, if part of the Maintainer
132 field, cause uploads to always be treated as maintainer uploads.
134 ================================================================================
139 Mandatory. List of all archives, e.g.
145 | OriginServer "ftp-master.debian.org";
146 | PrimaryMirror "ftp.debian.org";
147 | Description "Master Archive for the Debian project";
151 OriginServer and PrimaryMirror are mandatory and are used melanie's
152 bug closing mail templates. The host name and it's OriginServer and
153 Description are part of the SQL database in the 'archive' table.
155 ================================================================================
160 Mandatory. List of all architectures, e.g.
165 | all "Architecture Independent";
169 Both values go into the SQL database's 'architecture' table.
170 Description is currently unused.
172 ================================================================================
177 Mandatory. List of all components, e.g.
183 | Description "Main";
188 All three values go into the SQL database's 'component' table.
189 MeetsDFSG is currently unused.
191 ================================================================================
196 Mandatory. List of all valid sections, e.g.
203 The section goes into the 'section' table in SQL database.
205 ================================================================================
210 Mandatory. List of all valid priorities, e.g.
219 | source 0; // i.e. unused
222 The value is the sorting key. Both the section and it's sorting key
223 go into the SQL database's 'priority' table.
225 ================================================================================
230 Mandatory. List of al valid override types, e.g.
239 The type goes into the 'override_type' table in the SQL database.
241 ================================================================================
246 Mandatory. List all locations, e.g.
250 | /org/ftp.debian.org/ftp/pool/
252 | Archive "ftp-master";
257 There are three types: 'legacy', 'legacy-mixed' and 'pool'. 'legacy'
258 and 'pool' are assumed to have sections for all components listed in
259 the Components section 'legacy-mixed' are assumed to mix all
260 components into one location. The Archive and Type sections go into
261 the SQL database's 'location' table.
263 [Note: yes, this is horrible, it dates back to the original `import
264 the existent archive into the SQL Database' script (neve) and
265 isn't otherwise used. It should be revisted at some stage.]
267 ================================================================================
270 James Troup <james@nocrew.org>, Horsforth, Leeds
271 Wed, 26 Sep 2001 03:20:39 +0100