Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

clarify credential renewal in README #4

Merged
merged 1 commit into from Mar 12, 2018
Merged

clarify credential renewal in README #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.jp.md
View file
Open in desktop
Expand Up @@ -14,7 +14,7 @@
4. （authToken、timestamp、ttlが含まれてる）credentialオブジェクトをクライアントに返信する
5. [例：JavaScriptとjQueryを利用したリクエスト](#例javascriptとjqueryを利用したリクエスト)のように `new Peer()`のオプション引数に認証サーバから取得したcredentialを渡してSkyWayのサーバに接続する

**※注意: new Peer() を実行する際は、毎回1〜5の手順を実施し、authTokenを更新して下さい。** ネットワークの切断等で前のセッションがきれいに終了せず残っている場合、一定期間、同じPeerIdとauthTokenの組み合わせで再接続することが出来ません。authTokenを更新すればすぐに再接続が可能です。**
**※注意: new Peer() を実行する際は、毎回1〜5の手順を実施し、credentialを更新して下さい。** ネットワークの切断等で前のセッションがきれいに終了せず残っている場合、一定期間、同じcredentialで再接続することが出来ません。credentialを更新すればすぐに再接続が可能です。

## クレデンシャルの形式

Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Expand Up @@ -14,7 +14,7 @@ This repository contains samples that show how to calculate the credentials for
4. Send the credential object, (authToken, timestamp and token ttl,) back to the client
5. Connect to the SkyWay Server as normal using `new Peer()`, passing the credential as shown in [Example using JavaScript with jQuery](#example-using-javascript-with-jquery)

**Warning: Start again from step 1 and create a new authToken every time you call `new Peer()`.** If a client disconnected uncleanly due to network or other problems, the same peerId and authToken combination cannot be used for some time. It is possible to connect again immediately if a new authToken is used.
**Warning: Start again from step 1 and create a new credential object every time you call `new Peer()`.** If a client disconnected uncleanly due to network or other problems, the same credential cannot be used for some time. It is possible to connect again immediately if a new credential is used.

## Credential format

Expand Down