From cbdd4e428a89fed3e019629020b4d8487501f8d5 Mon Sep 17 00:00:00 2001 From: claudemiro Date: Sat, 5 Mar 2016 09:29:57 -0300 Subject: [PATCH] Better config example --- README.md | 28 +++++++++------------------- ipe/config-example.json | 25 +++++++------------------ 2 files changed, 16 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 6c8519a..6fb0efd 100644 --- a/README.md +++ b/README.md @@ -45,34 +45,24 @@ $ go install github.com/dimiro1/ipe { "Host": ":8080", "SSL": false, - "SSLHost": ":8090", - "SSLKeyFile": "key.pem", - "SSLCertFile": "cert.pem", + "SSLHost": ":4433", + "SSLKeyFile": "A key.pem file", + "SSLCertFile": "A cert.pem file", "Apps": [ { "ApplicationDisabled": false, - "Secret": "7ad3753142a6693b25b9", - "Key": "278d525bdf162c739803", + "Secret": "A really secret random string", + "Key": "A random Key string", "OnlySSL": false, - "Name": "App 1", - "AppID": "321", + "Name": "The app name", + "AppID": "The app ID", "UserEvents": true, "WebHooks": true, - "URLWebHook": "http://127.0.0.1:4567/php/hook.php" - }, - { - "ApplicationDisabled": false, - "Secret": "d6824d2fa32888931504", - "Key": "c8b30f611ffb13202976", - "OnlySSL": false, - "Name": "App 2", - "AppID": "123", - "UserEvents": true, - "WebHooks": false, - "URLWebHook": "http://127.0.0.1:4567/php/hook.php" + "URLWebHook": "Some URL to send webhooks" } ] } + ``` ## Libraries diff --git a/ipe/config-example.json b/ipe/config-example.json index f04e804..201149d 100644 --- a/ipe/config-example.json +++ b/ipe/config-example.json @@ -2,30 +2,19 @@ "Host": ":8080", "SSL": false, "SSLHost": ":4433", - "SSLKeyFile": "key.pem", - "SSLCertFile": "cert.pem", + "SSLKeyFile": "A key.pem file", + "SSLCertFile": "A cert.pem file", "Apps": [ { "ApplicationDisabled": false, - "Secret": "7ad3753142a6693b25b9", - "Key": "278d525bdf162c739803", + "Secret": "A really secret random string", + "Key": "A random Key string", "OnlySSL": false, - "Name": "App 1", - "AppID": "321", + "Name": "The app name", + "AppID": "The app ID", "UserEvents": true, "WebHooks": true, - "URLWebHook": "http://127.0.0.1:4567/php/hook.php" - }, - { - "ApplicationDisabled": false, - "Secret": "d6824d2fa32888931504", - "Key": "c8b30f611ffb13202976", - "OnlySSL": false, - "Name": "App 2", - "AppID": "123", - "UserEvents": true, - "WebHooks": false, - "URLWebHook": "http://127.0.0.1:4567/php/hook.php" + "URLWebHook": "Some URL to send webhooks" } ] }