Commit | Line | Data |
---|---|---|
ed328f53 AE |
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 | ||
6f6b747e AE |
25 | To run the test cases in the top level directory: (No emails are sent) |
26 | ||
27 | $ ln -s edward_config.py.example edward_config.py | |
28 | $ ./run-tests | |
29 | ||
ed328f53 AE |
30 | Edward expects the TO address of incoming emails and the FROM address of |
31 | outgoing emails to be "edward-en@domain" or "edward-es@domain", etc. For a list | |
32 | of supported languages, look at the beginning of the edward source file, or | |
33 | look in the lang/ directory. | |
34 | ||
35 | To view edward's output email without sending it: (for debugging purposes) | |
36 | ||
37 | $ ./edward -p < input-email.eml | |
38 | ||
39 | To automatically send the the replay email using sendmail: (For this to work, | |
40 | you will need to properly setup your mail transfer agent (MTA).) | |
41 | ||
42 | $ ./edward < input-email.eml | |
43 | ||
ed328f53 AE |
44 | No news (aside from execution duration) is good news. |
45 | ||
46 | To automatically pipe incoming messages to edward and send its replies: (Notice | |
47 | the added dot.) | |
48 | ||
a497df3f AE |
49 | $ cp edward_config.py.example edward_config.py |
50 | $ nano edward_config.py | |
51 | ||
ed328f53 AE |
52 | $ cd ~ ; mv edward edward-src |
53 | $ cp edward-src/procmailrc.example ~/.procmailrc | |
54 | $ nano .procmailrc | |
55 | ||
56 | ## Contact | |
57 | ||
58 | Feel free to contact me with issues or patches for this program. My name is | |
59 | Andrew E and you may reach me at andrew.e.7327@gmail.com | |
60 |