yonote/yjs
23
0
Fork 0
Code Pull Requests 1 Releases Activity

created doc for the auth method

Browse Source
This commit is contained in:
Kevin Jahns 2017-07-19 19:17:36 +02:00
parent ef2cbf210b
commit 4e3a297efc
1 changed files with 26 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -55,23 +55,23 @@ Install Yjs, and its modules with [bower](http://bower.io/), or
[npm](https://www.npmjs.org/package/yjs). [npm](https://www.npmjs.org/package/yjs).
### Bower ### Bower
``` ```sh
bower install --save yjs y-array % add all y-* modules you want to use bower install --save yjs y-array % add all y-* modules you want to use
``` ```
You only need to include the `y.js` file. Yjs is able to automatically require You only need to include the `y.js` file. Yjs is able to automatically require
missing modules. missing modules.
``` ```html
<script src="./bower_components/yjs/y.js"></script> <script src="./bower_components/yjs/y.js"></script>
``` ```
### Npm ### Npm
``` ```sh
npm install --save yjs % add all y-* modules you want to use npm install --save yjs % add all y-* modules you want to use
``` ```
If you don't include via script tag, you have to explicitly include all modules! If you don't include via script tag, you have to explicitly include all modules!
(Same goes for other module systems) (Same goes for other module systems)
``` ```js
var Y = require('yjs') var Y = require('yjs')
require('y-array')(Y) // add the y-array type to Yjs require('y-array')(Y) // add the y-array type to Yjs
require('y-websockets-client')(Y) require('y-websockets-client')(Y)
@ -84,7 +84,7 @@ require('y-text')(Y)
``` ```
### ES6 Syntax ### ES6 Syntax
``` ```js
import Y from 'yjs' import Y from 'yjs'
import yArray from 'y-array' import yArray from 'y-array'
import yWebsocketsClient from 'y-webrtc' import yWebsocketsClient from 'y-webrtc'
@ -98,7 +98,7 @@ Y.extend(yArray, yWebsocketsClient, yMemory, yArray, yMap, yText /*, .. */)
# Text editing example # Text editing example
Install dependencies Install dependencies
``` ```sh
bower i yjs y-memory y-webrtc y-array y-text bower i yjs y-memory y-webrtc y-array y-text
``` ```
@ -166,6 +166,25 @@ soon, if possible.
endpoint of the used connector. endpoint of the used connector.
* All of our connectors also have a default connection endpoint that you can * All of our connectors also have a default connection endpoint that you can
use for development. use for development.
* We provide basic authentification for all connectors. The value of
`options.connector.auth` (this can be a passphase) is sent to all connected
Yjs instances. `options.connector.checkAuth` may grant read or write access
depending on the `auth` information.
Example: A client specifies `options.connector.auth = 'superSecretPassword`.
A server specifies
```js
options.connector.checkAuth = function (auth, yjsInstance, sender) {
return new Promise(function (resolve, reject){
if (auth === 'superSecretPassword') {
resolve('write') // grant read-write access
} else if (auth === 'different password') {
resolve('read') // grant read-only access
} else {
reject('wrong password!') // reject connection
}
})
}
```
* Set `options.connector.generateUserId = true` in order to genenerate a * Set `options.connector.generateUserId = true` in order to genenerate a
userid, instead of receiving one from the server. This way the `Y(..)` is userid, instead of receiving one from the server. This way the `Y(..)` is
immediately going to be resolved, without waiting for any confirmation from immediately going to be resolved, without waiting for any confirmation from
@ -181,7 +200,7 @@ soon, if possible.
* Defaults to `/bower_components` * Defaults to `/bower_components`
* Not required when running on `nodejs` / `iojs` * Not required when running on `nodejs` / `iojs`
* When using nodejs you need to manually extend Yjs: * When using nodejs you need to manually extend Yjs:
``` ```js
var Y = require('yjs') var Y = require('yjs')
// you have to require a db, connector, and *all* types you use! // you have to require a db, connector, and *all* types you use!
require('y-memory')(Y) require('y-memory')(Y)