From 3aae508fe539901e943d78d5223277d3ae984eef Mon Sep 17 00:00:00 2001
From: hexa- <mweinelt@users.noreply.github.com>
Date: Tue, 18 Oct 2016 22:18:30 +0200
Subject: [PATCH] document the matrix notification platform (#1215)

---
 source/_components/notify.matrix.markdown |  39 ++++++++++++++++++++++
 source/images/supported_brands/matrix.png | Bin 0 -> 2239 bytes
 2 files changed, 39 insertions(+)
 create mode 100644 source/_components/notify.matrix.markdown
 create mode 100644 source/images/supported_brands/matrix.png

diff --git a/source/_components/notify.matrix.markdown b/source/_components/notify.matrix.markdown
new file mode 100644
index 00000000000..9cee32ce4b7
--- /dev/null
+++ b/source/_components/notify.matrix.markdown
@@ -0,0 +1,39 @@
+---
+layout: page
+title: "Matrix"
+description: "Instructions how to add Matrix notifications to Home Assistant."
+date: 2016-10-11 23:51
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: matrix.png
+ha_category: Notifications
+ha_release: 0.31
+---
+
+
+The `matrix` platform allows you to deliver notifications from Home Assistant to a Matrix room. Rooms can be both direct as well as group chats.
+
+```yaml
+# Example configuration.yaml entry
+notify:
+  - platform: matrix
+    homeserver: HOMESERVER
+    username: USERNAME
+    password: PASSWORD
+    default_room: ROOM_ID_OR_ALIAS
+```
+
+Configuration variables:
+
+- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
+- **homeserver** (*Required*): The base URL of the homeserver, where the notifier account is registered (e.g. `https://matrix.org`).
+- **username** (*Required*): The username of the notifying Matrix account.
+- **password** (*Required*): The password for the given Matrix account.
+- **default_room** (*Required*): The room all messages will be sent to, when no other target is given.
+- **verify_ssl** (*Optional*): Verify the homeservers certificate. Defaults to `true`.
+
+The target room has to be precreated, the room id can be obtained from the rooms settings dialog. Rooms by default have a canonical id of the form `!<randomid>:homeserver.tld`, but can also be allocated aliases like `#roomname:homeserver.tld`. The notifying account may need to be invited to the room, depending on the individual rooms policies.
+
+To use notifications, please see the [getting started with automation page](/getting-started/automation/).
diff --git a/source/images/supported_brands/matrix.png b/source/images/supported_brands/matrix.png
new file mode 100644
index 0000000000000000000000000000000000000000..807049fd075863ac5aa682bad0af005ac5060d37
GIT binary patch
literal 2239
zcmbW3X*kqtAIJYRvP>vM*%Cw9M#y?(9}FEb)Q~YzhGcEbxklCrlOzlpB~i9eS(2rZ
zttorbObfC#nXw(~*v@234_BS*dGow_-rV>7x$gV>`~BX1?vyjm_M#%PA^-r0!X0c8
z0Kg}+bG|OLcW0f;<C*VlhjB0uoLiVb4)2S_09Jls7colk5Z?d{0^{p<?P?Fk3;=|D
z;kH)pkzeQY8Gn5>J!DD7|M+<ggijy|&p9v8fQZ75YB%-y#sE{kSx}**<+1jBrC~zy
zc@Fu9D#6^T)^8#@-B}D&qwR$J;pf@<b!k%sXg7$@6aWY)KuLW=x&rbF*y|KH366pS
z--t$OgCjOk<|~|AT6+#@HSwxlxE6nu(1Ltjt$2I{QbLUo(42?@015zL`2Z&WZk69)
z3H=w8WPsm50t3GQ=oSE!r$jx0@ErQ;bTl|<h98Bthr(@2&payx1FcrOVWrt{M&`UV
z6xe<JE4tg_0Ck@?VRbZHpj)6_P}S4Y1N8fzpjwem@k>5=rMYpVCckK<Nl#t+7IJ(-
zk*?n{(j;Hmlf~$P$t3g~-7a?40lVhjT3;tAf({19)TMFXPB*B<N`~4iAIPujk4uAc
z$6pM)<m*iIx1QUhv$}4gn1}t$>|`D`Zl8{VmR`YM$}{IgVA=|9IJ@|74HL=uW25QL
zsrq_ZA{gKFOG_t0!~*>@b+!l<;Wgsbx|C&knSi;QxFc8w1tm}(-GwO*$=y~ta*^CO
z<l6By|MIN9+jVdE+sE7p-VQ8XOIQ_a1W#c;rq>N8x7fUfvoXP*H|(fvlDHLAU;JR;
zT7rk6qDFTSEUteKa>{h#ML{nHa`{nAFD$p<W(n6{n&p6~3P_jjENAI$4j}>xIuK=a
zy@xSN1FB<;X93vEo2p4Dy#a=61(k?~_h7zLmZALTn92v9Ke*NCMoz`Ws3f80NE7yv
zClS187`zu#MkVqUHbe-g3cY2Y&(J(e36@_<%n)djQM9db<#k0sbDU0R&#)~=)cHfp
zUOp1Yv&D&-Z+x4Zw)KvyXmtuDZ`Tp#-`+#38!wjrFgW!Z{O-egUm19BcnB>5Y5w%W
zs%{n9!HAmR1#WdP8(5MUc8OIiOIS*~FcWec)a9Lv{Z96v7P&F#qkfltc{z&I@~A(u
zi_!M#@?#c@olUo28A-1^$7z*G<tSVL<GS|W=fs54Q1#*&hP@N_d~`ZdkX1XBcda?H
zkS%>RhH-pqTzKy|1gS=H@}M}dYOc5nI<k@>Ot#+v3+MCFk5gc<F%#}~e%W^Lh@Sa|
z2UIgVgOfr!@wX*Zg|YGul-6a(Q4yvLiJgX51KRvjYjmrQQB4kus*B~QlSgSEu2*+a
za(d&d=iwZMdEO+d!}!rt`<jq2`7PzqoCP*9h&9z|F(NrS1)VOOP^c8twkZE6Y)Fgz
zQ%-H^Y<r&GrDo0Zwde}Sn-aWGwYJTjzmaxx6M_=9k8h+(_f02lY$n#q)ir82TCFM@
zQi6#G(aLwjsIgqeBdo>K@Sx-v#2ZK?25X6t9i&W7kkK2VuwY-B;q{QSDN>)_-8PWg
zvsho!9Uv|`P?w68^BQ2;w}-%O((bXc<Z_$cuJ&^miUzaT2`+BQ3|b=F7;L0US*yRx
z%qm*hJim>uy4pRd*%bqi`KhULk6b)43o7uE!h5(K3T)PI$$Ah>c{!bB`d3DAe;U#4
zGvl*0Q{sY0G5DiBxw9Xy+sKXed4hg8gcmz<$>?18<VCX<sZ)j3t!={3_q`fK6h|vK
zG4S!Ymeuak=uSHg$y$Ed89TcsF4KE3O$s|Jt$l~gHrnr1f0=^_UD%@MdDnA!MSXiL
zp<}L*#+-Gg*{K6g13=tUdK>m)-)4b)^5Qk7Sd=*iDcDX3#aANao_~_ygz~<KTO{&M
zn(5oOm8!0PfN^&6CnOsjojyu>W)n}ENzW|Lso}aEJU)pw1bv>fE)2Vpr<^lBsVsjb
z>#11IPg^LXM}Qdc#PmK@wC9G6&Uy}*Ne_brQOxSJYEHZhFNbfBLYWDuICed2gQwP)
z?Q?X7_BFkbsqu{!$fU=2X3h(~NOyUtGP3HfKCHB0?4D~0-OgaFI&7%Ajn*&d$v+vq
zoH@EK4>7Zbu0)J|f3@13j_I7mA!r$4j(467O89L+vBEB@Go9&4M8k$N%=hz1TKSpc
z?kLaa$u^rhYZoDmOysc2-G5j`o}M?Yk!Q9KWxz|iEOfW<+~)kWYhe!9KuIwJn6kIZ
z=KFvGmAlK&$ia8wFNsY4L*&oQ+mxA#5Evfa3NP<TtbOP+Yp^rNm{NYDo^H#%sgJVw
zxy_Ft8?pOUCS+y*gzy>9{P_8Fh#6hfH3jwKP3+q(f0eT82aZ8l)x2BrDaIPU!|d7(
zFn0EaW5?EMg*@v9cQcx<t+8JO%%Q2dbah#Xf*XkzzADE(SCj7qZj<iQE~9J6Yk(M}
z1)oZY8MbvdEEdb2h?c$`+7Sw3r2Z-3@no$ac&IVF8x!gN($t43k?ey)zVGEOF3^JH
z#y#WA$;mC7Ci2+BiYAof1l0Ha?<!|~wY+#=5-XTtasqt~q(74mGAf685;U%kg-wzT
zH0l&x@ypMbh&CwZOEVIMo|pBm=$hM1{D6+m`u@fJTU14#$AA~@_)E(0(j0NpH{3X6
zjS^=THyPP#YsCXB!4&SaBvlz$=Kp2GU*7ty#vS;-Jo#Vq{f}~%r%?)Y-pu+2slX+M
z*LPIA$B<y9XHt@JjQ3E1ULLpdcx8Z=d*r7bkAGhdmn5<?+>D{tj`nv%YMfl~ua9@N
hz0(ImZR6huOcbs!ehheRu=67U;4o*~Dr=vF{{Ri#B%1&L

literal 0
HcmV?d00001