summaryrefslogtreecommitdiffstats
path: root/packages/wekan_accounts-oidc/README.md
diff options
context:
space:
mode:
authorJustin Reynolds <justinr1234@gmail.com>2019-06-26 19:15:59 -0500
committerJustin Reynolds <justinr1234@gmail.com>2019-06-27 09:19:29 -0500
commit3d63b6006b13942a887bbeddebb055d697451223 (patch)
treeef64c00f146add91a484f7f6b27a40a785f459a0 /packages/wekan_accounts-oidc/README.md
parent7d86af2b004ed57d4295b1396fe24a14c8407c56 (diff)
downloadwekan-3d63b6006b13942a887bbeddebb055d697451223.tar.gz
wekan-3d63b6006b13942a887bbeddebb055d697451223.tar.bz2
wekan-3d63b6006b13942a887bbeddebb055d697451223.zip
Auto linting on commit
Diffstat (limited to 'packages/wekan_accounts-oidc/README.md')
-rw-r--r--packages/wekan_accounts-oidc/README.md75
1 files changed, 0 insertions, 75 deletions
diff --git a/packages/wekan_accounts-oidc/README.md b/packages/wekan_accounts-oidc/README.md
deleted file mode 100644
index ce0b5738..00000000
--- a/packages/wekan_accounts-oidc/README.md
+++ /dev/null
@@ -1,75 +0,0 @@
-# salleman:accounts-oidc package
-
-A Meteor login service for OpenID Connect (OIDC).
-
-## Installation
-
- meteor add salleman:accounts-oidc
-
-## Usage
-
-`Meteor.loginWithOidc(options, callback)`
-* `options` - object containing options, see below (optional)
-* `callback` - callback function (optional)
-
-#### Example
-
-```js
-Template.myTemplateName.events({
- 'click #login-button': function() {
- Meteor.loginWithOidc();
- }
-);
-```
-
-
-## Options
-
-These options override service configuration stored in the database.
-
-* `loginStyle`: `redirect` or `popup`
-* `redirectUrl`: Where to redirect after successful login. Only used if `loginStyle` is set to `redirect`
-
-## Manual Configuration Setup
-
-You can manually configure this package by upserting the service configuration on startup. First, add the `service-configuration` package:
-
- meteor add service-configuration
-
-### Service Configuration
-
-The following service configuration are available:
-
-* `clientId`: OIDC client identifier
-* `secret`: OIDC client shared secret
-* `serverUrl`: URL of the OIDC server. e.g. `https://openid.example.org:8443`
-* `authorizationEndpoint`: Endpoint of the OIDC authorization service, e.g. `/oidc/authorize`
-* `tokenEndpoint`: Endpoint of the OIDC token service, e.g. `/oidc/token`
-* `userinfoEndpoint`: Endpoint of the OIDC userinfo service, e.g. `/oidc/userinfo`
-* `idTokenWhitelistFields`: A list of fields from IDToken to be added to Meteor.user().services.oidc object
-
-### Project Configuration
-
-Then in your project:
-
-```js
-if (Meteor.isServer) {
- Meteor.startup(function () {
- ServiceConfiguration.configurations.upsert(
- { service: 'oidc' },
- {
- $set: {
- loginStyle: 'redirect',
- clientId: 'my-client-id-registered-with-the-oidc-server',
- secret: 'my-client-shared-secret',
- serverUrl: 'https://openid.example.org',
- authorizationEndpoint: '/oidc/authorize',
- tokenEndpoint: '/oidc/token',
- userinfoEndpoint: '/oidc/userinfo',
- idTokenWhitelistFields: []
- }
- }
- );
- });
-}
-```