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 |    NewAckList "/org/ftp.debian.org/katie/log";
  94 |    LockFile "/org/ftp.debian.org/katie/lock";
  95 |    Bcc "archive@ftp-master.debian.org";
  96 |    GroupOverrideFilename "override.group-maint";
  97 | };
  98
  99 PGPKeyring and GPGKeyring are mandatory fields which are filenames of
 100 the PGP and GnuPG keyrings to be used by katie respectively.
 101
 102 SigningKeyring is the private keyring used by ziyi.
 103
 104 MyEmailAddress is used as the From: line for sending mails as a
 105 script/daemon.  MyAdminAddress is used as a contact address in mails.
 106
 107 MyDistribution is used in emails sent out by katie and others.
 108
 109 BugServer is used by katie and melanie when closing bugs.
 110
 111 PackagesServer is used by melanie when carbon-copying a bug close mail
 112 to a package maintainer.
 113
 114 NewAckList is a mandatory field and contains the filename of list of
 115 NEW packages dinstall knows about and is used when dinstall is running
 116 in -k/--ack-new mode (usually in the daily cron run).
 117
 118 LockFile is a mandatory field and contains the filename of the
 119 lockfile used by dinstall when in action mode (i.e. not using
 120 -n/--no-action).
 121
 122 All sent mail is blind carbon copied to the email
 123 address in Bcc if it's not blank.
 124
 125 GroupOverrideFilename, if non-blank, is the override file which
 126 contains the list of email addresses which, if part of the Maintainer
 127 field, cause uploads to always be treated as maintainer uploads.
 128
 129 ================================================================================
 130
 131 Archive
 132 -------
 133
 134 Mandatory.  List of all archives, e.g.
 135
 136 | Archive
 137 | {
 138 |   ftp-master
 139 |   {
 140 |     OriginServer "ftp-master.debian.org";
 141 |     PrimaryMirror "ftp.debian.org";
 142 |     Description "Master Archive for the Debian project";
 143 |   };
 144 | };
 145
 146 OriginServer and PrimaryMirror are mandatory and are used melanie's
 147 bug closing mail templates.  The host name and it's OriginServer and
 148 Description are part of the SQL database in the 'archive' table.
 149
 150 ================================================================================
 151
 152 Architectures
 153 -------------
 154
 155 Mandatory.  List of all architectures, e.g.
 156
 157 | Architectures
 158 | {
 159 |   source "Source";
 160 |   all    "Architecture Independent";
 161 |   i386   "Intel ia32";
 162 | };
 163
 164 Both values go into the SQL database's 'architecture' table.
 165 Description is currently unused.
 166
 167 ================================================================================
 168
 169 Component
 170 ---------
 171
 172 Mandatory.  List of all components, e.g.
 173
 174 | Component
 175 | {
 176 |   main
 177 |   {
 178 |       Description "Main";
 179 |       MeetsDFSG "true";
 180 |   };
 181 | };
 182
 183 All three values go into the SQL database's 'component' table.
 184 MeetsDFSG is currently unused.
 185
 186 ================================================================================
 187
 188 Section
 189 -------
 190
 191 Mandatory.  List of all valid sections, e.g.
 192
 193 | Section
 194 | {
 195 |   base "";
 196 | };
 197
 198 The section goes into the 'section' table in SQL database.
 199
 200 ================================================================================
 201
 202 Priority
 203 --------
 204
 205 Mandatory.  List of all valid priorities, e.g.
 206
 207 | Priority
 208 | {
 209 |   required 1;
 210 |   important 2;
 211 |   standard 3;
 212 |   optional 4;
 213 |   extra 5;
 214 |   source 0; // i.e. unused
 215 | };
 216
 217 The value is the sorting key.  Both the section and it's sorting key
 218 go into the SQL database's 'priority' table.
 219
 220 ================================================================================
 221
 222 OverrideType
 223 ------------
 224
 225 Mandatory.  List of al valid override types, e.g.
 226
 227 | OverrideType
 228 | {
 229 |   deb "";
 230 |   dsc "";
 231 |   udeb "";
 232 | };
 233
 234 The type goes into the 'override_type' table in the SQL database.
 235
 236 ================================================================================
 237
 238 Location
 239 --------
 240
 241 Mandatory.  List all locations, e.g.
 242
 243 | Location
 244 | {
 245 |   /org/ftp.debian.org/ftp/pool/
 246 |     {
 247 |       Archive "ftp-master";
 248 |       Type "pool";
 249 |     };
 250 | };
 251
 252 There are three types: 'legacy', 'legacy-mixed' and 'pool'.  'legacy'
 253 and 'pool' are assumed to have sections for all components listed in
 254 the Components section 'legacy-mixed' are assumed to mix all
 255 components into one location.  The Archive and Type sections go into
 256 the SQL database's 'location' table.
 257
 258 [Note: yes, this is horrible, it dates back to the original `import
 259        the existent archive into the SQL Database' script (neve) and
 260        isn't otherwise used.  It should be revisted at some stage.]
 261
 262 ================================================================================
 263
 264 --
 265 James Troup <james@nocrew.org>, Horsforth, Leeds
 266 Wed, 26 Sep 2001 03:20:39 +0100