From 8ac7b4c32960b9b688194a69ae4085f71d53f0ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20S=C3=B8rensen?= Date: Mon, 9 Jul 2018 23:39:38 +0200 Subject: [PATCH] Documentation for Cloudflare (#5723) * Initial documentation for Cloudflare * Corrected typo * :pencil2: Tweaks * :pencil2: Tweaks * Changed records to be required * correction about records * Minor changes * changed ha_release --- source/_components/cloudflare.markdown | 58 ++++++++++++++++++ source/images/supported_brands/cloudflare.png | Bin 0 -> 9345 bytes 2 files changed, 58 insertions(+) create mode 100644 source/_components/cloudflare.markdown create mode 100644 source/images/supported_brands/cloudflare.png diff --git a/source/_components/cloudflare.markdown b/source/_components/cloudflare.markdown new file mode 100644 index 00000000000..c088bc1e8f0 --- /dev/null +++ b/source/_components/cloudflare.markdown @@ -0,0 +1,58 @@ +--- +layout: page +title: "Cloudflare" +description: "Automatically update your Cloudflare DNS records." +date: 2018-07-10 20:08 +sidebar: true +comments: false +sharing: true +footer: true +logo: cloudflare.png +ha_category: Utility +featured: false +ha_release: 0.74 +--- + +With the `cloudflare` component can you keep your Cloudflare records up to date. + +The component will run every hour, but can also be started manually by using the service `cloudflare.update_records` under services. + +## {% linkable_title Setup %} + +You will find your global API key in your Cloudflare account settings. + +## {% linkable_title Configuration %} + +To use the component in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +cloudflare: + email: user@example.com + api_key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41 + zone: example.com + records: + - bin + - www +``` + +{% configuration cloudflare %} +email: + description: The email address for your Cloudflare account. + required: true + type: string +api_key: + description: The global API key for your Cloudflare account. + required: true + type: string +zone: + description: The DNS zone you want to update. + required: true + type: string +records: + description: A list of records you want to update. + required: true + type: list +{% endconfiguration %} + +This platform uses the API from [ipify.org](https://www.ipify.org/) to set the public IP address. diff --git a/source/images/supported_brands/cloudflare.png b/source/images/supported_brands/cloudflare.png new file mode 100644 index 0000000000000000000000000000000000000000..52f2820974908b9ceacdd1ddf91b59f653bfbae5 GIT binary patch literal 9345 zcmZ{KWmr^Q)b=4HBo##(5fG8iL0V8`NNJE%x)G#ds1cBm?vfUep?e4cMX4blkQf-L z0V(O`JL7wO*Y*B+e=wXmv)A5x-D|CT-TTaZc&YJ%;wHmQ001bU%Fna`0DlC$-X$Rd zU%9Px!oYu|Zpua;06=yd_lGw&54!+>`vCOWQ(d2#t$AlB69d@7--Y->;{I}*qViO4 z=d>lnmUt!2$LPa{&&S;*M7CT)iWtP7wq-pW^$BStEt|WscDv zI{|V)K5^pyZl~?`<-7+jnT=%=TOH^KiRfwVdv>+d*HUPtFrOwyYoDG$Q58x$z>X(98A>{-4t0iZv9HajHv<0#tW+a!C6ev=CBIJmvT2G@tMQ`Cd%M-{HSC_sirX|1D$J3vWelooh5NiA2d5ehUn7N9z5LK223t1q4;RLn z%DZBo2&{WP9-T@@^M})QgLgzRzDp%f51L}=sMK)@BU2WgMTDV$E&UED2nPX;uT)!o zoLEvu$Rg;qY|;j$$2qrnwVRzZaeH58={0ZdZ5nb6=&y+m+}6p`P&-z*IS#jXh3*lG zgUEcQkA=hxK(Jf4hyGw=FnUA-XD>enr)v#ClUJ#&IwXHJ{bz5n`u%HD8R5|xZcsmc6g%0-8$X@r0Rkgs+~2I}*y@^Kcy zBj@C**!N!K{|ri%NadweSo}cONxHxS#QBbg`&c;>k^e%PDTe- zQPxmCuYJkw9V-={K_B{Gl}89w5y#kKU%zU|AlK>)onO)F#sKsR%aa###WC*y{>^e zevK~%6``qSNeo1)`XKt-zV0B|1-LEER0rUz6nc%c_`R`kO5C0o{oICCG81wb3Bum} zgfqIZJd2lnG2Bp>90E`PU0#?Li*Ao_2Y{79&K)76NMF!HO$h{7V0;zO!qafuMc7>x zYQB;h0-%{L_fO*ROVVIq>j4f+xb1y2VH+PBTqwImF!b14?IXBM#ANJ}Z$1sV{Vc*r z0s#2oYvn~`y7<#cOESDXaR4q>k&@DDq^PcrJCE={${7j5_*y310sPZS2|;`L>oO=q z33(T~nB|F4YHv9lcdt`$+%2d0cGne?PvZr=$T)E$(Onk~?q9isTLsuO-*!JBRdsN_kdcvH zC@62YOJ-T8G6)xl*y0L-@^wqqK00(>3Xc3iDJ{nQdALB1U_(9!0RkwxkH zQss8xd?BG}M+FBd3S8M1=bkL5E*PJOq0m^gsighibz1dw7Zrz+zO`9GJCNz_&jIs^ zq6(bBf#FSsr7q;{2bFvT?#D-Bm4W*PVK7p%hiX&jo>*c<5VqIhYtk6{-L*yY>xi&f z*#4`f)S@N4PWY{TPcKhDCoQzew$9~*$Ph0R5G<(2jkhR*4BYtU3{H2JGRxMP{n~e2 ztD{{~=D$}tEPtX=5+Kgh4@;);1L!WMHBD71a;A^Y{|qby3U{YL9;|n798B+R92h!# z`tjC8BXJ~=FW3Vy^rYU!bfE%Z=fMG$nEru5Wl4cDa8iBq9F~Dw;GpR|d`{pV#pZRfm5VFBhlOv)F@P2Llwn@@E;Hb&cc4Q;1Hl-qEyvykUYplgf7;?X=22hz&WW?&=rkp8I7jv zH39m-^R3VWdl-nsV?>W6n1R89%iMU?LBwV!eSKbMFv9VvUvB#76YTUB>;HWE2(MbM z>??scQEmmf^Ett>q?V@nT3>b1ltF2q11@bzMuP8#wd4i5mbT=H-+f8)`<*0pH8?Z0!=gT7%#u3s zE)eR5Yj44Ylvf8ChoB*tP!ek9O$PM7s-aSh1*Blz00^Q6&Gu#wiH@sISI(0ybHf~# z3S6%NMv@M=zNdO2eP529HJqlv(=aj7Y?(OF7C+6qup}34pGU_XKjqFQ8^sj}T`K5) zM6lQ1FUGcc>CeSHm%6u06-04i52xh>{JgQOfh)@hxp(I|Qi1xZA_(4Q1rT0%zB*|z zx+sr(K`qC}Zz}Ik$JA9&pkeMl|KKoAA`ou>Xc5O_z&>@@U7RN`Hdytik1Elly6M-^|PQ}OLY89qvXPXJWwxgij0tFIDQNm25G zl+qBGWhcfcv9&KRKa!Q+G>0XN}<2hRWNslf8iN;yR-cVTHU61o=HjA4&klwP67%fDB17QuEqZ6ng4a1R@^y)S+4&*wTai12i3%Zs}H}j z!>!zq#bP3=Ir_6X*Pk{%sYMf`Tw-pU>x{Z5vJIc|z#;`M>2n?TT&S&@iKyTC$R14( z^_ZW8*eof{;s2pmkIa6 zUggKLF##j2m=*;eqVBi5I+Nf?G`Se)dDp^O6PJ!++`JW8z-QWN(%WEHk3ZQpNqHBd z0(?~odgHX-WedC1-RK=3ZIAS4t`zHVtMgwwBW;W<3bt9s^*|C75J0q+FEG5ZC}0{X z4o>-{X% zdDhEC-8@%BsZ*7PGFTnmBEc+*`-^>fojJqT-AM!}z2E!YX$ZT^H~}+b^Q-Noz}9s$ z^*EIA)(228%I|fH)HwsRwYGPxji{DmnVOO7>s&)Gh7oj2^f z>^a=-m%0?DLLPE&fdm%+1(aG%t@knXA@5Zj*{ra=U5l1Mp7S$~1DAtt8@ob5RPHC~ zZ&;I$9oG8;uQ$;bOUAAK`|WXFys89$nu1O+UK?m**^u)vrF|oiEG;~I5XzY)w`nP3z^2UvTQ^n& zRfYt}!&=f?`(RF|#uC2)WmaU6&#+3l4yjbDBP(@oh*kNF-+j=$*W5J5pNRS%)m%MY zL1-oM8&FvHPWM|O?%U_8OygME!_DdUBCe_n7=k%*dssZ)Mzs6BHJzVizttYK1TJ9> zPITZM>=JEsYmOWfmu;fLEDdhd-!TnniZ8nsdr=x*C+y1|N1}i&YIK+OKBD&c?j;+jazG zhf^n44o(8T?u6m^<*(>dAEMB4({l^Et$9c;7y^poj?)#X^}LgoAJo$Dp&EB%9Gh9j8&MmC9_3e{0tXXBdO|j8UN|GN26DOOsO$YF$O!?wGxpuMlba zuL>6U>HKTlG-Pw|I2NbgBF%jeDy{OI!I7Z{HGM8DS1DDwZUvAta6BZawC*TuJ?s`= z0`m(TX_e#=Ti^nmN2&rmD?LXa(s&2$@64}v>~Gnb_u<&(>Pi4@)OOZDj`7tDpjrZ3 zkbKM+wbi{urO$-aZzIjlEwJ0JLHwE2?eCsDUT^JqlMJ7ya)P6R@{j4=xSw73p}bqY zUBdU_VEkd{<_m_GdDjXt9!KxNb+ICMRRD=Q1wj{PtLUApI>r#W(XqRgflCIGj#F2C z(DH3YkS0b1^dEZM71}3S%x>^TWN&s%lJFOGo=&zMNVdHPne^||9g)S)tU*iW{5Njr znxBsiHSAnQ^yp5PYvGbB4irsu^;fnAnnvyUyJjyOuP;3yQ|QYc8r>-w99|({$J7`T zOabN^{8qd-W8Qa6jlNnUgS2@gXmW8~lJ#aX;3h2}be$Cjw*{vJ>HE`*dDaD4bo(hS zCIj4p+q2x;fRNk1CJ74H|JV%!sUt%gb|6P$j4zJkU}3vzAb(B2N!=l$jwWpP^G0D# zW2@e!JBNX`)jX=C!SGig=~b9phTH+??-KU=6vELuHM-&02}@JJsh%S+6*xxD92*#4 zT?gwC^?2h}1*jpa2B2q^Np~LPg0!{R0lNB|&2!_|3;)xW2A(A5^1B(h0t0tM^l>fR z>pWvS%e;N|a`DBS1YHg-?g2#Ct+LW+sq3!xkN=^O)5Y2exLyZzeb~MD@zeC4*1B0v zOY!yw^<>l?FcRSTLYeA1c5)tObGb3~(+u<#0F=iT&G}_ImZ(e|BWq9ze~S9n{&g&i zjN8CAqYt8X>3C}4OknD>_VO$JMlnyq;Hzm20m<-UAIxFREugCKaAijpTKr%N_jCb} zxPLi_9mUBvNss8qIMs`>*TL^{CXn+zJJDEJTYYMaJ0gSL7Nq(uFKdHcXcpG#|Hpq$ z8XJCt5kd`WmisJp1QeixG(T_Y0bSGLPBF{ZPNrdo<$s&}ABO+SKC5PpdPdFFLp$SHAp~ht<2czBG2E>QbQJQddg5_Gs`_Qd$mCe) z_2d)gF5;@kWe>RPP!aTE=C*^D{NQO<*Bc9@r-|+?9h;}>>g25#9@YFpq82obU@|%- zFht}0DKNXR8ss$yovuBtv-WCzD_Ju{Y*Yml%^Z1#GRdFH!ynC9i}6v z%8T~dScxIm9$z=ZGS5Ei{3s4)o(hcFL3z~ZBAg_B4O2z;7yq(3=L=b>-!F$UP=2EB zNgP&@H0DjY$D#fW+XHnCpOP(4d}zn&rfj35EYV)p&Y#J=qh{&i6)v2QI-2s$<9fiD zpB(7sDvm&YbeSO{D}i|;qMq&1e@>^_i$&JjU0tcv=yp7^e`DE3eiBeX>YFw$KzQe4 zql44EsABh7B(!;+8Zy(zQ%}{~TaBz>9RH^6+hX{5O8qk^)8X&?=vG9Q&Lxhbii~Zp zlL|TVty9a3?0sd1En{1L=~}vobFDWcE2?Zc#MJv1ukhd1=wJ0K`2R z9GVLWxBF=6_+@JM&30V}HLC|X7VUToiQIa%NUOy!2_0TX|Ltfns zGv;t#%5;W!R}kTJ-{tYmtH*EN(+qS84$rwnB3$5hb@ykJGs66p#{TSmS2hrL;b5A6 zz_fDP>$_p8ks%Ho3x8XQPi#uv(`mL=t|7Eefwu|U*!s+JvRY2w=I3HbPcz#tP5h#%l803HnLPwEgb8Yz z{PLa00b36B^r@Fgkmtz_RIXrUyB;%CmojfZ+9LSaI+vcscQF0YBTJ*-DUX^Gm%;Rq zwOW0FLxnebiUA1Bn=+H>xhIL#hnGk$k#}wiXzh8JHJG5V@rz!5doH)EAUlibx@V5W zBEIwU4ef+U-{+jhHz&+R@dm))Bo2etKPU)F@OJ!ENUH5NJfUViW)wqwL#YAfC9pDWjf z1mAJq0*UR?!e+n73C;p({?1E;v7PJ8!)WL=cBLBX2_o=j4v?qq2_-bTfDmy*8mV%^ zmYY2*wu#!gf^Vc`kwLD#D{W=REIo#Fx7j@DcCV=XfCd#>H@=Q8U25hMjZG5rUbJ+z z!&%HHLvAFIR?{SEQC6)q+16f*L0Cjr?Rf~zCW zgG2vC7uPP}H=KUi4ve@Lal}?-+qmQPpZF!-&aJDho)F_I9le1K zMfDjj?^zX`GLKOoU8H7z=wYaHHI6wEAv~dQ(A(;4@@cEygq-O8dgw3^R64}@%13mJ zkd}~lB8kVtKB2tl2>MIVT0Z8Kw1U}Lh#WSLzV&MoMY!3AlT#@nIlK=Icq*Vq zc{3Ssb=7E@Gjz!Z3zvw^%)(mu&Vqsl{t;~pKrLLf_v;u|Lya;#xIFU&lHThbbvipF zv!U@MU(jPz&Obp2C>vk9)GFzg??D7$0y5b!f_L8t12+R_AN&U9_fF}0M6aGX_I(L- zQy|XbvNAgD{8jp#^VThM9;)&P#)-iLFPKf}4{D<0&2KCS^80YWxzM{vo||;!V?9+T z$}>Zqa=Tt6l%fy@uoyG z`MWyQOy|N8hhG$RLis}AHH&`1VOtynh*nDcz4@rDk42>2b&7a1gDY5DsK!s@RF4N( zg7%D$Tx;H?UEKoyk|%v-fp?a#-P;`TMvsI?p1kth;S!+5Kfq6UM(7OTx*kxBka<1} z$41WD%W21Aex3|KJ4S`txka;UMoz-`bxp5U>ynE~dpRdB;r$Zzahb)(4sBCiD0S)o z@av2JA}_7F*BU+k!pSeky_Rh14Ii&H8VV!xJUJ#AJnGa8(sqHs4p2ITIb7KMQtia} zCQ#X0;YnhTv}#6VCGoN`O#vN<^39<`qnZQQZPehZJNhe)a2Bls`73fu(yA?+y9-%+ z4|{#E6jhnKY7u!$cz#M_H^|~3>{We(N0e-~+|S&6?XEpNS^}-CZN)0?&qOTbEJS`Y zqhBDNgiU8;9a$Cfy<=h>ZyC&9`=Fa}&BLWtMyqPAP*^I@JSSeg{>kTO_fjmVPg;lW zHLqLPSVp|GP1=zXZJCqJq->&MlyTLe-O!D{W;yFcy?mqbUskQi#CsaAXKceV&Gf%o zv{MPe4$`7T&qOtn+S5aC%x146!BDg7me#_E{@}LmaBfKc88ZCcGFMzN{bJ(h_q*B8 zf?$J!pHhpDdP$`U?0RlQZ$Tcvy%{S2Wtd%c9PM7pvwbV*?M#k&2`akp-A-g#irQw{ z)}3j&Lp!J+Xmw4d!2ps^fy>MDdYh$z6MQVZp)>ZgH*<8rZM09tyPk3sX7n~XE4)y@ z^2f4Dzjm!%lmAgp>O<874xmm#X*#w|*-Of-@>$)}%bK(GO~fG%~kU73_od%1JIIjJuZQyu73ANy(M#fVgC>*i3IpV`>68r|Fk@AoAQ zqtULRp6CEQ>tpThV!FAJM1jbhZ@Ex{QLzbqmnbe=ccQy+3b#t z{nnB@i2;|5l{dTmt0M5rLN45I0klHZ2oK8#0_lJ4K+zQ+)5Cc_b~8b;DX?#o{@X5( zI!$4!qt2+bv}p&6z*1bKFQTt3zMV;FmVWw87{q$5HjGS?REo#@b%gx+wExgdBLDYh zjcDGQS^vn_2w(URyk2cgR+UL)M}#*#{E4+i)^!y(z3Pa5#tR{8s6FfJ@EpIvCWx1J zfDn5gYMwzPQbb1mkEt$pOPBb?le^Kl#xW2J2#En=z84TkI3nmVRu% zr^$vWn%i4If&5IH>)WlznFAf_&jNCgrr7nsLul zHhkyL8%vkew~=4Bsb7_NTS%5{u}4*lG zdx_wpRs!n&GC`&CtA3(ieteuq)JIVN1SIvIMH7o%3-jH?{Lx(y=g;2i5$5oN4}P80hML!B02FS6KR7#X*BHK0)v=`8JDxv z3|+qvC`2+^Ay)Q`#6eI!4~X4!v~}^V0pfaks3+xK4f$AoTsyN>W{G#1Lq|BD97SGf z9Ix`L)QM#9fd7EE$204w7-kansZtZ#y0|a&F!@t17N>aVGv8RY$G!q7;WaC5A<*8! zmM$_ATc&q&)v>CAgHPEZE9}+yXjp)%nd@t&dedK82U_RVZ^yJmq^1H^HiMnC$sP(rq%dsM*`rywkHm?afVhp2xnP?5-9+E(xYdk|J HScLvR(Pg|8 literal 0 HcmV?d00001