GPG-WKS-SERVER(1) User Commands GPG-WKS-SERVER(1)
gpg-wks-server - Server for the Web Key Service
gpg-wks-server [COMMAND] [OPTIONS] [ARGS]
gpg-wks-server is a server for the Web Key Service. It can handle
incoming mails with the --receive command.
See the EXAMPLES section for procmail and crontab configurations.
You also need a webserver configured to alias requests to
/.well-known/openpgp/ and below to the /var/lib/gnupg/wks/<wkd-domain>/
Receive a submission or confirmation.
--cron Run regular jobs.
List configured domains, and checks some file and directory per-
Show program version and some meta information.
Output a short usage information.
Print warranty information.
Dump all available options and commands.
Enable verbose output.
Be somewhat more quiet.
--send Send the mail using sendmail.
-o, --output FILE
Write the mail to FILE.
Use ADDR as the default sender.
Add "NAME: VALUE" as header to all mails.
Can be used to add a header for loop detections, see procmail
Set debugging flags. All flags are or-ed and flags may be
given in C syntax (e.g. 0x0042) or as a comma separated list of
flag names. To get a list of all supported flags the single
word "help" can be used.
Use the specified command instead of gpg.
Contains a subdirectory for each domain to run the server for.
Each subdirectory is supposed to contain what should show up on
The user running gpg-wks-server needs write access to these sub-
Store received emails in ~/Mail/ (create it manually first), uses From:
email@example.com and X-WKS-Loop: example.com as loop detec-
# filter out FROM_DAEMON mails (bounces, ...) into separate mailbox
# archive (copy!) all "normal" mails
# if not in a loop: handle mails with gpg-wks-server
* !^From: firstname.lastname@example.org
* !^X-WKS-Loop: example.com
|gpg-wks-server -v --receive \
--header X-WKS-Loop=example.com \
--from email@example.com --send
# if handling failed: store in separate mailbox
In case procmail is not used automatically the following ~/.forward
file might be useful:
"|exec /usr/bin/procmail || exit 75"
The double quotes are supposed to be included in the file!
You should run the --cron command once a day. Edit the crontab with
and append the following line:
42 3 * * * gpg-wks-server --cron
-- Latest draft for the Web Key Service protocol:
-- GnuPG on Web Key Service: <https://wiki.gnupg.org/WKS>
Please report bugs to <https://dev.gnupg.org>.
Copyright (C) 2017 Free Software Foundation, Inc. License GPLv3+: GNU
GPL version 3 or later <https://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
This manpage was written by Stefan Buhler for the Debian distribution
(but may be used by others).
gpg-wks-server (GnuPG) 2.1.20 May 2017 GPG-WKS-SERVER(1)