Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/techsneeze/dmarcts-report-viewer.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTechSneeze <dave@techsneeze.com>2016-03-11 02:13:23 +0300
committerTechSneeze <dave@techsneeze.com>2016-03-11 02:13:23 +0300
commit066feca1fde5fdfd86e8d8d9aae2e832ecf6e1aa (patch)
tree753e076bf1005032e4b7dc972742c15de99515a8
parente269d3bfe904928a3d0ada40251329655c4f7189 (diff)
Update README.md
-rw-r--r--README.md27
1 files changed, 22 insertions, 5 deletions
diff --git a/README.md b/README.md
index 37ab1e4..fc4dd28 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,26 @@
# dmarcts-report-viewer
+A PHP viewer for DMARC records that have been parsed by [John Levine's rddmarc script](http://www.taugh.com/rddmarc/) or the [dmarcts-report-parser.pl](https://github.com/techsneeze/dmarcts-report-parser)
+* Allow to view pass/fail data for the parsed reports
+* Identify potential DMARC related issues through red/yellow/green signals
-Current documentation about use of this report can be found at: http://www.techsneeze.com/dmarc-report/
+## Installation and Configuration
-Hoping to migrate documentation here as things get settled here!
+NOTE: The viewer expects that you have already populated a database with data from [John Levine's rddmarc script](http://www.taugh.com/rddmarc/) or the [dmarcts-report-parser.pl](https://github.com/techsneeze/dmarcts-report-parser)
---
-Dave
-TechSneeze.com
+Once the php files ave been downloaded, you'll want to edit these basic configuration options at the top of the `dmarcts-report-viewer-config.php` script. Most of them are self-explanatory:
+
+```
+$dbhost="localhost";
+$dbname="dmarc";
+$dbuser="dmarc";
+$dbpass="xxx";
+```
+
+Ensure that `dmarcts-report-viewer-config.php` and `dmarcts-report-viewer.php` are in the same folder.
+## Usage
+
+Navigate in your browser to the location of the `dmarcts-report-viewer.php` file.
+
+You should be presented with the basic report view, allowing you to navigate through the reports that have been parsed.
+
+More info can currently be found at : [TechSneeze.com](http://www.techsneeze.com/dmarc-report/)