Files
telfax/QUICKSTART.md
Warren 55bca92691 V1.0: Class 1 fax — real-world 4-page send to external number confirmed
Core features:
- Class 1 T.30 protocol: full send/receive implementation
- HDLC: DLE-stuffing, FCS strip, USR5637 bit-reversal handling
- T.4 MH encoder/decoder (1728px A4 standard)
- Document pipeline: PDF (Ghostscript), PNG, TIFF input
- Width clamping: US Letter 1734px → 1728px fax standard
- Cover page: CJK rasterization (TW/CN/JP/EN), TIFF + HTML output
- OCR verification: Tesseract 5 with eng+chi_tra, CJK space-tolerant
- API server (axum): health, send, jobs, cover, retry, cancel
- Background worker: auto-poll queue, speed fallback, retry policy
- Modem detection, pool management

Real-world test results (2026-07-23):
- V90 → 25153038: 4 pages, V.17 12000 bps, 2:33 ✅
- USR5637 → 25153038: 4 pages, V.17 12000 bps, 2:26 ✅
- Both faxes confirmed received on remote machine

Tested: loopback (100% pixel match), multi-page, all input formats,
cover pages, OCR verify, API endpoints, worker processing.
13 unit tests pass, 0 new clippy warnings.
2026-07-24 18:47:15 +08:00

1.1 KiB

Quick Production Deployment Test

Test the binary

# Check binary version
./target/release/telfax --version

# Test help
./target/release/telfax --help
./target/release/telfax serve --help

# Test with production config (dry run)
./target/release/telfax serve --config deployment/config.production.toml

Install as macOS service

# Run installer
sudo ./deployment/install-macos.sh

# Edit config
nano /usr/local/etc/telfax/config.toml

# Start service
sudo launchctl load -w /Library/LaunchDaemons/com.telfax.server.plist

# Check status
sudo launchctl list | grep telfax

# View logs
tail -f /usr/local/var/log/telfax/telfax.log

Test API

# Health check
curl http://localhost:3000/health

# Status (with token from config)
curl -H "Authorization: Bearer prod-admin-token-change-me-abc123xyz" \
     http://localhost:3000/api/v1/status

# Modem status
curl -H "Authorization: Bearer prod-admin-token-change-me-abc123xyz" \
     http://localhost:3000/api/v1/modems

# Prometheus metrics
curl http://localhost:9090/metrics

Stop service

sudo launchctl unload /Library/LaunchDaemons/com.telfax.server.plist