Skip to content

Commit abf82ae

Browse files
author
Adam Ciarciński
committed
One-line installer screen-shot replacement; clean-ups
1 parent 2f59635 commit abf82ae

7 files changed

Lines changed: 37 additions & 34 deletions

File tree

.DS_Store

-6 KB
Binary file not shown.
-3.63 MB
Binary file not shown.
366 KB
Loading

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.DS_Store

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

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -27,26 +27,25 @@ Also, if core has a custom SSL CA to secure gRPC communication, [you need the CA
2727
## Package Install
2828

2929
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:
3231

33-
```bash
34-
sudo dpkg -i <path_to_deb_package>
35-
```
32+
**Ubuntu/Debian:**
3633

37-
\
38-
**Fedora/Red Hat Linux/SUSE:**
34+
```bash
35+
sudo dpkg -i <path_to_deb_package>
36+
```
3937

40-
```bash
41-
sudo rpm -i <path_to_rpm_package>
42-
```
38+
**Fedora/Red Hat Linux/SUSE:**
4339

44-
\
45-
**FreeBSD:**
40+
```bash
41+
sudo rpm -i <path_to_rpm_package>
42+
```
4643

47-
```bash
48-
pkg add <path_to_txz_package>
49-
```
44+
**FreeBSD:**
45+
46+
```bash
47+
pkg add <path_to_txz_package>
48+
```
5049
3. Fill in the default configuration file (`/etc/defguard/gateway.toml`) with values corresponding to your Defguard installation (token and gRPC enpoint URL).
5150
4. Enable and start the systemd service.
5251

@@ -55,11 +54,11 @@ Also, if core has a custom SSL CA to secure gRPC communication, [you need the CA
5554
sudo systemctl start defguard-gateway.service
5655
```
5756

58-
## Docker-compose
57+
## Docker Compose
5958

60-
To start your gateway using docker-compose:
59+
To start Defguard Gateway using [Docker Compose](https://docs.docker.com/compose/):
6160

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:
6362

6463
```
6564
git clone --recursive https://github.com/DefGuard/deployment.git && cd deployment/gateway
@@ -71,20 +70,23 @@ git clone --recursive https://github.com/DefGuard/deployment.git && cd deploymen
7170
cp .env.template .env
7271
```
7372
74-
3. Finally, run the service with docker-compose:
73+
3. Finally, run the service with Docker Compose:
7574
7675
```
77-
docker-compose up
76+
docker compose up
7877
```
7978
80-
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).
8180
8281
## OPNsense plugin
8382
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:
8586
8687
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+
8890
2. Install the package:
8991
9092
```bash
@@ -97,21 +99,21 @@ pkg add <path_to_txz_package>
9799
opnsense-patch
98100
```
99101

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**.
101103

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

104-
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**.
105107

106108
{% hint style="info" %}
107109
You can find detailed description of all fields [here](../../../features/setting-up-your-instance/configuration.md#gateway-configuration).
108110
{% endhint %}
109111

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).
111113

112114
## Binary Install
113115

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.
115117
2. Decompress and move to bin directory
116118

117119
```sh

admin-and-features/setting-up-your-instance/standalone-package-based-installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@ Before proceeding with the installation, ensure your system meets the following
4949
* 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.**
5050
* System clock is synchronized using Network Time Protocol (NTP). This is important for time-based one-time password (TOTP) codes.
5151

52-
### Prequesities
52+
### Prerequisites
5353

5454
#### PostgreSQL
5555

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**.
5757

5858
First of all, install PostgreSQL package:
5959

features/setting-up-your-instance/one-line-install.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
icon: rocket
33
---
44

5-
# One-line install script
5+
# One-Line Installer
66

77
{% hint style="info" %}
88
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
1212

1313
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:
1414

15-
<figure><img src="../../.gitbook/assets/Screenshot 2024-10-30 at 12.08.43.png" alt=""><figcaption></figcaption></figure>
15+
<figure><img src="../../.gitbook/assets/one-line-install.png" alt=""><figcaption></figcaption></figure>
1616

1717
Just copy and paste this command and [secure the setup afterwards](one-line-install.md#securing-the-setup):
1818

19-
### **Production release (most stable)**
19+
### Production Release (most stable)
2020

2121
```shell
2222
curl --proto '=https' --tlsv1.2 -sSf -L https://raw.githubusercontent.com/DefGuard/deployment/main/docker-compose/setup.sh -O && bash setup.sh
2323
```
2424

25-
### **Pre-release (latest alpha/beta/release candidate)**
25+
### Pre-release (latest alpha/beta/release candidate)
2626

2727
```bash
2828
curl --proto '=https' --tlsv1.2 -sSf -L https://raw.githubusercontent.com/DefGuard/deployment/main/docker-compose/setup.sh -O && bash setup.sh --pre-release
@@ -40,7 +40,7 @@ GATEWAY_IMAGE_TAG=pre-release
4040
Downgrading to the production release may not be trivial afterwards because of the changes made to the database during the upgrade.
4141
{% endhint %}
4242

43-
### **Latest development builds**
43+
### Latest development builds
4444

4545
```bash
4646
curl --proto '=https' --tlsv1.2 -sSf -L https://raw.githubusercontent.com/DefGuard/deployment/main/docker-compose/setup.sh -O && bash setup.sh --dev

0 commit comments

Comments
 (0)