From d5c16bd11bd0b1fe036ca7f136b65f6cd7dc4a7c Mon Sep 17 00:00:00 2001 From: Tanner Collin Date: Mon, 17 Sep 2018 18:16:39 -0600 Subject: [PATCH] Add to setup instructions --- authserver/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/authserver/README.md b/authserver/README.md index 4ff8fb8..490b924 100644 --- a/authserver/README.md +++ b/authserver/README.md @@ -5,6 +5,7 @@ Provides an API to the web client and web server to serve tool data and authenti ## Setup ``` +$ sudo apt install python3 python3-pip python3-virtualenv # for Debian $ virtualenv -p python3 env $ . env/bin/activate (env) $ pip install -r requirements.txt @@ -13,10 +14,18 @@ $ . env/bin/activate (env) $ python manage.py runserver ``` +Authenticate a Protospace login using the `curl` command below against **your** server, then navigate to http://127.0.0.1:8000/admin/ and login with the superuser account you just created above. + +Once logged in, navigate to "Profiles" and make your Protospace user a lockout admin. + +Now you have total control of the system and can make other users lockout admins though the API or web interface. + ## API The API is RESTful and returns hyperlinked json data. **URLs require a trailing slash.** +It's also possible to interact with the API through a web interface at http://tools-auth.protospace.ca from the Protospace LAN. Any Protospace users that have already authenticated through /login/ are able to login. + ### Authentication Authentication is token-based and done against the Protospace member portal. Upon successful login, the auth server will automatically register the user and create them a profile.