alis/Sinatra
1
0
Fork 0
Code Issues 5 Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Alex Rennie-Lis 2024-04-05 23:13:47 +01:00
parent 86ed5cf978
commit 49e7ef1a4f
1 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,3 +1,25 @@
# Netradius
Network management RADIUS server
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)