From 0c169d98040aa0a5a7e39828ee1ec82c33812850 Mon Sep 17 00:00:00 2001 From: cyberjacob Date: Thu, 20 Jul 2017 22:48:50 +0100 Subject: [PATCH] add example configuration to readme --- .idea/workspace.xml | 100 ++++++++++++++++++++++++++++++++++---------- README.md | 27 ++++++++++++ 2 files changed, 104 insertions(+), 23 deletions(-) diff --git a/.idea/workspace.xml b/.idea/workspace.xml index 5167a2d..8ea6427 100644 --- a/.idea/workspace.xml +++ b/.idea/workspace.xml @@ -2,7 +2,7 @@ - + \ No newline at end of file diff --git a/README.md b/README.md index 01dc9f8..fd9aad9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,29 @@ # hass-asterisk Home Assistant platform for Asterisk integration + + +##### Example configuration + +``` +asterisk_ami: + host: localhost + username: admin + password: correcthorsebatterystaple + monitor: + - 100 + - 101 + - 102 +``` + +The platform requires a matching entry in Asterisk's manager.conf or similar. For example: + +``` +[admin] +secret = correcthorsebatterystaple +deny=0.0.0.0/0.0.0.0 +permit=127.0.0.1/255.255.255.0 +read = system,call,log,verbose,command,agent,user,config,command,dtmf,reporting,cdr,dialplan,originate,message +writetimeout = 5000 +``` + +TODO: Confirm which permissions are actually needed