From c4ea263129303c686ea312baf2c59ee096cc0ab5 Mon Sep 17 00:00:00 2001 From: JohnGrubba Date: Mon, 24 Jun 2024 19:41:45 +0200 Subject: [PATCH] Add MK Documentation --- .github/workflows/ci.yml | 23 ++++++++++++++++++++ README.md | 19 +++++++---------- docs/email.md | 1 + docs/ezauth_banner.png | Bin 0 -> 12554 bytes docs/index.md | 17 +++++++++++++++ mkdocs.yml | 45 +++++++++++++++++++++++++++++++++++++++ 6 files changed, 94 insertions(+), 11 deletions(-) create mode 100644 .github/workflows/ci.yml create mode 100644 docs/email.md create mode 100644 docs/ezauth_banner.png create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..4a2fd94 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,23 @@ +name: ci +on: + push: + branches: + - master + - main +permissions: + contents: write +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 + with: + python-version: 3.x + - uses: actions/cache@v2 + with: + key: ${{ github.ref }} + path: .cache + - run: pip install mkdocs-material + - run: pip install pillow cairosvg + - run: mkdocs gh-deploy --force \ No newline at end of file diff --git a/README.md b/README.md index 02d1d4e..ad49c17 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,12 @@ -# EZAuth + -- Fully Customizable Authentication Service -- Built on top of FastAPI and MongoDB +

High performance self-hosted and fully customizable authentication service

-## Inbuilt E-Mail Templates +## Disclaimer -### 1. Email Verification -- Can be enabled in the `config.json` file. -- Check here for predefined placeholders. +- ⚠️ The project is under **very active** development. +- ⚠️ Expect bugs and breaking changes. +- ⚠️ Make sure to always have a backup of your user data. -### 2. Welcome Email -- Can be enabled in the `config.json` file. -- Will be sent out after the user has successfully verified their email address. -- Check here for predefined placeholders. \ No newline at end of file +> [!NOTE] +> The Documentation is still in progress. \ No newline at end of file diff --git a/docs/email.md b/docs/email.md new file mode 100644 index 0000000..f3e7801 --- /dev/null +++ b/docs/email.md @@ -0,0 +1 @@ +# EMAIL Configuration \ No newline at end of file diff --git a/docs/ezauth_banner.png b/docs/ezauth_banner.png new file mode 100644 index 0000000000000000000000000000000000000000..44f047e83abf7c89b3c3a48dd7008b25c166764b GIT binary patch literal 12554 zcmbVThd${uHrqhUrOTM`nK_}$|nJs$V@yxy<(Yd&8?^c|fWjC7oI5D0|vrlz_+1Oml@|CiHHfq%bk z6=J|IS`STAZwQ2*mGnaf$;e`dK%|>)s;e6MXDv+z`EWUg9Ib7!dpkqVgkOE|`tE}U zHYW)x8YHZ`U-G7Au*J6*w!$#W>4@x14gT{UI$dWj{@64CE zqR3Ne9Z&L;z04X!3!XF2KKEkmUr9)GF}1uIl%Bn^xIBmI;aOSkQtEZ|6^?IF?Ctu= z0D}pz{!1Dc4)^9>hT9-g^E=6Rkf~TGV8a zqhi>k_n$>CnLo$20=$>($ZP+H66HR2!^}$DEA{ww_4{n6ap;_hO$P$QYyR!Qor~5F z%d3a3$xm+xO&rp!_7arH*2#41Ejx8tjz5WShFnw^h3i6T;H=x{JXENf*0u+v=_i9n zF8c4~g#UxDq6p84-3M0$jz2HzGQ^?|W>X$q^=73|$4kt8v|E{&%CL(>N1(LPXWM(Ye6ey(c6Egp0-^Ms=rNQ8@DS zQ8bAj33xZzpVnhe2tME{XUfVhP5sM!!m3?yG2doVT??HFM4U?H?!82Xsmhp(Q8!e= zxJKzFegzgypHS5QS^Ne(n5j#dg05olpIf^i7UeCzC-31#U0XkuHFv^dk=|(w=Dly- z254<`XL#LHgZ22j5;3}&A0tRAH!?>Iv0Ei3iuBQZR`eAx=oWbSk$AhO3VqYT_Nmi2 z4e=nVZL#wH4TmGD6ZSauJSi)3Mw8oq&@=p%%vz(v^p_bi>y|H4V^O8@jjaDYbw>s~ zHQ|5eQ3?6nPdG&qeG#9eZ6_y7f9iYb0~yKj9fUy+EPYwxb#4$aqcMvJ0prsDqK7)3=CxClCB$?v%rY+P0pz z=JxngA(z(b_yqN|9_RYk^t-%CG{6^%N; zxyqAgitnaWj?N16)b}GEpD2@GK#KHTX86UtW#f)zE#w;3fyjJvgPoXaaJ#xmTJhLQ z-RL1%QSXD#n>T7M z`|m#>8-I51cUHM;=y=xX9KnC@5`GVs{ft^_iMOzkR@ryzX?*am(oPkst@p|<#%>(( zvnwWRr`h{kJKN)kfHK9Iy+4@T z#v*w~LRx*bYgqf&5kX|m+Lq^fWyR4Udr)Jp%F`(>rA_ynfpw_fd2YFNxa7l-*P+Y< z!kejz<2Z%b@1<$I{Jl$5?PhmJE3#HRvsdPljI9)^5_WbrkSwT$q`eYp}gaodnW9**Bhu2*W$+LTNz@nZoey#!4hvaQCIG(>gxH-xuuMDG)UC#bUsHj{joB+~i{m z1^&r%jfb5GJklb*F5dT|| z_%1$zU2G5G#KKaOSR=o)tgeSQuOQtOHCNlrCt8;1zOyptgo>TC~mjpQ$7SSOVvFh!y zfu=mNG>7cGTLW0mpA5h%?8M%Ygdho-khL#5e?-XzQ6iX^`t{3wxill}*UY_5^PIwg z%$;7s#@_1y*Lt@8yZ3Sh2(+h#mCGFa(Woeaf)CK-{_3)t3G<`6#f?Vjz_=mPYIjqVlI2T@v;S;YowtySg!HQot;~9Ua*?v8W(r zO3jiOQxRy{J7Y;?zMyGNEmGwxwtC$W*!Vd*1+}J#G37@M(9!w8oLz?oga_uI6~#xi zB=Y-)p0&bik=MpqJ9j}i-X}?dQ&|A3Me2@9jf3IvQvvj2PxiuVhr8v}Xc4Z&eT2=!Lw!$yD z1KF5S31bc~vT|;yJ5Cvzk~>rOyL5zVFRJMDRP@WzRGp7gpM^`V)mx6UmX4%Q+=bZ} zpDtwK@)i*I`6q3ps=gPYUQv5#7$<-@{y+eCvF5~&Nk^v{VLnD`jD}W2%QE`ky-j=qwBLRm5 z<2DASYhkh(#G24dYnlx*qBu(c^izeffUMbNhL=wlMk9l7=hlWom_ZXS#hc8ZG58*)t=~2TzDKT~xkij?rI%XCxYvjD7TG&UBSO7NIUmx&n1ibq`BL zG717*zF!ET7EHFfDH6dxP6&+sZ65hG6}(S<#bhoDJ5C#~%93c~+`D3$RRLp(0Ixv3 zoAF-m7!b@@5)*~QqQ>)RY!=-{%zdI!QP&zQJ1<}-@d^Tcq!?oRQ@YOvIPDUiEH1wU z3KD1BB?l7Mp$r~^UACXRF<0T=u_rqi?7lm&7FzVg1Wel^+Rse z^w^v~4sQ4Jzx@<9XEUWc*9&#U^Iz+u+K0f05tcKc$iB7(=CShH z4#d^OyE#^$48)%S=d*SiGdB0V670Lxq;iZVq_2}0(IGPv>^W8AFk-$hM`SMW!ZaZN zB?V;^EejM5>ni; z$prWkyS722TAPOYd51QH+5}ybN(UcHtXfb*no>_fJ2%2a%$WCiIV@3))5M8eAQB#W7m6o4 zZ`mdmb#e3Kn9@E?{TM=>V6{l1EW&3q8w!pg0dhOK+muGdzb^fYX*K2G5}`URjz1s%p9g?4q~~$ec{(mGrr^j>F}yY z(r5TY0{_NvO7=-y)e!;dgfntM5>Z+Qoc7^VdqC(6OFQDRWc-#sxGf4yi{Ua0`$t(r(spVloNrrxW*m^wZ@% z%qGXG@<$NrX|-3D-nAck<*TJGHh7@@*>JBTOw`qFt$kGYX_MIc>)SU{_InWO4Got6 zR?tBtd~lgJPawAe@Bmw+FSq4#TQVK6;eNvan1EZ-Y;iiUKj;BwhBpVvFLCV3N51%< zANpJM=^Y~@js7*?{U;-KDrV2o%?)zbbWY@&(d~*$T4M-^8s%D_=}i4C<+S4rRI_A4 zGR-EI?RuLOufUFt6eVyCvC@(K^Q+0Ic-fu$9RJy8AOX!R90Cc%0a>7`H^u){!B}ct zZ!2<^w{&hLYH!{fMb4nwMB1H>F@*m3^;i5VQ2%VB=dycGffo;d>@5=n<=go>*kWv% z?RxdHRb?AOJ-ynTnlMZ5zwUf-uz8@e>JteH50xfTu0?j~CtKB=iTqjgJEZitol(9M zQ`cxR`CR}5u3ct&`P83*z9%l&^MOb0cGS%mNx&ZfGFaj?Weyt^*9bV^*^WoiK&Saf zw;mdPXfM|6=Siz5iYJr~ycC(N4EqMsk=H1`TJXt1c5{Md<=p2ft`$dt9+{MCQjjXL zNFv+EWsH!QdZu{o$gJ(0R?@mbvw7f(SM9)VuqHI&yI&n#1b!{^;#2dgSld|2fwn9# zJ`q=Lbj6C;q_)y^wp%+|ojpTyzP+6$AkP(9KU;BC86uO0&vbj{Fkxio;q5tdRoqWX zh*_(aT(^04|4E?-B_1XBGg-L*Df^(N-o23#x+J`H@O(i$N>>=}5CV?#T*b!SUNW3# z)20|vGA;npUqAyW!T$5sYC(`>*Tj{rv&uoCZn>MQfrS$^4ec)=Z47OYUqy>b@&vonjew%a|Eb&pG_ z;U8{V$>+fe{I<~tY6q8xuf1YBin+y<&)aibYdU1vV{my+R@*OAvX^qkmEExj5ORl7 zemFoc_rvFZ8aXGUqy@DP&xMH z{LP_js{0Wrh}v+|%5ZR3%=VUIEj;4)VD5yNs;^35xbo&F+Bm&xIx#jbS%i zP*F7bAE1yMcNb0jQriR5W#>fHk1^>`%1w$VUx*(bCF@)${JV?Geeap20o&LID8rv_#{%uGd!sjk-9E!N-lk+Tl3-!J?=A8va70%zD)d*d z;a;=xUd2VP2x>={Vro2lyU5)@H}6>E^H5Q;LFb0U-d;)_q}{}1kY4uc0&+(|9D%=n{_*=j8{jK-;2+kSZ?PLeozHVk z4BQ@mPp>2uB{eqNl7qvGm$4v!u=^uFH5*qwMEYt#;BY$wXn6OKKiPtNM2Z!(dclg&I zr-RO{pRKSEn&m1m@i*w~L69)J{(%q~NCg6YPTbh5c_=i^kSR5D^i}G$w9kcil)Lv* zO92?E0ObsSdQ{!T)MFr16qROdokfNU87f z6%cScJMK>w1sC-`1{@8L5t&(>>tNEeU;ir8?`n;zu_(kqv%S z!^or6ax(?rf;O(Kii&KyY};r;##}}v=0T9)T0@VbK}TEaQiHUb^sMrKoPWFxuw})? z4^Z{jXEycnA1Yr8v4g%eH+-A<(EZ&d+&d@pW8Yesl0^m&KUd&3elgl~Z_NSkT}#`42>Hf_Oz5@7hWMcKDBmmU{P zl2EW=*-flAc-uDMLUSYgkiG6la-)o;Ht+8ojYUn{olq|M|D@mL!>qZML9ojqjq?=^&@ww(FO^=wHw> zrDo5SkGuZ#trddnx;cNk7m#%_35XWy)LgkAILe7^*w8Ied;CRrd56{d843oi@dpF~ zodWH3D~5cmAGDxo=*NNL$-IH$6`F!qA`Y3yJ0FkUWj|3o;x;)|i5feca@3hyKs|_d zvk1>%Ld{HjQ+TaG+mk;~pZcL!Oo0u^sDkTHCoF|#H?=O$wWU}b!|9a^ZkXf&Jq=iDG}PTY<^p1CZd@7fpwOOtJL#dqfw{chCA zx;As!k3YclFFb7EqcT|*t}CsC>4_s798Z@|AR=?kRD28Ql$1j3lwSrls3B0Vg$hl` zt${!TXS|`+d7WF5^B2_`(`BnoV|+<9vVMpV8L|pyQ_`yIX70fK=1!>BmaLdx=|K6= zZpFoyWl7r;x%JHN4X9Hj2GVMX}T zj|8;Y8T*(-zC$tTPLDziXMSNTDdUIhxXmP(l1i=4$!2@h)cSrfJuYO$YTr~rHJ?}>HQWF{uuSV~5xr4w{8NL9);%@wldU&4y+!Ty>_di*wt#1(c(4~uiDmU4T`w?0!b4tdwi<^@5rDocz}L+3r^SV=+QgGMv_Gs zLAX(p48~;tJSk+l`_<*${HK~OjEparFM&Y6o(1g$?t~*{Wa(c|Q!GS*H4RvETXTWi zv`LeQ&)98${84z@05_h)I?=z=80yt-1b!4dh7)rpHekpGq8Oo3E#xquVYiqZ;ZQK( zbE-@(cE?O{4qF+Aih_@_bSW#fBO)PJ1kda;?snbiKw#mVAE2|9AA+vupr}})6TYd1 z71yVYDx!(u!+^A^H7|VH0~33QNxptC+v5ibW7J{wkX&6D$iq``SLw^}q&HV&cZlc1 z@)URDL8;Ey-qnz6Z#-$#*vlJL-g`*1C#DWk(mhG%@#(AfQ&Os6v_m)Z8IwWat@TD* z?R-<*L%T=(V_RLp$`O>9_6Ig3_ZiVSO>@IoUPxiYKi`O%-4H@>vNgQlS#UbGqtNcI z*k{2(`Ag_Qo9sMIPO*?T0P`xSa+x|wqe+R7_vU^#hAnc(qWhVyq}D8z2{sFgQGu#mv*{MO zN7YgbdGJs1;hD==^Kc~eEu-?G%e?aG)*q{ri{C3Ugw4*U-gxUi&$q4kdVnh<#M%_p z#A!Fpsh=m^YHYSQ4#9=+#Mie3OY8@aH-q#jSj{@kOTKqPopWvfW)+*jll}^^imk8f zjL)!Qpg!yaK?dX+O`Ro{tr1?&uqUAYhIj;w9|q1S-s3c6j{PbkNI&DAS->nB7jG0@ zbE9Yc&J9WctoE>#p+siS%Df`ECvGq{UNmPHx8vRZP9p+!3R%* zGNlPclUSh?IQ5k6rNWm1;E22D{oW#ocT~Cj{=7q&4Nnf7GqTdiAYV6Q`vT6=Wj*Rt z4+O=O=Kd|74Fr8xHO;At!tfxpJ4Cl(>P^nGd-KAIg^(4p9;yt8{NKmnE08@hrtMe6 z8dx0oYO9IGpLcZxONkB2gE{dzb6>qLp75$J_f-dvn6fpuz*Bu(&~~Bv(IX9}wZndA zPF1}Le*@#et8CnsQ}`q*M=cjNbA9HHcJG%=;h*mO zl82V{Ru!G4DLo3|+@>b5j3~C04F#*V{Z2)j@6R^7QnZYgl3Q|IAD1Z~?0%)}#Qo-T zLC!Yr<8`zuM0iWfF6?X1nmwsZ>{Mv(Qm`4{uT`k%{Uj5SFpQ51S#nYGe=rBPIP(i! z@DlS8xS+nD_3tH2Lww}DoH^R*pI^6xwsokzU6Y)%S;steEL9v{S^rFQ?dlbO*i~_p zU;l!eRDZg62(k3zdl3CZ{BCehN*r*1Xk^k;K%zg8k0D1=OrbuZ1s8{{wCpa92kKJ{ ziWzkrG7+muN%+z(gA5j9ctdp`;_;FwabT&y>4(wXV3~0JD})S~yH7|6M^YcsY^xDa zTvE@iAfaUYQmaTTQ}~fDCV(>MLl4qwFcy0`)XR#=11gQV7oy=*h(e1=zwBt*^E3%; zbzAN4cx6lLb1P05GzjTl2*K?*p6H0Z=ga!s$F!T{+Q}uvj+juS39-r~ba@7u>q7ga zX`UHwUf#$CF#r539kHm%#g3J|=$e=7opVl5tfPhdcl*TyqmF%T#rKw|D9+Tc>p2@aG z3o@ccixr@yqt%ce$0kI&)0L%<_|jbw#KOEA2j9mTMLGjooyT#(hDkc40A^)(8aGMN z8hr5^=ZJZV2gd#YuR7DQp?^@Cs&yyeh&3#nkj57MtX(YZU3HukaI%;I9viD{mdy)a z6sv23u9pGq99@=0S&?ZGklZ19HI%x`8xxDP z_a4az#rsEJ5!yUrKTMK2|BeQn8|(K`8WtyUbY%nFu#INVnR@+^YcTiNSV2{*fNZl2 zy{&xXUr%g;w07#L$Q&}e-wmM!6}}<8oyWZg4ip2EHKzlc6}kg0t6BL z1h0^P9>me&&(6{BZ-c%DOLWUx53^eE(Tf#+xZJ)0k?&;>80{w$Zh0o4Qe;XhV0^M# z!kl6j-2jZ`-!CGXH7>kaa6$QLQ-89^xL}EQ`;*b{2#TZ`_csySJcM+S2)5Vb8!Fje zRXK+RsOJxV1XhLp39K@}t$bW_q={EeH1S_-V&rxbd-X6C41F$SURy`HB7bV{a zMD(m6aIi_7wx+C^OYq9vheO8xZ*O`kirEf)&sJ%r10Hg8;L z8J)!Q8b!WuG)LU6S$0!L7Mqx33Y;BCc2dLzMjdXxzobBa_#B!j_*E`t1v1CJY31BQ z#zU>*l=g#4KBz~EVec$Q5$o+%19|{dX8S5!Ry4Bl{B4!K%gP(rFq1iUwV3%8wM6pW zzUi}fYu*23e76Cz73)+VVP-O?Rx_m3KN3i}Lioq@6T^46%I z|NZya%dN<)#Jp4Pg+hY|x+TMUUaw^Q4y<|wRk^v!t-hq~wwYzcv3}8ud}U%|!|9#R z2Qa?+`eU^cbC%I0@~c`K0?Yo^Vtj0v8C4iIJvl&q>CGFsR%CdaqR(V`6dV7v91e00 zeI#c5Tqb{F@o%BPvcc2(sglB|!;Ftd0&u+g%xl)$6^0i#C90E4)1+N533c>T!^*M7}GZ>V)E@_#fRNjch6H)k= zCDcw$7GKJvlHa|K@c(L`TL|y3!bZq$@jo%Yy5nAQciB!`eU`$n@Wl1JzJglt4iFby zKP5ZtkH6l8U3y+eNi)XTK?@LhoJ)up?Y3OIO^BDh&*2-MX|Wc}F`g<=|2@4IdN#Qt zRuK#mr^W5|1OytuyeKYr1aXyr%&)iC#F72R!Wh03(Fw6yc%`^nu-qU@kV{c0#_I8T zHom=kDv|lL_fvL)SBKmM-9kXtiDT>~bNzRY1pQZ;P5V)Vv{Nk6W@Ct}up6mM7}8Ld z##0%Jc#^iiy7p_i!5Pi;nt$laJlTT0U-x1Sn2`<_ygTO9`7^KWCjENngA3aXpZre0 zeL}L7$ceX6U+b53T;B`7lGg!1>rVc$LP29>&ueRtE(CkQ} z)CWrT>}q&h^L`3}(^PYeC5A86-n1o(lm{A&l93PT zu8deiB9{V}<;Sfz0RCJ69JAj5T@4dJc0BC1pLfPA0p)yOEN3z%f{U`(XL=*g-X|t5&i3-Glz`W{Zp9@pSwf^EplM|t?e%{>WH1PXeqIBcoZy7DB7UX@q&8qaClt-zT%to+d zyDdZM%kyv!DSOcy-2Avi*}tq?evnRW7l+8qgINiF9601IC>z-U$WDF}vbC=gAs6EL zvKIEdjQBBAv5e^Eb{_7$&oQISg}I|lL3woUichze`+UYrnI1ub%Pw9~t`g+;2nQFc zD>`&twresiJVP|o&#QyGybm|JaOIzJgq?;u4hQ5V8d2mw^ZV-n<}7G4(5OoN=v8M) zVO!(oem;nr>^{J9T6YhB2qMyK=6cSvwA&mta0$UB14sP2dq%IbuqY(T!P%!SWPzQG z!SEGmAv)=OBdsNGkUKcCpT$gCG(D%j44S3)#pBcTS}ZnbVzJ>@TB{l8XTH5R{ILuc z*{15mC-R&~edF}EPc475^vZNYLuZ@|(J0-8pR0W9(2%PueCw0=%R$x?+$=0IY!6i# z2*Pd(O#ZKN5$ptneB(^4jYHDRcJy8;W%C`vRw{ABM?Przk&OdbflFky_+DG)Isf42 zor*EY5E(;!T2NzD#I}fPZYLi@oc|Pk4_3mWYELUpQs7hrSbBkgtruC3D|7R15hKEw zy5a6plT((mqRBb+?)2qwe;EGJ;txf5wXfQ~EAJ$3?O2Z8=J(BbA9?4SaR1y%- z6V*QE5W`aMW$2gJ*n9fHI`I*f(#?0LSB)OD^pmKkAQP>xy_eVgVkM*8y{hIyRl0&t zR>BIz%#UB5WDq~sKRLhbtxA|%8#|kRyzjsPfEyHq)kd%l0x-R=ZG_K#^`?KM?&?C*&^wb465Zpv82%Yiwe3bSdKyLFdyC|oEUIUaExamFCkCIIAerk5`` z-Zazn?+ASApO%R!VVtKcYOu#9h1wdZX)X;bAsbrA{9mv>txL_<2GN!D!C9QAltE`= z7J~_;q(iZPlqhK|0eCFg4I4Z&D&ETni0 z^;MM?FB0wn;k{x~bicfoly2~8hkUhxkj<6j=SjJSa`W9i+o~;gEDn83A;4r#y(<~q z?^RR&d<45kD8mFz2?}F>Me&S5sO(S3#qi!o|L{MxuZc!Uc~uRza>AreBuQHZTw1pT znQCqJ)*zw999T)o147`4IiA~XrejuE?gMt1t5L^4LO}i~Vmp9vO?QCqaGKeAaB0eKjd)nyHKW3?xj} zreATYvVwj_l_2Nl+cw555PPiNv=}226IX(nN4w^U7OkRDH=0A)M`Qg`}CXymjtz2C6PT@~!~Onc4cXC-37l7U_WFRoI*=ht*fdQLe2f&0zx=zLH}~ z>*lSr8!pePg{B7yJ!0UZn#(~Sk%!I%<^&eK z=1vDI(3d&<=~u6Ks6cK(55@f9g}1U4*CYG|Jqn23#S59wL9`$Zo?}8(fycQi#j4&7 z|F;HOT=#kt$dP2PDCal`EssWeywz4(AU)dH6?AT+v|<^#CG9P$xebaZE1B2;`qg&q z_$LL|`2$hP-?W}bkgPE4=fiHk_`KumM;TVch(<;3MBjeE)r{p^krj)gHw6j7+)>}g zHIog8gp_(?zGt62JA?+C%w+qsZ;j=?dU4HFVaF4sqAgVKVFMi~*W|Fq;m=Ct_vHV3 zHY!FO(EY#Fa_Vo|#Ohw$>#^_?5~E&nYew;36!D!s^QQl{-u zdL2!O@5#fzi;mb<08LUw3#ngV3PAd_8@iH&IpxXON1;RSai(3Yy;vfOI{e0`?~IGy zn759{2eKq483Lid$eEC3bb|5p>?KGQ#YAieVJ)r8h?jYTqbrT+;SvykK*K1u#zqjb>nZ+_!L7H*(HiFL>T2Q#+0_Vd@AJo za&TQp2o~&V{WUltn=b-Z!B>;AK_`rSin_-NqQ*3L8+#6Y^HWCdS)3FUNj;}Pu!=`! z6{30TEs3!j%P&r39tUKn8|t+O{&oO5CA;n~2M?oYqJ_J@GkNv@+4Ao?qV7_jbg>gl T9sz&c0J*85qh5N=I^ur-{utN7 literal 0 HcmV?d00001 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..0c37674 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,17 @@ +# Welcome to MkDocs + +For full documentation visit [mkdocs.org](https://www.mkdocs.org). + +## Commands + +* `mkdocs new [dir-name]` - Create a new project. +* `mkdocs serve` - Start the live-reloading docs server. +* `mkdocs build` - Build the documentation site. +* `mkdocs -h` - Print help message and exit. + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + ... # Other markdown pages, images and other files. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..b968af3 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,45 @@ +site_name: EZAuth +site_description: EZAuth is a high performance self-hosted and fully customizable authentication service +use_directory_urls: True +repo_url: https://github.com/JohnGrubba/ezauth +nav: + - Home: index.md + - Quickstart with Docker: docker_quickstart.md + - Installation: + - Linux/MacOS/Raspberry: installation.md + - Windows: windows_installation.md + - Freqtrade Basics: bot-basics.md + - Configuration: configuration.md + - Strategy Customization: strategy-customization.md + - Strategy Callbacks: strategy-callbacks.md + - Stoploss: stoploss.md + - Plugins: plugins.md + - Start the bot: bot-usage.md + - Control the bot: + - Telegram: telegram-usage.md + - freqUI: freq-ui.md + - REST API: rest-api.md + - Web Hook: webhook-config.md +theme: + name: material + logo: "ezauth_banner.png" + features: + - content.code.annotate + - search.share + - content.code.copy + - navigation.top + - navigation.footer + language: en + palette: + - scheme: default + primary: "blue grey" + accent: "tear" + toggle: + icon: material/toggle-switch-off-outline + name: Switch to dark mode + - scheme: slate + primary: "blue grey" + accent: "tear" + toggle: + icon: material/toggle-switch + name: Switch to light mode