From f40803ba6b79f3660cad1f0d11a99bdb94b95b0e Mon Sep 17 00:00:00 2001
From: Kegan Dougal <kegan@matrix.org>
Date: Mon, 24 Oct 2016 11:52:24 +0100
Subject: [PATCH] Flesh out config file to explain gotchas

---
 config.sample.yaml | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/config.sample.yaml b/config.sample.yaml
index a3fd0e3..5428c6f 100644
--- a/config.sample.yaml
+++ b/config.sample.yaml
@@ -38,9 +38,7 @@ clients:
 realms:
   - ID: "github_realm"
     Type: "github"
-    Config:
-      ClientSecret: "YOUR_CLIENT_SECRET"
-      ClientID: "YOUR_CLIENT_ID"
+    Config: {} # No need for client ID or Secret as Go-NEB isn't generating OAuth URLs
 
 # The list of *authenticated* sessions which Go-NEB is aware of.
 # Delete or modify this list as appropriate.
@@ -72,18 +70,27 @@ services:
     Config:
       api_key: "2356saaqfhgfe"
 
+  - ID: "rss_service"
+    Type: "rssbot"
+    UserID: "@another_goneb:localhost"
+    Config:
+      feeds:
+        "http://lorem-rss.herokuapp.com/feed?unit=second&interval=60":
+          rooms: ["!qmElAGdFYCHoCJuaNt:localhost"]
+
   - ID: "github_cmd_service"
     Type: "github"
     UserID: "@goneb:localhost" # requires a Syncing client
     Config:
       RealmID: "github_realm"
 
+    # Make sure your BASE_URL can be accessed by Github!
   - ID: "github_webhook_service"
     Type: "github-webhook"
     UserID: "@another_goneb:localhost"
     Config:
       RealmID: "github_realm"
-      ClientUserID: "@YOUR_USER_ID:localhost"
+      ClientUserID: "@YOUR_USER_ID:localhost" # needs to be an authenticated user so Go-NEB can create webhooks.
       Rooms:
         "!someroom:id":
           Repos: