Skip to content

Commit abfdb16

Browse files
defguard-communitygitbook-bot
authored andcommitted
GITBOOK-447: change request with no subject merged in GitBook
1 parent f12a009 commit abfdb16

8 files changed

Lines changed: 13 additions & 8 deletions

File tree

.gitbook/assets/obraz (1) (1).png

62.7 KB
Loading

.gitbook/assets/obraz (1).png

105 KB
Loading

.gitbook/assets/obraz (2) (1).png

62.7 KB
Loading

.gitbook/assets/obraz (2).png

-40.1 KB
Loading

.gitbook/assets/obraz.png

111 KB
Loading

admin-and-features/setting-up-your-instance/gateway/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This instruction helps configuring Defguard Gateway in OPNsense. This is based o
99
### Configure Defguard Gateway plugin
1010

1111
1. Go to **VPN → Defguard Gateway**
12-
2. Fill out the approriate values in the form
12+
2. Fill out the appropriate values in the form. You can read more about the available configuration options here: [#gateway-configuration](../../../configuration.md#gateway-configuration "mention")
1313
3. Eventually, **Start/Restart** the service.
1414

1515
<figure><img src="../../../.gitbook/assets/OPNSense Plugin.png" alt="OPNSense plugin"><figcaption></figcaption></figure>

configuration.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ This is of course not recommended in production but can be useful when testing w
9494

9595
[More on that in this help page.](deployment-strategies/grpc-ssl-communication.md)
9696

97-
* `DEFGUARD_GRPC_PORT`: gRPC server port, default `50055`
97+
* `DEFGUARD_GRPC_PORT`: the port on which the gRPC server should listen, default is `50055`. This port is used by Defguard Gateways to connect to your Core instance.
9898
* `DEFGUARD_GRPC_CERT` (optional): path to TLS certificate file
9999
* `DEFGUARD_GRPC_KEY`(optional): path to TLS key file
100100
* `DEFGUARD_GRPC_URL`: external URL of your instance's gRPC server, default `http://localhost:50055`; used for generating example VPN gateway startup command in Web UI
@@ -123,20 +123,25 @@ Here are proxy ENV variables. gRPC configuration is described more [on this help
123123

124124
If you're using docker image you can pass this value as environmental variables or on binary you can pass them as arguments
125125

126+
* `DEFGUARD_GRPC_URL` , `-g <URL>` - Defguard Core gRPC endpoint URL. This is used by the gateway to connect to your Defguard Core instance. If you configured the `DEFGUARD_GRPC_URL` variable on your Core instance before (as described in the [#grpc-server-configuration](configuration.md#grpc-server-configuration "mention") section), use the same value here. Otherwise, provide an URL that will allow the Gateway to reach your Core instance, e.g. `http://localhost:50055` if both Core and Gateway are running on the same host.&#x20;
127+
* `DEFGUARD_TOKEN` ,`-t <TOKEN>` - Token displayed in the Defguard Core web UI after completing the network wizard. It can be copied from the "Authentication Token" section on the Location Settings page.
128+
129+
<figure><img src=".gitbook/assets/obraz (1).png" alt=""><figcaption></figcaption></figure>
126130
* `DEFGUARD_USERSPACE` , `-u` - Use userspace wireguard implementation, useful on systems without native wireguard support
127-
* `DEFGUARD_GRPC_URL` , `-g <URL>` - Defguard server gRPC endpoint URL default is https://localhost:50055
128131
* `DEFGUARD_GRPC_CA - path to ca file` more on this topic [on this help page.](deployment-strategies/grpc-ssl-communication.md)
129132
* `DEFGUARD_STATS_PERIOD` ,`-p <SECONDS>` - Defines how often (seconds) should interface statistics be sent to the Defguard server
130-
* `DEFGUARD_TOKEN` ,`-t <TOKEN>` - Token received on Defguard after completing network wizard
131133
* `DEFGUARD_GATEWAY_NAME`, `--name <NAME>` - (optional) human-readable gateway name that will be displayed in Defguard webapp
132134
* `-s, --use-syslog` - enable logging to syslog
133135
* `RUST_LOG` : Logger log level, default: `info`, supported: `debug`, `warn`, `error`
134136
* `DEFGUARD_MASQUERADE` - controls whether the gateway automatically applies masquerade NAT firewall rule; defaults to `false`
135-
* `DEFGUARD_DISABLE_FW_MGMT` - disables all firewall management by the gateway; this overrides `DEFGUARD_MASQUERADE` setting; defaults to `false` \\
137+
* `DEFGUARD_DISABLE_FW_MGMT` - disables all firewall management by the gateway; this overrides `DEFGUARD_MASQUERADE` setting; defaults to `false`&#x20;
138+
139+
{% hint style="info" %}
140+
`DEFGUARD_DISABLE_FW_MGMT` is meant as a workaround for running in incompatible environments, where our [default firewall integration](admin-and-features/access-control-list/firewall-internals.md) is not supported.
136141

137-
\{% hint style="warning" %\} `DEFGUARD_DISABLE_FW_MGMT` is meant as a workaround for running in incompatible environments, where our [default firewall integration](admin-and-features/access-control-list/firewall-internals.md) is not supported.
142+
As a consequence, enabling this option disables [ACL functionality](admin-and-features/access-control-list/) on a given gateway.
143+
{% endhint %}
138144

139-
As a consequence, enabling this option disables [ACL functionality](admin-and-features/access-control-list/) on a given gateway. \{% endhint %\}
140145
* `HTTP_BIND_ADDRESS`: The IP address that the HTTP should bind to (available since version 1.5.0)
141146

142147
#### Executing custom commands on VPN up/down

deployment-strategies/gateway/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ opnsense-patch
124124

125125
<figure><img src="../../.gitbook/assets/OPNSense Plugin.png" alt=""><figcaption></figcaption></figure>
126126

127-
5. Fill out the form with appropriate values, click **Save**, and then click **Start/Restart**.
127+
5. Fill out the form with appropriate values, click **Save**, and then click **Start/Restart.**
128128

129129
{% hint style="info" %}
130130
You can find detailed description of all fields [here](../../configuration.md#gateway-configuration).

0 commit comments

Comments
 (0)