Helpdesk System

A system for managing a helpdesk.

Production

In general, the Django deployment guidelines should be followed.

If SRComp is live, you can sync teams and pit locations using a management command:

./manage.py import_from_srcomp --srcomp_url "https://srcomp.studentrobotics.org/comp-api"

Development

This is a Django application.

1. Clone the repository
2. python3 -m venv venv
3. source venv/bin/activate
4. pip3 install -r requirements-dev.txt
5. cd helpdesk
6. cp helpdesk/configuration.dev.py helpdesk/configuration.py
7. ./manage.py migrate
8. ./manage.py createsuperuser
9. ./manage.py runserver

The Makefile contains commands that can be used to run tests and linting:

• make lint - Lint
• make test - Run unit tests
• make type - Type checking

Deployment

This system is deployed using our Ansible configuration.

Login with Google

Credentials are configured through the Django admin. OAuth credentials need to be configured as below:

• User type: Internal (this ensures it's only SR accounts which can be used)
• Scopes: .../auth/userinfo.email, .../auth/userinfo.profile, openid
• Redirect URIs: https://studentrobotics.org/helpdesk/auth/google/login/callback/
• Authorised JavaScript origins: https://studentrobotics.org

A project exists for this in our Google Cloud account.