From a44341ddefd3a279a9efbad9c8fc39a5542d4aa3 Mon Sep 17 00:00:00 2001 From: unknown Date: Fri, 15 Jan 2021 13:03:06 +0100 Subject: [PATCH] Documentation Squashed and rebased --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 08489e9..df6b659 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # zfinger React app that talks to a RESTful-ish API written in Python/Flask. -API endpoints: +## API endpoints: | Path | Method | Requires Log-in | Result | | ----- | ----- | ----- | ----- | @@ -17,9 +17,9 @@ API endpoints: If log-in is required, user will be redirected to `login.kth.se` if not already. -Information displayed in `hodis` is `ugKthid`,`uid`,`on`,`mail`,`givenName`,`displayName`,`year` and`tag`. +Information displayed in `hodis` is `ugKthid`,`uid`,`cn`,`mail`,`givenName`,`displayName`,`year` and`tag`. -Required environment variables: +## Required environment variables: ``` AWS_ACCESS_KEY_ID= AWS_SECRET_ACCESS_KEY= @@ -29,3 +29,17 @@ Required environment variables: HODIS_HOST=https://hodis.datasektionen.se LOGIN_HOST=https://login2.datasektionen.se ``` + +## Dependencies +Depends on login, hodis is refered to but not integral. + +## Development +With docker installed, run `docker-compose up --build`, will be the local development version. +Will look for ENV in a file called variables.env. + +## Production +See development, on production machine. + +## PLs permissions +None, merely checks if user can login in, not any permissions. +