Defguard
Search
⌃K
Comment on page

Gateway

Don't forget to copy DEFGUARD_TOKEN necessary to start gateway connection from modal available on overview page under Docker run command

Binary Install

  1. 1.
    Checkout Gateway releases here and download compatible binary from Github page.
  2. 2.
    Decompress and move to bin directory
tar xcf ./gateway.tar.gz
sudo chmod +x gateway
sudo mv gateway /usr/bin/
  1. 3.
    Start gateway gateway -g defguard.com:50055 -t <DEFGUARD_TOKEN>

Package Install

  1. 1.
    On the release page find and download a correct software package for your system (currently DEB, RPM and TXZ are available).
  2. 2.
    Install the package using relevant system tools: Ubuntu/Debian:
    sudo dpkg -i <path_to_deb_package>
    Fedora/Red Hat Linux/SUSE:
    sudo rpm -i <path_to_rpm_package>
    FreeBSD:
    pkg add <path_to_txz_package>
  3. 3.
    Fill in the default configuration file (/etc/defguard/gateway.toml) with values corresponding to your Defguard installation (token and gRPC enpoint URL).
  4. 4.
    Enable and start the systemd service.
    sudo systemctl enable defguard-gateway.service
    sudo systemctl start defguard-gateway.service

Docker-compose

To start your gateway using docker-compose:
  1. 1.
    We prepared a git repository with docker-compose configuration, clone it:
git clone --recursive https://github.com/DefGuard/deployment.git && cd deployment/gateway
  1. 2.
    Copy and fill in the .env file:
cp .env.template .env
  1. 3.
    Finally, run the service with docker-compose:
docker-compose up
If everything went well, your Gateway should be connected to Defguard and you can start adding new devices to your network.

SSL

You'll need a valid CA certificate to connect Gateway to Defguard. See SSL instructions.
​

OPNsense plugin

To start your gateway as OPNsense plugin:
  1. 1.
    On the release page find and download OPNsense package which will be named: defguard-gateway_VERSION_x86_64-unknown-opnsense.txz .
  2. 2.
    Install the package
pkg add <path_to_txz_package>
  1. 3.
    Refresh your OPNsense UI by running below command:
opnsense-patch
  1. 4.
    Go to you OPNsense UI and navigate VPN -> Defguard Gateway .
  1. 5.
    Fill form with appropriate values click Save then Start/Restart
​
You can find detailed description of all fields here.
If everything went well, your Gateway should be connected to Defguard and you can start adding new devices to your network.
Previous
Kubernetes
Next
Health check
Last modified 7d ago