Documment config.yml.tpl main keys

Signed-off-by: David Pordomingo <[email protected]>
src-d · Jan 15, 2019 · 8b14a9e · 8b14a9e
1 parent 362e256
commit 8b14a9e
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/config.yml.tpl b/config.yml.tpl
@@ -1,3 +1,4 @@
+# list of the analyzers to be called by lookoutd
 analyzers:
   - name: Dummy
     addr: ipv4://localhost:9930
@@ -20,15 +21,15 @@ providers:
     # client_id:
     # client_secret:
 
-# only for authorization with a GitHub token
+# list of repositories to watch when using authorization with a GitHub token
 repositories:
   - url: github.com/_USER_/_REPO_TO_WATCH_
     client:
       # user:
       # token:
       # minInterval: 1m
 
-# only for authorization with GitHub App
+# web interface configuration, only available if authorizing with GitHub App
 web:
   # Secret key to sign JSON Web Tokens
   signing_key: