Skip to content

Releases: FieldmouseWorks/consolebook

Consolebook 0.3.0

Choose a tag to compare

@github-actions github-actions released this 15 Oct 23:12
Immutable release. Only release title and notes can be modified.
dcdb9dc

An agency can now leave with everything: a complete installation export
carries all the installation holds except credentials, verifiable from the
file alone. The stack moves to current versions, so the interface now needs
Chrome or Edge 111+, Firefox 114+, or Safari 16.4+
. Upgrading from 0.2.0
runs no migration
; existing data directories open unchanged.

Added

  • A complete installation export: everything the installation holds except
    credentials (finalized records as their stored bytes, plus people,
    programs, enrollments, sessions, drafts and their reviews, retention
    policies and holds, notices, and the audit trail) as one archive. A
    manifest ledger names every carried table and every exclusion. Holders of
    export_records download it from the home page, even before any record is
    finalized, and consolebook-server export verify checks it from the file
    alone (ADR 0028,
    format). The archive is not
    encrypted.

Changed

  • The interface now needs Chrome or Edge 111+, Firefox 114+, or Safari
    16.4+ (iOS 16.4+). Firefox ESR 102 and earlier and Chrome or Edge before
    111 no longer load it; see the install guide.
  • The web interface is built with SvelteKit 3, Vite 8, Svelte 5.57, and
    TypeScript 6 (from SvelteKit 2 and Vite 7), which also drops a
    vulnerable cookie dependency from the build
    (#54). Building
    it needs Node.js ^22.17 || >=24; the installed server still needs no
    Node.js.
  • Building from source needs Rust 1.99 (rust-toolchain.toml), and the
    bundled SQLite is now 3.51.3 (was 3.46.0) with sqlx 0.9. Existing data
    directories open unchanged: their recorded migrations, records, exports,
    and passwords are byte-for-byte compatible, and a test pins the released
    migration checksums and the export container's bytes.

Fixed

  • doctor reports a migration history serve would refuse (a changed
    checksum or a failed migration), instead of ok. Pending migrations,
    which the service applies on its next start, now warn instead of failing
    (#138).

Install or upgrade

On a Linux server with systemd, as root:

curl -fsSL https://github.com/FieldmouseWorks/consolebook/releases/latest/download/install.sh | sudo sh

To check where an archive came from:
gh attestation verify consolebook-linux-x86_64.tar.gz -R FieldmouseWorks/consolebook.

See docs/install.md.

Consolebook 0.2.0

Choose a tag to compare

@github-actions github-actions released this 15 Oct 15:36
e4fc1d3

Safer upgrades and recovery for a pilot: a backup before every migration,
Secure cookies behind HTTPS, backup copies that cannot be buried by a
replacement server, a rehearsed restore drill, and an operations guide.
Upgrading from 0.1.0 runs a migration, so the first start of 0.2.0 takes
a validated backup before it changes the database.

Added

  • Before a new version migrates the database, it takes a validated backup
    of it as it was and refuses to migrate without one, whichever command
    runs first; the install guide shows how to go back with the previous
    release.
  • A version that finds a database upgraded by a newer release refuses it in
    plain words and names the way back.
  • --public-url / CONSOLEBOOK_PUBLIC_URL (installer: --public-url): the
    address people use. An https:// address marks sign-in cookies Secure,
    and the sign-in page points browsers that arrived by another address to it
    (ADR 0025). The install guide gives a tested Caddy configuration for HTTPS.
    Turning it on signs out sessions whose cookies were not Secure.
  • doctor --backup-copy-dir reports whether off-server backup copies are
    current, behind, unreachable, or not configured, without writing anything.
  • ADR 0027: Consolebook does
    not encrypt backup copies; the install guide states what the share must
    provide.
  • A restore drill from a lost server to verified
    records, with a scripted version (scripts/restore-drill/) and a recorded
    run from the v0.1.0 release.
  • Operating a pilot installation: what to monitor and
    how, the logs and their retention, reporting a problem, and what support a
    pre-alpha pilot can expect. The release workflow runs its commands against
    a real install.

Changed

  • The one-line install fetches the installer published with the latest
    release instead of the main branch, and every release asset carries
    build provenance (gh attestation verify; ADR 0026).

Fixed

  • A new server set up to replace a lost one no longer copies its own empty
    database into the backup copy directory as the newest backup. A copy
    directory holds one installation's backups, and copying there is refused
    until the lost installation is restored; a restore then backs up what it
    restored, so copies resume at once. The database a restore sets aside is
    never copied off the server (#115).
  • Two backups or restores within the same second no longer fail or mislabel
    the set-aside database as damaged; the second waits for a new name.
  • doctor judges whether the newest backup is overdue against the service's
    backup interval (--backup-interval-hours, or
    CONSOLEBOOK_BACKUP_INTERVAL_HOURS) instead of always 24 hours (#117).
  • A phase change that waited behind another write is no longer refused as
    out of order; it is judged at the moment it can commit (#108).
  • After a restore, the set-aside database no longer counts as the newest
    backup: snapshots order by their time, so off-server copy status,
    catch-up copies, and retention follow the latest backup (#105).
  • A draft that saves after a failed save no longer keeps saying "The draft
    did not save" (#83).

Install or upgrade

On a Linux server with systemd, as root:

curl -fsSL https://github.com/FieldmouseWorks/consolebook/releases/latest/download/install.sh | sudo sh

To check where an archive came from:
gh attestation verify consolebook-linux-x86_64.tar.gz -R FieldmouseWorks/consolebook.

See docs/install.md.

Consolebook 0.1.0

Choose a tag to compare

@github-actions github-actions released this 14 Oct 21:02
17b4851

The first versioned release: everything built through Milestone 4 and the
first Milestone 5 slices (roadmap).

Added

  • One executable and one SQLite data directory: first-run setup code, local
    administrator, sign-in, administrator-issued password resets, local
    recovery, doctor (read-only diagnostics), validated backups and restore.
  • Versioned program configuration: programs, immutable published versions,
    phases and transitions, competencies, tasks, rating scales, evaluation
    forms, comparison, export and import.
  • Training workflow: users and capabilities, enrollments and phase history,
    assignments, training sessions in agency-local time, daily evaluation
    drafts with autosave and attribution, review and change requests, notices.
  • Defensible records: canonical record format, immutable finalized
    versions with content and chain hashes, acknowledgments, responses and
    refusals, amendments as successor versions, weekly summaries, task
    signoffs, and a trainee's own record timeline and signoff history.
  • Exports: verifiable record exports and trainee packets, checked offline
    with consolebook-server export verify.
  • Retention administration: explicit authority, versioned retention
    policies, and attributed record holds. Disposition is not yet executed.
  • Build identity: --version, /api/instance, /api/health, the startup
    log, and the interface footer report the version and source commit.
  • One-command install and upgrade for Linux with systemd
    (install/install.sh), static x86_64 and arm64 release archives, and an
    operator guide (docs/install.md).
  • A "Getting started" checklist on the administrator's home that follows the
    installation from first run to its first finalized evaluation, and an
    optional guided setup: people in a batch with a printable sign-in sheet,
    and an editable example program.
  • Backup copies off the server (--backup-dir / CONSOLEBOOK_BACKUP_COPY_DIR,
    ADR 0024): each validated backup is copied to a second disk or share and
    verified byte for byte; backup health on the administrator's home, with a
    warning until copies are current; --data-dir to place the data.
  • An interface that leads each role with its own work, shows who is signed in
    with sign out on every page, works at phone width, and explains refused or
    missing pages in plain words.

Install or upgrade

On a Linux server with systemd, as root:

curl -fsSL https://raw.githubusercontent.com/FieldmouseWorks/consolebook/main/install/install.sh | sudo sh

See docs/install.md.