tanner/pslockout
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add to setup instructions

Browse Source
This commit is contained in:
Tanner Collin 2018-09-17 18:16:39 -06:00
parent 0da2410869
commit d5c16bd11b
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
authserver/README.md
View File

@ -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.