diff --git a/docs.json b/docs.json index 9f05b5e..cfe578d 100644 --- a/docs.json +++ b/docs.json @@ -92,6 +92,7 @@ "manage/clients/nat-traversal", "manage/clients/install-client", "manage/clients/configure-client", + "manage/clients/client-logs", "manage/clients/update-client", "manage/clients/credentials", "manage/clients/fingerprinting", diff --git a/manage/clients/client-logs.mdx b/manage/clients/client-logs.mdx new file mode 100644 index 0000000..f7bee5b --- /dev/null +++ b/manage/clients/client-logs.mdx @@ -0,0 +1,72 @@ +--- +title: "Client Logs" +description: "View Pangolin client logs on Windows, Mac, Linux, Android, and iOS" +--- + +import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx"; + + + + + +How you access client logs depends on the platform. Use the section for your client type below. + +## Windows + +You can view logs in the Pangolin client GUI under **Preferences > Logs**. + +You can also open the log file directly. The default location is: + +``` +C:\ProgramData\pangolin\logs\pangolin.log +``` + +To tail the log in PowerShell: + +```powershell +Get-Content "C:\ProgramData\pangolin\logs\pangolin.log" -Tail 0 -Wait +``` + +## Mac + +Mac uses the Apple system logger. To stream Pangolin logs: + +```bash +log stream --predicate 'subsystem == "net.pangolin.Pangolin" OR subsystem == "net.pangolin.Pangolin.PacketTunnel"' --level debug --style compact +``` + +## CLI / Linux + +The default log file location is: + +``` +~/.config/pangolin/logs/client.log +``` + +If you run `pangolin up` in detached mode, you can tail logs with: + +```bash +pangolin logs client -f -n 10 +``` + +This example follows new log lines and shows the last 10 rows. + +Alternatively, run in attached mode to see logs in the current terminal session: + +```bash +sudo pangolin up --attach +``` + +## Android + +View logs within the app under **Preferences > Logs**. + +## iOS + +Because of how iOS handles system logging, attach the iPhone to a Mac and use Console.app to view logs. + +In Console.app, add a **Subsystem** filter for: + +``` +net.pangolin.Pangolin +``` diff --git a/manage/clients/configure-client.mdx b/manage/clients/configure-client.mdx index b3493b1..7b59675 100644 --- a/manage/clients/configure-client.mdx +++ b/manage/clients/configure-client.mdx @@ -13,6 +13,8 @@ import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx"; Each respective client has a preferences window with all currently available configuration parameters. In your desktop client, click the menu bar or system tray icon, select "More" in the menu, and click "Preferences". In the mobile apps, navigate to the "Settings" screen. +To troubleshoot connection or configuration issues, see [Client Logs](/manage/clients/client-logs) for how to view logs on each platform. + ## Preferences The following preferences control how your client handles DNS resolution and network routing. Understanding these settings helps you configure Pangolin to work best with your network setup.