From 81640b27c2b8b7ed71acefe424a03968f69ab329 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andreas=20=C3=85kre=20Solberg?= <andreas.solberg@uninett.no>
Date: Mon, 16 Feb 2009 17:41:35 +0000
Subject: [PATCH] Adding documentation on consent module

git-svn-id: https://simplesamlphp.googlecode.com/svn/trunk@1274 44740490-163a-0410-bde0-09ae8108e29a
---
 modules/consent/docs/consent.txt | 39 ++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 modules/consent/docs/consent.txt

diff --git a/modules/consent/docs/consent.txt b/modules/consent/docs/consent.txt
new file mode 100644
index 000000000..e050a900e
--- /dev/null
+++ b/modules/consent/docs/consent.txt
@@ -0,0 +1,39 @@
+Installing and configuring the consent module
+=============================================
+
+The consent module is implemented as an Authentication Processing Filter. That means it can be configured in the global config.php file or the SP remote or IdP hosted metadata.
+
+It is recommended to run the consent module at the IdP, and configure the filter to run after all attribute mangling filters is completed, to show the user the exact same attributes that are sent to the SP.
+
+Setting up a database
+---------------------
+
+Here is the initialization SQL script for PostgreSQL
+
+	CREATE TABLE consent (
+		consent_date TIMESTAMP NOT NULL,
+		usage_date TIMESTAMP NOT NULL,
+		hashed_user_id VARCHAR(80) NOT NULL,
+		service_id VARCHAR(255) NOT NULL,
+		attribute VARCHAR(80) NOT NULL,
+		UNIQUE (hashed_user_id, service_id)
+	);
+
+
+Configuring the processing filter
+---------------------------------
+
+Example config using PostgreSQL database:
+
+	90 => array(
+		'class' 	=> 'consent:Consent', 
+		'store' 	=> array(
+			'consent:Database', 
+			'dsn' => 'pgsql:host=sql.uninett.no;dbname=andreas_consent',
+			'username' => 'simplesaml',
+			'password' => 'sdfsdf',
+		),
+		'focus' 	=> 'yes', 
+		'checked' 	=> TRUE
+	),
+
-- 
GitLab