https://github.com/umegbewe/dhcpd
A fast, reliable DHCP server in Go
https://github.com/umegbewe/dhcpd
dhcp dhcp-server go networking
Last synced: over 1 year ago
JSON representation
A fast, reliable DHCP server in Go
- Host: GitHub
- URL: https://github.com/umegbewe/dhcpd
- Owner: umegbewe
- License: mit
- Created: 2025-01-15T17:21:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-19T13:55:12.000Z (over 1 year ago)
- Last Synced: 2025-03-03T21:58:05.281Z (over 1 year ago)
- Topics: dhcp, dhcp-server, go, networking
- Language: Go
- Homepage:
- Size: 1.01 MB
- Stars: 70
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## dhcpd
`dhcpd` is a dhcp server written in Go. It is designed to be fast, reliable and easy to configure.
## Install
Get binary from [releases](https://github.com/umegbewe/dhcpd/releases) or clone:
```bash
git clone https://github.com/umegbewe/dhcpd.git
cd dhcpd
```
Build binary:
```
make build
```
## Running dhcpd
Create a conf.yaml with desired settings, see [example conf.yaml](https://github.com/umegbewe/dhcpd/blob/9c62c723f07d68aabbfd38e76c44ea0534d4c70d/conf.yaml)
Start dhcp server with configuration
```bash
./dhcpd --conf conf.yaml
INFO[2025-01-03T10:07:47+01:00] [INIT] Set to cleanup expired leases every 120 seconds
INFO[2025-01-03T10:07:47+01:00] [INIT] Metrics server listening on :9100
INFO[2025-01-03T10:07:47+01:00] [INIT] DHCP server listening on 0.0.0.0:67 (interface: eth0, IP: 192.168.100.1)
....
```
Test with a client e.g dhcping or dhclient:
`dhcpd` is configured to bind to 0.0.0.0 (all interfaces) on port 67 but some client require you to pass an IP address you should pass the interface IP
```bash
sudo dhcping -v -s 192.168.100.1
Got answer from: 192.168.100.1
```
```bash
dhclient -i -v eth0
DHCPDISCOVER on eth0 to 255.255.255.255 port 67 interval 3 (xid=0x14e6f62e)
DHCPOFFER of 192.168.100.92 from 192.168.100.1
DHCPREQUEST for 192.168.100.92 on eth0 to 255.255.255.255 port 67 (xid=0x2ef6e614)
DHCPACK of 192.168.100.92 from 192.168.100.1 (xid=0x14e6f62e)
bound to 192.168.100.92 -- renewal in 261 seconds.
```
## Testing
See [DEVELOPMENT.md](https://github.com/umegbewe/dhcpd/blob/fce86844b650f8a5d32d83b23cd4144a6176426f/DEVELOPMENT.md) guide on how to test ``dhcpd`` in isolated linux namespaces
## About
`dhcpd` uses [boltdb](https://github.com/etcd-io/bbolt) to maintain leases across restarts or crashes, there is a potential for support swapping lease persistent backends in the future (leases.txt, redis, mysql, postgres etc)
`dhcpd` also provides server and lease metrics, accessible at `:9100/metrics`. Additionally, a sample Grafana dashboard [JSON](https://github.com/umegbewe/dhcpd/blob/699c7546e35768876f2b3d40d43bfb46b5d5f612/grafana/%20dashboard.json) is available for visualizing these metrics."
## Future work
At this stage dhcpd works well for development environments and small networks.
* Subnet/scope configuration
* Vendor specific options
* Optional embedded web UI/API for managing leases
* Support other databases for lease persistence
* Choose allocation straetgies i.e random, sequential or segment (current: sequential)