Skip to content

Commit

Permalink
v5.4.2 Use endo-core 14.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Roy van de Water committed Aug 3, 2016
1 parent a6342fe commit d7587bc
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 3 deletions.
9 changes: 8 additions & 1 deletion README.md
Expand Up @@ -100,7 +100,7 @@ After the mapping is complete, the Endo Service should respond to the device tha

So, to send a meshblu response, the `credentials device` will send the `flow` a direct message as the `user device`.

# Creating a Channel
# Creating an Endo

## Install yo and the generator

Expand All @@ -118,6 +118,12 @@ cd endo-github
yo endo
```

## Setting up the Oauth Device with Octoblu

An Oauth device must be [registered with Octoblu](https://app.octoblu.com/node-wizard/add/551478c1537bdd6e20c9c608). After the device has been created, use the `Credentials: generate` (and download) link to pull down a `meshblu.json`. Save that `meshblu.json` to the root of your endo directory (This file should not be checked in, and has been added to the project's `.gitignore`)

Use [endo-doctor](https://github.com/octoblu/endo-doctor) to finish configuring the device.

## Modify the passport configuration

The passport configuration is available in `src/api-strategy`. It's purpose is to map the API oauth profile to some required endo values in the `onAuthorization` function.
Expand All @@ -126,6 +132,7 @@ The callback passed in to the `onAuthorization` function expects a user object a

The properties listed are all required. However, the developer can add whatever additional properties they'd like. Keep in mind that every attribute that is not under the `secrets` key may be made available users authenticated by the API. In other words, if a user uses Oauth to authenicate the endo service as Twitter user @sqrtofsaturn, they may get access to all of the properties in the user object that are not under the `secrets` key.

If you wish to have an API that doesn't require authentication, we recommend using [passport-endo-passthru](https://github.com/octoblu/passport-endo-passthru). It will use the user's Meshblu UUID to identify the `Credentials Device`.

### User Required Properties

Expand Down
2 changes: 1 addition & 1 deletion app/templates/_package.json
Expand Up @@ -37,7 +37,7 @@
"cookie-session": "^2.0.0-alpha.1",
"cors": "^2.5.3",
"debug": "^2.2.0",
"endo-core": "^13.2.0",
"endo-core": "^14.1.0",
"errorhandler": "^1.4.2",
"express-meshblu-auth": "^5.0.0",
"express-meshblu-healthcheck": "^1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion package.json
@@ -1,6 +1,6 @@
{
"name": "generator-endo",
"version": "5.4.1",
"version": "5.4.2",
"description": "A generator for Yeoman",
"keywords": [
"yeoman-generator"
Expand Down

0 comments on commit d7587bc

Please sign in to comment.