From 49e7ef1a4fe1f59fdc83b1f7712be361624e2c92 Mon Sep 17 00:00:00 2001 From: alis Date: Fri, 5 Apr 2024 23:13:47 +0100 Subject: [PATCH] Update README.md --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c1531a2..2bf6f1d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ # Netradius -Network management RADIUS server \ No newline at end of file +Network management RADIUS server + +RADIUS-based network access is common in prosumer/office networks for requiring pre-registered MAC adddresses and/or selectively assigning VLANs to devices based on MAC address. + +Typically, FreeRADIUS is used, however its flexibility and complexity is burdensome when only MAC-based authentication is required. +Such a setup _requires_ pre-registered MAC addresses, which can be difficult with IoT and consumer devices; and configuration of a default VLAN for unrecongnised MAC addresses is difficult. + +Certain vendors' router hardware can provide simplistic RADIUS servers, e.g. a Ubiquiti Unifi Dream Machine, but they do not provide default VLAN assignment. It is also useful to be vendor agnostic. + +Netradius provides for this simple use case: + +- A simple NodeJS-based RADIUS server that provides (MAC-based) authentication. +- A simple REST API to add/update/delete reqistered users (MAC addresses). +- A Dockerfile to encapsulate the server within a docker container. +- Optional default VLAN support to support unknown MAC addresses, e.g. into a guest network. + +# Feature roadmap + +- Mass-import from CSV +- Time-based authentication +- Time-limited access +- Connection accounting (with REST API endpoints for data access) +