Skip to content

feat(opnsense): enable PID file monitoring for Defguard Gateway service #222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+6 −5
Open

feat(opnsense): enable PID file monitoring for Defguard Gateway service #222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22099e8
feat(opnsense): enable PID file monitoring for Defguard Gateway service
jamtur01 Oct 13, 2025
9f638b4
Also identified that the actions file needs to match the service name
jamtur01 Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion opnsense/src/etc/inc/plugins.inc.d/defguardgateway.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,17 @@ function defguardgateway_services()
{
$services = [];

$pidfile = (string) (new OPNsense\DefguardGateway\DefguardGateway())->general->PidFile;

$services[] = [
"description" => "Defguard Gateway",
"configd" => [
"start" => ["defguard_gateway start"],
"restart" => ["defguard_gateway restart"],
"stop" => ["defguard_gateway stop"],
],
"pidfile" => empty($pidfile) ? "/var/run/defguard_gateway.pid" : $pidfile,
"name" => "defguard_gateway",
"nocheck" => true,
];

return $services;
Expand Down
2 changes: 1 addition & 1 deletion opnsense/src/opnsense/mvc/app/controllers/OPNsense/DefguardGateway/forms/general.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@
<id>defguardgateway.general.PidFile</id>
<label>PID file</label>
<type>text</type>
<hint>Save PID to this file.</hint>
<help>Optional: write PID to this file.</help>
<hint>Default value: /var/run/defguard_gateway.pid</hint>
</field>
<field>
<id>defguardgateway.general.SyslogSocket</id>
Expand Down
1 change: 1 addition & 0 deletions opnsense/src/opnsense/mvc/app/models/OPNsense/DefguardGateway/DefguardGateway.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
<Required>Y</Required>
</UseSyslog>
<PidFile type="TextField">
<default>/var/run/defguard_gateway.pid</default>
<Required>N</Required>
</PidFile>
<SyslogSocket type="TextField">
Expand Down
0 ...nf/actions.d/actions_defguardgateway.conf → ...f/actions.d/actions_defguard_gateway.conf
View file
Open in desktop
File renamed without changes.
4 changes: 1 addition & 3 deletions opnsense/src/opnsense/service/templates/OPNsense/DefguardGateway/config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,7 @@ stats_period = {{ OPNsense.defguardgateway.general.StatsPeriod|default(60) }}
# Required: name of WireGuard interface
ifname = "{{ OPNsense.defguardgateway.general.IfName|default("wg0") }}"
# Optional: write PID to this file
{% if not helpers.empty('OPNsense.defguardgateway.general.PidFile') %}
pidfile = "{{ OPNsense.defguardgateway.general.PidFile }}"
{% endif %}
pidfile = "{{ OPNsense.defguardgateway.general.PidFile|default("/var/run/defguard_gateway.pid") }}"
# Required: enable logging to syslog
{% if OPNsense.defguardgateway.general.UseSyslog == "1" %}
use_syslog = true
Expand Down