talksik/ipe
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added comments in config example section in README

Browse Source
This commit is contained in:
claudemiro
2016-03-06 00:17:19 -03:00
parent 9dfc8c9cc0
commit c272361861
1 changed files with 17 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+17 -15
View File
@@ -49,22 +49,22 @@ $ go install github.com/dimiro1/ipe
```json ```json
{ {
"Host": ":8080", "Host": ":8080", // Required
"SSL": false, "SSL": false, // Required but can be false
"SSLHost": ":4433", "SSLHost": ":4433", // Required if SSL is true
"SSLKeyFile": "A key.pem file", "SSLKeyFile": "A key.pem file", // Required if SSL is true
"SSLCertFile": "A cert.pem file", "SSLCertFile": "A cert.pem file", // Required if SSL is true
"Apps": [ "Apps": [ // Required, A Json arrays with multiple apps
{ {
"ApplicationDisabled": false, "ApplicationDisabled": false, // Required but can be false
"Secret": "A really secret random string", "Secret": "A really secret random string", // Required
"Key": "A random Key string", "Key": "A random Key string", // Required
"OnlySSL": false, "OnlySSL": false, // Required but can be false
"Name": "The app name", "Name": "The app name", // Required
"AppID": "The app ID", "AppID": "The app ID", // Required
"UserEvents": true, "UserEvents": true, // Required but can be false
"WebHooks": true, "WebHooks": true, // Required but can be false
"URLWebHook": "Some URL to send webhooks" "URLWebHook": "Some URL to send webhooks" // Required if WebHooks is true
} }
] ]
} }
@@ -79,6 +79,8 @@ $ go install github.com/dimiro1/ipe
var pusher = new Pusher(APP_KEY, { var pusher = new Pusher(APP_KEY, {
wsHost: 'localhost', wsHost: 'localhost',
wsPort: 8080, wsPort: 8080,
wssPort: 4433, // Required if encrypted is true
encrypted: false, // Optional. the application must use only SSL connections
enabledTransports: ["ws", "flash"], enabledTransports: ["ws", "flash"],
disabledTransports: ["flash"] disabledTransports: ["flash"]
}); });