Christian Krakau-Louis
d79652b494
- Introduced new authentication settings in config.py including `auth_enabled`, `admin_username`, `admin_password`, and `session_secret`. - Added validation for `session_secret` to ensure it meets security requirements when authentication is enabled. - Updated main.py to conditionally mount static files and log warnings if the directory is not found. - Removed unused email template files and added new authentication and notification setup documentation. - Implemented authentication configuration validation in validators.py and updated settings display. - Enhanced the user interface with a new login template and SVG assets for branding. - Added comprehensive guides for setting up authentication and notifications in the documentation.
3.3 KiB
3.3 KiB
User Guide
This guide helps you get started with using DocuElevate for document management and processing.
Getting Started
DocuElevate offers an intuitive web interface for uploading, managing, and processing your documents.
Accessing the System
- Navigate to your DocuElevate instance (typically at
http://your-server-address:8000) - If authentication is enabled, you'll be prompted to log in using your credentials
Authentication
DocuElevate supports two main authentication methods:
Basic Authentication
If basic authentication is configured:
- You'll see a simple login form
- Enter your username and password as configured in the system
- Click "Log In" to access DocuElevate
OpenID Connect (OIDC)
If OpenID Connect authentication is configured:
- You'll see a login button
- Clicking this will redirect you to your identity provider (e.g., Authentik, Keycloak, Auth0)
- Log in with your existing credentials on that platform
- You'll be redirected back to DocuElevate after successful authentication
User Sessions
- Once authenticated, your session will remain active until you log out or it expires
- Click the "Logout" button in the top navigation bar to end your session
- For security, sessions automatically expire after a period of inactivity
Main Interface
DocuElevate features a simple navigation system with the following main sections:
- Home: Dashboard and overview
- Upload: For adding new documents to the system
- Files: For viewing and managing processed documents
- About: Information about DocuElevate
Uploading Documents
Web Upload
- Navigate to the Upload page
- Drag and drop files onto the upload area, or click to browse your files
- Select files to upload (supported formats include PDF, Word documents, images, etc.)
- Click "Upload" to begin the process
- Your documents will be processed automatically according to the system configuration
Email Attachments
If configured, DocuElevate can automatically fetch documents from email attachments:
- Send an email with attachments to the configured email account
- DocuElevate will poll the mailbox at the configured interval
- Attachments will be automatically downloaded and processed
- No further action is required
Managing Documents
The Files page provides access to all processed documents:
- Navigate to the Files page
- Use the search box to find specific documents
- Click on any file to view its details
- Sort the list by any column by clicking on the column header
Document Processing Features
Depending on the system configuration, DocuElevate can perform:
- OCR - Extract text from images and scanned PDFs
- Metadata Extraction - Automatically identify document types, dates, and other key information
- PDF Conversion - Convert various file formats to PDF
- Document Distribution - Store documents in Dropbox, Nextcloud, or Paperless NGX
API Access
For programmatic access, DocuElevate provides a comprehensive REST API:
- Navigate to
/docson your DocuElevate instance - The interactive Swagger documentation allows you to test API endpoints directly
- Obtain an API token if authentication is enabled
Troubleshooting
If you encounter issues while using DocuElevate, please refer to the Troubleshooting Guide.