AckMan
The Manual Under construction

Doc’s still
writing it all down.

The full deployment and usage guide is on its way. Here’s the table of contents so you know exactly what’s coming — install steps, on-prem and cloud setups, and how to read the acknowledgement trail.

Get a build ↓ See what’s coming

Quick start

Coming soon

The five-minute version: download, run, point it at a folder of documents, share the link. Here’s roughly the shape of it —

# unpack & run
./ackman --docs /srv/company-docs --port 8080
# then open http://your-server:8080

Full walkthrough with screenshots lands here shortly.

Installation

Coming soon

Per-platform setup for Linux (x86-64), Raspberry Pi (ARM64), and Windows — including running AckMan as a background service so it stays up after a reboot.

Configuration

Coming soon

Ports, document directories, branding, and how acknowledgements are recorded and stored. Sensible defaults, with knobs when you need them.

Deploying on-premises

Coming soon

Run AckMan behind the office firewall on a spare box or a Raspberry Pi. Covers local networking, reverse proxies, and keeping everything inside your four walls.

Deploying to the cloud

Coming soon

Stand it up on a cloud VM for distributed and remote teams — TLS, domains, and access basics so people can ack from anywhere.

Adding & organizing documents

Coming soon

How to drop in handbooks, memos, and training files, group them, and decide which ones require an acknowledgement versus a plain read.

Reading the acknowledgement trail

Coming soon

The good part: see who opened what and who ack’d it, filter by document or person, and export the records for HR, training, or audits.

Security & backups

Coming soon

Locking things down, keeping the acknowledgement log safe, and backing up your records so the receipts survive a hardware hiccup.

FAQ

Coming soon

The questions everyone asks: file types supported, how many people it scales to, what counts as an “ack,” and whether Doc ever sleeps. (He doesn’t.)

Want a holler when the docs drop?

The GitHub repo goes public soon — watch it there for the full guide and release notes.

GitHub · coming soon