You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: admin-and-features/setting-up-your-instance/gateway/README.md
+29-27Lines changed: 29 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,26 +27,25 @@ Also, if core has a custom SSL CA to secure gRPC communication, [you need the CA
27
27
## Package Install
28
28
29
29
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).
30
-
2. Install the package using relevant system tools:\
31
-
**Ubuntu/Debian:**
30
+
2. Install the package using relevant system tools:
32
31
33
-
```bash
34
-
sudo dpkg -i <path_to_deb_package>
35
-
```
32
+
**Ubuntu/Debian:**
36
33
37
-
\
38
-
**Fedora/Red Hat Linux/SUSE:**
34
+
```bash
35
+
sudo dpkg -i <path_to_deb_package>
36
+
```
39
37
40
-
```bash
41
-
sudo rpm -i <path_to_rpm_package>
42
-
```
38
+
**Fedora/Red Hat Linux/SUSE:**
43
39
44
-
\
45
-
**FreeBSD:**
40
+
```bash
41
+
sudo rpm -i <path_to_rpm_package>
42
+
```
46
43
47
-
```bash
48
-
pkg add <path_to_txz_package>
49
-
```
44
+
**FreeBSD:**
45
+
46
+
```bash
47
+
pkg add <path_to_txz_package>
48
+
```
50
49
3. Fill in the default configuration file (`/etc/defguard/gateway.toml`) with values corresponding to your Defguard installation (token and gRPC enpoint URL).
51
50
4. Enable and start the systemd service.
52
51
@@ -55,11 +54,11 @@ Also, if core has a custom SSL CA to secure gRPC communication, [you need the CA
55
54
sudo systemctl start defguard-gateway.service
56
55
```
57
56
58
-
## Docker-compose
57
+
## Docker Compose
59
58
60
-
To start your gateway using docker-compose:
59
+
To start Defguard Gateway using [Docker Compose](https://docs.docker.com/compose/):
61
60
62
-
1. We prepared a [git repository](https://github.com/DefGuard/deployment) with docker-compose configuration, clone it:
61
+
1. We prepared a [git repository](https://github.com/DefGuard/deployment) with Docker Compose configuration, clone it:
63
62
64
63
```
65
64
git clone --recursive https://github.com/DefGuard/deployment.git && cd deployment/gateway
If everything went well, your Gateway should be connected to Defguard and you can start [adding new devices to your network](../../../features/setting-up-your-instance/features/wireguard/adding-wireguard-devices.md).
79
+
If everything went well, Defguard Gateway should be connected to Defguard Core and you can start [adding new devices to your network](../../../features/setting-up-your-instance/features/wireguard/adding-wireguard-devices.md).
81
80
82
81
## OPNsense plugin
83
82
84
-
To start your gateway as OPNsense plugin:
83
+
[OPNsense®](https://opnsense.org) is an open source, feature rich firewall and routing platform, offering cutting-edge network protection.
84
+
85
+
To start Defguard Gateway as OPNsense plugin:
85
86
86
87
1. On the [release page](https://github.com/DefGuard/gateway/releases) find and download OPNsense package which will be named: \
87
-
`defguard-gateway_VERSION_x86_64-unknown-opnsense.pkg -`this package **includes the gateway as well as OPNSense plugin.**
88
+
`defguard-gateway_VERSION_x86_64-unknown-opnsense.pkg` - this package **includes Defguard Gateway as well as OPNSense plugin.**
89
+
88
90
2. Install the package:
89
91
90
92
```bash
@@ -97,21 +99,21 @@ pkg add <path_to_txz_package>
97
99
opnsense-patch
98
100
```
99
101
100
-
4. Go to you OPNsense UI and navigate `VPN` -> `Defguard Gateway`.
102
+
4. Go to you OPNsense UI and navigate to **VPN** > **Defguard Gateway**.
5. Fill form with appropriate values click `Save`then `Start/Restart`
106
+
5. Fill out the form with appropriate values, click **Save**, and then click **Start/Restart**.
105
107
106
108
{% hint style="info" %}
107
109
You can find detailed description of all fields [here](../../../features/setting-up-your-instance/configuration.md#gateway-configuration).
108
110
{% endhint %}
109
111
110
-
If everything went well, your Gateway should be connected to Defguard and you can start [adding new devices to your network](../../../features/setting-up-your-instance/features/wireguard/adding-wireguard-devices.md).
112
+
If everything went well, Defguard Gateway should be connected to Defguard Core and you can start [adding new devices to your network](../../../features/setting-up-your-instance/features/wireguard/adding-wireguard-devices.md).
111
113
112
114
## Binary Install
113
115
114
-
1. Checkout Gateway releases [here](https://github.com/DefGuard/gateway/releases) and download compatible binary from Github page.
116
+
1. Checkout Gateway releases [here](https://github.com/DefGuard/gateway/releases) and download compatible binary from GitHub page.
Copy file name to clipboardExpand all lines: admin-and-features/setting-up-your-instance/standalone-package-based-installation.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,11 +49,11 @@ Before proceeding with the installation, ensure your system meets the following
49
49
* If you have a **firewall**, we assume you have **open port 443** in order to expose both defguard and enrollment service, but also to automatically issue for these domains SSL Certificates. Port 444 (used for internal GRPC communication) **should not be exposed public.**
50
50
* System clock is synchronized using Network Time Protocol (NTP). This is important for time-based one-time password (TOTP) codes.
51
51
52
-
### Prequesities
52
+
### Prerequisites
53
53
54
54
#### PostgreSQL
55
55
56
-
Defguard Core uses PostgreSQL database, so if you do not have installed and configured yet, you can do it in this section. For this tutorial we need to create **a user with superuser privileges and database**.
56
+
Defguard Core uses [PostgreSQL](https://www.postgresql.org) database, so if you do not have installed and configured yet, you can do it in this section. For this tutorial we need to create **a user with superuser privileges and database**.
Copy file name to clipboardExpand all lines: features/setting-up-your-instance/one-line-install.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
icon: rocket
3
3
---
4
4
5
-
# One-line install script
5
+
# One-Line Installer
6
6
7
7
{% hint style="info" %}
8
8
The instance deployed by the script is meant to serve as a starting point and makes some tradeoffs to enable automated setup. Most importantly it assumes that your Web UI is available publicly (to generate SSL certificates with Caddy). In general it's not recommended for production and we strongly encourage you to customize this setup to work better within your own infrastructure.
@@ -12,17 +12,17 @@ To simplify the setup and enable automated deployment we prepared a script which
12
12
13
13
Just by launching this one command there will be an interactive configuration and setup that will guide you step by step and deploy full defguard instance based on Docker Compose setup:
14
14
15
-
<figure><imgsrc="../../.gitbook/assets/Screenshot 2024-10-30 at 12.08.43.png"alt=""><figcaption></figcaption></figure>
0 commit comments