Configuration file example, reflecting README and .gitignore.

You can now configure xkcd-Mailer without touching the script itself. Yay!
This commit is contained in:
Ismo Vuorinen
2013-06-23 15:25:57 +03:00
parent 005b952e6d
commit cb52b4e730
4 changed files with 48 additions and 10 deletions

2
.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
config.php
.DS_Store

View File

@@ -2,17 +2,37 @@
Takes the first/latest item from the [xkcd](http://xkcd.com/) atom-feed and mails the image and punchline to a specified email address.
## configuration ##
The script needs a simple configuration. Modify ``config.example.php`` to fit your needs and save as ``config.php``
```php
<?php
/**
* xkcd-Mailer configuration example
* Save me as config.php
*/
// Your timezone, PHP5 required.
// See full list: http://www.php.net/manual/en/timezones.php
date_default_timezone_set("Europe/Helsinki");
// Your destination
$mail = "your@email.com";
$from = "xkcd mailer <xkcdmailer@example.com>";
```
## crontab example ##
15 minutes over 7am on monday, wednesday and friday.
15 7 * * 1,3,5 /usr/bin/php /full/path/to/xkcd-mailer.php
## caveats ##
- Script doesn't check has the feed been updated, possibly causing old strip delivery
- You have to modify script to change delivery address, config file could be the solution
## contributing ##

15
config.example.php Normal file
View File

@@ -0,0 +1,15 @@
<?php if ( empty($here) ) exit('No direct script access allowed');
/**
* xkcd-Mailer configuration example
* Save me as config.php
*/
// Your timezone, PHP5 required.
// See full list: http://www.php.net/manual/en/timezones.php
date_default_timezone_set("Europe/Helsinki");
// Your destination
$mail = "your@email.com";
$from = "xkcd mailer <xkcdmailer@example.com>";

View File

@@ -6,17 +6,18 @@
* strip with alt/title-text underneath the image.
*
* @author Ismo Vuorinen
* @version 23 August, 2010
* @version 1.0.20130619
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
* @package default
**/
// Your timezone, PHP5 required.
date_default_timezone_set("Europe/Helsinki");
// Your destination
$mail = "ivuorinen@me.com";
$from = "xkcd mailer <xkcdmailer@example.com>";
// Use config.example.php as base for your configurations.
$here = dirname( __FILE__ );
if( !is_readable($here . '/config.php') ) {
die("Please configure me. I don't know where I should sent the comic. (Config file {$here}/config.php missing.)");
} else {
include_once($here . '/config.php');
}
$feed = "http://xkcd.com/atom.xml";
$data = simplexml_load_file($feed);