copilot-swe-agent[bot]
46b2f17acc
- Add MkDocs Material docs build stage to Dockerfile and Dockerfile.local - Mount pre-built docs as static files at /help/ in FastAPI (app/main.py) - Add app/views/help.py with /help → /help/ permanent redirect route - Register help router in app/views/__init__.py - Add Help nav link to base.html (public + app nav, desktop + mobile) - Create how-to guides: HP printer, ScanSnap, watched folder, email ingestion, mobile scanning - Update mkdocs.yml with How-To Guides section and Material theme palette - Add optional docs service (squidfunk/mkdocs-material) to docker-compose.yaml with docs profile - Add mkdocs-material to requirements-dev.txt - Add /docs_build to .gitignore - Add tests for help view (8 tests, 100% coverage on help.py) Co-authored-by: christianlouis <361235+christianlouis@users.noreply.github.com>
2.8 KiB
2.8 KiB
How-To Guides
Welcome to the DocuElevate How-To Guides. These step-by-step articles help you connect common scanners, printers, and mobile devices to DocuElevate for automatic document ingestion and processing.
Document Ingestion Guides
Choose the method that matches your hardware or workflow:
🖨️ Scanners & Printers
| Guide | Description |
|---|---|
| HP Enterprise Printer Setup | Configure HP MFPs for automatic scan-to-DocuElevate via email, network folder, or WebDAV |
| Fujitsu ScanSnap Setup | Set up ScanSnap iX1600/iX1500/iX500 to send scans directly to DocuElevate |
| Watched Folder Setup | Monitor a local or network folder and automatically ingest any files dropped into it |
📧 Email & Cloud
| Guide | Description |
|---|---|
| Email Ingestion | Route documents sent as email attachments into DocuElevate automatically |
| Mobile Scanning | Use iOS/Android apps to capture and upload documents from your phone |
Quick Comparison: Which Method Is Right for You?
| Method | Best For | Setup Complexity |
|---|---|---|
| Web Upload | Occasional one-off uploads | ⭐ Very Easy |
| Watched Folder | Any scanner that saves to a folder | ⭐⭐ Easy |
| Email Ingestion | Scanners with Scan-to-Email, fax services | ⭐⭐ Easy |
| HP Printer (SMB) | HP Enterprise MFPs on a corporate network | ⭐⭐⭐ Medium |
| ScanSnap + Cloud | Home/office ScanSnap via Dropbox/Drive | ⭐⭐ Easy |
| Mobile App | On-the-go document capture | ⭐ Very Easy |
| API Integration | Custom workflows, developer integrations | ⭐⭐⭐⭐ Advanced |
General Configuration Tips
Enable OCR for Searchable PDFs
DocuElevate applies OCR (Optical Character Recognition) to scanned documents, making them fully searchable. Configure the OCR engine in your .env:
OCR_ENABLED=true
OCR_ENGINE=tesseract # or: azure, google
OCR_LANGUAGE=eng # ISO 639-2 language code
Set Up Automatic Cloud Backup
After processing, DocuElevate can store documents in your preferred cloud storage. Configure in Settings or .env:
DEFAULT_STORAGE_TARGET=dropbox # or: gdrive, onedrive, s3, nextcloud
Configure Notifications
Get notified when documents are processed:
NOTIFICATION_ENABLED=true
NOTIFICATION_EMAIL=you@example.com
See Notifications Setup for webhook, Slack, and other integrations.
Need Help?
- Browse the full Documentation
- Check Troubleshooting for common issues
- View Configuration Reference for all settings
- Explore the API Reference for programmatic access