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 000000000..f161c7bab Binary files /dev/null and b/docs/src/theme/DocCard/assets/logs-error.png differ 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 (