From 91dd8e2376e9b5a9caea8fee627f136cf177ab13 Mon Sep 17 00:00:00 2001 From: Alex Rennie-Lis Date: Mon, 27 May 2024 23:14:29 +0100 Subject: [PATCH] Update README.md --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2bf6f1d..63f9b47 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Netradius +# Sinatra -Network management RADIUS server +SImple Network Access Tool with RAdius 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. @@ -9,11 +9,11 @@ Such a setup _requires_ pre-registered MAC addresses, which can be difficult wit 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: +Sinatra provides for this simple use case: -- A simple NodeJS-based RADIUS server that provides (MAC-based) authentication. +- A simple NodeJS-based RADIUS server that provides (MAC-based) authentication, in any format. - A simple REST API to add/update/delete reqistered users (MAC addresses). -- A Dockerfile to encapsulate the server within a docker container. +- A Dockerfile (and docker-compose) 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 @@ -22,4 +22,3 @@ Netradius provides for this simple use case: - Time-based authentication - Time-limited access - Connection accounting (with REST API endpoints for data access) -