aboutsummaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2017-10-05 18:06:47 +1300
committerTom Ryder <tom@sanctum.geek.nz>2017-10-05 19:32:42 +1300
commit7969bce43d9c445d87a68080587298728d0d3e38 (patch)
tree6b0564dda9aecf08e3d465e4c52efb13984af419 /README.markdown
parentAdd Module::Starter boilerplate for perlmodding (diff)
downloadMail-Run-Crypt-7969bce43d9c445d87a68080587298728d0d3e38.tar.gz
Mail-Run-Crypt-7969bce43d9c445d87a68080587298728d0d3e38.zip
Rename/separate out into app and module
This still needs a lot more work before release. In particular, I have to figure out what I'm going to do about the `passphrase` option. It's probably better to both not require it, in which case no signing is done (only encryption), and to instead allow a path to a file to be specified. The other big puzzle would be how on earth to write automated tests for it... I may end up imitating however Mail::GnuPG is testing itself.
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown45
1 files changed, 0 insertions, 45 deletions
diff --git a/README.markdown b/README.markdown
deleted file mode 100644
index be1457e..0000000
--- a/README.markdown
+++ /dev/null
@@ -1,45 +0,0 @@
-Croncrypt
-=========
-
-Wrapper to sign and encrypt `cron(8)` output and errors with PGP/MIME before
-sending them to the `MAILTO` destination.
-
- $ crontab -l
- CRONCRYPT_KEYID=0x0A1B2C3D4E5F6G7H
- CRONCRYPT_PASSPHRASE=hibbityboo
- MAILTO=me@mynet
-
- 0 1 * * * croncrypt rsync /home/tom/important-file /home/backups
-
-The main design goal is simplicity; just whack `croncrypt` in front of all your
-`crontab(5)` entries, provided they don’t use pipes or `stderr`/`stdout`
-redirects, in which case you should consider putting it all into a script file
-anyway.
-
-Don’t use your own GPG key for signing! I recommend you create a dedicated key
-just for Croncrypt, and sign it locally with `gpg --lsign` so that your
-software trusts it locally.
-
-Installation
-------------
-
-Put the `croncrypt` binary somewhere in your `crontab`’s `PATH`, and install
-the following Perl modules:
-
-* `Carp`
-* `IPC::Run3`
-* `Mail::GnuPG`
-* `MIME::Entity`
-
-On Debian-derived systems, this should do the trick:
-
- # aptitude install perl-base perl-modules libmail-gnupg-perl \
- libmime-tools-perl libipc-run3-perl
-
-License
--------
-
-Copyright (c) [Tom Ryder][1]. Distributed under [Artistic License 2.0][2].
-
-[1]: https://sanctum.geek.nz/
-[2]: http://opensource.org/licenses/artistic-license-2.0