projects / app-edwardng.git / blame
| Commit | Line | Data |
|---|---|---|
| 2f9e679a MG |
1 | App-EdwardNG version 0.001 |
| 2 | ========================== | |
| 3 | ||
| 4 | EdwardNG is a reimplementation of the Edward reply bot referenced in https://emailselfdefense.fsf.org/. | |
| 5 | ||
| 6 | It takes mail messages, checks them for PGP signatures and encryption, then replies appropriately. | |
| 7 | ||
| 8 | INSTALLATION | |
| 9 | ||
| 10 | To install this module type the following: | |
| 11 | ||
| 12 | perl Makefile.PL | |
| 13 | make | |
| 14 | make test | |
| 15 | make install | |
| 16 | ||
| 2a57ed8d MG |
17 | USAGE |
| 18 | ||
| 19 | Typical usage of EdwardNG is as follows: | |
| 20 | ||
| 21 | 1. Create a new GPG homedir | |
| 22 | $ mkdir /srv/edwardng | |
| 23 | 2. Create a suitable gpg.conf | |
| 24 | $ cat > /srv/edwardng/gpg.conf <<END | |
| 25 | no-greeting | |
| 26 | keyserver hkp://keys.gnupg.net | |
| 27 | auto-key-locate keyserver | |
| 28 | keyserver-options auto-key-retrieve | |
| 29 | END | |
| 30 | 3. Generate a new key | |
| 31 | $ gpg --homedir /srv/edwardng --gen-key | |
| 32 | 4. Add an entry to /etc/aliases | |
| 33 | $ echo 'edwardng: |/path/to/edwardng --keydir=/srv/edwardng --key=KEYID --from=edwardng@hostname.tld' >> /etc/aliases | |
| 34 | For multiple language support, add multiple entries to /etc/aliases of the form: | |
| 35 | $ echo 'edwardng-lang: |/path/to/edwardng --keydir=/srv/edwardng --key=KEYID --from=edwardng@hostname.tld --tmpl=lang' >>/etc/aliases | |
| 36 | ||
| 2f9e679a MG |
37 | DEPENDENCIES |
| 38 | ||
| 39 | This module requires these other modules and libraries: | |
| 40 | ||
| 41 | * Email::Sender | |
| 42 | * File::Slurp | |
| 2a57ed8d MG |
43 | * File::Share |
| 44 | * File::ShareDir::Install | |
| 2f9e679a MG |
45 | * MIME-Tools |
| 46 | * Mail::GnuPG | |
| 47 | * PerlX::Maybe | |
| 48 | * Template-Toolkit | |
| 49 | * Try::Tiny | |
| 50 | ||
| 51 | COPYRIGHT AND LICENCE | |
| 52 | ||
| 1f08c352 | 53 | Copyright (C) 2014 by Fundația Ceata |
| 2f9e679a MG |
54 | |
| 55 | This library is free software; you can redistribute it and/or modify | |
| 56 | it under the same terms as Perl itself, either Perl version 5.18.2 or, | |
| 57 | at your option, any later version of Perl 5 you may have available. | |
| 58 | ||
| 59 |