4 o Please be careful: katie sends out lots of emails and if not
5 configured properly will happily send them to lots of people who
6 probably didn't want those emails.
8 o Don't use katie.conf, apt.conf, cron.* etc. as starting points for
9 your own configuration files, they're the configuration files for
10 auric (aka ftp-master.debian.org) and are highly Debian specific.
11 Start from scratch and refer to the security.debian.org config files
12 (-security) as they're a better example for a private archive.
14 o Don't be put off by the names, see doc/README.names for a mapping of
15 name -> what the script does.
17 What do all these scripts do?
18 =============================
20 Generic and generally useful
21 ----------------------------
25 * jennifer - processes queue/unchecked
26 * kelly - processes queue/accepted
27 * lisa - processes queue/new and queue/byhand
29 o To generate indices files:
31 * jenna - generates file lists for apt-ftparchive and removes
32 obsolete packages from suites
33 * ziyi - generates Release
37 * rhona - to remove obsolete files from the pool
38 * shania - to remove obsolete/stray files from the queue
39 * melanie - to remove package(s) from suite(s)
40 * alicia - to change individual override entries
42 o Information display:
44 * madison - shows information about package(s)
45 * helena - shows information about package(s) in queue/
46 * alicia - can show you individual override entries
48 Generic and useful, but only for those with existing archives
49 -------------------------------------------------------------
51 o catherine - migrates packages from legacy locations to the pool
52 o neve - initializes a projectb database from an exisiting archive
54 Generic but not overly useful (in normal use)
55 ---------------------------------------------
57 o ashley - dumps info in .katie files
58 o julia - sync PostgreSQL users with system users
59 o rene - check for obsolete or duplicated packages
60 o rose - directory creation in the initial setup of an archive
61 o tea - various sanity checks of the database and archive
62 o natalie - manpiulates/list override entries
63 o heidi - removes/adds/lists package(s) from/to/for a suite
64 o saffron - produces various statistics
65 o rosamund - checks for users with no packages in the archive
70 To generate less-used indices files:
72 o charisma - generates Maintainers file
73 o denise - generates override.<foo> files
75 Mostly Debian(.org) specific
76 ----------------------------
78 o amber - wrapper for Debian security team
79 o halle - removes obsolete .changes files from proposed-updates
80 o jeri - basic dependency checking for proposed-updates
81 o emilie - syncs fingerprint and uid information with a debian.org LDAP DB
82 o lauren - manually reject packages from proposed-updates
84 Very Incomplete or otherwise not generally useful
85 -------------------------------------------------
87 o alyson - currently only initializes a DB from a katie.conf config file
88 o andrea - looks for version descrepancies that shouldn't exist in many
90 o cindy - override cruft checker that doesn't work well with New Incoming
92 Scripts invoked by other scripts
93 --------------------------------
95 o fernanda - invoked by lisa to "check" NEW packages
96 o claire - invoked by catherine to determine packages still in legacy locations
97 o katie - common code used by lisa, jennifer, kelly and others
100 =====================
102 [Very incomplete - FIXME]
104 o Write your own katie.conf and apt.conf files. katie looks for those
105 config files in /etc/katie/. /etc/katie/katie.conf can define
106 alternative configuration files with Config::host::KatieConfig and
107 Config::host::AptConfig (where "host" is the fully qualified domain
108 name of your machine).
109 o Create a PostgreSQL database on the host given in katie.conf's DB::Host
110 with the name specified in DB::Name.
111 o Run rose: this will create all directories which are specified in
112 katie.conf and apt.conf.
113 o If you have an existing archive:
116 * Create the table structure. init_pool.sql contains all SQL statements
117 which are needed for this. After changing all occurences of "projectb"
118 to the name of your database (as defined in DB::Name) you can run:
119 psql <DB::Name> < init_pool.sql
120 * Run alyson: it will populate your database with the values from
121 katie.conf and apt.conf.
122 * Run 'psql <DB::Name> < add_constraints.sql'.
123 o Copy all templates from the "templates" directory to to the directory
124 specified in Dir::Templates, and adapt them to your distribution.
125 o Create an 'ftpmaster' group in postgres.