X-Git-Url: https://git.decadent.org.uk/gitweb/?p=dak.git;a=blobdiff_plain;f=docs%2FREADME.first;h=017985dc6054ad2e4ea3afccc2f82252afd171d6;hp=59d796d8a706bb6b721c46a3d628a30efbd63fbb;hb=026bdb9580e6d18bf504d2f44d46890df5d89f1a;hpb=3686a00f1001f2d5692fa5e706b898053e39191a diff --git a/docs/README.first b/docs/README.first index 59d796d8..017985dc 100644 --- a/docs/README.first +++ b/docs/README.first @@ -1,18 +1,15 @@ Notes ===== -o Please be careful: katie sends out lots of emails and if not +o Please be careful: dak sends out lots of emails and if not configured properly will happily send them to lots of people who probably didn't want those emails. -o Don't use katie.conf, apt.conf, cron.* etc. as starting points for - your own configuration files, they're the configuration files for - auric (aka ftp-master.debian.org) and are highly Debian specific. - Start from scratch and refer to the security.debian.org config files - (-security) as they're a better example for a private archive. - -o Don't be put off by the names, see doc/README.names for a mapping of - name -> what the script does. +o Don't use the debian dak.conf, cron.* etc. as starting + points for your own configuration files, they're highly Debian + specific. Start from scratch and refer to the security.debian.org + config files (-security) as they're a better example for a private + archive. What do all these scripts do? ============================= @@ -22,105 +19,73 @@ Generic and generally useful o To process queue/: - * jennifer - processes queue/unchecked - * kelly - processes queue/accepted - * lisa - processes queue/new and queue/byhand + * dak process-upload - processes queue/unchecked + * dak process-new - allows ftp administrator to process queue/new and queue/byhand + * dak process-policy - processes policy queues (including new and byhand) o To generate indices files: - * jenna - generates file lists for apt-ftparchive and removes - obsolete packages from suites - * ziyi - generates Release + * dak dominate - removes obsolete packages from suites + * dak generate-packages-sources2 - generate Packages, Sources + * dak generate-releases - generates Release o To clean things up: - * rhona - to remove obsolete files from the pool - * shania - to remove obsolete/stray files from the queue - * melanie - to remove package(s) from suite(s) - * alicia - to change individual override entries + * dak clean-suites - to remove obsolete files from the pool + * dak clean-queues - to remove obsolete/stray files from the queue + * dak rm - to remove package(s) from suite(s) + * dak override - to change individual override entries o Information display: - * madison - shows information about package(s) - * helena - shows information about package(s) in queue/ - * alicia - can show you individual override entries + * dak ls - shows information about package(s) + * dak queue-report - shows information about package(s) in queue/ + * dak override - can show you individual override entries + * dak graph - creates some pretty graphs of queue sizes over time Generic and useful, but only for those with existing archives ------------------------------------------------------------- -o catherine - migrates packages from legacy locations to the pool -o neve - initializes a projectb database from an exisiting archive +o dak init-archive - initializes a projectb database from an existing archive Generic but not overly useful (in normal use) --------------------------------------------- -o ashley - dumps info in .katie files -o julia - sync PostgreSQL users with system users -o rene - check for obsolete or duplicated packages -o rose - directory creation in the initial setup of an archive -o tea - various sanity checks of the database and archive -o natalie - manpiulates/list override entries -o heidi - removes/adds/lists package(s) from/to/for a suite -o saffron - produces various statistics -o rosamund - checks for users with no packages in the archive +o dak import-users-from-passwd - sync PostgreSQL users with system users +o dak cruft-report - check for obsolete or duplicated packages +o dak init-dirs - directory creation in the initial setup of an archive +o dak check-archive - various sanity checks of the database and archive +o dak control-overrides - manipulates/lists override entries +o dak control-suite - removes/adds/lists package(s) from/to/for a suite +o dak stats - produces various statistics +o dak find-null-maintainers - checks for users with no packages in the archive Semi-generic ------------ To generate less-used indices files: -o charisma - generates Maintainers file -o denise - generates override. files +o dak make-maintainers - generates Maintainers file used by, e.g. debbugs +o dak make-overrides - generates override. files Mostly Debian(.org) specific ---------------------------- -o amber - wrapper for Debian security team -o halle - removes obsolete .changes files from proposed-updates -o jeri - basic dependency checking for proposed-updates -o emilie - syncs fingerprint and uid information with a debian.org LDAP DB -o lauren - manually reject packages from proposed-updates +o dak security-install - wrapper for Debian security team +o dak import-ldap-fingerprints - syncs fingerprint and uid information with a debian.org LDAP DB Very Incomplete or otherwise not generally useful ------------------------------------------------- -o alyson - currently only initializes a DB from a katie.conf config file -o andrea - looks for version descrepancies that shouldn't exist in many - archives -o cindy - override cruft checker that doesn't work well with New Incoming +o dak init-db - currently only initializes a DB from a dak.conf config file +o dak check-overrides - override cruft checker that doesn't work well with New Incoming Scripts invoked by other scripts -------------------------------- -o fernanda - invoked by lisa to "check" NEW packages -o claire - invoked by catherine to determine packages still in legacy locations -o katie - common code used by lisa, jennifer, kelly and others +o dak examine-package - invoked by 'dak process-new' to "check" NEW packages How do I get started? ===================== -[Very incomplete - FIXME] - -o Write your own katie.conf and apt.conf files. katie looks for those - config files in /etc/katie/. /etc/katie/katie.conf can define - alternative configuration files with Config::host::KatieConfig and - Config::host::AptConfig (where "host" is the fully qualified domain - name of your machine). -o Create a PostgreSQL database on the host given in katie.conf's DB::Host - with the name specified in DB::Name. -o Run rose: this will create all directories which are specified in - katie.conf and apt.conf. -o If you have an existing archive: - * Run neve - otherwise: - * Create the table structure. init_pool.sql contains all SQL statements - which are needed for this. After changing all occurences of "projectb" - to the name of your database (as defined in DB::Name) you can run: - psql < init_pool.sql -o Run alyson: it will populate your database with the values from - katie.conf and apt.conf. -o Copy all templates from the "templates" directory to to the directory - specified in Dir::Templates, and adapt them to your distribution. -o Create an 'ftpmaster' group in postgres. -o Run 'psql < add_constraints.sql'. - +Please refer to setup/README for instructions how to setup dak.