From 73e265d8fd050ae3daa67472b4465a5c49d68910 Mon Sep 17 00:00:00 2001
From: Lauri Ojansivu <x@xet7.org>
Date: Sat, 20 Apr 2019 15:18:33 +0300
Subject: Include to Wekan packages directory contents, so that meteor command
 would build all directly. This also simplifies build scripts.

Thanks to xet7 !
---
 packages/meteor-accounts-cas/README.md | 88 ++++++++++++++++++++++++++++++++++
 1 file changed, 88 insertions(+)
 create mode 100644 packages/meteor-accounts-cas/README.md

(limited to 'packages/meteor-accounts-cas/README.md')

diff --git a/packages/meteor-accounts-cas/README.md b/packages/meteor-accounts-cas/README.md
new file mode 100644
index 00000000..3e246c4f
--- /dev/null
+++ b/packages/meteor-accounts-cas/README.md
@@ -0,0 +1,88 @@
+This is a merged repository of useful forks of: atoy40:accounts-cas
+===================
+([(https://atmospherejs.com/atoy40/accounts-cas](https://atmospherejs.com/atoy40/accounts-cas))
+
+## Essential improvements by ppoulard to atoy40 and xaionaro versions
+
+* Added support of CAS attributes
+
+With this plugin, you can pick CAS attributes : https://github.com/joshchan/node-cas/wiki/CAS-Attributes
+
+Moved to Wekan GitHub org from from https://github.com/ppoulard/meteor-accounts-cas
+
+## Install
+
+```
+cd ~site
+mkdir packages
+cd packages
+git clone https://github.com/wekan/meteor-accounts-cas
+cd ~site
+meteor add wekan:accounts-cas
+```
+
+## Usage
+
+Put CAS settings in Meteor.settings (for example using METEOR_SETTINGS env or --settings) like so:
+
+If casVersion is not defined, it will assume you use CAS 1.0. (note by xaionaro: option `casVersion` seems to be just ignored in the code, ATM).
+
+Server side settings:
+
+```
+Meteor.settings = {
+    "cas": {
+        "baseUrl": "https://cas.example.com/cas",
+        "autoClose": true,
+        "validateUrl":"https://cas.example.com/cas/p3/serviceValidate",
+        "casVersion": 3.0,
+        "attributes": {
+            "debug" : true
+        }
+    },
+}
+```
+
+CAS `attributes` settings :
+
+* `attributes`: by default `{}` : all default values below will apply
+* *  `debug` : by default `false` ; `true` will print to the server console the CAS attribute names to map, the CAS attributes values retrieved, if necessary the new user account created, and finally the user to use
+* *  `id` : by default, the CAS user is used for the user account, but you can specified another CAS attribute
+* *  `firstname` : by default `cas:givenName` ; but you can use your own CAS attribute
+* *  `lastname` : by default `cas:sn` (respectively) ; but you can use your own CAS attribute
+* *  `fullname` : by default unused, but if you specify your own CAS attribute, it will be used instead of the `firstname` + `lastname`
+* *  `mail` : by default `cas:mail`
+
+Client side settings:
+
+```
+Meteor.settings = {
+	"public": {
+		"cas": {
+			"loginUrl": "https://cas.example.com/login",
+			"serviceParam": "service",
+			"popupWidth": 810,
+			"popupHeight": 610,
+			"popup": true,
+		}
+	}
+}
+```
+
+`proxyUrl` is not required. Setup [ROOT_URL](http://docs.meteor.com/api/core.html#Meteor-absoluteUrl) environment variable instead.
+
+Then, to start authentication, you have to call the following method from the client (for example in a click handler) :
+
+```
+Meteor.loginWithCas([callback]);
+```
+
+It must open a popup containing you CAS login form or redirect to the CAS login form (depending on "popup" setting).
+
+If popup is disabled (== false), then it's required to execute `Meteor.initCas([callback])` in `Meteor.startup` of the client side. ATM, `Meteor.initCas()` completes authentication.
+
+## Examples
+
+* [https://devel.mephi.ru/dyokunev/start-mephi-ru](https://devel.mephi.ru/dyokunev/start-mephi-ru)
+
+
-- 
cgit v1.2.3-1-g7c22