1 Explanation of configuration files options for katie
2 ====================================================
7 Essential. List of database details, e.g.
16 Name (required): The name of the PostgreSQL database which has been created
19 Host (required): The name of the host on which the database is located. If
20 the database is local, Host should be blank.
22 Port (required): The port of the database. If the port is the default
23 value (5432), this option should be set to -1.
25 ================================================================================
30 Mandatory. List of directory locations, e.g.
34 | Root "/org/ftp.debian.org/ftp/";
35 | Pool "/org/ftp.debian.org/ftp/pool/";
36 | Templates "/org/ftp.debian.org/katie/templates/";
38 | Override "/org/ftp.debian.org/scripts/override/";
39 | Lists "/org/ftp.debian.org/database/dists/";
40 | Log "/org/ftp.debian.org/log/";
41 | Morgue "/org/ftp.debian.org/morgue/";
42 | MorgueReject "reject";
43 | AcceptedAutoBuild "/org/incoming.debian.org/buildd/";
44 | UrgencyLog "/org/ftp.debian.org/testing/urgencies/";
47 | Accepted "/org/ftp.debian.org/queue/accepted/";
48 | Byhand "/org/ftp.debian.org/queue/byhand/";
49 | Done "/org/ftp.debian.org/queue/done/";
50 | Holding "/org/ftp.debian.org/queue/holding/";
51 | New "/org/ftp.debian.org/queue/new/";
52 | Reject "/org/ftp.debian.org/queue/reject/";
53 | Unchecked "/org/ftp.debian.org/queue/unchecked/";
57 Root (required): Specifies the path of the root of the FTP archive.
59 Pool (required): This variable specifies the path of the pool directory.
60 Debian packages will be placed in the pool by kelly after they have been
63 Templates (required): katie sends various mails and uses templates from
66 PoolRoot (required): This variable specifies the basename of the pool
69 Override (optional): This directory optionally stores override files (used
72 Lists (optional): This directory holds file lists used by apt-ftparchive to
73 generate Packages and Sources files (used by jenna).
75 Log (required): Log files are put in this directory.
77 Morgue (required): Removed files are moved there. The morgue has various
78 sub-directories, including (optionally) those defined by
79 Shania::MorgueSubDir and Rhona::MorgueSubDir.
81 MorgueReject (required): if katie cannot move a rejected package to
82 Dir::Queue::Reject, it will try to move it to the Dir::MorgueReject
83 directory located under Dir::Morgue.
85 AcceptedAutoBuild (optional): This variable is only relevant if any suites
86 are to be auto built, i.e. if Dinstall::AcceptedAutoBuildSuites has any
89 UrgencyLog (optional): If this directory is specified, kelly will store the
90 urgency value of each upload. This is mainly used for britney (the testing
93 Queue (required): This sub-tree defines important directories for the
94 incoming queue. The following variables have to be set: Accepted, Byhand
95 Done, Holding, New, Reject, Unchecked. An explanation of the function of
96 these directores can be found in README.new-incoming.
98 ================================================================================
103 Mandatory. List of all suites, e.g.
119 | Announce "debian-devel-changes@lists.debian.org";
121 | Description "Debian Unstable - Not Released";
123 | OverrideCodeName "sid";
128 Announce (optional): controls where "Installed foo" mails are sent.
130 CodeName, Origin and Description (optional): This settings are used by ziyi
131 and put in the Release files.
133 OverrideCodeName (optional): used by Denise.
135 Priority (optional) determines which suite is used for the Maintainers file
136 as generated by charisma/da_mkmaintainers (highest wins).
138 CopyChanges (optional): if this variable is present it should be a path
139 into the archive (i.e. "Dir::RootDir"); any upload targeted for a suite
140 with this config option present will have the .changes file copied into
143 CopyKatie (optional): if this is present it should be an absolute path; any
144 upload targeted for a suite with this config option present will have the
145 .katie file copied into that path. This option is similar to CopyChanges
146 and will most often be used with it; they're seperate because .changes
147 files are mirrored and .katie files aren't, so the paths will usually be
150 There are more optional variables, such as VersionChecks. Please see
151 katie.conf for examples.
153 ================================================================================
158 Optional. List of mappings for the Distribution file in a .changes file, e.g.:
162 | "map stable proposed-updates";
163 | "map frozen unstable";
164 | "map-unreleased stable unstable";
165 | "map-unreleased proposed-updates unstable";
169 There are three mapping types:
171 (1) map <source> <dest>
173 Any target suite of '<source>' is unconditionally overriden to
176 (2) map-unreleased <source> <dest>
178 Any upload targeted for suite '<source>' will be mapped to
179 '<dest>' iff it contains uploads for an architecture that is not
184 Any target suite of '<suite>' is unconditionally removed from
185 the list of target suites. NB: if the upload had only one
186 target suite this will lead to rejection.
188 NB: ordering is not guaranteed.
190 ================================================================================
195 Mandatory. List of dinstall options, e.g.:
199 | PGPKeyring "/org/keyring.debian.org/keyrings/debian-keyring.pgp";
200 | GPGKeyring "/org/keyring.debian.org/keyrings/debian-keyring.gpg";
201 | SigningKeyring "/org/ftp.debian.org/s3kr1t/dot-gnupg/secring.gpg";
202 | SendmailCommand "/usr/sbin/sendmail -odq -oi -t";
203 | MyEmailAddress "Debian Installer <installer@ftp-master.debian.org>";
204 | MyAdminAddress "ftpmaster@debian.org";
205 | MyHost "debian.org"; // used for generating user@my_host addresses in e.g. manual_reject()
206 | MyDistribution "Debian";
207 | BugServer "bugs.debian.org";
208 | PackagesServer "packages.debian.org";
209 | TrackingServer "packages.qa.debian.org";
210 | LockFile "/org/ftp.debian.org/katie/lock";
211 | Bcc "archive@ftp-master.debian.org";
212 | GroupOverrideFilename "override.group-maint";
213 | FutureTimeTravelGrace 28800; // 8 hours
214 | PastCutoffYear "1984";
216 | AcceptedAutoBuildSuites
222 PGPKeyring and GPGKeyring (required): filenames of the PGP and GnuPG
223 keyrings to be used by katie respectively.
225 SigningKeyring (optional): this is the private keyring used by ziyi.
227 SendmailCommand (required): command to call the MTA.
229 MyEmailAddress (required): this is used as the From: line for sending mails
232 MyAdminAddress (required): used as a contact address in mails.
234 MyDistribution (required): this variable is used in emails sent out by
235 katie and others. It should indicate the name of the distribution.
237 BugServer (required): is used by katie and melanie when closing bugs.
239 PackagesServer (requried): used by melanie when carbon-copying a bug close
240 mail to a package maintainer.
242 TrackingServer (optional): used by katie and melanie to send messages for
243 the maintainer also to an alias for people tracking a specific source
246 LockFile (required): contains the filename of the lockfile used by dinstall
247 when in action mode (i.e. not using -n/--no-action).
249 All sent mail is blind carbon copied to the email address in Bcc if it's
252 GroupOverrideFilename (optional): this is the override file which contains
253 the list of email addresses which, if part of the Maintainer field, cause
254 uploads to always be treated as maintainer uploads.
256 FutureTimeTravelGrace (required): specifies how many seconds into the
257 future timestamps are allowed to be inside a deb before being rejected.
259 PastCutoffYear (required): specifies the cut-off year which is used when
260 deciding whether or not to reject packages based on the file timestamp.
262 BXANotify (optional): a boolean (default: no); if true (Debian-specific)
263 BXA notification is sent. The template for the BXA notification is located
264 in Dir::Templates/lisa.bxa_notification and should be changed if this
267 OverrideDisparityCheck (optional): a boolean (default: no); if true,
268 jennifer compares an uploads section/priority with the overrides and whines
269 at the maintainer if they differ.
271 CloseBugs (optional): a boolean (default: no); if true the automated bug
272 closing feature of dinstall is activated.
274 AcceptedAutoBuildSuites (optional): a list of suites which should be auto
277 SpecialAcceptedAutoBuild is a boolean; if true it activates support
278 for auto-building from accepted.
280 OverrideMaintainer (optional): be used to globally override the
281 __MAINTAINER_TO__ and __MAINTAINER_FROM__ variables in template mails.
284 SkipTime (required): an integer value which is the number of seconds that a
285 file must be older than (via it's last modified timestamp) before jennifer
286 will REJECT rather than SKIP the package.
288 ================================================================================
293 Mandatory. List of all archives, e.g.
299 | OriginServer "ftp-master.debian.org";
300 | PrimaryMirror "ftp.debian.org";
301 | Description "Master Archive for the Debian project";
305 OriginServer and PrimaryMirror (required): used melanie's bug closing mail
306 templates. The host name and it's OriginServer and Description are part of
307 the SQL database in the 'archive' table.
309 ================================================================================
314 Mandatory. List of all architectures, e.g.
319 | all "Architecture Independent";
323 Both values go into the SQL database's 'architecture' table.
324 The description is currently unused.
326 ================================================================================
331 Mandatory. List of all components, e.g.
337 | Description "Main";
342 All three values go into the SQL database's 'component' table.
343 MeetsDFSG is currently unused.
345 ================================================================================
350 Mandatory. List of all valid sections, e.g.
357 The section goes into the 'section' table in SQL database.
359 ================================================================================
364 Mandatory. List of all valid priorities, e.g.
373 | source 0; // i.e. unused
376 The value is the sorting key. Both the section and it's sorting key
377 go into the SQL database's 'priority' table.
379 ================================================================================
384 Mandatory. List of al valid override types, e.g.
393 The type goes into the 'override_type' table in the SQL database.
395 ================================================================================
400 Mandatory. List all locations, e.g.
404 | /org/ftp.debian.org/ftp/pool/
406 | Archive "ftp-master";
411 There are three types: 'legacy', 'legacy-mixed' and 'pool'. 'legacy'
412 and 'pool' are assumed to have sections for all components listed in
413 the Components section 'legacy-mixed' are assumed to mix all
414 components into one location. The Archive and Type sections go into
415 the SQL database's 'location' table.
417 Note that the archive value specified here must correspond to one defined
420 [Note: yes, this is horrible, it dates back to the original `import
421 the existent archive into the SQL Database' script (neve) and
422 isn't otherwise used. It should be revisted at some stage.]
424 ================================================================================
444 This defines the valid and default urgency of an upload. If a package is
445 uploaded with an urgency not listed here, it will be rejected.
447 ================================================================================
450 James Troup <james@nocrew.org>, Horsforth, Leeds
451 Wed, 26 Sep 2001 03:20:39 +0100