Parcourir la source

Documented the auth server

Brendan Abolivier il y a 8 ans
Parent
révision
89f5cdc040
Signé par: Brendan Abolivier <contact@brendanabolivier.com> ID de la clé GPG: 8EF1500759F70623
1 fichiers modifiés avec 10 ajouts et 0 suppressions
  1. 10
    0
      auth/README.md

+ 10
- 0
auth/README.md Voir le fichier

@@ -0,0 +1,10 @@
1
+# Authentication server
2
+
3
+This server handles user authentication. In our very simple case, it will only ask for an username, but we can think of improving it to interact with a LDAP server. Once the user authenticated itself, it server will place a Macaroon in the user's browser, with a status caveat, depending on the route used:
4
+
5
+* If the user authed on `/`, they will have the "student" status.
6
+* If the user authed on `/teacher`, they will have the "teacher" status.
7
+
8
+## Install & run
9
+
10
+Just run `npm install` in this repository to install the dependencies, then run either `npm start` or `node server.js` to start the server.