PrintToVeraeTimeStamp/platform/windows/README-WINDOWS.txt
George Lambert 48da24a661 feat: 2026 brand UI — statuslang, tray/menubar, CERT pdf, site kit
- Brand receipt status strings (statuslang) for notify/queue
- Windows tray + Start Menu/Startup install; macOS menubar helper
- CERT-01 plum/gold PDF + multihash/blake3 when present
- printit.verae.ai brand kit, queue page, customer-auth helper
- verae-print pending/tray-status/menubar commands
2026-10-13 21:11:32 -04:00

134 lines
6.4 KiB
Text

Verae Print Stamp for Windows
=============================
Print any document to "Verae TimeStamp PDF" to save it as a PDF and register
a Verae timestamp of its fingerprint (SHA-256; the document itself is not sent).
Install
-------
1. Double-click VeraePrintStamp-windows-amd64-<version>-setup.exe and accept
the Windows administrator prompt.
2. Verae key: keep the key that was found, sign in with your Verae email and
password (plus authenticator code if you use 2FA), create a new account,
paste an xVerae- key from https://customer.verae.ai/portal/ (Security), or
skip (you will be asked on your first print).
Your password goes only to customer.verae.ai over HTTPS and is never saved.
Only the issued key is saved, in %USERPROFILE%\.verae\xverae-token
(readable only by you).
3. After each print: "Ask for a file name for each print" (on by default)
shows a Save As dialog for every print; also choose whether to show the
new certificate in File Explorer (default), open it in your PDF viewer, or
do nothing.
4. The last page lists each step as OK / FAIL / SKIP.
Printing
--------
* Printer "Verae TimeStamp PDF" (main): built-in Microsoft IPP driver, served
by the Verae helper that runs in your session.
* Printer "Verae TimeStamp PDF (Local Port)" (fallback): built-in Microsoft
Print to PDF driver; use it if the main printer is not available.
Save As (promptForFilename on, the default): after each print a Save As
dialog appears on top of your app. It starts in the folder you used last
(first time: Documents\Verae Timestamps) with the document's name filled in
(or "Printed <date> <hhmmss>"). The printed PDF is saved where you choose and
the certificate and receipt are saved next to it:
<chosen name>.pdf
<chosen name>-verae-timestamp-<RECEIPT>.pdf
<chosen name>.verae.json
If the file already exists, Windows asks whether to replace it (the
certificate and receipt are never overwritten; they get "-2", ...).
Cancel discards the print: nothing is timestamped and no credit is used.
Without the dialog (promptForFilename false), results go to
Documents\Verae Timestamps:
<name>.pdf the printed document
<name>-verae-timestamp-<RECEIPT>.pdf the timestamp certificate
<name>.verae.json receipt details
Existing files are never overwritten: a second job with the same name gets
"-2", "-3", ... (fallback-printer jobs are named "Printed <date> <hhmmss>").
If your key is missing, expired or revoked
------------------------------------------
The print job is never lost. It is kept in %APPDATA%\Verae\PrintStamp\pending
and a Verae sign-in window opens (email, password, 2FA code; or Create account /
Paste key). After you sign in, waiting jobs are timestamped automatically.
If you cancel, they stay waiting and are retried when the helper starts again,
after you sign in (Start > Verae > Setup signing key), or after the next print.
Settings (%USERPROFILE%\.verae\config.json)
--------
{ "promptForFilename": true } Save As dialog for each print (true/false;
read for every print, no restart needed)
{ "openOnComplete": "folder" } folder | pdf | none
{ "logLevel": "debug" } verbose helper logging (or set the
environment variable VERAE_LOG_LEVEL=debug)
Restart the helper after changing settings (sign out/in, or Start > Verae >
Start print helper).
Tray icon (PT-W3)
-----------------
Long-running NotifyIcon that polls the helper GET /status and shows brand
labels (Printer ready / Sign in to finish timestamp / held count). Context
menu: Open print job queue, Pending count, Exit. Balloon tip click opens
http://127.0.0.1:8631/queue. Hold ids are never evidence.
Package version = internal/job.HelperVersion (currently 0.3.6). Stamped by
verae-tray.ps1, install-tray-startup.ps1, and build-tray-startmenu.ps1
(via common.ps1 Get-VeraePackageVersion). Override with VERSION=x.y.z.
User-level only — no elevated MSI required for tray presence.
verae-print menubar
powershell -NoProfile -ExecutionPolicy Bypass -STA -File scripts\verae-tray.ps1
Install at login (user Startup folder shortcut — not a full MSI product):
verae-print menubar --install
verae-print menubar --uninstall
powershell -NoProfile -ExecutionPolicy Bypass -File scripts\install-tray-startup.ps1
powershell -NoProfile -ExecutionPolicy Bypass -File scripts\install-tray-startup.ps1 -Uninstall
Creates:
%APPDATA%\Microsoft\Windows\Start Menu\Programs\Startup\Verae Tray.lnk
pointing at verae-tray.ps1 (hidden PowerShell, STA). Tray starts at next
login; run "verae-print menubar" to start it now. IPP POST is unchanged
(print path stays pure).
Start Menu folder + Startup (WiX/NSIS-free stub)
-----------------------------------------------
Practical packaging without WiX Toolset or a commercial / elevated MSI.
Package version follows HelperVersion (see above). Creates user-level
shortcuts under Start > Verae and optionally the Startup .lnk:
powershell -NoProfile -ExecutionPolicy Bypass -File scripts\build-tray-startmenu.ps1
powershell -NoProfile -ExecutionPolicy Bypass -File scripts\build-tray-startmenu.ps1 -Uninstall
powershell -NoProfile -ExecutionPolicy Bypass -File scripts\build-tray-startmenu.ps1 -NoStartup
Creates (user profile, no elevation):
%APPDATA%\Microsoft\Windows\Start Menu\Programs\Verae\
Verae Tray.lnk
Verae - Open print job queue.lnk (or .url)
Verae - Setup signing key.lnk (when verae-print.exe is found)
Verae - Start print helper.lnk (when verae-print.exe is found)
Verae - Customer portal.url
+ Startup\Verae Tray.lnk (unless -NoStartup)
WiX (candle/light) is optional and not required for tray presence. The full
NSIS product remains installer-windows.nsi; a future MSI can supersede this
stub. Hold ids are never evidence.
Start menu > Verae (full NSIS install)
--------------------------------------
Setup signing key, Start print helper, Logs folder, Collect diagnostics
(right-click > Run as administrator for complete results; the zip is saved on
your Desktop), Uninstall.
Logs (C:\ProgramData\Verae\logs)
----
installer-<time>.log errors (if any) and the per-step summary
install-errors-<time>.log printer-setup failures (only if a step failed)
helper-<user>.log one line per print job step (job IDs J<time>-...)
Uninstall
---------
Settings > Apps > "Verae Print Stamp". Your key, settings, logs and
timestamped documents are kept.