mirror of
https://github.com/fosrl/docs-v2.git
synced 2026-02-17 10:26:44 +00:00
add platform specific install instructions
This commit is contained in:
@@ -7,7 +7,7 @@ description: "Learn about the fundamentals of Pangolin and how they work togethe
|
|||||||
## Basic Steps
|
## Basic Steps
|
||||||
|
|
||||||
<Steps>
|
<Steps>
|
||||||
<Step title="Link remote network via sites">
|
<Step title="Link remote networks with sites">
|
||||||
Join remote networks together using site connectors. Pangolin's lightweight connectors use intelligent routing and NAT traversal to make any network anywhere available.
|
Join remote networks together using site connectors. Pangolin's lightweight connectors use intelligent routing and NAT traversal to make any network anywhere available.
|
||||||
</Step>
|
</Step>
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
- [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.
|
- [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
|
## Mac
|
||||||
|
|
||||||
- [Pangolin for macOS Installer](https://pangolin.net/downloads/mac) - This is the official page to download the latest installer file for macOS.
|
- [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.
|
- [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 (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.
|
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.
|
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.
|
||||||
</Note>
|
</Note>
|
||||||
|
|
||||||
|
### 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
|
||||||
|
|
||||||
Olm CLI is the most basic form of a client. All other clients implement Olm under the hood in some form.
|
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.
|
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.
|
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.
|
Once /dev/net/tun is available, the olm can run within the LXC.
|
||||||
|
|||||||
Reference in New Issue
Block a user