projects / edward.git / blame
| 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 | ||
| 0255e91b AE |
10 | Edward's Git repo is current hosted at: |
| 11 | <https://vcs.fsf.org/?p=edward.git;a=summary> | |
| 12 | ||
| 13 | $ git clone https://vcs.fsf.org/git/edward.git | |
| 14 | ||
| ed328f53 AE |
15 | ## License |
| 16 | ||
| 17 | This program, its translation files, and its automated test cases are licensend | |
| 18 | under AGPLv3. | |
| 19 | ||
| 20 | The public and private GPG keys in tests/testgnupghome are licensed under CC0. | |
| 21 | ||
| 22 | * https://creativecommons.org/publicdomain/zero/1.0/ | |
| 23 | ||
| 24 | ## Dependencies | |
| 25 | ||
| 26 | $ sudo apt-get install python3 python3-gpgme sendmail | |
| 27 | ||
| 28 | ## Usage | |
| 29 | ||
| 6f6b747e AE |
30 | To run the test cases in the top level directory: (No emails are sent) |
| 31 | ||
| 32 | $ ln -s edward_config.py.example edward_config.py | |
| 33 | $ ./run-tests | |
| 34 | ||
| ed328f53 AE |
35 | Edward expects the TO address of incoming emails and the FROM address of |
| 36 | outgoing emails to be "edward-en@domain" or "edward-es@domain", etc. For a list | |
| 37 | of supported languages, look at the beginning of the edward source file, or | |
| 38 | look in the lang/ directory. | |
| 39 | ||
| 40 | To view edward's output email without sending it: (for debugging purposes) | |
| 41 | ||
| 42 | $ ./edward -p < input-email.eml | |
| 43 | ||
| 44 | To automatically send the the replay email using sendmail: (For this to work, | |
| 45 | you will need to properly setup your mail transfer agent (MTA).) | |
| 46 | ||
| 47 | $ ./edward < input-email.eml | |
| 48 | ||
| ed328f53 AE |
49 | No news (aside from execution duration) is good news. |
| 50 | ||
| 51 | To automatically pipe incoming messages to edward and send its replies: (Notice | |
| 52 | the added dot.) | |
| 53 | ||
| a497df3f AE |
54 | $ cp edward_config.py.example edward_config.py |
| 55 | $ nano edward_config.py | |
| 56 | ||
| ed328f53 AE |
57 | $ cd ~ ; mv edward edward-src |
| 58 | $ cp edward-src/procmailrc.example ~/.procmailrc | |
| 59 | $ nano .procmailrc | |
| 60 | ||
| 61 | ## Contact | |
| 62 | ||
| 63 | Feel free to contact me with issues or patches for this program. My name is | |
| cbe017bc | 64 | Andrew E and you may reach me at <andrew@engelbrecht.io> |
| ed328f53 | 65 |