docs/README.config

   1 Explanation of configuration files options for katie
   2 ====================================================
   3
   4 DB
   5 --
   6
   7 Essential.  List of database details, e.g.
   8
   9 | DB
  10 | {
  11 |   Name "projectb";
  12 |   Host "";
  13 |   Port -1;
  14 | };
  15
  16 If the database is local, Host should be blank.  If the port is the
  17 default (5432), it should be set to -1.
  18
  19 ================================================================================
  20
  21 Dir
  22 ---
  23
  24 Mandatory.  List of directory locations, e.g.
  25
  26 | Dir
  27 | {
  28 |   RootDir "/org/ftp.debian.org/ftp/";
  29 |   PoolDir "/org/ftp.debian.org/ftp/pool/";
  30 |   TemplatesDir "/org/ftp.debian.org/katie/templates/";
  31 |   PoolRoot "pool/";
  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/";
  37 | };
  38
  39 ================================================================================
  40
  41 Suite
  42 -----
  43
  44 Mandatory.  List of all suites, e.g.
  45
  46 | Suite
  47 | {
  48 |   Unstable
  49 |   {
  50 |       Components
  51 |       {
  52 |         main "";
  53 |       };
  54 |       Architectures
  55 |       {
  56 |         "source" "";
  57 |         "all" "";
  58 |         "i386" "";
  59 |       };
  60 |       Announce "debian-devel-changes@lists.debian.org";
  61 |       Origin "Debian";
  62 |       Description "Debian Unstable - Not Released";
  63 |       CodeName "sid";
  64 |       OverrideCodeName "sid";
  65 |       Priority "5";
  66 |   };
  67 | };
  68
  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).
  74
  75 ================================================================================
  76
  77 Dinstall
  78 --------
  79
  80 Mandatory.  List of dinstall options, e.g.:
  81
  82 | Dinstall
  83 | {
  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 |    LockFile "/org/ftp.debian.org/katie/lock";
  95 |    Bcc "archive@ftp-master.debian.org";
  96 |    GroupOverrideFilename "override.group-maint";
  97 |    FutureTimeTravelGrace "8640"; // 6 hours
  98 |    PastCutoffYear "1984";
  99 |    BXANotify 0;
 100 | };
 101
 102 PGPKeyring and GPGKeyring are mandatory fields which are filenames of
 103 the PGP and GnuPG keyrings to be used by katie respectively.
 104
 105 SigningKeyring is the private keyring used by ziyi.
 106
 107 MyEmailAddress is used as the From: line for sending mails as a
 108 script/daemon.  MyAdminAddress is used as a contact address in mails.
 109
 110 MyDistribution is used in emails sent out by katie and others.
 111
 112 BugServer is used by katie and melanie when closing bugs.
 113
 114 PackagesServer is used by melanie when carbon-copying a bug close mail
 115 to a package maintainer.
 116
 117 TrackingServer is used by katie and melanie to send messages for the
 118 maintainer also to an alias for people tracking a specific source
 119 package.
 120
 121 LockFile is a mandatory field and contains the filename of the
 122 lockfile used by dinstall when in action mode (i.e. not using
 123 -n/--no-action).
 124
 125 All sent mail is blind carbon copied to the email
 126 address in Bcc if it's not blank.
 127
 128 GroupOverrideFilename, if non-blank, is the override file which
 129 contains the list of email addresses which, if part of the Maintainer
 130 field, cause uploads to always be treated as maintainer uploads.
 131
 132 FutureTimeTravelGrace specifies how many seconds into the future
 133 timestamps are allowed to be inside a deb before being rejected.
 134 PastCutoffYear specifies the cut-off year which is used when deciding
 135 whether or not to reject packages based on the file timestamp.
 136
 137 If BXANotify is non-zero/blank a (Debian-specfic) BXA notification is sent.
 138
 139 ================================================================================
 140
 141 Archive
 142 -------
 143
 144 Mandatory.  List of all archives, e.g.
 145
 146 | Archive
 147 | {
 148 |   ftp-master
 149 |   {
 150 |     OriginServer "ftp-master.debian.org";
 151 |     PrimaryMirror "ftp.debian.org";
 152 |     Description "Master Archive for the Debian project";
 153 |   };
 154 | };
 155
 156 OriginServer and PrimaryMirror are mandatory and are used melanie's
 157 bug closing mail templates.  The host name and it's OriginServer and
 158 Description are part of the SQL database in the 'archive' table.
 159
 160 ================================================================================
 161
 162 Architectures
 163 -------------
 164
 165 Mandatory.  List of all architectures, e.g.
 166
 167 | Architectures
 168 | {
 169 |   source "Source";
 170 |   all    "Architecture Independent";
 171 |   i386   "Intel ia32";
 172 | };
 173
 174 Both values go into the SQL database's 'architecture' table.
 175 Description is currently unused.
 176
 177 ================================================================================
 178
 179 Component
 180 ---------
 181
 182 Mandatory.  List of all components, e.g.
 183
 184 | Component
 185 | {
 186 |   main
 187 |   {
 188 |       Description "Main";
 189 |       MeetsDFSG "true";
 190 |   };
 191 | };
 192
 193 All three values go into the SQL database's 'component' table.
 194 MeetsDFSG is currently unused.
 195
 196 ================================================================================
 197
 198 Section
 199 -------
 200
 201 Mandatory.  List of all valid sections, e.g.
 202
 203 | Section
 204 | {
 205 |   base "";
 206 | };
 207
 208 The section goes into the 'section' table in SQL database.
 209
 210 ================================================================================
 211
 212 Priority
 213 --------
 214
 215 Mandatory.  List of all valid priorities, e.g.
 216
 217 | Priority
 218 | {
 219 |   required 1;
 220 |   important 2;
 221 |   standard 3;
 222 |   optional 4;
 223 |   extra 5;
 224 |   source 0; // i.e. unused
 225 | };
 226
 227 The value is the sorting key.  Both the section and it's sorting key
 228 go into the SQL database's 'priority' table.
 229
 230 ================================================================================
 231
 232 OverrideType
 233 ------------
 234
 235 Mandatory.  List of al valid override types, e.g.
 236
 237 | OverrideType
 238 | {
 239 |   deb "";
 240 |   dsc "";
 241 |   udeb "";
 242 | };
 243
 244 The type goes into the 'override_type' table in the SQL database.
 245
 246 ================================================================================
 247
 248 Location
 249 --------
 250
 251 Mandatory.  List all locations, e.g.
 252
 253 | Location
 254 | {
 255 |   /org/ftp.debian.org/ftp/pool/
 256 |     {
 257 |       Archive "ftp-master";
 258 |       Type "pool";
 259 |     };
 260 | };
 261
 262 There are three types: 'legacy', 'legacy-mixed' and 'pool'.  'legacy'
 263 and 'pool' are assumed to have sections for all components listed in
 264 the Components section 'legacy-mixed' are assumed to mix all
 265 components into one location.  The Archive and Type sections go into
 266 the SQL database's 'location' table.
 267
 268 [Note: yes, this is horrible, it dates back to the original `import
 269        the existent archive into the SQL Database' script (neve) and
 270        isn't otherwise used.  It should be revisted at some stage.]
 271
 272 ================================================================================
 273
 274 --
 275 James Troup <james@nocrew.org>, Horsforth, Leeds
 276 Wed, 26 Sep 2001 03:20:39 +0100