pangolin_mirror/docs-v2
1
0
Fork 0
mirror of https://github.com/fosrl/docs-v2.git synced 2026-09-22 05:49:11 +02:00
Code Issues Packages Projects Releases Wiki Activity

Move interface stuff to the bottom

Browse Source
This commit is contained in:
Owen
2026-09-15 17:11:17 -04:00
parent 2bb5fd4d6b
commit 00a69567d9
1 changed files with 77 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files
manage/sites/configure-site.mdx
+77 -60
View File
@@ -88,56 +88,6 @@ Almost every setting below can also be set via an environment variable (**Env va
**Env var**: `CONFIG_FILE` **Env var**: `CONFIG_FILE`
</ResponseField> </ResponseField>
<ResponseField name="port" type="integer">
Port for the peers to connect to the site on. This can be used to keep a static port open in firewalls instead of default random ports.
**Example**: `34534`
**Env var**: `PORT`
**Config file key**: `port`
</ResponseField>
<ResponseField name="native" type="boolean">
Use a native WireGuard interface for client tunnels instead of the userspace netstack implementation.
**Default**: `false`
**Env var**: `USE_NATIVE_INTERFACE`
**Config file key**: `native`
</ResponseField>
<ResponseField name="native-main" type="boolean">
Use a native WireGuard interface for the main tunnel (instead of netstack).
**Default**: `false`
**Env var**: `USE_NATIVE_MAIN_INTERFACE`
**Config file key**: `nativeMain`
</ResponseField>
<ResponseField name="interface-main" type="string">
Name of the native main tunnel WireGuard interface (used with `--native-main`).
**Default**: `pangolin`
**Env var**: `INTERFACE_MAIN`
**Config file key**: `interfaceMain`
</ResponseField>
<ResponseField name="mtu" type="integer">
MTU for the internal WireGuard interface.
**Default**: `1280`
**Env var**: `MTU`
**Config file key**: `mtu`
</ResponseField>
<ResponseField name="dns" type="string"> <ResponseField name="dns" type="string">
DNS server to use for resolving the endpoint. DNS server to use for resolving the endpoint.
@@ -272,16 +222,6 @@ Almost every setting below can also be set via an environment variable (**Env va
**Config file key**: `disableSsh` **Config file key**: `disableSsh`
</ResponseField> </ResponseField>
<ResponseField name="interface" type="string">
Name of the WireGuard interface.
**Default**: `pangolin`
**Env var**: `INTERFACE`
**Config file key**: `interface`
</ResponseField>
<ResponseField name="metrics" type="boolean"> <ResponseField name="metrics" type="boolean">
Enable Prometheus /metrics exporter. Enable Prometheus /metrics exporter.
@@ -460,6 +400,83 @@ Almost every setting below can also be set via an environment variable (**Env va
**Config file key**: `preferEndpoint` **Config file key**: `preferEndpoint`
</ResponseField> </ResponseField>
<ResponseField name="interface" type="string">
Name of the WireGuard interface.
**Default**: `pangolin`
**Env var**: `INTERFACE`
**Config file key**: `interface`
</ResponseField>
<ResponseField name="port" type="integer">
Port for the peers to connect to the site on. This can be used to keep a static port open in firewalls instead of default random ports.
**Example**: `34534`
**Env var**: `PORT`
**Config file key**: `port`
</ResponseField>
<ResponseField name="native" type="boolean">
Use a native WireGuard interface for client tunnels instead of the userspace netstack implementation.
<Note>
Most users should not use this feature.
</Note>
**Default**: `false`
**Env var**: `USE_NATIVE_INTERFACE`
**Config file key**: `native`
</ResponseField>
<ResponseField name="native-main" type="boolean">
Use a native WireGuard interface for the main tunnel (instead of netstack).
<Note>
Most users should not use this feature.
</Note>
**Default**: `false`
**Env var**: `USE_NATIVE_MAIN_INTERFACE`
**Config file key**: `nativeMain`
</ResponseField>
<ResponseField name="interface-main" type="string">
Name of the native main tunnel WireGuard interface (used with `--native-main`).
<Note>
Most users should not use this feature.
</Note>
**Default**: `pangolin`
**Env var**: `INTERFACE_MAIN`
**Config file key**: `interfaceMain`
</ResponseField>
<ResponseField name="mtu" type="integer">
MTU for the internal WireGuard interface.
<Note>
Most users should not use this feature.
</Note>
**Default**: `1280`
**Env var**: `MTU`
**Config file key**: `mtu`
</ResponseField>
## Config File ## Config File
The site can be configured entirely with a JSON config file instead of (or in addition to) CLI flags and environment variables. Almost every flag documented above has a matching camelCase key in this file — see the **Config file key** on each flag for its exact name. The site can be configured entirely with a JSON config file instead of (or in addition to) CLI flags and environment variables. Almost every flag documented above has a matching camelCase key in this file — see the **Config file key** on each flag for its exact name.