NAME
dupload.conf - configuration file for dupload
DESCRIPTION
The configuration file is rather straight forward Perl code as it's
included by the dupload script via CWdo $config. The config file
is read as Perl code!
Any dupload.conf must begin with CWpackage config; because CWconfig is
the namespace expected by dupload.
For examples of the configuration please refer to the global configuration
file /etc/dupload.conf.
It contains associative arrays, each indexed by the nickname (see --to
option of dupload), for the following items:
"fqdn
The fully qualified domain name (\s-1FQDN\s0) of the nickname.
"method
The transfer method. The available methods are: "ftp"
(which is the default), "scp", "scpb" and
"rsync" (over \s-1SSH\s0).
If you are using an upload queue, use \s-1FTP\s0 because it's fast.
If you are using an authenticated host, always use scp or rsync
via \s-1SSH\s0, because \s-1FTP\s0 transmits the password in clear text.
For scp and rsync to work properly, you have to setup the remote
and local host to establish a ssh/slogin connection using .shosts/.rhosts
or the files in ~/.ssh/. If you don't want or can't do that,
you may find the scpb more convenient since it uploads in batch,
reducing the number of password prompts.
The only major caveat of the rsync and scpb options is that the files are
processed in a batch mode, i.e. not separately, so in case of an error
dupload won't be able to detect which part of the transfer failed, and
just delete the .upload file completely.
"login
The account name used to log into the \s-1FTP\s0 server. The default is
"anonymous", should work with firewall logins too.
"incoming
Incoming directory, the directory we try to upload to.
"queuedir
The directory we move the uploaded files to (after successful upload to
incoming. Usually necessary only with some special upload queues.
"mailto
Email address where the announcement about stable packages is sent.
"mailtx
Email address where the announcement about unstable and experimental
packages is sent.
"cc
Email address where to send a copy address of the announcement.
"fullname
Your full name, one that should appear in the announcement;
If you leave this setting empty, the default will depend on your mail
system. Usually the full name will be copied from the \s-1GCOS\s0 field in
/etc/passwd.
"visibleuser
Your username that should appear in the announcement. Defaults to
CWgetlogin().
"visiblename
The host/domain name that appears as the part to the right of the @
character in the from-part of the announcement. Defaults to the value
your local \s-1MTA\s0 likes.
"passive
Set the passive mode for \s-1FTP\s0 transfers. Since dupload uses Net::FTP,
you can also use the environment variable \s-1FTP_PASSIVE\s0.
"dinstall_runs
Tells dupload that the remote host runs dinstall (or equivalent)
so that dupload won't send a duplicate announcement mail.
The default is 0 (false), set it to 1 to enable it.
"nonus
Tells dupload that the remote host is a valid destination for packages
with non-US in their Section field, so that dupload doesn't warn about it.
The default is 0 (false), set it to 1 to enable it.
"archive
If set to 0 (false), adds a “X-No-Archive: yes” header in the announcement.
The default is 1 (true).
The configuration files also contain the following global variables:
"default_host
The default host to upload to. The default value of this variable is unset.
"no_parentheses_to_fullname
Prevents dupload to add parentheses around the full name when making
mail announcements. Default is 0 (false), set it to 1 to enable it.
HOOKS
Hooks are a powerful way to add actions which will be run before or
after a dupload (like the preinst and postinst script of dpkg).
You have two sort of hooks: pre-upload and post-upload. Both are simple
shell commands (executed by CWsh -c so you can use any shell tricks).
Pre-uploads are
always run (even in dry mode) and stop dupload if they fail
(failure being mesured by the hook's exit status). Post-uploads
are only run when you are not in dry mode and only if the uploading succeeded.
Both sorts of hooks are run for a given category: changes, sourcepackage,
package, file or deb.
"changes"
This hook is run once per “changes” file (given as an argument to dupload)
with the filename as its parameter.
"sourcepackage"
This hook is run once per “changes” file
with the source package name and its version as its two parameters.
"package"
This hook is run once per binary package (a “deb” file) with
the package name and its version as its two parameters.
"file"
This hook is run once per uploaded file, with the file name as its parameter.
"deb"
This hook is run once per binary package (a “deb” file) with
the filename as its parameter.
Syntax
Hooks are defined in two Perl hashes, CW%preupload and CW%postupload, each indexed
by category. In addition to the global hashes, each host entry has two fields
with the same names, for the host-specific hooks.
The shell command will be substituted first: CW%1 will be replace by the first
argument, etc.
Per-host or global hooks
A hook can be global (for all the hosts) or it can be for a specific host.
If there is no specific hook, for a given category, the global one is used.
Examples
This one runs lintian before uploading. It is global and guarantee
that you will always upload lintian-free packages (thanks to lintian
return status).
$preupload{'deb'} = 'lintian -v -i %1';
This one just display the name and versions of successfully uploaded packages.
$postupload{'package'} = 'echo PACKAGE %1 %2 uploaded';
Unlike the two others, this one is specific to one host, master.
$cfg{master}{preupload}{'changes'} = "echo Uploading %1";
LOCATION
The configuration is searched as following:
/etc/dupload.conf
~/.dupload.conf
The latest entries override the former.
ENVIRONMENT VARIABLES
Those of Net::FTP for the \s-1FTP\s0 method:
FTP_FIREWALL
FTP_PASSIVE
AUTHOR
Heiko Schlittermann <heiko@lotte.sax.de>
Stephane Bortzmeyer <bortzmeyer@debian.org>