Skip to content

Commit da3f767

Browse files
author
Adam Ciarciński
committed
Added package upgrade on FreeBSD/OPNsense
1 parent b167178 commit da3f767

File tree

1 file changed

+49
-20
lines changed

1 file changed

+49
-20
lines changed

deployment-strategies/gateway/README.md

Lines changed: 49 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -23,32 +23,61 @@ Also, if core has a custom SSL CA to secure gRPC communication, [you need the CA
2323
## Package Install
2424

2525
1. On the [release page](https://github.com/DefGuard/gateway/releases) find and download a correct software package for your system (currently DEB, RPM and TXZ are available).
26-
2. Install the package using relevant system tools:
26+
2. Install the package using relevant system tools:
2727

28-
**Ubuntu/Debian:**
28+
**Ubuntu/Debian:**
2929

30-
```bash
31-
sudo dpkg -i <path_to_deb_package>
32-
```
30+
```bash
31+
sudo dpkg -i <path_to_deb_package>
32+
```
3333

34-
**Fedora/Red Hat Linux/SUSE:**
34+
**Fedora/Red Hat Linux/SUSE:**
3535

36-
```bash
37-
sudo rpm -i <path_to_rpm_package>
38-
```
36+
```bash
37+
sudo rpm -i <path_to_rpm_package>
38+
```
3939

40-
**FreeBSD:**
40+
**FreeBSD:**
41+
42+
```bash
43+
pkg add <path_to_txz_package>
44+
```
4145

42-
```bash
43-
pkg add <path_to_txz_package>
44-
```
4546
3. Fill in the default configuration file (`/etc/defguard/gateway.toml`) with values corresponding to your Defguard installation (token and gRPC enpoint URL).
46-
4. Enable and start the systemd service.
47+
4. On systems with [systemd](https://systemd.io/), enable and start the **systemd** service:
48+
49+
```bash
50+
sudo systemctl enable defguard-gateway.service
51+
sudo systemctl start defguard-gateway.service
52+
```
53+
54+
On systems with rc.d (like FreeBSD, NetBSD), start the service. For example, on OPNsense:
55+
56+
```bash
57+
sudo /usr/local/etc/rc.d/defguard_gateway start
58+
```
59+
60+
## Package Upgrade
61+
62+
### FreeBSD/OPNsense
63+
64+
1. Uninstall the current version.
65+
66+
```bash
67+
pkg delete defguard-gateway
68+
```
4769

48-
```bash
49-
sudo systemctl enable defguard-gateway.service
50-
sudo systemctl start defguard-gateway.service
51-
```
70+
2. Install a newer version (as described above in [Package Install](#package-install)).
71+
72+
```bash
73+
pkg add <path_to_txz_package>
74+
```
75+
76+
3. Restart Defguard Gateway service.
77+
78+
```bash
79+
sudo /usr/local/etc/rc.d/defguard_gateway restart
80+
```
5281

5382
## Docker Compose
5483

@@ -62,13 +91,13 @@ git clone --recursive https://github.com/DefGuard/deployment.git && cd deploymen
6291

6392
2. Copy and fill in the .env file:
6493

65-
```
94+
```bash
6695
cp .env.template .env
6796
```
6897

6998
3. Finally, run the service with Docker Compose:
7099

71-
```
100+
```bash
72101
docker compose up
73102
```
74103

0 commit comments

Comments
 (0)