TGWITNESS / REFERENCE
The complete reference
Every document of the project, rendered here with its diagrams. The guides are the short path; these pages hold every detail.
Set up
Quick start
Every way to install and launch TgWitness: Windows package, Python, Docker and the synthetic demo, with first checks.
02Accounts and session formats
Sign in by phone, QR code or auth key, import Telethon, Pyrogram or Telegram Desktop sessions, and run several accounts.
03Access and permissions
Issue scoped access to accounts and chats, choose permissions, limit sessions and IP addresses, and withdraw access.
04Connection, proxies and data protection
Authentication, automatic proxy pools, IP modes, fallback policy, external requests and secret storage.
05Deployment
Run TgWitness as a service on Windows, Linux, macOS or Docker, behind HTTPS, with backups and updates.
Collect
How collection works
Observation scope, live updates, rechecks, attachments, own actions and what a gap means, record by record.
07Load source history
Load past messages from enabled sources, pause and resume, and verify a signed progress report.
08Workflows and operations
Daily operation of the panel: modes, monitoring categories, parameters, notifications, exports, backup and capacity.
09Investigation mode
Whole-account investigations across channels, groups, private chats and bots, from scope to a verified case package.
10Features and limits
What TgWitness implements today, what the Telegram platform limits and what remains future work.
Archive & integrations
Archive analysis
Search saved messages, review AI inputs and keep analytical reports with their source references.
12Read-only MCP
Connect an MCP client to selected workspaces and chats with expiring, revocable access.
13Local OCR and transcription
Recognize captured images and audio with a local worker; keep derived text linked to its source file.
14Outgoing webhooks
Send scoped events to HTTPS receivers with HMAC signatures, retries and delivery status.
Evidence
How the evidence works
Hash chain, signatures, checkpoints and witnesses explained with the exact formulas the verifier uses.
16Evidence format
Contents of the signed ZIP, record kinds, process receipts, people profiles, off-site copies and offline verification.
17Independent witness
Run a witness with its own key and bot, publish signed checkpoints to a channel and check exports against it.
18Timestamps
RFC 3161 timestamps for signed checkpoints: what is sent to the authority and how a response is verified.
Security & project
Security and data handling
Threat model, access model, secrets at rest, network exposure, session imports and how to report a vulnerability.
20Architecture
Components of the collector, panel, journal, workers and witness, and how data moves between them.
21What has been tested
The live Telegram test, automated checks, browser checks and what remains unverified.
22Licence and architectural incompatibility notice
TgWitness is MIT-licensed for everyone, and why it is architecturally incompatible with the Taylor Wessing workflow.
23Operator incompatibility notice
Our operator notice on Taylor Wessing and its source record.
24Changelog
Every change by version, including the changes not yet released.