From 2ae348e4b094978cb747baa5af5bcfe4afa020ff Mon Sep 17 00:00:00 2001
From: chapeau <corentin@canebier.fr>
Date: Mon, 17 May 2021 21:38:34 +0200
Subject: [PATCH] Create Optionnal Apps/Radius

---
 Optionnal-Apps/Radius.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 Optionnal-Apps/Radius.md

diff --git a/Optionnal-Apps/Radius.md b/Optionnal-Apps/Radius.md
new file mode 100644
index 0000000..6b54d88
--- /dev/null
+++ b/Optionnal-Apps/Radius.md
@@ -0,0 +1,18 @@
+This optionnal app provides an API for a radius script ([which you can get here](https://gitlab.federez.net/re2o/re2o-radius)).
+
+### Installation
+
+You juste have to add `'radius'` in `OPTIONNAL_APPS_RE2O`, in your `settings_local.py`. No migration is required.  
+Of course, you also need to have `api` app activated to be able to use this app.
+
+### API Reference
+
+- `GET /api/radius/authorize/<nas_id>/<username>/<mac_address>` : return required informations for the authorize step. See in radius/api/serializer.py for more details of returned fields.
+
+- `GET /api/radius/post_auth/<nas_id>/<nas_port>/<user_mac>` : return required informations for the post_auth step. See in radius/api/serializer.py for more details of returned fields.
+
+- `GET /api/radius/autoregister/<nas_id>/<username>/<mac_address>` : add (if possible) a new machine with `<mac_address>` to `<username>` account.
+
+- `GET /api/radius/assign_ip/<mac_address>` : try to assign an ip address to a machine.
+
+In all theses routes, `<nas_id>` is the ip address or the domain name of the nas from which the user is trying to connect.
\ No newline at end of file