README.md

   1 # About 'edward'
   2
   3 This is 'edward', a program that automatically responds to GPG encrypted and
   4 signed email. It tests whether users' early attempts to use GPG encrypted and
   5 signed email are successful.
   6
   7 At the time of writing, this program is used by the Free Software Foundation
   8 as part of its campaign at https://emailselfdefense.org
   9
  10 ## License
  11
  12 This program, its translation files, and its automated test cases are licensend
  13 under AGPLv3.
  14
  15 The public and private GPG keys in tests/testgnupghome are licensed under CC0.
  16
  17     * https://creativecommons.org/publicdomain/zero/1.0/
  18
  19 ## Dependencies
  20
  21     $ sudo apt-get install python3 python3-gpgme sendmail
  22
  23 ## Usage
  24
  25 Edward expects the TO address of incoming emails and the FROM address of
  26 outgoing emails to be "edward-en@domain" or "edward-es@domain", etc. For a list
  27 of supported languages, look at the beginning of the edward source file, or
  28 look in the lang/ directory.
  29
  30 To view edward's output email without sending it: (for debugging purposes)
  31
  32     $ ./edward -p < input-email.eml
  33
  34 To automatically send the the replay email using sendmail: (For this to work,
  35 you will need to properly setup your mail transfer agent (MTA).)
  36
  37     $ ./edward < input-email.eml
  38
  39 To run the test cases in the top level directory: (No emails are sent)
  40
  41     $ ./run-tests
  42
  43 No news (aside from execution duration) is good news.
  44
  45 To automatically pipe incoming messages to edward and send its replies: (Notice
  46 the added dot.)
  47
  48     $ cd ~ ; mv edward edward-src
  49     $ cp edward-src/procmailrc.example ~/.procmailrc
  50     $ nano .procmailrc
  51
  52 ## Contact
  53
  54 Feel free to contact me with issues or patches for this program. My name is
  55 Andrew E and you may reach me at andrew.e.7327@gmail.com
  56