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-05-27 23:14:29 +01:00
parent e9e774148b
commit 91dd8e2376
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -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. 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. 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 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. - Optional default VLAN support to support unknown MAC addresses, e.g. into a guest network.
# Feature roadmap # Feature roadmap
@ -22,4 +22,3 @@ Netradius provides for this simple use case:
- Time-based authentication - Time-based authentication
- Time-limited access - Time-limited access
- Connection accounting (with REST API endpoints for data access) - Connection accounting (with REST API endpoints for data access)