From 059461db49775e985fa6c18d74b3c1be4727401b Mon Sep 17 00:00:00 2001 From: Arista Indrajaya Date: Wed, 6 Mar 2024 13:57:27 +0700 Subject: [PATCH] docs: Add guides doc for how to get error logs --- .../error-codes/how-to-get-error-logs.mdx | 49 ++++++++++++++++++ docs/src/theme/DocCard/assets/logs-error.png | Bin 0 -> 4698 bytes docs/src/theme/DocCard/index.js | 10 +++- 3 files changed, 57 insertions(+), 2 deletions(-) create mode 100644 docs/docs/guides/error-codes/how-to-get-error-logs.mdx create mode 100644 docs/src/theme/DocCard/assets/logs-error.png diff --git a/docs/docs/guides/error-codes/how-to-get-error-logs.mdx b/docs/docs/guides/error-codes/how-to-get-error-logs.mdx new file mode 100644 index 000000000..045468e33 --- /dev/null +++ b/docs/docs/guides/error-codes/how-to-get-error-logs.mdx @@ -0,0 +1,49 @@ +--- +title: How to Get Error Logs +sidebar_position: 5 +description: A step-by-step guide to get the Jan app error logs. +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + troubleshooting, + permission denied, + ] +--- + +To get the error logs of your Jan application, follow the steps below: +### Jan Application +1. Navigate to the main dashboard. +2. Click the **gear icon (⚙️)** on the bottom left of your screen. +3. Under the **Settings screen**, click the **Advanced Settings**. +4. On the **Jan Data Folder** click the **folder icon (📂)** to access the data. +5. Click the **logs** folder. + +### Jan UI +1. Open your Unix or Linux terminal. +2. Use the following commands to get the recent 50 lines of log files: +```bash +tail -n 50 ~/jan/logs/app.log + +``` + +### Jan API Server +1. Open your Unix or Linux terminal. +2. Use the following commands to get the recent 50 lines of log files: +```bash +tail -n 50 ~/jan/logs/server.log + +``` +:::warning +Ensure to redact any private or sensitive information when sharing logs or error details. +::: + +:::note +If you have any questions or are looking for support, please don't hesitate to contact us via our [Discord community](https://discord.gg/Dt7MxDyNNZ) or create a new issue in our [GitHub repository](https://github.com/janhq/jan/issues/new/choose). +::: \ No newline at end of file diff --git a/docs/src/theme/DocCard/assets/logs-error.png b/docs/src/theme/DocCard/assets/logs-error.png new file mode 100644 index 0000000000000000000000000000000000000000..f161c7babac4828dd7378012b978d62d59872985 GIT binary patch literal 4698 zcmZvAXH*kF({AWZdhdwRLl;4m-lR(>NDB~ZfY6(OLI9QCL7D*p>7gT?AWb?Z^r|2& z6e-f-_8P^*~6IeClKs^%j4qp^hHg{3Z- zaj~<@SIH@^IG41{;qlwM=C5SG1dDYFJsXTovM>>84KgNFG&(2oA{(d4$q>)yhAEds zU++-7{-Gwvr=KsQgcxHUkj>v+TV(Mw1}-<=Nr+%a1CIJl2qyGLR+_0k-# zaL}e3-rqirtJ?o%#3h@~muMe6jtuD4+0QET>*k)HsB_99#T71aK`@jum@mkNAcjwy z*~{kv&j|z*G0+|JoM(X9G%a=cN#T*R5J99iLt*49?rH*ebi_-Pkn1o?9`iSDh_j$?I@;P)7h zPfz_^D;vyB$?YU`=EhoF%(GR>930B7RgEBeQg3pNO|(p+FC3D1l^7zG-Rs+>M}|D2 zQ)Mh{lE7hh^Zd-@7*KM|i3E^5uMA8U967NBUaGYS<*j;2+zdV_DHUdgpdk{HV`#B@ zy*dW_xlm;I!hCrEvW>Lhbfr9wtp6aUNpx}ClgU%x_b5IG@gykX;yCKWaU0CCZdk;3 zt6Ymepb=|QQ>*&^gV=&ZTGp4`1MY-&!^f(qUE-@wbD04LtFcPFK^QB(YmurLahm!E zJE}qTY-aS7UE9#QWO=~omAEA3sqe_y7&lfbm-Exj+67`RKOg;|+}KICIM4AK--1z;;%9Cpvv2{fa789nox|mu4n4bozVZa{aH2 z+6|bcZuG6oE?VbaF8qZhrzm&&k7W?dRLeI?GYDHcpLf!j!Q~~>@ivq{D?o4AEd!Ps zVdsO?=6*NvoAT04oEE{ID5o?NL|3a<5XL7Lsm5UK55nwTgs#jy$dVB`F}@RZvu0&t zOS`3@=rlRz5J4LLZkgbtK#R1qFa?rL%LR_f@K^|SvVAx-c_2YmvwSJvca@H4gCHow zEp5eqvSdUhRLG<$R4q*uNhrF3wuln*UZ0zP5=*R-R8J6JTz5xjN!dZ$)W;7(x=$n* z@)s<`N8+4;w;!Cq*c#E-B_JN>HPCn}hRb<&A8FJRwuX1}AD<;u&NjvViBq}gyLyA% zB-zKfwYPL!kMT66IUVcN?g9P2w^8Jo^k8Y~vA_?KrFvsP*7RD=q~C4S#59YC zvxd^e^4nX&E!H61gq{pCTMa8NZ0jrPhfZFKW53?!_TfB>#q(w$TCP^}qb~ZORO*-q zeYP7>&2Vm4IZCa9waw6ex51&r0JVztX}#|H2ujgYoC5=eNaK*jmG+Maw%3RxztOD| z9jwV7uP^5y_NM%(uCMblfYrmKVV9AkiwWgyAtzoX7$ysJUOkM5d3mIqNJJ``bEgk3 zA!$$a#aO0&w)MeZ$Gzd-%O;18r>X5vH5{*mM7KpaP$r%2^j*S`(Y?QVSwQ-4riQGN zfzyo`HG=WWsHTHO9^vfti(byV@0MYK8*Ws@{w!g7Te20#gI+gB&;7B+aw~mru;`3h zw(qFbPn5~w?3V>EbYY)%ao_Iw457GXQlLME4IAd=2irtu1(NC?fmdSokuG`D5Vr_F7w=80jm%c77d##2Z#< z6M=*N(^PAm!p7*r&&^F~yg(VQ|MN0{JdBa_ba3SUOA8C4f-Tm*2O{?5|B9<%HiFDS zS_duVIfOK!MU0s<@1$9y^`?9?XjePs0I=BAv3-4>M>p+6&;C>f1#oUtHV25*^fngD z{n(R_gME?84cY7(*P|bs-t``?RbBbI%|omwBji1>Ala9_eT>ccEx7{r%BmWsVmA>S zHI61EM}A*8OlhbDHWsnq_wJ|iI7xji(pmF2EqX3EDc!1kASdD^^`Q{^yaFUD$D=dG ztq~esRzGO4Ddx-YtenNlDY?jX@?O=-VYydN%DgkIG^8%8y6Bze{EWNjM!lm{FQb_f z>q54rF7wV_!fxftY-T@b5WJp8wAts^o04cDAHCQdU|)Nt`xmmOoLb42RR4cn^#8!S z4x|_a{kIMB)D2=!!hw+7^jXc~LNyhB?H}4j-gIe3WpvTat{nCR3qR`G%nE4PmWm59 z3EBUowL(LU`2JBf#7l~Iv1UaqiY;kp7qjZqmu~QJO zt21~Q^dl7AUXnE4vo2#(B2|AP;5b`eFP{gTTXsYX(zaFqk~j1W(KOvTlKB2Y$~0TP zb@HgzZ@aP#Q2>%}5`%_@zistl;5`*DYHpr6q-_yzpx^Omu}?!g4gAZjXzIb}f~A9$ zceJv27>(=~K#Xb@4`+8q=bP=vLw_EIo`&_P+nPl**VW{3Tz^0Jl96?H7lq0p5zZZ3 zynn`Lbn{Lfj|c~b*WLMdP@rC-eE%wF2BAucNbq6VEqQhNXexo;IY&DN-TA_Hr~UB9 zjBX;;t;Bb9r$^)*3?vauwg(itNE9w`s|nIDF?RyP0pVVv;$%u>yTGcfR^}{kBi_v4 zl>flQ^TgvJhn$J@4;3J91{D5;G!IWqfVFvaI)ipQ03p+E9h*Uv^0LkJ%ewl#+xkwv z3ifFSOT;>q?a;ZIFZzciq!|Kvqjt(Ob8|YaypVUInFxcA;9N`OkK=_~i)V%xT?Dyv zdov_@3G`ChJud-zBIXbW2YmniMS{|Sf#N&&3HJCtGY84-@^$$pn#cZdJfyGE^BM7r zZ5nKde%q#~#h4+a+?J}0$TL8qhrF=%{1VD*Rfdh)mNnlN{0eH^Y1Ojcz*Knppei-e z_2Gj?JI2apz9}>vF9rBw>arWsM6HM+B%dx!9ZCFo6!D!vc`qhVS~Ypp0$0fgvuZ#k zT5p_HEYtN}v=`qYHd*t?R6?eV$<35*?I zNroAlzN93F?B&mzfwxJtqTw4tI;`?LYq7`?d>$3l5&LjsW+}>!KJ5XCHt}?EO0sTy zbRaj-T4^W=34a$fV8Lvbc@3hcd&oA+=8dtaCXU6&z()SuC?}A{;;RkHa06-R5d9g* zm#^R)8E~}-?vYg*29l4qQJUtD`6C!rz!$<_rxkmlw3EKhx8B_7SDTFiD%xZu71m{! z8!)e>^^@%I^QCn^cre%E@(x^SX`g6zL8<+Ywg+1`}E!HJ8b$)NAbpe-7_kwSjq8@i{^gf8k@*P~Q1(zfi zMnJ=`M*0|tqJL=)7fM1Bn{k1us})h)|NjB!y_#;i#4dcb#k-(i_-Wn(#P_hE!osJ& z4c~*sdpq3VA(({lql@d7(Z_4PPi^7xF6V{-EEzk`|&P_^G ztuEAD{kt-H1-$h0ztg0=CZxCt%@gvco633Eb%0~jRpjYz5LS*K8FM^!cTZd33!nIe zzi;F1g6(FPc-%(3qrBeX1dWK1V--(9TH@PlF}<$C{phrn7m2)VdR>vQ zkHx~{yDp0#%LuK$_j275pXqw8wrqvlOR|kvu@Jdl5L7Bt>XAF?jS)_d|EYNKftIQj z)f(z}ZfbAE;I=q;b-OvE9NgW(IZCn)!>15j?3M=m1w3&Sit`Dxe{_Y9{GL0GqMmsf zNmhy&Y*SfP^}b6rL#?++Dok~+eqOtZNo4aH@n^GK8x><;2TB^l;sB12^*y>2mhRLh;nw5N!w z16WToksZ-CNAc;~z9!d5LdqNla|gj*wSD^;vgEQ(g8elVw*O?WQ)Bt}am2*@&VGgi#J>YMdafxn;*L9B`<m)s2=22#9W z%>PMxq*^xvUHPVc9EZn&F&DgLi0_-J4{IsoJ}@0~apIm6S!lW`E}84yJa5&1!4ltB zVE4?=wrAd`6F*6ezg1>=Uo)Oy;}2EQ%?lxu(nOE6=oMA+kh<&>(nrnbyg(ig^<}a? z!)Jium`v^WyJQA4(h2g^_{;fK_U#)Fp{;dbX?M`y}aXY=<(s>1Q9ruoJPhxR$e$0K$ok2pgg zr`>b9z$XkVj}=^k!S|&1@@X;@U*vh`ZFG(+e%kQHDuPoE*XFJtQB!y(1|_cFa$}F;_Q)MYVE#)LW37UcGdhK^DjNug z`odLX;l5&Wfctvd%sJQNOQRv;;}qu4G7M`B|1GECL~U5vX%$)<3?Oxsz~W1ON>7Ai z42OujkoOa*8`*aB#2SN8Lh_|~nZvp@ATZ*EHh*^;EZA`9{hzdW=68nMi^kwWPhXdB za(ld#(o(N~q{l%Yv4Hg6n|F1nn sYTC6v=f|y)DpfPa16*@bJDfK>Z`umJ?;HU%)$~-Wm2D&b2TM958~^|S literal 0 HcmV?d00001 diff --git a/docs/src/theme/DocCard/index.js b/docs/src/theme/DocCard/index.js index 2246ef3c1..b0723058b 100644 --- a/docs/src/theme/DocCard/index.js +++ b/docs/src/theme/DocCard/index.js @@ -45,6 +45,7 @@ import gpu from './assets/gpu.png'; import mistral from './assets/mistral.png'; import lm from './assets/lm.png'; import ollama from './assets/ollama.png'; +import logsError from './assets/logs-error.png'; function CardContainer({href, children}) { return ( @@ -166,7 +167,7 @@ function CardLink({item}) { Logo ) : (item.label === "Broken Build") ? ( Logo - ) : (item.label === "Jan not using GPU") ? ( + ) : (item.label === "Troubleshooting NVIDIA GPU") ? ( Logo ) : (item.label === "Mistral AI") ? ( Logo @@ -174,10 +175,15 @@ function CardLink({item}) { Logo ) : (item.label === "Ollama") ? ( Logo + ) : (item.label === "How to Get Error Logs") ? ( + Logo ) : ( // If not "Customize Engine Settings", use default icon '📄️' - ); + ); + + + const doc = useDocById(item.docId ?? undefined); return (