ABOUT
-----
Kup is a file upload utility for kernel.org. It is designed to only accept
cryptographically verified uploads from pre-authorized, trusted members.

See man kup and man kup-server for more information.

AUTHORS
-------
Kup was written by H. Peter Anvin <hpa@zytor.com>
Kup is currently maintained by Konstantin Ryabitsev <mricon@kernel.org>

INSTALLING
----------

No particular installation is necessary. However Kup has a few dependencies
and will fail to start if they are not installed. Most distros have them
already packaged. In the rare event that your distro would not provide
them, then your distro likely has the "cpan" tool to install them :

  $ sudo cpan install Config::Simple Encode File::Spec

kup-server checks signatures with gpgv (from GnuPG) or, if configured, sq
(from Sequoia-PGP).

TESTING
-------

Run the test suite with:

  $ make check

The tests need gpg, git, gzip and xz in addition to the dependencies
above. Each test builds a throwaway server tree, keyrings and git repo
in a temporary directory, so nothing outside of it is touched. What
kup-server logs goes to a file in that directory instead of syslog, so
the tests can check it.

To run one test with verbose output:

  $ make check-one T=t/put.t

The gitolite tests run when gitolite is installed, or when
KUP_TEST_GITOLITE points to the src directory of a gitolite checkout:

  $ make check KUP_TEST_GITOLITE=~/src/gitolite/src

SUPPORT
-------

Please send questions, bug reports and patches to tools@kernel.org.
The list archive is at https://lore.kernel.org/tools/.

The easiest way to send patches is with b4. This repository has a
.b4-config, so "b4 send" already knows where patches should go.
