mirror of
https://github.com/fosrl/docs-v2.git
synced 2026-10-01 10:19:23 +02:00
add platform specific configure clients
This commit is contained in:
miloschwartz
@@ -52,7 +52,7 @@ sudo pangolin up --attach
|
||||
|
||||
## Android
|
||||
|
||||
View logs within the app under **Preferences > Logs**.
|
||||
Turn on **Enable Log Collection** under **Preferences**. Tunnel logs are then saved to a file you can download from the app. You can also view logs under **Preferences > Logs**. See [Configure Clients](/manage/clients/configure-client).
|
||||
|
||||
## iOS
|
||||
|
||||
|
||||
@@ -1,17 +1,19 @@
|
||||
---
|
||||
title: "Configure Clients"
|
||||
description: "Configure Olm for connecting to Pangolin clients"
|
||||
description: "Configure Pangolin clients to work best with your network setup"
|
||||
---
|
||||
|
||||
## GUI Clients (Mac, Windows, Android, iOS/iPadOS)
|
||||
|
||||
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.
|
||||
Each client has a preferences window. On Mac and Windows, click the menu bar or system tray icon and select "Preferences". In the mobile apps, open the "Preferences" screen.
|
||||
|
||||
The preferences in the next section are shared across platforms. Each platform section after that covers settings that exist only on that client. When a client has a config file, that file is documented in an **Advanced** subsection of the platform.
|
||||
|
||||
To troubleshoot connection or configuration issues, see [Client Logs](/manage/clients/client-logs) for how to view logs on each platform.
|
||||
|
||||
## Preferences
|
||||
## Shared 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.
|
||||
The following preferences control how your client handles DNS resolution and network routing. They are available on Mac, Windows, Android, and iOS/iPadOS.
|
||||
|
||||
### Enable Aliases (Override DNS)
|
||||
|
||||
@@ -57,7 +59,7 @@ By default, when match domains are not set, all DNS queries are sent to the conf
|
||||
|
||||
### Exit Nodes Take Precedence Over Resources
|
||||
|
||||
By default this is disabled. When a client is connected using an exit node other Pangolin resources will still be accessible and resolvable - even on other sites not designated on the exit node resource. In this way Pangolin is still split tunneling these destinations. By enabling this setting, you are configuring Pangolin to ignore other resources outside of the exit node - all traffic will flow to and through the exit node resource and DNS aliases and subnets on other resources will no longer function.
|
||||
By default this is disabled. When a client is connected using an exit node other Pangolin resources will still be accessible and resolvable even on other sites not designated on the exit node resource. In this way Pangolin is still split tunneling these destinations. By enabling this setting, you are configuring Pangolin to ignore other resources outside of the exit node. All traffic will flow to and through the exit node resource and DNS aliases and subnets on other resources will no longer function.
|
||||
|
||||
### MTU
|
||||
|
||||
@@ -70,7 +72,17 @@ You can set the maximum transmission unit (MTU) for the client’s internal Wire
|
||||
change it, you must update every connected site to the identical value.
|
||||
</Warning>
|
||||
|
||||
## Windows Client (Advanced)
|
||||
## Windows
|
||||
|
||||
### Start at Login
|
||||
|
||||
When enabled, Pangolin starts when you sign in to Windows.
|
||||
|
||||
### Connect at Start
|
||||
|
||||
When enabled, the tunnel connects whenever Pangolin starts. This also opens Pangolin at sign-in.
|
||||
|
||||
### Advanced
|
||||
|
||||
On Windows, the Pangolin GUI reads configuration from two `pangolin.json` files:
|
||||
|
||||
@@ -132,11 +144,11 @@ Most keys in the `Config` object below can be set in either file. If the same ke
|
||||
</ResponseField>
|
||||
|
||||
<ResponseField name="openUIAtLogin" type="boolean">
|
||||
When true, opens the Pangolin UI when the user signs in to Windows. If omitted, the default is `false`.
|
||||
When true, matches the **Start at Login** preference and starts Pangolin when you sign in to Windows. If omitted, the default is `false`.
|
||||
</ResponseField>
|
||||
|
||||
<ResponseField name="autoConnectAtLogin" type="boolean">
|
||||
When true, the client connects automatically whenever the app starts. This also opens the Pangolin UI at sign-in, regardless of `openUIAtLogin`. If omitted, the default is `false`.
|
||||
When true, matches the **Connect at Start** preference. The tunnel connects whenever Pangolin starts, and Pangolin also opens at sign-in, regardless of `openUIAtLogin`. If omitted, the default is `false`.
|
||||
</ResponseField>
|
||||
|
||||
<ResponseField name="autoUpdateChecksEnabled" type="boolean">
|
||||
@@ -170,7 +182,25 @@ As a system administrator, you can script placing `pangolin.json` in `%ProgramDa
|
||||
your enterprise license.
|
||||
</Tip>
|
||||
|
||||
## Mac Client (Advanced)
|
||||
## Mac
|
||||
|
||||
### Start at Login
|
||||
|
||||
When enabled, Pangolin opens automatically when you log in to your Mac.
|
||||
|
||||
### Connect Automatically On
|
||||
|
||||
Choose when Pangolin may connect automatically. **Connect** enables on-demand for that interface; **Disconnect** disables it.
|
||||
|
||||
**Ethernet** connects automatically while the Mac is on Ethernet.
|
||||
|
||||
**Wi-Fi** connects automatically while the Mac is on Wi-Fi. You can limit which networks that applies to:
|
||||
|
||||
- **Any Wi-Fi Network** connects on every Wi-Fi network.
|
||||
- **Only these Wi-Fi Networks** connects only on the networks you list.
|
||||
- **Except these Wi-Fi Networks** connects on every network except the ones you list.
|
||||
|
||||
### Advanced
|
||||
|
||||
On Mac, the Pangolin GUI reads configuration from `~/Library/Application Support/Pangolin/pangolin.json`. Restart Pangolin after editing for changes to apply.
|
||||
|
||||
@@ -207,15 +237,15 @@ On Mac, the Pangolin GUI reads configuration from `~/Library/Application Support
|
||||
</ResponseField>
|
||||
|
||||
<ResponseField name="onDemandWiFiEnabled" type="boolean">
|
||||
When true, the client connects on demand whenever the Mac is on Wi-Fi. Use `onDemandSSIDOption` and `onDemandSSIDs` to limit this to specific networks. If omitted, the default is `false`.
|
||||
When true, matches the **Wi-Fi** option under **Connect Automatically On** and connects on demand whenever the Mac is on Wi-Fi. Use `onDemandSSIDOption` and `onDemandSSIDs` to limit this to specific networks. If omitted, the default is `false`.
|
||||
</ResponseField>
|
||||
|
||||
<ResponseField name="onDemandNonWiFiEnabled" type="boolean">
|
||||
When true, the client connects on demand whenever the Mac is on Ethernet. If omitted, the default is `false`.
|
||||
When true, matches the **Ethernet** option under **Connect Automatically On** and connects on demand whenever the Mac is on Ethernet. If omitted, the default is `false`.
|
||||
</ResponseField>
|
||||
|
||||
<ResponseField name="onDemandSSIDOption" type="string">
|
||||
Which Wi-Fi networks on-demand applies to when `onDemandWiFiEnabled` is true. Supported values are `any` (every Wi-Fi network), `only` (just the networks in `onDemandSSIDs`), and `except` (every network other than those in `onDemandSSIDs`). If omitted, or if `onDemandSSIDs` is empty, the default is `any`.
|
||||
Which Wi-Fi networks on-demand applies to when `onDemandWiFiEnabled` is true. Supported values are `any` (**Any Wi-Fi Network**), `only` (**Only these Wi-Fi Networks**, the names in `onDemandSSIDs`), and `except` (**Except these Wi-Fi Networks**). If omitted, or if `onDemandSSIDs` is empty, the default is `any`.
|
||||
</ResponseField>
|
||||
|
||||
<ResponseField name="onDemandSSIDs" type="array of strings">
|
||||
@@ -241,7 +271,37 @@ On Mac, the Pangolin GUI reads configuration from `~/Library/Application Support
|
||||
</Expandable>
|
||||
</ResponseField>
|
||||
|
||||
## Android Battery Optimization
|
||||
## iOS/iPadOS
|
||||
|
||||
### Dynamic Island and Live Activity
|
||||
|
||||
When enabled, Pangolin shows connection status in the Dynamic Island and on the Lock Screen.
|
||||
|
||||
### Connect Automatically On
|
||||
|
||||
Choose when Pangolin may connect automatically. Tap **Connect** to enable on-demand for that interface; **Disconnect** disables it.
|
||||
|
||||
**Cellular** connects automatically while the device is on cellular.
|
||||
|
||||
**Wi-Fi** connects automatically while the device is on Wi-Fi. You can limit which networks that applies to:
|
||||
|
||||
- **Any Wi-Fi Network** connects on every Wi-Fi network.
|
||||
- **Only these Wi-Fi Networks** connects only on the networks you list.
|
||||
- **Except these Wi-Fi Networks** connects on every network except the ones you list.
|
||||
|
||||
## Android
|
||||
|
||||
### Show Persistent VPN Notification
|
||||
|
||||
When enabled, Pangolin keeps a status notification while connected. A temporary notification may still appear when connecting or recovering. Android's own VPN indicators are unaffected.
|
||||
|
||||
Leaving this on makes it less likely that Android will stop the connection while the app is in the background.
|
||||
|
||||
### Enable Log Collection
|
||||
|
||||
When enabled, tunnel logs are saved to a file that can be downloaded for troubleshooting. See [Client Logs](/manage/clients/client-logs).
|
||||
|
||||
### Battery Optimization
|
||||
|
||||
To ensure Pangolin functions correctly in the background on Android devices, it's recommended to disable battery optimization for the app. This prevents the operating system from restricting its background activities, which could lead to disconnections.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user