From ea68e3a6bc8e5eada38bf3bfdb7d916827a60ed7 Mon Sep 17 00:00:00 2001 From: miloschwartz Date: Wed, 10 Dec 2025 17:47:23 -0500 Subject: [PATCH] add platform specific install instructions --- about/how-pangolin-works.mdx | 2 +- manage/clients/install-client.mdx | 71 ++++++++++++++++++++++++++++++- 2 files changed, 71 insertions(+), 2 deletions(-) diff --git a/about/how-pangolin-works.mdx b/about/how-pangolin-works.mdx index e747005..5243119 100644 --- a/about/how-pangolin-works.mdx +++ b/about/how-pangolin-works.mdx @@ -7,7 +7,7 @@ description: "Learn about the fundamentals of Pangolin and how they work togethe ## Basic Steps - + Join remote networks together using site connectors. Pangolin's lightweight connectors use intelligent routing and NAT traversal to make any network anywhere available. diff --git a/manage/clients/install-client.mdx b/manage/clients/install-client.mdx index 5d50b30..3171d08 100644 --- a/manage/clients/install-client.mdx +++ b/manage/clients/install-client.mdx @@ -8,11 +8,54 @@ description: "Install native clients for Mac, Windows, and Linux" - [Pangolin for Windows Installer](https://pangolin.net/downloads/windows) - This is the official page to download the latest installer file for Windows. - [All Versions](https://github.com/fosrl/windows/releases) - The releases section of this repository contains release notes and download artifacts for the latest version and all older versions. +### Installation Steps + +1. **Download and install the Pangolin client** + + Download and install the Pangolin client using the official .msi installer from the download button above. + +2. **Launch Pangolin** + + Open Pangolin from the Start menu or the shortcut on your Desktop. + +3. **Log in with your Pangolin account** + + Log in on your Pangolin Cloud account or your self-hosted Pangolin instance. + + - Click the Pangolin icon in the task bar's system tray and select Log in. + ## Mac - [Pangolin for macOS Installer](https://pangolin.net/downloads/mac) - This is the official page to download the latest installer file for macOS. - [All Versions](https://github.com/fosrl/apple/releases) - The releases section of this repository contains release notes and download artifacts for the latest version and all older versions. +### Installation Steps + +1. **Download and install the Pangolin client** + + Download and install the Pangolin client using the official .dmg installer from the download button above. + + - Open the downloaded .dmg file + - Drag and drop Pangolin.app into your Applications folder + +2. **Launch Pangolin** + + Open Pangolin from your Applications folder. + +3. **Install the VPN configuration** + + Follow the Pangolin onboarding flow, which will guide you to install the Pangolin VPN configuration. + + - Select Open System Settings on startup when it asks to install a network extension. + - In System Settings, under General > Login Items & Extension > By Category > Network Extensions, ensure that Pangolin.app is toggled on. + - Select Allow when Pangolin asks to add a VPN configuration. + +4. **Log in with your Pangolin account** + + Log in on your Pangolin Cloud account or your self-hosted Pangolin instance. + + - Click the Pangolin icon in the menu bar and select Log in. + ## Pangolin CLI (Linux) Pangolin CLI is the recommended way to run a client using a command line interface on Mac or Linux. Support for Windows is coming soon. @@ -41,6 +84,32 @@ wget -O pangolin "https://github.com/fosrl/cli/releases/download/{version}/pango Replace `{version}` with the desired version and `{architecture}` with your architecture. Check the [release notes](https://github.com/fosrl/cli/releases) for the latest information. +### Installation Steps + +1. **Download and install the Pangolin client** + + Install Pangolin using the installation script: + + ```bash + curl -fsSL https://static.pangolin.net/get-cli.sh | bash + ``` + +2. **Log in with your Pangolin account** + + Log in on your Pangolin Cloud account or your self-hosted Pangolin instance: + + ```bash + pangolin login + ``` + +3. **Start Pangolin** + + Connect Pangolin by running: + + ```bash + pangolin up + ``` + ## Olm CLI Olm CLI is the most basic form of a client. All other clients implement Olm under the hood in some form. @@ -228,4 +297,4 @@ Olm creates a native tun interface. This usually requires sudo / admin permissio 4. On the Add Device prompt, enter dev/net/tun in the Device Path field and select Add. 5. If the container is running, shut it down and start it up again. -Once /dev/net/tun is available, the olm can run within the LXC. \ No newline at end of file +Once /dev/net/tun is available, the olm can run within the LXC.