Skip to content

PhysCIP Dashboard - Graphical account management for computer lab users

Notifications You must be signed in to change notification settings

physcip/physdash

Repository files navigation

PhysCIP Dashboard

Graphical account management interface for computer lab users. This is a static website that may be hosted on any HTTP(S) server. All actions are performed by accessing the respective APIs (physreg API / printer quota API) via HTTPS requests from client-side javascript.

Functionality

  • Create Accounts (Physreg API)
  • Reset Password (Physreg API)
  • Query printing quota (printer quota API)
  • FAQ

The communication protocol with the physreg API is specified in doc/physreg_protocol.md. The communication protocol with the cups_quota API is specified in doc/quota_protocol.md. The FAQ (physfaq) is included as a git submodule.

Installation / Configuration

Clone this repository recursively in order to download all included git submodules:

git clone --recursive https://github.com/physcip/physdash

This website can be hosted on any HTTP server. For testing, the http.server module built into python3 may be used:

cd physdash
python -m http.server 8080

Make sure PHYSREG_API_BASE in script.js is configured to point to a working instance of the physreg API:

var PHYSREG_API_BASE = "https://www.physcip.uni-stuttgart.de/physreg";

Also make sure QUOTA_API_BASE in content/quota.js is configured to point to a working instance of cups_quota:

var QUOTA_API_BASE = "https://www.physcip.uni-stuttgart.de/quota";

Kiosk Mode

Physdash's FAQ may contain links to external webpages - if users are not supposed to leave physdash, a "Kiosk Mode" can be enabled by adding the ?kioskmode=1 parameter to the query URL. This disables the FAQ entirely.

About

PhysCIP Dashboard - Graphical account management for computer lab users

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published