From 50d04bb2970e4636078d708f5818348ce2115ebd Mon Sep 17 00:00:00 2001 From: Miquel Lionel Date: Mon, 16 Nov 2020 20:49:18 +0100 Subject: We add a README --- README.txt | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 README.txt (limited to 'README.txt') diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..8d56e81 --- /dev/null +++ b/README.txt @@ -0,0 +1,43 @@ +GPIGEON +======== + +Gpigeon generate links for a GPG user to be sent to a non technical person (or +not a GPG user) so they can send you encrypted mail messages via a one-time +web link. +Feels of déjàvu ? I was inspired by https://hawkpost.co but wasn't really +interested in the multi-user perspective and managing a database. + +Dependencies +============ + +You need perl and the following modules and my perl version is v5.32.0, YMMV: + + * Net:SSLeay + * Digest::SHA + * Email::Valid + * String::Random + * HTML::Entities + * CGI (I'm planning on removing it, I use it just for the + convenient param function.) + * CGI::Carp (primarly for debugging, comment the line in + gpigeon-template.cgi if you won't need it) + * Net::SMTP + * Net::SMTPS + * GPG + +Having a webserver with CGI support or a separate CGI engine is needed. I'm using +nginx and fcgiwrap. +A note on Net::SMTP and Net:SMTPS dependencies: if you have a mailserver well +configured with OpenDKIM and the likes (so your chances to get your mail +treated as spam is greatly reduced) you could replace these two deps with +Mail::Sendmail then comment and uncomment some lines in . + + +Installation +============ + +I'm currently making a install script for it but frankly if you look around in +the perl script source code you should figure things out quickly (hint: look for variables +values ending in 'goes_here'). + +##WIP## -- cgit v1.2.3-70-g09d2