Skip to content

admin-ui.md

Latest commit

 

History

History
107 lines (93 loc) · 7.48 KB

admin-ui.md

File metadata and controls

107 lines (93 loc) · 7.48 KB
Raw

Admin console

The admin console is a web page served by tapqueue-server at https://<server>:8632/admin (or http://<server>:8631/admin). It covers everything tapqueue-admin does, and adds the things a CLI is bad at: live status, tap-to-enroll, logs, and remote control of stations and clients. When HTTPS is on, the http:// address sends browsers on other machines to the https:// one (on the server itself, http://localhost keeps working).

Sign-in. With auth.mode = "token" the console asks for a sign-in, and each admin sees and does what their roles allow. In dev mode it's open to anyone on the network, so you can set up the first admins. See admin-roles.md.

Principles

  • One API. The console is a client of /api/v1/admin, the same API the CLI uses. Nothing the console can do is out of the CLI's reach, and every feature is built and tested at the API first.
  • No build step. Plain HTML, CSS and ES modules in src/TapQueue.Server/Admin/wwwroot, embedded in the server binary. No npm, no bundler, no framework. A page is one module.
  • Explain, don't just refuse. Errors say what to do next ("Move station office first"), the same way the CLI does. Destructive actions confirm and say what they'll affect.
  • Status is color; everything else is calm. Green, amber and red only mean online, needs attention and failed.

Layout

A sidebar groups pages by what you're doing; each page is a list with a detail drawer.

Group Page What it's for
Operate Overview Health at a glance: held jobs, printers, stations and clients online, things that need attention, recent activity.
Jobs Held jobs and history. Filter by user, queue, status. Release to a printer, cancel.
Activity The audit trail: who changed what, badge taps, releases, sign-ins.
Reports Pages printed over a period, by person, group, printer, queue, day or month; CSV download. See reports.md.
People Users Create, edit, enable/disable, reset token. A user's detail shows their cards, groups, jobs, sessions and quota.
Groups Groups of users, which queues and printers they may use, and their quotas.
Cards Every badge. Enroll by tapping at a station, reassign, label, remove. Unknown taps.
Active Directory AD sync: connection, scope (OUs, groups, users), daily schedule, preview, sync now, history. See active-directory.md.
Fleet Printers Add, edit, remove, test. Live status, supported formats.
Queues The printers users see in Windows: name, defaults, who may print to them.
Stations Release stations: status, printer, reader, settings, restart, update, token.
Workstations Windows and Linux PCs running the client: who's signed in, client version, update now, sign out.
System Updates Client and station builds: check GitHub for the newest release and publish it, upload a build, see who runs what, roll back.
Server Version, uptime, settings, live log, restart, check for updates and upgrade (now or scheduled), backups (full admins).
Notifications Email alerts for printer problems, offline stations and crash reports: your mail server, who gets them, send a test. See notifications.md.
Admins Who may use the console: roles for people and groups, per area. Full admins only.

URLs are /admin/<page> and /admin/<page>/<id> for an open detail drawer, so every view can be linked to and survives a reload.

Code layout

src/TapQueue.Server/Admin/
  AdminUi.cs            serves wwwroot (embedded; from disk with TAPQUEUE_ADMIN_UI_DIR)
  wwwroot/
    index.html          the shell: sidebar, header, <main>
    app.js              router: path -> page module
    api.js              fetch wrapper; turns ErrorResponse into thrown errors
    ui.js               small helpers: h() to build elements, table, drawer, dialog, toast, format
    styles.css          design tokens (light + dark) and components
    pages/<page>.js     one module per page, exporting render(main, params)

For development, TAPQUEUE_ADMIN_UI_DIR=src/TapQueue.Server/Admin/wwwroot makes the server read the files from disk, so edits show up on reload without a rebuild.

Roadmap

Each phase ships on its own and leaves the console usable.

  1. Shell and what exists today. (Done.) Overview, Jobs, Users, Cards, Printers, Queues, Stations, Workstations, Updates (client builds), Server (status).
  2. People. (Done.) Enable/disable users, edit display names, card labels and reassigning, enrolling by tapping, cancel/release any job, delete users. An events table records every admin change, release and tap, which feeds Activity and the Overview.
  3. Groups and permissions. (Done, with CSV import/export and bulk actions.) Groups, membership, and which queues and printers a group may use, checked when a job is printed (rejected with a clear IPP error) and when it's released (skipped, and the station says why). Users with no group can use everything, so nothing changes until groups are set up.
  4. Station control. (Done.) Stations send a heartbeat every 15 s (version, reader state, uptime) and get settings, commands (restart) and the published build back. Every setting except the server address and token can be set from the console, and a station can be taken out of service with a message. Station builds are published and installed like client builds. Tap feedback is a screen: Screen link on a station makes the address of a page that shows what each tap did (release-station.md). The station box itself still gives none: the pcProx's LED and beeper are only reachable through the configuration commands that stop it reading cards, sound would need ALSA installed on every station, and the HP M404n ignores PJL panel messages. A USB status light is the likely next step; feedback in station settings is reserved for it.
  5. Workstation and server control. (Done.) The TapQueue service on each PC checks in once a minute, so Workstations lists PCs with their client version, a failed update's error and who's signed in. Sign a person out of a PC (the tray app stays signed out and their jobs stop going to them), tell a PC to update now, forget a PC. The Server page edits hold hours and session timeout (saved in the database; server.toml gives the defaults), streams the live log (server-sent events, the last 2000 lines kept in memory) and restarts the server when systemd runs it (exit code 75, which the unit restarts).
  6. Quotas. (Done.) Jobs' pages are counted when they arrive (PDF, PWG raster, Apple raster and JPEG; anything else counts as 1 page and is flagged). Page limits per day, week or month on users and groups, checked job by job at release. A user's own limit overrides their groups'; otherwise the most generous group limit counts. The Server page chooses whether a job may take someone over their limit (the default) or has to fit. Users shows each person's usage. See admin-cli.md.
  7. Admin sign-in and roles. (Done.) Admins are TapQueue users. Roles (viewer, operator, admin) go to people or groups, per area of the console or for all of them. Local users sign in with a console password, AD users with their domain password. The console is available with auth.mode = "token" and shows each admin only their pages. See admin-roles.md.