From a2f7fd9d1590eabcae7f40c60cc2d77ecd89bde3 Mon Sep 17 00:00:00 2001 From: Rita Onwudiwe Date: Thu, 24 Oct 2024 15:51:47 +0000 Subject: [PATCH 01/14] social login guide --- docs/plugins/images/API_key.png | Bin 0 -> 6788 bytes docs/plugins/images/Call_back.png | Bin 0 -> 6210 bytes docs/plugins/images/adding_social_login.png | Bin 0 -> 5444 bytes docs/plugins/social_login.rst | 103 +++++++++++++++++++- 4 files changed, 99 insertions(+), 4 deletions(-) create mode 100644 docs/plugins/images/API_key.png create mode 100644 docs/plugins/images/Call_back.png create mode 100644 docs/plugins/images/adding_social_login.png diff --git a/docs/plugins/images/API_key.png b/docs/plugins/images/API_key.png new file mode 100644 index 0000000000000000000000000000000000000000..90de5b3e2be7cc4bcd16ba3440935e45f03f7a43 GIT binary patch literal 6788 zcmZvhbyQUCx5trCT1rAXB&0(a8i$rfdWJ4(1_UVyX=bE5r9l*#0fz?Z1_41DhLRXM zhw}2?_pWt+cdh%!bDp!;S?77qI(wh9Kl{65b+uJV2%i#SVPTP|t10PYVLc$bKR3aD zcz=}jt@w05J@D371!7f?GHl-)xQ;KiUSeUv6NqlC@$PK`Pc>6-EG#0*f5ro>>|9zb ztfzG9N-qukEcVPX3E-);(e^}3Hv1Aj3iaTu@i$@%U| zBm|e>7U^;u;Xfmb1j22&!?>y9p4jq}skK`41%2B$^Cyk%7IPj!HhO%Q-jrJ2`!ty) zfog1I3+S*PcM?yG=@F(QW|ueK>v>KUHyJm@nF#I<=M}t>%Aeiq1xmvH-fn-t>=}{o z(y4AI(UHGk*q^)MDwa6Ipj=9(n z9x($`WS|$}xCyahIJ;+b8H8|DkDH2_s!D@}Xa)gctiI|nyu8!8V3m=KIIujCm8n4m zgD<)YY;U7TF1N$So{q$t3$9lEy%fBxhqgm?+u|e&g7Il??swl~UWoD8onDK~u;{o_ zWl}9$=k(ay)MFEan@T8*K;_1DAgI>=p<&6?@1hSel1CS_(QbT)6F5S-2jeKim*3NbtBj z^@U0IdLD%YKvXchqMmcdG{WejG5v{1d8kf0G2z$PIa)xbDwG!C8@xx8p##K>?B2#yOy!l<#u+t~eDJ|O2VIQ_Fh*kjg{%}F-f_Ezft3I5wiB)l;G ziac9*d>^OhHDv@!+WtBG_fflA+`W#LVM5j)HdIBH%cS2d&34+3a#EzF6uhimya0FRCbyG+tF0^mWbw}exuFm zMh**4{Xo+W-|HB-7APB-JR-igbMBh@c1~*%lmGF?QE6^wyUvtp&q~$@S?)520EpjK zt)f*MwjyL764(-e#F54L(YE*^a{X_U z2CQ&j_C}T!9bSF#^vA&$%GDgRa^Qq2vBj#1g>}DuI$-xyFRII{V30+N-u4JkRs<=T z&2MZ(!1eM!rYwNPj<3#ujS#;srK>_2wCJSKFX69EsAw2C_A;ksf6}jw2?5E%kRqzGbB@L^J(| z2V3t`2k7Uqso}ZAF1ZR@!iTT@CB>ZWadCoS@w3+6S1ZRDVQcS|pD1ev28KS|wHxpj zqQAT$=6%Wozm{OXpa)Uv*kM8gR&mCxu~@nL>Hygk&xV#7$pzXRPb7Zm+1;a`a;yY!OZ?%HAoscbomt0swXGank0(oHRU)u(};|B2yTk@sbngC4fNy7B4-_cK#Cw|0jD) z@0P!2Ia%ya#Y1o5bLzqr=ufS@6$6-s!h#=bvOBdn4SZySRo%~jtY_yOM3f0NI>tYW zQ5ES?W=d-zzP@3dR+m-emP^s822#r%xoBm>sC8x z^7yR=5+@ToRwwPpZZGT{$&-fYiyV_BmU33n%E8r8AC8FTN4pIlBaWu+h%Oi^=sngY zK{ygAn(hn6U3t-4c|UO)*Lx`PkC)_mJr;rLK zC|P0&t4sF?m5FT?>)Rt(yv1I;)vtts1;zs1LC4DOiVa^2hlShpDbhaN#7B12wa+lO!|D$WAx57TO+&x^R7P5V^eGii_`yIUzb5e$dg)yk zE>q9Po;#Kp2#xD!Eq-D_@jDG?NIB^QTe2qAST!bp-E{b!s|l$q|E==rV`-XQ6B(>D01v3s zi23|%U3co&vULO3ZPSLr)J;SI?sH>FVq|djm`rj4+l7}ExRlF?Eq0*eGsCEFn#`!b z!93LaljiE1{Ln|ou#jKl-6wbA;(=y<-PW-|?CeYf=;V{+jr%`y3HWOcUa>B>+|zyu z!BzW)4KgI)@nhxA7XiWtk6f}9UOmA)`y8C}N%xE47bk4^U8c4yS)|QZ;J+EiC12r` zSgFt?hfL075|?eA_2J-hcSS|T7yc~Xp#tyRRiBzFbrx()_UpE613f)c5SzRp;F(d* zKNLkr{GS-}|D>=eivH^^Fgzyf27I7hs7w1rJWR|{)NczpU$dNoZDuNSw}sPi5-)w& zou1+8=ZPhVW)KP}j8&YuJ-1L|4|Wakm0mZk*(*Ea4#i-WzL`oN=jx@K4z4DE#Mj!c zL!c7AAk6q)remVXOAO`J67!KT;_urZqb*NpnP;P|%B(sU9Z2FK^sWN_Gh-Z4s_6a< zoujpuFwQyPmf@9M1 zXqjiirQO>p>6zv~gcXL*c>a}=xw-U32mWze2)tnTyUlwC-<#!voVe{C4ibG^JNEc1 z?Y?v>GKWqK^~Nq!Gp5F$wsj7UVgOm$5QS zQ;(WsHjh0^kcqvGR)xFt`GVh%aTZHoog0CJJM0^7^8=6i7^NY9657KBgHS}5O4_@U+WA|zwxZs1%jHAK#kH@_b%sMTwLxb)2t=$x_4{UFGcPN zwuX&deC;}`mw}<)OMBk6--*h3FUha`4L+d_zB}PPTyY5;w~q#>l6K{MDFW>EjiRuq zvkhC$GI0K(8mkus9F%WuCet%UYE>`(`fwrL1IeY&(aNnCL~|9(@fpjEVyGBz+Us|Z zi)JfUw*MeetvJ^;{wJJh8Q1VJUwj(NQ~nztHs`msa5ALFd(!q0FUmWwH^gur=KQ%j zf&(+vl&r^E9u9l?BJWnlZ>MRp*lseyK4B0t zKlQ6Fcg&O=&OM;jM>dVUVM3!oFEf9#9EJP_=t~FTN}yyJllh+_tHGK;tY-Fr(ea- zyKc{izH=EiPRGZ;maHmWa!sO4=fVr0;vn;Hcd0b1T_Wxq{5#E-$8OWPIpW(|7u>*Q z?wuwv$lo@#AM-XN?u@!+lsrjdm|qJNw7Xz)xm6eJ=M*5Hkk)2$Zqu6TzeFDxa3njg ziP6|IXPX9{$9o(g5JDbjbX~W>uO$PO<&@SHw@RoG*|=;v_8A1q>?N(YhuU@F<`9h~hf4)S_#BVLEn-tP@$s>i5_vf2a{-n)8#X>=tz>go+?z@JZ_IgDEpct={ihmTg*FigPYXowBBcnDnAW z_d+&HOQX+UzS+06CX(ir|M~Ul{$7$7>B|+hH%5IyC#*g(+Lr6|$qu!VW{U_AdN*22 znzmY0yKQ3sXD_nlSMP5LtC)=ti zu`}@!EmtTeJ=VDLcZ*5PIdX<+((;B2dD@N=5wNW`P^r{Mo|;sjnpZ7~+ww5W zxkWwGzS6lWljka7a4LW`Z(X=0A!!4f(q*4as`{KzJac-zY(zJSsQhN%qj7zGyR_Ta zj(6;HeiHrVaKnl|VJ63~UX`iYX8P>6B8j&w-E_mFPX1wad?jKJFH|ZZb})@F4kOcv z;>Iq-FB^UVTQR^5TS@gd%lyp@1Y|34P)EyCeduErgM?YpzD@#AR1$kdnu@a8uMUr< z>G7rO=JHyn`wSnO0+Z&b4h!HQjOWRvFU?WQRN1UYCT#A+>YbkJEfL$2UzxKH70YP1u}vC_s*; zDh>`&KF_p*f}}ngaP~<#d}Op~R!*(UYKkoS)fa5T>>tFcWTKsqRFiZN))&ke8sEg{ z#ChGDPkcrc$>!jIs8dJV{Y5ap7WIcR%osNYJs3D87MZx4m0YhZ*lewnrFCG|mG4Cq zmAywN_+0xO)L{#V+Iq^0ABc2-|}bA;Ix^Lwn(qYvDt? z(UY^7(_r#Qg1F*Xw9utGo?+#yT!rYbtJP^N3$$0g-G&?!EzAVk`^PWUrBX#apf-CYO!-78M-W?MOB|29Y zeUuqXN{O@42Ex^Wwpyfm+%}VX?dtIyW$Knc;Kbb3tA6Eqq5@t0yC&Nf@{XZGaf=*8 z{!Tr^Xej@1GBtBJr#u}6@L@+xRwg-V!{m1FRwhmtyErjv!fQ^U?!!c|sv9l+JDazi zqldT;{pIvpG?AHY92Xg#n5bbc&=Q0j5ZnxCo49 z_YXxLY_v9KjP=FtZ*shAYAGWgPrC)>wz0la5oveXQOv6xTV~#aW0%Q4~rc^^~^-1 z*bWNYwiA_ZohfD=+p#k4NV9``e?)?EG<%DHL9sp|A7)~JqO~Tq05NR&)wU*ok2Y7sn zZiA3&g{Z@yA16|*&DXaTkKn=O zWY|3;1UwOJ5D^|(L``NN57Z(iipYZVpn;EKPG}TQ%$c%tMd@IQCk2eJLS2@ZGB@IN zb3>I@rTIpBPY60smX?^D7`@y*v`+IORXna0@uozM=kH-mIMI&>f;1<@vK3aL>nk=G zpmy&=F7S#hq`KS#}eohyKDRD*Hm^6Zi^3OFtShK;<4rvzVt(kC>v@oTJj>=auNag zfmkM7SQdWSJp4d3u;^YgWjg7R=T9r zT4<|}TZB_1rFQ(Ri=yV$XunDA`mN|bc_-vnoVPR(_WV2|yTM(RfZlDPTBO-kxD@uL z66&ZXuG5t5X~$orX4DiTWO3+K6Um6W^N!SU9dfO7Muzm2sxwvYM$6aXuX`6rfYvqu zE4KXmL5BN5f!n{}%5K1>Fep*x1VaB(M*$tzTa>v{luZmF zQfU^g<5g|;io~ApM69asAapW0&-=x7ck))#wUA(a_e?2*vOlmqBj%X*s{@#=2R%;3 zuJ1Y8BT~L7&beMmX945f(#{7j%Np@g;lj2fGRnx8qvCeE&*p)%4&86s{q%vC#T?p} zLW7VsWbX|3EzA5D#P&Sje9{_H37O_J?Qx~mVv4kMO~}Tuf>d2dW8JfTpcc93r8DJD z@j0;Dx6h$$@~7E1Kc#)!^0kxBYJTqhke}@K4PZOy$*FiD?Wrko_^KkT6HJuAP`#p; zJlL;El(PMBe+d-Dt|OB9rzz>?gfYT#en!r;ulfyT$f@|Dc1dg=F%*qI35EX_%1Zb)DfX2f;j}$-bo_0Gi#Ti?%c|w14EZ9kVY|x1@N9^@A099iLl$uZGY=jW zi2lGe;WWTXXR7tK^!3-U6e0TI8rFOZu>4Yqu*G014$?v6E%hWv0(e6~mvq*FBzB-M z*D#95c+ie%z-6OcSC!Ou!vnbPfeYh@)pk$7mz)J26}M!I#3!}2+KlOm^MAKIO)oh+ zF!vYMUu`6V@-f$JDzZxX1 z7X-D4gn{1igsFw7-w>S2CySEJ_A(F+Vf492iNExM&CUM6UA9aD%@$twhxfYV;r$9^ zLzMzd>9y-r5;~okitc57QHK8%f&YiA|Fh75O{%awmYabZ+}A6_)y?~3vJXWcP2&Njw`F>tl?|wTeb?f%cP=zwkr9P@Uk3=L+{-k%cD^j&!mZ|2(zg@#f-J z2LWQ;k?`5jLe?iw(!5R4=S(~%As<1j;;Kx*slM2MWCiZ{Fjr7Fjw#_k`oK{e%W~7d wDtCvg^*W@~+-oM{JX6D|RJ8|aRdG6dNN?TKzjD&#%3k!=(RYg%33kzH5LAE0zc&OD)#;P6~ zY)@Tf5LWd#)9!91pRu9?z>PD!hf7 z9j*}j(`>I0V%Ao3H0q>=6aSqR#>46O{+QlpXJO@o zPsV7%PFC*SV2O}W@S=up^63i@(QZD2q<%fUctv9~iYN2z4T$KcB#i|uF&2!iMD)`T zj-UC{CNyizkr=q8J(DW*jE__%veR5TcdmvCG_+G5#_TN|ih3{w_J;rV|KDl2TEJ=h zlEp5>K7WPZ)E9v)XZ zXa3mbaeL(Jcuzoz=)1k5Gz(&$`yrjV?827z%M}Pq1orgs9Uif*ED+B>Z|*v}L+?wR zx~^lj-Uo87L2(xVbY0?(>8ol)z}Ih}f2Ew=SA6-H)^74v7dv|i49C$yS`SC17r#yB zqRjK%i^Ms=b%_EiQx(@NvOFTl} z*&uKMF4uR;9(PT1nKl(<1i872`9A9ecs+sZtTC)a58~?FpBHebqV{$yEV0nyd(KqN z1+eOU%*@{vM9|$n;;q4cRYZ}+^j>KT`Xk`zw+Xt-OgDx%EgTb3G#r0Jw&THdMu2$W}Y-ws7G#Fsd&mkWqaD?O%N~x3NjcVXv zAVJCH$SEq{2%IB%o_(w6`f-)YL-O_hlA6=cP-#2x04p_;zE$Wg*mGUAoE9%eO$T2+GAW2-rUk-yZJG> zNDX$k7nrLuA)^K$62zSp3^E=kL7qH6JVds*F!q!`Ij(wiF6Ld#&C}DZWQd+cE5&m~ zU9a3A0(Q(wY_Q)uYg|H>Tv83@*yfX!)IAElKu!NNu@1*H*43pXo2+m~^|_C8Nfz5I zQ`0oD(%_t1lLXWja1EfXk(HhlwOVwvj)@FCnEdgNR_V#v)!@=M^RH8@5DWZ^1Y_~0 zrl)r?NytXJiaD3C(R!*elM2LE|GXui9J7I$2k`iS-)8Q4|DrRqq`dLprT*$3+LFw zlX7nnF25L>$_uA8Y1&*q8CR&C?g5nn>V`NN$a|-$Lpzr!OkC(;@jhNRMMD~cM^ob~ zZnPQJ=c9TkuR0wLMycT=Lv&8Tn^K$eiUF*Z_ju{Qtc71Z{)0Ig8hh58 z(dj{Q9#}`-YApFyeKb7TJWBc_!zxr@uk39v&F;X-L}&1rQ^WZoI*&rDg7E&Vegvg{ z#gK3EG4w> zuS`4nC!>4~3TCIpg$`F%KfPtQrD^0mO4(N9`EgzD^-CfkF8wIc0p_fW#h0kbb7Izn zqQ)D|GUOxi)F1;$ciPPuSq!y`q9fP~P5|RDDiCAN5%N5_ePwa-ZyX7o$R(Z)$E+VZ z;Bqe-{-IS+%URb>CUWPc(QvCD#8JE1QfmbmCzpDvVH9ewB$3xEDMG!!UsBSu&ZuRV43t#3{R|mqd^YHX_7qfd3|w4l>;JCr4o*xH;Y}cDGH}E9yqoV z2j=QiMtLS~B}r)vJ^0gSwXn@kHXo!c8x2qOK|_XL0s(L>HMb8Ry8A*8A#p=Q>Mysu zti<)8R3hU@XK^~y_J{;{jwSY7POH*5?1te_yK4P9Q@aSj~XTxvf&9ft6 z8LBDYFzXx%y9s~HbtA*%LZfMM^)NG@F*+tD70!C?rVWs!z@_yn!&;oi7cTiX_4oDD=s(9Gc4D}$y(5b z;2{D25M#k^6*x04HJ6czhiQJm`={ObnBg^Zg?D2|JbCK_GOks9m7bdYKVF=*tQVb3 zGRK1=bKC~Xr%|r_*FQEw!S#k z6oiyX!tILn%QSJ`&e;o)l76aQLXb>DugXoS70a^6%C=#XXh?XFKhDm??X86VwWx!p zP1?fg;MULp%n8smFHz87!)_9-Z7NGOS3+1dMWf~ctu*|O?U%E-o)F&6h3A$e`S0j= zPUJv>Q;B%CcilRJI<)*p>&pmI!8A6a>xV756TVOra{(GlKS3N_XHDW>lwg;!v^?YE z?M}^B+ma3@#s~B8@`80xc>mIauO7XMbyw3sBbMiUQ^BkaN@p6CK1Aji>)*S zooRBUc4^(w@xNHSg6<0j_2hlL4;?f!#x73yLv9}|Rqr9}JnW9J+eX2r$NPl!_)u}f zl1=hK= z87)U_r=hA_|AO9wSx5ynD_L;&DVi-p9?5Q!f=%m{T%{UHcz7RP&^)Vt9(F^2uo=h3ZKcMaJ~@B=W2ai?Re;OA=T(}o zV@*lw+t4ILhtkj=swi$6skC47@tRggR$P*vW$bO|*{dQ#z2qC*T=dDDz`?ZAW=hZi zfX-r(5K73>cVDEm#nv%vHK%Epww<~PBBG~29sr(F1E|kxEbabee4l;Hj?l@}kYNnE zG$#exNb)YSdQWZ)d+goZO)=I^^Dy}^E<2Hw=Q)+@-k1Fc1HX&vvY!u){1oSJBN)MW zNW&;S#FWOODq)l&sidqSN2)q9nXcDfiK;~O6*JZrdx9lCNGIQsDaKKvQ3RG=Yt%`* zx$D&LUJgtY9?%9_e$#F|s=cyPKeHC<8canjl+;e-eVUeW_{)R{xEaC#q!Pex9w~hn zCuPjxNgCT<5U%td7Av!7M7SqqvFGK{X~-D~Ltgm3?v|(I4eM01!6@7o0ucWOqS{~7 zUC+(xW`sF9#@XSL2Fty;qzeFHcS|AmSN>V? z>FIQ)0cW$<42;Q7i`KUUJFIIAYnf=@rR4*L!!mHgPP%Yl5yqo-p84Kq!Va~4+pdDW zm02G);;$$mcjc*GBuP+1^Zhp~tMnfb7kjIOXLKN?@dmvQo1+Zefj3Kph^^hhqg8zh zfsRWY$;xYHQmbWQL?8*nu_=~d`?bVd&Fn&2G1IHLXP>>RjVIjz0&Ra}y$EJQ;a#KC zd+Uxaa6$XtncYU{hi$cGznhxLUk;{Zz>nQ{nQ1gVsDHR!JPt3SOkD5D@`Cn+8z}0? zGpU%!xdC0=4Q|{vEvE*P+TPRsJ65Pxvzd9BMP7Xz zXH3HAa;1Rsr?`O}pd`$NoE*vYRt@T?wWcQ};U8VzWMPa~Ak}LIi@i3el{>LR#W2bz zTRYJpxTl9*eMm4kC5~ps+z{pQyKB#_D{oW2Z>@?}?Dl8^a_S}qIRz^%#-E`rwttf^ z`;Q2^&o)X}+ojRR)wwj!h)zik z;J2h_5D1b;eI@MtK7g~*2>kWg&;vTzDVe#@d8{nB+0uLZpxv@0T=RS!`s8DzrRyZ? zlLERTm$n8s0fuO}aRArwY4c_3c{S%)i2k3zU1zd(TJ){Z(C z?v0PaukSt-_c$U*1;4x|0xDb2d>;BQ)BK5{dLsB0pG>dvgEWrP!!KhXV#Q&WoR!{I zaWABNrH?vPT%xJ&lW_lIpmjb2OA)92V3#TV!%ZbOCg`oaolH!0=VsbT-1q2CuEi(I zN|K~_fU0BPi@S*d&{QI;a0gndu!Cg{QbTCx6byc?qX<%fap?4s-O)i9#+;qk`_*rs zZ}573^gY{G(p}#@X2EbEAPMT7Ko9HrEk@KZwXZY~f9*#Y}}qf+eA?ehpP5Q|J~!Z}@s) zemOXZx)8Izstc;$$%AjXg75P5p|USAmwo`vZxg&U=qgTnjNcSJ(d$UC``rrz)I(Gp zw9R-Am-74#!RLJEd>|K|6X>ot@V1xhweoYwWg0ygdfAN+-KbT@Sn4s!T~9SzN?dvg zzfK5YHl0k2xjEWcGXpt~c{OqI`S_pK>QA~I?rFLGyW%eF;2@A#DtyMr4P0G_k9_`k zP@`J0RSu`)3$5Jk5m)5krmw5DiMuLsb=z--59Q0xA9<9FdV6=hLU%p|#KjUu z@IhKi0|A<&4WaPzw+z%z^--srj@@Uc7D_8ol7}UmItCwchL0=V=;kfXcW03ZcZwcW zdfn(a6?O5?B6o(jx6yoq8qjk8gS)Jtixud4$eOJev>eYe=+0Hdr8EV)`*W>ZomujPSxB+7LV_@$9$_Q|Tx8(q5$)v9!zqfwFBO_*Cg$* zt4ZwVyy>Hjau#HX;YorOEPq6|2jp#j6#StQ#SI0kt2z0FveyN2Hi=0%y?f+yZg543|sKDoQP^~f=CWEvD%s;Qqv#Sowgt2GstovFVK{5{o z>pJH6hR*TNH+>Dm$_d3wuzgf`6;OteOv54gH#4AM8w~k7i=k0}BvCDL2sKKf-yeaIl54l|&xi`Y9nf_+KNm;Cm2)G4_&89XY2HNoG{Fe&O zO%i6N4jkvI!uludzP)@!oTrHPHA#rAzD&x`(7&|c?Q@fJ(6KLV3o8;yN2^-38VpnmP>ozfhe>nAQ6^`_ z0))Wb@tVX5RXay!t(D|$VoM7|6$L%;0ez~RY`m7wbWD1X?mYr3@f>13q<0F7xN|p+ zKZu0&ucnm*pyF8s@x8r@m2*m@aWj4EQi@86#@ErtE*Jdc`q4^rY&4>S-JhWqc`nhc z8p-?gnkY5Vy{iRFG|SDZlsO~spv$153Q?P9?M{CvjPG44&clmu(q_N)U0tP=_PKdo zWjk+i`Y&Bv#5?BF+B6@5@M9c+U8N^N8m=k`-S_v$oQxe(WAP_tGE{M2 z*4>scCs_iViuh8W=+p&mw8Fw??B9vc&@5nPdCApz8+&?`49)X~aonTH#;E8;pUSw8 z3yW_dt}NZ7nDKoql;Wu6WEZ09Wb4l}_4u4K`#{N*BIi?|9>{2&@NrxYSS;Xwh-q&m zmZ;Q#);m4W5RZk-@!IiAj4%QpkZAgY=KN$L;(MFvO={wUqh+^w^KD)Gwz#xW#k1bZ zyB@9uV-MV;DAqIhcbP*(ltMtFSA-AXq?HQbK zhc6GYm;5#WHcmVjJeQ2q#L-VOia1j`sanru3O+!=kob4FH0E}6D4A2j0XxO-c z4;Ss^vS26;&G}J7xHcldew7+%&f`|a=;PxcIZi~0Nn}do-&slt66Y!TPD*Zir7k9> z@X(oCar|j-)BB1mPbcdbGc(SZXTEoC63x)Q1p?m)XJ)iGPumc6Q#Y!y?x|+^#Pb#& z@eGdm{bORC+I$H0ucPCgjZJ^TI_e1?Z_>ym2E7V`y~4M_qoaIKD89LGZ(>A^Qyj<2 zyilLrLH?_hsIV{^6;;)#!=2^B^gXeoq~zqqg0SP`5GlK=^IP-X`u_f9X>4cDwuCdV zy?FgP*Zv$xqn({?Dl6*}3XPsB9k#ckt@NgZ$Iix*ATdJixd_gA5VO_w=x=W^NmvO7yH_vQdS!#rkF7z zX4GwCvcY3)p*M4|?4A1K>7~KEks@q$&?%?ZaTtjt6&VxLI6iLw&bcqkkO+0C2`Ezg z80l|e0s8*^`{c^XvrPTxOK!r@tIshaQX<2(!H;V;+piEW`1|=Gx47G>RemsSZQAs} zIsWaXK{l(8CJmdj9lal5Oj0&wCJbJVj>4q;{Gtax^mqytLqbA)HfIcZvbdYLC+q6! zBp*2hEs91)M&|r5-q+L9BVuR1TdHaut&{*Eh)LVp+q;cBGqYtFJR^%cU~BK_*eT%x zy>2YzN?}DxPKm&xbIhs5E^%oPWpBZt-IZJlNF!+bOH=H*!I~Glu)JIOa$b~cP0h`@ zTqz#Ax46kHEG$b0VYKv!_onaEkV4&5s?fvvE@Z2a(!Ez6vDZ9@*yp?6Mdas8j|cqV z*r`kpT9QC|)gP@@2TVnQ3xoH(d3Lk2vzIF1a94S$NQJ9c5i~~G5hN2+Q6Jhzbmxr&MnUbz*Bd$a+9+2g|pJusMX4KrzgQX zp`#8meTK-fdK_+LqTb<~uFz95*dgSD(?N!!f%T16)7XfQyYiHJzyIA-X7*4aRV-nR9zZZ^vYhL}f3 z7Jgq6#ewkni^{1ob~=WJu_weeK42}*Cn6^BJJ4u3(4Vot$6`**=RmLV|Mg*p9*DfD z05A4G1M2;u7n-n&8TuxFDYALCBX!W>%mF&^?Afykt(cj)IigIMl;^>Fb~X&!@Mb99 zDzwKc^fW#qA|g|Q^Q+o{kjdhi>+Fp>ukiS#g#WtS|9CM#5PEvdJKrdC8mCA#03@H9 znK>gXD~t7{u28GNzjegPDI@4vLc&lv7f4YWP$NrAZW4*KLBZ8WZ=ulu6PWIKc@0`O z`pvGcatH_rWMyULILlanHki<0DmM6OZ55DEQCBUnl8(Zc)j`MJ61u6OErG^t!El4PANuA_^x$kMcd#Nw$^T05o2yJ`~Hy$Urn- z!P>Kofd0^P+*_l*QhAV3HOYJNVgew=xuJ!&ZHaOzyAigp65G)Ui%UyHLKHsdE}#ps z_?*8%`)`o8ZE&SHTudh5<|Zd6-P>WsrlBq;7$6$Im1J*kw(M%)%-{cHiY>FUvF)4> zkpp;etoVZSlC}wayCR1~LX3((=WKt$m9ir;BTEM$daf_q__BmVufw1aU||a)a=$s) z^pB#XYd)Lfc`!Kd$8XP7xN-Mx?qQw3sp;9`;^KkZ*~>b-{Oto> zZcW1+vG|KA7?F^fHc-gHY$`J+XY0(@MEQV?$s^XbfdRzz)8j4tvu6Wt-fBVHm(xQJ z?;am-bsw@1kokWd?dktz`fhS*$$DOngM$M(Z)|Mb55%F<8O3Zy&=fM$Jh)U`QZh*9 z1QmSwY^zWzknc;WTbo)jd_Mu8 zpVRKjDADUhYHCdAuS3jid-DEFq8S$m^rWy*j{U+l=Kha28*e*c8ML&t9<7htF_gx~ zbMVUAKbvZdao%3&y(}e#XnpAKKh$mc4G{W#>(Z*cG$FtpS5{W!{8vz&uhsRX^GE+O zg8=T#4w$8RYtj-r9ikb+2MOI584sKnVi!_7->tDH2smUm1b{LI5SYHPWZaJEK$cOm zuwB(73F~t2{KHxTc9(xV^vJ7bXUIl!TZ)$rsF|`Q`(3}KVJ7OZk|ZjXD)0D(=Fuup z@8qqHmDgX16cQ9fFcZ`tn-XYE->Q7*65!^h!{Km`7J6ub{oh(o4O{nJ0MKGPG&@`PbS>_+f*UbCA3<8Blv-hJ7Qyu=hsyx~0($dq z%a#&e)D@grO4kTRR2Y>?ickT0^0P3N!~k-JUH4FM?KDT0-vf)Ar6cBFRsuN4^GTie zed04xh~d);z0NCRn_3QJKyh6J!jyUhSn5bg!&620G2-6#jth=SRr!q|!Z{Qzv)VVUA0*cfRIJNcE0 z`xW=}>A=y;moE{HuC6ZQ6?k!QN0v^qms{7{-U*gL@suH$uWzxM0|Jpm{Fp5S%^C(A zCNI6UsVV1V{e=h&$V8wF;pX_2)+DyDOUj*tQnD&U7?Z7u0QCnGAdB_g3_|ZE9s8o);^FQ(cgYDO33o7i*l0$JKf-p$v z$oiG0l?|QqNfWjZ=&{M!!%t7iW8QxT4F8&h#Vgz4TD69RTE4D8e=We_9Dv+t`WA6x zYkYf7hiyZA>z$XSeO6YH$`{k(E1-_LT8j+mONow)z zcKIaZ9IjM1k?>R9Y(ZZf>Vb-m-Y8lz;z=j07f!|<@fA;KmCa6Dt!m(gFEY75u~Cry zp>UrqdZiP#CM|MYr2m=qdx{nPPe^~n&jyct$sr=8tUtWR`b}bM6?`g!Hzp=TbInct!w)^2*(v6zcP4&8- z-Nj{pbB3Q=l;e4UlP^8_t#TvF%qN}?E|bI$Cl-Vh{x3Rx^d~aHkZQ{g3tMzKWI8E0 zy!Fg{p2uOj2nks=WUX7h)bq_@=oRmaNY~8AP7X#p7aI9fEIY@rtalHTahDLbQj)DX zLOvPt0^h>;9>0J&TU2I+pyEkag7$WVV*EU&7`8yy{>}@9bj)S@C*C z|Ib+pA1T%dHYg3bLt2krlKnf=@Eu;VVxh?%=;0yeBPCt$7ppcDYQmDry_{8D7Qd8=9PIx>sCYXgHuj%dr z!KYZ!6-lhs)G-vYseA>>fd0XUqPAFLN;n?cWS`UY?Q-qdlh3R>@v1ELnK}V|yFUsq ztY)rdxoh@9JTv=uq=8z+LvTqnQZy{)a5ndTZTvt>4SkeK68eL;Ro+c=4^_s~l*hx$ z%NLa*SG`%Lc&(X@aTULVav=gh19}Uy{fW*mj*|S6vg}X^*S$KhC!8tmg5P8gZgyR?`RqkG0Vcg_QyWznne$n6rZnW} z=1^P?x~!ORVqG@DUsIkC9K8|X@HveeZ#FE{a$KAHs#=+0J^wm>DDl_NZ$r+n{;Ex{ zm*u%%d7Ln3jp`UqvN2=%qIJ3xQ?+qBo*^YxX)^N^f*eu=8PSvz*F==Tqu7nb-H19ESKxtdK=ZMRS4Qa=bp3 zd1Yb;G@4A0tadU1=aYiLD&AKJ(#A$@7|O)l_Z@|C60)xD|CN+!;t+q+R)!chwmx5Y zY3176#_sC_`|{U#(&hOt=aPc2Yl9ZAH)zWgn>B0w8 zfMVMct0Xo%JNp|5+y69>IodiEITdF@8!)Ka27wr-AA={4DG*S^7Fc$@6(E4n2Oq(>CxcgKT{rD%yyZrc%%vj7Z*5A z`Emw$aW+Bp&kabs-uB&kk>ty(f9@qxrL{#I+WPW&|NPa-bDudeOs8M=7qy^UA!VT{ zV?ZOlV9_Hi5&~Vk_VL@}hVWTWP=z>MAcHQd!b#e)>to~Cea`DjzZm!Y>Ybt!)m@J# zqop+)Hg>7>)v8^n$r{F8O7OfCI-YR7On7(1P|9I7$}3caPtBDvLG*23x34$w*3ioX;eYOiu3rPg60# pOmM%}|LD5VcH&TIqHX=jDfsI?TyUDa3Y>h>80wnBKj}Dz{|nZIS{(oY literal 0 HcmV?d00001 diff --git a/docs/plugins/social_login.rst b/docs/plugins/social_login.rst index 6c138275..66267c78 100644 --- a/docs/plugins/social_login.rst +++ b/docs/plugins/social_login.rst @@ -1,10 +1,105 @@ .. vale off -Social Login -############# +Social Login Guide +========================= - .. image:: images/twilio-sid-authtoken.png +With Mautic's Social Login, users can easily sign in via their favorite social platforms like Twitter, Facebook, or LinkedIn. The social login feature automatically pre-fills forms with profile data and updates or creates new contacts in Mautic, streamlining the user experience. + +Before You Begin: Setup Requirements +---------------------------------------- + +Before enabling social login, make sure you have created social media apps on the platforms you want to integrate: + +- `X-Developer `_ +- `Facebook `_ +- `LinkedIn `_ + +Once these apps are set up, you're ready to connect them to Mautic! + +Step 1: Authorizing Social Media Plugins +---------------------------------------- + +Before you can use social login, each social media plugin needs authorization. Here’s how to do it: + +To get started with social login, you’ll first need to authorize each plugin: + +1. Copy the Callback URL: + + After creating your social app, the platform will ask for a Callback URL. + + - Go to Mautic's plugin configuration window and copy the Callback URL provided there. + - Paste it into the appropriate field in your social app setup. + + .. image:: images/Call_back.png + :width: 400 + :alt: Screenshot of a call back url input field. + +2. Add Your API Keys: + + Now that your social app is set up: + + - Copy the API Key (Client Key) and API Secret (Client Secret) from the social platform. + - Paste these keys into the relevant fields in the Mautic plugin configuration. +.. image:: images/API_key.png :width: 400 - :alt: Screenshot of the SID and Auth Token fields + :alt: Screenshot of an API Key input field. + +3. Authorize the Plugin: + + - In the Mautic plugin configuration, click **Authorize**. + - Ensure the plugin is marked as **Published** by toggling the option to “Yes”. + - Save your configuration to complete the setup. + +.. Tip:: You can manage each social network under its respective tab in Mautic’s plugin settings. Make sure each network is fully authorized by adding the required API credentials. + +Step 2: Adding Social Login Buttons to Forms +-------------------------------------------- + +Once your plugins are authorized, you can add social login buttons to your Mautic forms. + +1. Create or Edit a Form: + + Go to the Forms section in Mautic and either create a new form or edit an existing one. + +2. Add the Social Login Field: + + Select the **Social Login** field from the form builder. Buttons for all authorized social platforms (e.g., Twitter, Facebook, LinkedIn) will automatically appear. + +3. Pre-fill Form Fields: + + When users log in using their social accounts, Mautic will attempt to automatically fill in fields like **Name** or **Email** based on their social profile. +.. image:: images/adding_social_login.png + :alt: Mautic plugin configuration screen showing authorized status + :width: 400 +.. note:: + Only the buttons for plugins you’ve authorized will work in the form. Ensure all integrations are configured correctly for a smooth user experience. + +Step 3: Configuring Features and Mapping Contact Fields +------------------------------------------------------- + +Once the plugin is authorized, you can customize how Mautic handles the incoming social profile data. + +1. Map Social Profile Fields to Mautic Fields: + + Under the **Contact Field Mapping** tab in the plugin settings, map the fields from the user’s social profile (e.g., Email, Name) to the appropriate Mautic contact fields. + + - You only need to map fields that are relevant to your form. + - Unmapped fields will not be used to update or create contacts in Mautic. + +Example: Map **First Name** from Facebook to **First Name** in Mautic's contact fields. + +Supported Social Profile Fields +------------------------------- + +Each platform provides different user data fields. Here's a quick reference of the fields you can map: + +Twitter: +- Profile Handle, Name, Location, Description, URL, Time Zone, Language, Email. + +Facebook: +- First Name, Last Name, Name, Gender, Locale, Email, Profile Link. + +LinkedIn: +- First Name, Last Name, Maiden Name, Formatted Name, Headline, Location, Summary, Specialties, Positions, Public Profile URL, Email Address. .. vale on \ No newline at end of file From c145a8368b24c79895591d71b192c0ee5aaf56d7 Mon Sep 17 00:00:00 2001 From: Favour Kelvin Date: Tue, 29 Oct 2024 11:19:36 +0000 Subject: [PATCH 02/14] fixed formatting issues --- docs/plugins/social_login.rst | 48 +++++++++-------------------------- 1 file changed, 12 insertions(+), 36 deletions(-) diff --git a/docs/plugins/social_login.rst b/docs/plugins/social_login.rst index 66267c78..63d22ee9 100644 --- a/docs/plugins/social_login.rst +++ b/docs/plugins/social_login.rst @@ -21,34 +21,19 @@ Step 1: Authorizing Social Media Plugins Before you can use social login, each social media plugin needs authorization. Here’s how to do it: -To get started with social login, you’ll first need to authorize each plugin: - -1. Copy the Callback URL: - - After creating your social app, the platform will ask for a Callback URL. - - - Go to Mautic's plugin configuration window and copy the Callback URL provided there. - - Paste it into the appropriate field in your social app setup. +1. **Copy the Callback URL**: Go to Mautic's plugin configuration window and copy the Callback URL provided there. Paste it into the appropriate field in your social app setup. .. image:: images/Call_back.png :width: 400 :alt: Screenshot of a call back url input field. -2. Add Your API Keys: +2. **Add Your API Keys**: Copy the API Key (Client Key) and API Secret (Client Secret) from the social platform. Paste these keys into the relevant fields in the Mautic plugin configuration. - Now that your social app is set up: - - - Copy the API Key (Client Key) and API Secret (Client Secret) from the social platform. - - Paste these keys into the relevant fields in the Mautic plugin configuration. .. image:: images/API_key.png :width: 400 :alt: Screenshot of an API Key input field. -3. Authorize the Plugin: - - - In the Mautic plugin configuration, click **Authorize**. - - Ensure the plugin is marked as **Published** by toggling the option to “Yes”. - - Save your configuration to complete the setup. +3. **Authorize the Plugin**: In the Mautic plugin configuration, click **Authorize**. Ensure the plugin is marked as **Published** by toggling the option to “Yes”. Finally, save your configuration to complete the setup. .. Tip:: You can manage each social network under its respective tab in Mautic’s plugin settings. Make sure each network is fully authorized by adding the required API credentials. @@ -57,20 +42,16 @@ Step 2: Adding Social Login Buttons to Forms Once your plugins are authorized, you can add social login buttons to your Mautic forms. -1. Create or Edit a Form: +1. Go to the Forms section in Mautic and either create a new form or edit an existing one. - Go to the Forms section in Mautic and either create a new form or edit an existing one. +2. Select the **Social Login** field from the form builder. Buttons for all authorized social platforms (e.g., Twitter, Facebook, LinkedIn) will automatically appear. -2. Add the Social Login Field: +3. When users log in using their social accounts, Mautic will attempt to automatically fill in fields like **Name** or **Email** based on their social profile. - Select the **Social Login** field from the form builder. Buttons for all authorized social platforms (e.g., Twitter, Facebook, LinkedIn) will automatically appear. - -3. Pre-fill Form Fields: - - When users log in using their social accounts, Mautic will attempt to automatically fill in fields like **Name** or **Email** based on their social profile. .. image:: images/adding_social_login.png :alt: Mautic plugin configuration screen showing authorized status :width: 400 + .. note:: Only the buttons for plugins you’ve authorized will work in the form. Ensure all integrations are configured correctly for a smooth user experience. @@ -79,9 +60,7 @@ Step 3: Configuring Features and Mapping Contact Fields Once the plugin is authorized, you can customize how Mautic handles the incoming social profile data. -1. Map Social Profile Fields to Mautic Fields: - - Under the **Contact Field Mapping** tab in the plugin settings, map the fields from the user’s social profile (e.g., Email, Name) to the appropriate Mautic contact fields. +1. Under the **Contact Field Mapping** tab in the plugin settings, map the fields from the user’s social profile (e.g., Email, Name) to the appropriate Mautic contact fields. - You only need to map fields that are relevant to your form. - Unmapped fields will not be used to update or create contacts in Mautic. @@ -93,13 +72,10 @@ Supported Social Profile Fields Each platform provides different user data fields. Here's a quick reference of the fields you can map: -Twitter: -- Profile Handle, Name, Location, Description, URL, Time Zone, Language, Email. +- **Twitter**: Profile Handle, Name, Location, Description, URL, Time Zone, Language, Email. -Facebook: -- First Name, Last Name, Name, Gender, Locale, Email, Profile Link. +- **Facebook**: First Name, Last Name, Name, Gender, Locale, Email, Profile Link. -LinkedIn: -- First Name, Last Name, Maiden Name, Formatted Name, Headline, Location, Summary, Specialties, Positions, Public Profile URL, Email Address. +- **LinkedIn**: First Name, Last Name, Maiden Name, Formatted Name, Headline, Location, Summary, Specialties, Positions, Public Profile URL, Email Address. -.. vale on \ No newline at end of file +.. vale on From c1a2e1b08eab1ecc26d0cc1b49a574f22d4c9e95 Mon Sep 17 00:00:00 2001 From: Favour Kelvin Date: Tue, 29 Oct 2024 11:52:14 +0000 Subject: [PATCH 03/14] Update social_login.rst --- docs/plugins/social_login.rst | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/plugins/social_login.rst b/docs/plugins/social_login.rst index 63d22ee9..ed046766 100644 --- a/docs/plugins/social_login.rst +++ b/docs/plugins/social_login.rst @@ -1,12 +1,12 @@ .. vale off -Social Login Guide -========================= +Social Login +============ With Mautic's Social Login, users can easily sign in via their favorite social platforms like Twitter, Facebook, or LinkedIn. The social login feature automatically pre-fills forms with profile data and updates or creates new contacts in Mautic, streamlining the user experience. Before You Begin: Setup Requirements ----------------------------------------- +------------------------------------ Before enabling social login, make sure you have created social media apps on the platforms you want to integrate: @@ -58,12 +58,11 @@ Once your plugins are authorized, you can add social login buttons to your Mauti Step 3: Configuring Features and Mapping Contact Fields ------------------------------------------------------- -Once the plugin is authorized, you can customize how Mautic handles the incoming social profile data. +Once the plugin is authorized, you can customize how Mautic handles the incoming social profile data. Under the **Contact Field Mapping** tab in the plugin settings, map the fields from the user’s social profile (e.g., Email, Name) to the appropriate Mautic contact fields. -1. Under the **Contact Field Mapping** tab in the plugin settings, map the fields from the user’s social profile (e.g., Email, Name) to the appropriate Mautic contact fields. +- You only need to map fields that are relevant to your form. - - You only need to map fields that are relevant to your form. - - Unmapped fields will not be used to update or create contacts in Mautic. +- Unmapped fields will not be used to update or create contacts in Mautic. Example: Map **First Name** from Facebook to **First Name** in Mautic's contact fields. From b02c606c51665df6f8caee2de38c13b66e7139e5 Mon Sep 17 00:00:00 2001 From: Rita Onwudiwe Date: Fri, 1 Nov 2024 07:39:49 +0100 Subject: [PATCH 04/14] Updated heading --- docs/plugins/social_login.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/plugins/social_login.rst b/docs/plugins/social_login.rst index ed046766..fe21622b 100644 --- a/docs/plugins/social_login.rst +++ b/docs/plugins/social_login.rst @@ -1,7 +1,7 @@ .. vale off Social Login -============ +############ With Mautic's Social Login, users can easily sign in via their favorite social platforms like Twitter, Facebook, or LinkedIn. The social login feature automatically pre-fills forms with profile data and updates or creates new contacts in Mautic, streamlining the user experience. From e4d0f277acca6d439775fe809eca55e6d1782d2c Mon Sep 17 00:00:00 2001 From: Rita Onwudiwe Date: Fri, 1 Nov 2024 07:49:49 +0100 Subject: [PATCH 05/14] Create X-developer.py --- docs/links/X-developer.py | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 docs/links/X-developer.py diff --git a/docs/links/X-developer.py b/docs/links/X-developer.py new file mode 100644 index 00000000..784093b9 --- /dev/null +++ b/docs/links/X-developer.py @@ -0,0 +1,7 @@ +from . import link + +link_name = "X-developer" +link_text = "X-developer" +link_url = "https://developer.twitter.com/en/portal/petition/essential/basic-info/" + +link.xref_links.update({link_name: (link_text, link_url)}) From 07c103b84f20863e2b314aad98e30dcd3c413706 Mon Sep 17 00:00:00 2001 From: Rita Onwudiwe Date: Fri, 1 Nov 2024 07:55:04 +0100 Subject: [PATCH 06/14] Update X link in social_login.rst --- docs/plugins/social_login.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/plugins/social_login.rst b/docs/plugins/social_login.rst index fe21622b..dfa5a948 100644 --- a/docs/plugins/social_login.rst +++ b/docs/plugins/social_login.rst @@ -10,7 +10,7 @@ Before You Begin: Setup Requirements Before enabling social login, make sure you have created social media apps on the platforms you want to integrate: -- `X-Developer `_ +- :xref:`X-developer` - `Facebook `_ - `LinkedIn `_ From 3ecdbbd472819bd2d375e8437f010f1557238400 Mon Sep 17 00:00:00 2001 From: Rita Onwudiwe Date: Fri, 1 Nov 2024 07:59:01 +0100 Subject: [PATCH 07/14] Create Facebook_developer.py --- docs/links/Facebook_developer.py | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 docs/links/Facebook_developer.py diff --git a/docs/links/Facebook_developer.py b/docs/links/Facebook_developer.py new file mode 100644 index 00000000..cbc0174f --- /dev/null +++ b/docs/links/Facebook_developer.py @@ -0,0 +1,7 @@ +from . import link + +link_name = "Facebook Developer" +link_text = "Facebook Developer" +link_url = "https://developers.facebook.com/products/facebook-login/" + +link.xref_links.update({link_name: (link_text, link_url)}) From 3bb04c9fcc41f48d20217a1131df100244f4e805 Mon Sep 17 00:00:00 2001 From: Rita Onwudiwe Date: Fri, 1 Nov 2024 08:01:33 +0100 Subject: [PATCH 08/14] Update Facebook link --- docs/plugins/social_login.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/plugins/social_login.rst b/docs/plugins/social_login.rst index dfa5a948..a6dcf29d 100644 --- a/docs/plugins/social_login.rst +++ b/docs/plugins/social_login.rst @@ -11,7 +11,7 @@ Before You Begin: Setup Requirements Before enabling social login, make sure you have created social media apps on the platforms you want to integrate: - :xref:`X-developer` -- `Facebook `_ +- :xref:`Facebook developer` - `LinkedIn `_ Once these apps are set up, you're ready to connect them to Mautic! From 6397f56bb929cff1f6c5aa86a03bcef4ab54ec7e Mon Sep 17 00:00:00 2001 From: Rita Onwudiwe Date: Fri, 1 Nov 2024 08:02:29 +0100 Subject: [PATCH 09/14] Update Facebook_developer.py --- docs/links/Facebook_developer.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/links/Facebook_developer.py b/docs/links/Facebook_developer.py index cbc0174f..7abe5b44 100644 --- a/docs/links/Facebook_developer.py +++ b/docs/links/Facebook_developer.py @@ -1,7 +1,7 @@ from . import link -link_name = "Facebook Developer" -link_text = "Facebook Developer" +link_name = "Facebook developer" +link_text = "Facebook developer" link_url = "https://developers.facebook.com/products/facebook-login/" link.xref_links.update({link_name: (link_text, link_url)}) From 643c7ad0e04ec20991ba33d7d0f08dc943e923d8 Mon Sep 17 00:00:00 2001 From: Rita Onwudiwe Date: Fri, 1 Nov 2024 08:07:18 +0100 Subject: [PATCH 10/14] Create Linkedin_developer.py --- docs/links/Linkedin_developer.py | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 docs/links/Linkedin_developer.py diff --git a/docs/links/Linkedin_developer.py b/docs/links/Linkedin_developer.py new file mode 100644 index 00000000..0581af96 --- /dev/null +++ b/docs/links/Linkedin_developer.py @@ -0,0 +1,7 @@ +from . import link + +link_name = "Linkedin developer" +link_text = "Linkedin developer" +link_url = "https://www.bing.com/ck/a?!&&p=b2b85466e898e3f3JmltdHM9MTcyODQzMjAwMCZpZ3VpZD0wZmNhOGE5ZC05ODA0LTY0OGYtMjVhYy05ZWQwOTk2MzY1NjYmaW5zaWQ9NTE5Mg&ptn=3&ver=2&hsh=3&fclid=0fca8a9d-9804-648f-25ac-9ed099636566&psq=linkedin+developer+app&u=a1aHR0cHM6Ly9kZXZlbG9wZXIubGlua2VkaW4uY29tLw&ntb=1" + +link.xref_links.update({link_name: (link_text, link_url)}) From acf0d035c5fec6dd7e03b575eba053363ac69f52 Mon Sep 17 00:00:00 2001 From: Rita Onwudiwe Date: Fri, 1 Nov 2024 08:09:12 +0100 Subject: [PATCH 11/14] Update the LinkedIn link --- docs/plugins/social_login.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/plugins/social_login.rst b/docs/plugins/social_login.rst index a6dcf29d..b8a1079f 100644 --- a/docs/plugins/social_login.rst +++ b/docs/plugins/social_login.rst @@ -12,7 +12,7 @@ Before enabling social login, make sure you have created social media apps on th - :xref:`X-developer` - :xref:`Facebook developer` -- `LinkedIn `_ +- :xref:`LinkedIn developer` Once these apps are set up, you're ready to connect them to Mautic! From f37a3d718d5ec1dd89f0a504852543908c109f8d Mon Sep 17 00:00:00 2001 From: Rita Onwudiwe Date: Fri, 1 Nov 2024 08:09:44 +0100 Subject: [PATCH 12/14] Update Linkedin_developer.py --- docs/links/Linkedin_developer.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/links/Linkedin_developer.py b/docs/links/Linkedin_developer.py index 0581af96..d870b527 100644 --- a/docs/links/Linkedin_developer.py +++ b/docs/links/Linkedin_developer.py @@ -1,7 +1,7 @@ from . import link -link_name = "Linkedin developer" -link_text = "Linkedin developer" +link_name = "LinkedIn developer" +link_text = "LinkedIn developer" link_url = "https://www.bing.com/ck/a?!&&p=b2b85466e898e3f3JmltdHM9MTcyODQzMjAwMCZpZ3VpZD0wZmNhOGE5ZC05ODA0LTY0OGYtMjVhYy05ZWQwOTk2MzY1NjYmaW5zaWQ9NTE5Mg&ptn=3&ver=2&hsh=3&fclid=0fca8a9d-9804-648f-25ac-9ed099636566&psq=linkedin+developer+app&u=a1aHR0cHM6Ly9kZXZlbG9wZXIubGlua2VkaW4uY29tLw&ntb=1" link.xref_links.update({link_name: (link_text, link_url)}) From 0e06cd85c1443faff11749f080c9cf849b17ce84 Mon Sep 17 00:00:00 2001 From: Rita Onwudiwe Date: Mon, 4 Nov 2024 15:07:03 +0100 Subject: [PATCH 13/14] Apply suggestions from code review To sort the vale removal, heading and formatting issues Co-authored-by: Ruth Cheesley --- docs/plugins/social_login.rst | 65 +++++++++++++++++------------------ 1 file changed, 32 insertions(+), 33 deletions(-) diff --git a/docs/plugins/social_login.rst b/docs/plugins/social_login.rst index b8a1079f..2db9301f 100644 --- a/docs/plugins/social_login.rst +++ b/docs/plugins/social_login.rst @@ -1,80 +1,79 @@ -.. vale off -Social Login +Social login ############ -With Mautic's Social Login, users can easily sign in via their favorite social platforms like Twitter, Facebook, or LinkedIn. The social login feature automatically pre-fills forms with profile data and updates or creates new contacts in Mautic, streamlining the user experience. +With Mautic's Social Login, Users can easily sign in via their favorite social platforms like Twitter, Facebook, or LinkedIn. The social login feature automatically pre-fills Forms with profile data and updates or creates new Contacts in Mautic, streamlining the user experience. -Before You Begin: Setup Requirements +Before you begin: setup requirements ------------------------------------ -Before enabling social login, make sure you have created social media apps on the platforms you want to integrate: +Before configuring social login, make sure you have created apps on the developer platforms for the social media profiles you want to integrate: - :xref:`X-developer` - :xref:`Facebook developer` - :xref:`LinkedIn developer` -Once these apps are set up, you're ready to connect them to Mautic! +Once created, you're ready to connect them to Mautic. -Step 1: Authorizing Social Media Plugins ----------------------------------------- +Step 1 - authorizing social media Plugins +***************************************** -Before you can use social login, each social media plugin needs authorization. Here’s how to do it: +Before you can use social login, each social media Plugin needs authorization. Here's how to do it: -1. **Copy the Callback URL**: Go to Mautic's plugin configuration window and copy the Callback URL provided there. Paste it into the appropriate field in your social app setup. +1. **Copy the Callback URL**: go to Mautic's Plugin configuration window and copy the Callback URL provided there. Paste it into the appropriate field in your developer app setup. .. image:: images/Call_back.png :width: 400 - :alt: Screenshot of a call back url input field. + :alt: Screenshot of a callback URL input field. -2. **Add Your API Keys**: Copy the API Key (Client Key) and API Secret (Client Secret) from the social platform. Paste these keys into the relevant fields in the Mautic plugin configuration. +2. **Add Your API Keys**: copy the API Key - Client Key - and API Secret - Client Secret - from the social platform. Paste these keys into the relevant fields in the Mautic Plugin configuration.``` .. image:: images/API_key.png :width: 400 :alt: Screenshot of an API Key input field. -3. **Authorize the Plugin**: In the Mautic plugin configuration, click **Authorize**. Ensure the plugin is marked as **Published** by toggling the option to “Yes”. Finally, save your configuration to complete the setup. +1. **Authorize the Plugin**: in the Mautic Plugin configuration, click **Authorize**. You must **turn on** the Plugin - do this by toggling the option to “Yes”. Finally, save your configuration to complete the setup. -.. Tip:: You can manage each social network under its respective tab in Mautic’s plugin settings. Make sure each network is fully authorized by adding the required API credentials. +.. Tip:: You can manage each social network under its respective tab in Mautic's Plugin settings. Make sure each network is fully authorized by adding the required API credentials. -Step 2: Adding Social Login Buttons to Forms --------------------------------------------- +Step 2: adding social login buttons to Forms +******************************************** -Once your plugins are authorized, you can add social login buttons to your Mautic forms. +Having configured the social Plugins, you can add social login buttons to your Mautic Forms. -1. Go to the Forms section in Mautic and either create a new form or edit an existing one. +1. Go to the Forms section in Mautic and either create a new Form or edit an existing one. -2. Select the **Social Login** field from the form builder. Buttons for all authorized social platforms (e.g., Twitter, Facebook, LinkedIn) will automatically appear. +2. Select the **Social Login** field from the Form builder. Buttons for all authorized social platforms - for example Twitter, Facebook, LinkedIn automatically appear. -3. When users log in using their social accounts, Mautic will attempt to automatically fill in fields like **Name** or **Email** based on their social profile. +3. When Users log in using their social accounts, Mautic attempts to automatically fill in fields like **Name** or **Email** based on their social profile. .. image:: images/adding_social_login.png - :alt: Mautic plugin configuration screen showing authorized status + :alt: Mautic Plugin configuration screen showing authorized status :width: 400 .. note:: - Only the buttons for plugins you’ve authorized will work in the form. Ensure all integrations are configured correctly for a smooth user experience. + Only the buttons for Plugins you've authorized work in the Form. Ensure you've configured all Integrations correctly for a smooth User experience. -Step 3: Configuring Features and Mapping Contact Fields -------------------------------------------------------- +Step 3: configuring features and mapping Contact fields``` +******************************************************* -Once the plugin is authorized, you can customize how Mautic handles the incoming social profile data. Under the **Contact Field Mapping** tab in the plugin settings, map the fields from the user’s social profile (e.g., Email, Name) to the appropriate Mautic contact fields. +After configuration and authorization of the Plugin, you can customize how Mautic handles the incoming social profile data. Under the **Contact Field Mapping** tab in the Plugin settings, map the fields from the User's social profile - for example Email, Name - to the appropriate Mautic Contact fields. -- You only need to map fields that are relevant to your form. +- You only need to map fields that are relevant to your Form. -- Unmapped fields will not be used to update or create contacts in Mautic. +- Unmapped fields aren't used to update or create Contacts in Mautic. -Example: Map **First Name** from Facebook to **First Name** in Mautic's contact fields. +Example: map **First Name** from Facebook to **First Name** in Mautic's Contact fields. -Supported Social Profile Fields -------------------------------- +Supported social profile fields +******************************* Each platform provides different user data fields. Here's a quick reference of the fields you can map: -- **Twitter**: Profile Handle, Name, Location, Description, URL, Time Zone, Language, Email. +- **Twitter**: profile handle, name, location, description, URL, time zone, language, email address. -- **Facebook**: First Name, Last Name, Name, Gender, Locale, Email, Profile Link. +- **Facebook**: first name, last name, name, gender, locale, email address, profile link. -- **LinkedIn**: First Name, Last Name, Maiden Name, Formatted Name, Headline, Location, Summary, Specialties, Positions, Public Profile URL, Email Address. +- **LinkedIn**: first name, last name, maiden name, formatted name, headline, location, summary, specialties, positions, public profile URL, email address. .. vale on From 35d7a4b40fdd392e185c08b7969b1ad69c3eca12 Mon Sep 17 00:00:00 2001 From: Rita Onwudiwe Date: Mon, 4 Nov 2024 15:10:19 +0100 Subject: [PATCH 14/14] Apply suggestions from code review To sort vale removal & heading issue Co-authored-by: Ruth Cheesley --- docs/plugins/social_login.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/plugins/social_login.rst b/docs/plugins/social_login.rst index 2db9301f..8a74985d 100644 --- a/docs/plugins/social_login.rst +++ b/docs/plugins/social_login.rst @@ -5,7 +5,7 @@ Social login With Mautic's Social Login, Users can easily sign in via their favorite social platforms like Twitter, Facebook, or LinkedIn. The social login feature automatically pre-fills Forms with profile data and updates or creates new Contacts in Mautic, streamlining the user experience. Before you begin: setup requirements ------------------------------------- +************************************ Before configuring social login, make sure you have created apps on the developer platforms for the social media profiles you want to integrate: @@ -76,4 +76,3 @@ Each platform provides different user data fields. Here's a quick reference of t - **LinkedIn**: first name, last name, maiden name, formatted name, headline, location, summary, specialties, positions, public profile URL, email address. -.. vale on