AdGuardHome/internal/dhcpd/README.md

 #  Testing DHCP Server

Contents:
 *  [Test setup with Virtual Box](#vbox)
 *  [Quick test with DHCPTest](#dhcptest)

##  <a href="#vbox" id="vbox" name="vbox">Test setup with Virtual Box</a>

   ### Prerequisites

To set up a test environment for DHCP server you will need:

 *  Linux AG Home host machine (Virtual).
 *  Virtual Box.
 *  Virtual machine (guest OS doesn't matter).

   ### Configure Virtual Box

 1.  Install Virtual Box and run the following command to create a Host-Only 
     network:

     ```sh
     $ VBoxManage hostonlyif create
     ```
     
     You can check its status by `ip a` command.  

     You can also set up Host-Only network using Virtual Box menu: 
     
     ```
     File -> Host Network Manager...
     ```

 2.  Create your virtual machine and set up its network:

     ```
     VM Settings -> Network -> Host-only Adapter
     ```

 3.  Start your VM, install an OS.  Configure your network interface to use
     DHCP and the OS should ask for a IP address from our DHCP server.

 4.  To see the current IP addresses on client OS you can use `ip a` command on
     Linux or `ipconfig` on Windows.

 5.  To force the client OS to request an IP from DHCP server again, you can
     use `dhclient` on Linux or `ipconfig /release` on Windows.

   ### Configure server

 1.  Edit server configuration file `AdGuardHome.yaml`, for example:

     ```yaml
     dhcp:
          enabled: true
          interface_name: vboxnet0
          local_domain_name: lan
          dhcpv4:
            gateway_ip: 192.168.56.1
            subnet_mask: 255.255.255.0
            range_start: 192.168.56.2
            range_end: 192.168.56.2
            lease_duration: 86400
            icmp_timeout_msec: 1000
            options: []
          dhcpv6:
            range_start: 2001::1
            lease_duration: 86400
            ra_slaac_only: false
            ra_allow_slaac: false
     ```

 2.  Start the server

     ```sh
     ./AdGuardHome -v
     ```

     There should be a message in log which shows that DHCP server is ready:

     ```
     [info] DHCP: listening on 0.0.0.0:67
     ```

##  <a href="#dhcptest" id="dhcptest" name="dhcptest">Quick test with DHCPTest utility</a>

   ### Prerequisites

 *  [DHCP test utility][dhcptest-gh].

   ### Quick test

The DHCP server could be tested for DISCOVER-OFFER packets with in
interactive mode.

[dhcptest-gh]: https://github.com/CyberShadow/dhcptest