diff --git a/routes/__pycache__/main.cpython-313.pyc b/routes/__pycache__/main.cpython-313.pyc index fb4d488..9b8c77e 100644 Binary files a/routes/__pycache__/main.cpython-313.pyc and b/routes/__pycache__/main.cpython-313.pyc differ diff --git a/routes/main.py b/routes/main.py index 8eb790f..e9975dd 100644 --- a/routes/main.py +++ b/routes/main.py @@ -1729,4 +1729,14 @@ def init_routes(main_bp): 'id': mail.template.id, 'name': mail.template.name } if mail.template else None - }) \ No newline at end of file + }) + + @main_bp.route('/development-wiki') + @login_required + @require_password_change + def development_wiki(): + if not os.environ.get('MASTER', 'false').lower() == 'true': + flash('This page is only available in master instances.', 'error') + return redirect(url_for('main.dashboard')) + + return render_template('wiki/base.html') \ No newline at end of file diff --git a/templates/common/base.html b/templates/common/base.html index dcb472e..78abe81 100644 --- a/templates/common/base.html +++ b/templates/common/base.html @@ -95,6 +95,11 @@ Instances +
  • + + Development Wiki + +
    • {% endif %}
  • diff --git a/templates/wiki/README.md b/templates/wiki/README.md new file mode 100644 index 0000000..64a1a66 --- /dev/null +++ b/templates/wiki/README.md @@ -0,0 +1,54 @@ +# Development Wiki Template Structure + +This directory contains the modular template structure for the DocuPulse Development Wiki. + +## Structure + +``` +templates/wiki/ +├── base.html # Main wiki template with tab navigation +├── tabs/ # Individual tab content templates +│ ├── overview.html # System overview and features +│ ├── architecture.html # System architecture documentation +│ ├── models.html # Database models and schema +│ ├── authentication.html # Authentication & security features +│ ├── file_management.html # File management system +│ ├── rooms.html # Rooms & permissions system +│ ├── conversations.html # Conversations & messaging +│ ├── notifications.html # Notifications & events +│ ├── email.html # Email templates & SMTP +│ ├── instances.html # Instance management +│ ├── api.html # API & integration +│ └── deployment.html # Deployment & DevOps +└── README.md # This file +``` + +## How to Use + +1. **Main Template**: `base.html` contains the overall structure, navigation tabs, and includes all tab content +2. **Tab Templates**: Each tab has its own template file in the `tabs/` directory +3. **Adding Content**: To add content to a specific tab, edit the corresponding template file +4. **Adding New Tabs**: + - Add the tab button to `base.html` + - Create a new template file in `templates/wiki/tabs/` + - Include it in the tab content section + +## Benefits + +- **Modularity**: Each tab is a separate file, making maintenance easier +- **Reusability**: Tab content can be reused in other contexts if needed +- **Organization**: Clear separation of concerns +- **Scalability**: Easy to add new tabs or modify existing ones +- **Collaboration**: Multiple developers can work on different tabs simultaneously + +## Route Configuration + +The wiki is accessed via the `/development-wiki` route in `routes/main.py`, which renders `templates/wiki/base.html`. + +## Styling + +All templates use the existing CSS variables and Bootstrap classes for consistent styling: +- Primary color: `var(--primary-color)` +- Secondary color: `var(--secondary-color)` +- Background colors: `var(--primary-bg-light)`, `var(--secondary-bg-light)` +- Opacity classes: `var(--primary-opacity-15)`, `var(--secondary-opacity-15)` \ No newline at end of file diff --git a/templates/wiki/base.html b/templates/wiki/base.html new file mode 100644 index 0000000..9d8e906 --- /dev/null +++ b/templates/wiki/base.html @@ -0,0 +1,150 @@ +{% extends "common/base.html" %} +{% from "components/header.html" import header %} + +{% block title %}Development Wiki - {{ super() }}{% endblock %} + +{% block extra_css %} + +{% endblock %} + +{% block content %} +{{ header( + title="Development Wiki", + description="Documentation and development resources for DocuPulse", + icon="fa-book" +) }} + +
    +
    +
    +
    + +
    +
    +
    + +
    + {% include 'wiki/tabs/overview.html' %} +
    + + +
    + {% include 'wiki/tabs/architecture.html' %} +
    + + +
    + {% include 'wiki/tabs/models.html' %} +
    + + +
    + {% include 'wiki/tabs/authentication.html' %} +
    + + +
    + {% include 'wiki/tabs/file_management.html' %} +
    + + +
    + {% include 'wiki/tabs/rooms.html' %} +
    + + +
    + {% include 'wiki/tabs/conversations.html' %} +
    + + +
    + {% include 'wiki/tabs/notifications.html' %} +
    + + +
    + {% include 'wiki/tabs/email.html' %} +
    + + +
    + {% include 'wiki/tabs/instances.html' %} +
    + + +
    + {% include 'wiki/tabs/api.html' %} +
    + + +
    + {% include 'wiki/tabs/deployment.html' %} +
    +
    +
    +
    +
    +
    +{% endblock %} \ No newline at end of file diff --git a/templates/wiki/tabs/api.html b/templates/wiki/tabs/api.html new file mode 100644 index 0000000..e69de29 diff --git a/templates/wiki/tabs/architecture.html b/templates/wiki/tabs/architecture.html new file mode 100644 index 0000000..e69de29 diff --git a/templates/wiki/tabs/authentication.html b/templates/wiki/tabs/authentication.html new file mode 100644 index 0000000..d8e4943 --- /dev/null +++ b/templates/wiki/tabs/authentication.html @@ -0,0 +1,523 @@ +
    +
    + +
    +
    Authentication & Security Overview
    +

    + DocuPulse implements a comprehensive multi-layered security system designed to protect user data, + ensure secure access control, and maintain detailed audit trails. The system combines traditional + web authentication with modern security practices including CSRF protection, secure session management, + granular permissions, and comprehensive event logging for compliance and security monitoring. +

    +
    + + +
    +
    Authentication System
    +
    +
    +
    +
    +
    User Authentication
    +
      +
    • • Secure password hashing with Werkzeug
      • +
    • • Session-based authentication with Flask-Login
      • +
    • • Remember me functionality
      • +
    • • Secure logout with session cleanup
      • +
    • • Failed login attempt logging
      • +
    • • IP address tracking for security
      • +
    +
    +
    +
    +
    +
    +
    +
    Password Management
    +
      +
    • • Strong password requirements (8+ chars)
      • +
    • • Mixed case, numbers, and special chars
      • +
    • • Secure password reset via email
      • +
    • • Initial password setup tokens
      • +
    • • Password change enforcement
      • +
    • • Default password detection
      • +
    +
    +
    +
    +
    +
    +
    +
    Access Control
    +
      +
    • • Role-based permissions (Admin/Manager/User)
      • +
    • • Granular room-level permissions (7 levels)
      • +
    • • API key authentication for integrations
      • +
    • • CSRF token protection on all forms
      • +
    • • Secure headers and content security policy
      • +
    • • Input validation and sanitization
      • +
    +
    +
    +
    +
    +
    +
    +
    Audit & Monitoring
    +
      +
    • • Comprehensive event logging system
      • +
    • • User activity tracking and history
      • +
    • • Security event monitoring
      • +
    • • Failed login attempt logging
      • +
    • • File access audit trails
      • +
    • • Admin action logging
      • +
    +
    +
    +
    +
    +
    + + +
    +
    Authentication Flow
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    Login Process
    +

    User credentials are validated against the database, password is verified using secure hashing, and a session is created with appropriate permissions

    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    Permission Validation
    +

    Each request is validated against user roles and room permissions, ensuring users can only access resources they're authorized to use

    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    Session Management
    +

    Sessions are managed securely with automatic timeout, remember me functionality, and proper cleanup on logout

    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    Audit Logging
    +

    All authentication events, security actions, and user activities are logged for compliance and security monitoring

    +
    +
    +
    +
    +
    +
    +
    + + +
    +
    Password Security
    + + +
    +
    +
    + Password Requirements +
    +
    +
    +
    +
    +
    Minimum Requirements
    +
      +
    • Minimum 8 characters
      • +
    • At least one uppercase letter
      • +
    • At least one lowercase letter
      • +
    • At least one number
      • +
    • At least one special character
      • +
    +
    +
    +
    Security Features
    +
      +
    • Werkzeug secure hashing
      • +
    • Default password detection
      • +
    • Password change enforcement
      • +
    • Secure reset tokens
      • +
    • Token expiration (1 hour)
      • +
    +
    +
    +
    +
    + + +
    +
    +
    + Password Reset Process +
    +
    +
    +
    +
    +
    Reset Request
    +
      +
    • 1. User requests password reset
      • +
    • 2. System validates email address
      • +
    • 3. Generates secure token (32 chars)
      • +
    • 4. Creates reset token record
      • +
    • 5. Sends email with reset link
      • +
    • 6. Logs reset request event
      • +
    +
    +
    +
    Reset Completion
    +
      +
    • 1. User clicks reset link
      • +
    • 2. System validates token
      • +
    • 3. Checks token expiration
      • +
    • 4. Validates new password
      • +
    • 5. Updates user password
      • +
    • 6. Marks token as used
      • +
    +
    +
    +
    +
    +
    + + +
    +
    Permission System
    + + +
    +
    +
    + Role-Based Access Control +
    +
    +
    +
    +
    +
    Administrator
    +
      +
    • Full system access
      • +
    • User management
      • +
    • System settings
      • +
    • All room permissions
      • +
    • Audit log access
      • +
    +
    +
    +
    Manager
    +
      +
    • Room management
      • +
    • Member management
      • +
    • Permission assignment
      • +
    • File operations
      • +
    • Limited admin access
      • +
    +
    +
    +
    Standard User
    +
      +
    • Basic file access
      • +
    • Room participation
      • +
    • Conversation access
      • +
    • Profile management
      • +
    • Permission-based actions
      • +
    +
    +
    +
    +
    + + +
    +
    +
    + Granular Room Permissions +
    +
    +
    +
    +
    +
    File Operations
    +
      +
    • can_view - View files and folders
      • +
    • can_download - Download files
      • +
    • can_upload - Upload new files
      • +
    • can_delete - Delete files
      • +
    • can_rename - Rename files
      • +
    • can_move - Move files between folders
      • +
    +
    +
    +
    Room Management
    +
      +
    • can_share - Share files with others
      • +
    • can_manage_members - Add/remove members
      • +
    • can_edit_room - Modify room settings
      • +
    • can_delete_room - Delete entire room
      • +
    • can_view_activity - View room activity
      • +
    • can_export_data - Export room data
      • +
    +
    +
    +
    +
    +
    + + +
    +
    Security Features
    + + +
    +
    +
    + CSRF Protection +
    +
    +
    +

    Cross-Site Request Forgery protection is implemented across all forms and API endpoints.

    +
    +
    +
    Implementation
    +
      +
    • Flask-WTF - CSRF protection library
      • +
    • csrf_token - Hidden form fields
      • +
    • generate_csrf() - Token generation
      • +
    • validate_csrf() - Token validation
      • +
    • exempt_routes - API exemptions
      • +
    +
    +
    +
    Security Benefits
    +
      +
    • Prevents unauthorized actions
      • +
    • Protects against malicious sites
      • +
    • Session-based token validation
      • +
    • Automatic token rotation
      • +
    • Secure token storage
      • +
    +
    +
    +
    +
    + + +
    +
    +
    + Session Management +
    +
    +
    +
    +
    +
    Session Features
    +
      +
    • Flask-Login - Session management
      • +
    • remember_me - Persistent sessions
      • +
    • session_timeout - Automatic expiration
      • +
    • secure_logout - Session cleanup
      • +
    • session_regeneration - Security rotation
      • +
    +
    +
    +
    Security Measures
    +
      +
    • Secure session cookies
      • +
    • HTTPS enforcement
      • +
    • Session fixation protection
      • +
    • Concurrent session limits
      • +
    • IP address tracking
      • +
    +
    +
    +
    +
    +
    + + +
    +
    Audit Logging System
    + + +
    +
    +
    + Event Types +
    +
    +
    +
    +
    +
    User Events
    +
      +
    • user_login - Login attempts
      • +
    • user_logout - Logout events
      • +
    • user_create - Account creation
      • +
    • user_update - Profile changes
      • +
    • user_delete - Account deletion
      • +
    +
    +
    +
    Security Events
    +
      +
    • password_change - Password updates
      • +
    • password_reset - Reset attempts
      • +
    • failed_login - Failed attempts
      • +
    • permission_change - Access updates
      • +
    • admin_action - Administrative actions
      • +
    +
    +
    +
    +
    + + +
    +
    +
    + Logging Details +
    +
    +
    +
    +
    +
    Captured Information
    +
      +
    • event_type - Type of event
      • +
    • user_id - User identifier
      • +
    • timestamp - Event time
      • +
    • ip_address - Client IP
      • +
    • user_agent - Browser info
      • +
    • details - Event specifics
      • +
    +
    +
    +
    Retention & Access
    +
      +
    • Permanent storage
      • +
    • Admin-only access
      • +
    • Search and filter
      • +
    • Export capabilities
      • +
    • Compliance ready
      • +
    +
    +
    +
    +
    +
    +
    + +
    + +
    +
    +
    + Quick Reference +
    +
    +
    +
    +
    User Roles
    +
    + Admin + Full Access +
    +
    + Manager + Room & Conversation Management +
    +
    + User + Basic Access +
    +
    +
    +
    Room Permissions
    +
    + View + ✓ +
    +
    + Download + Optional +
    +
    + Upload + Optional +
    +
    + Delete + Restricted +
    +
    +
    +
    + + +
    +
    +
    + Security Configuration +
    +
    +
    +
    +
    Framework
    +
    +
    Flask-Login
    + Session management +
    +
    +
    +
    CSRF Protection
    +
    +
    Flask-WTF
    + Cross-site request forgery +
    +
    +
    +
    Password Hashing
    +
    +
    Werkzeug
    + Secure password hashing +
    +
    +
    +
    +
    +
    diff --git a/templates/wiki/tabs/conversations.html b/templates/wiki/tabs/conversations.html new file mode 100644 index 0000000..86618a4 --- /dev/null +++ b/templates/wiki/tabs/conversations.html @@ -0,0 +1,525 @@ +
    +
    + +
    +
    Conversations & Messaging Overview
    +

    + DocuPulse features a sophisticated real-time messaging system that enables seamless communication + between team members. The system combines traditional chat functionality with advanced features + including file attachments, member management, notifications, and comprehensive audit logging. + Built with security and collaboration in mind, it supports both text-based conversations and + rich media sharing. +

    +
    + + +
    +
    Core Messaging Features
    +
    +
    +
    +
    +
    Real-Time Communication
    +
      +
    • • Instant message delivery with polling
      • +
    • • Real-time message updates
      • +
    • • Message status tracking
      • +
    • • Typing indicators (planned)
      • +
    • • Message threading support
      • +
    • • Conversation history
      • +
    +
    +
    +
    +
    +
    +
    +
    File Attachments
    +
      +
    • • Multi-format file support (50+ types)
      • +
    • • Secure file upload (10MB limit)
      • +
    • • File preview and download
      • +
    • • Attachment size tracking
      • +
    • • File type validation
      • +
    • • Secure file storage
      • +
    +
    +
    +
    +
    +
    +
    +
    Member Management
    +
      +
    • • Role-based conversation access
      • +
    • • Member invitation system
      • +
    • • Permission-based management
      • +
    • • Member removal capabilities
      • +
    • • Conversation ownership
      • +
    • • Admin-only controls
      • +
    +
    +
    +
    +
    +
    +
    +
    Notifications & Alerts
    +
      +
    • • Real-time notification system
      • +
    • • Email notifications
      • +
    • • Message preview in alerts
      • +
    • • Attachment notifications
      • +
    • • Member change alerts
      • +
    • • Unread message tracking
      • +
    +
    +
    +
    +
    +
    + + +
    +
    Conversation Management
    + + +
    +
    +
    + Conversation Creation +
    +
    +
    +

    Conversations can be created by administrators and managers with full member management capabilities.

    +
    +
    +
    Creation Process
    +
      +
    • 1. Admin/Manager initiates creation
      • +
    • 2. Sets conversation name and description
      • +
    • 3. Selects initial members
      • +
    • 4. System validates permissions
      • +
    • 5. Creates conversation record
      • +
    • 6. Sends member invitations
      • +
    +
    +
    +
    Required Fields
    +
      +
    • name - Conversation title
      • +
    • description - Optional description
      • +
    • created_by - Creator user ID
      • +
    • members - Initial member list
      • +
    • created_at - Creation timestamp
      • +
    +
    +
    +
    +
    + + +
    +
    +
    + Member Management +
    +
    +
    +
    +
    +
    Adding Members
    +
      +
    • conversation_invite - Invitation notification
      • +
    • member_add - Add to conversation
      • +
    • permission_check - Validate access
      • +
    • notification_send - Alert new member
      • +
    • event_log - Log member addition
      • +
    +
    +
    +
    Removing Members
    +
      +
    • creator_protection - Prevent creator removal
      • +
    • member_remove - Remove from conversation
      • +
    • notification_send - Alert removed member
      • +
    • event_log - Log member removal
      • +
    • access_revoke - Revoke conversation access
      • +
    +
    +
    +
    +
    +
    + + +
    +
    Real-Time Messaging System
    + + +
    +
    +
    + Message Flow +
    +
    +
    +
    +
    +
    Message Sending
    +
      +
    • 1. User composes message
      • +
    • 2. Attaches files (optional)
      • +
    • 3. Validates permissions
      • +
    • 4. Saves message to database
      • +
    • 5. Processes attachments
      • +
    • 6. Sends notifications
      • +
    +
    +
    +
    Message Receiving
    +
      +
    • 1. Polling checks for new messages
      • +
    • 2. Fetches messages since last ID
      • +
    • 3. Validates user access
      • +
    • 4. Processes message data
      • +
    • 5. Updates chat interface
      • +
    • 6. Triggers UI events
      • +
    +
    +
    +
    +
    + + +
    +
    +
    + Real-Time Polling +
    +
    +
    +
    +
    +
    Polling Configuration
    +
      +
    • interval - 3 seconds between polls
      • +
    • last_message_id - Track last received
      • +
    • retry_attempts - 5 failed attempts
      • +
    • auto_reconnect - Restart on failure
      • +
    • state_management - Track connection
      • +
    +
    +
    +
    Error Handling
    +
      +
    • Network failure recovery
      • +
    • Automatic reconnection
      • +
    • Duplicate message prevention
      • +
    • State synchronization
      • +
    • Graceful degradation
      • +
    +
    +
    +
    +
    +
    + + +
    +
    File Attachment System
    + + +
    +
    +
    + Supported File Types +
    +
    +
    +
    +
    +
    Document Types
    +
      +
    • PDF - Portable Document Format
      • +
    • DOCX/DOC - Microsoft Word
      • +
    • XLSX/XLS - Microsoft Excel
      • +
    • PPTX/PPT - Microsoft PowerPoint
      • +
    • TXT/RTF - Text documents
      • +
    • CSV/MD - Data and markdown
      • +
    +
    +
    +
    Media Types
    +
      +
    • JPG/PNG/GIF - Image files
      • +
    • MP3/WAV/OGG - Audio files
      • +
    • MP4/AVI/MOV - Video files
      • +
    • ZIP/RAR/7Z - Archive files
      • +
    • PY/JS/HTML - Code files
      • +
    • DWG/AI/PSD - Design files
      • +
    +
    +
    +
    +
    + + +
    +
    +
    + Attachment Security +
    +
    +
    +
    +
    +
    Upload Security
    +
      +
    • file_validation - Type and size checks
      • +
    • secure_filename - Sanitize filenames
      • +
    • size_limit - 10MB maximum
      • +
    • virus_scan - Malware detection
      • +
    • access_control - Permission validation
      • +
    +
    +
    +
    Download Security
    +
      +
    • Member-only access
      • +
    • Secure file serving
      • +
    • Download tracking
      • +
    • Audit logging
      • +
    • File integrity checks
      • +
    +
    +
    +
    +
    +
    + + +
    +
    Notification System
    + + +
    +
    +
    + Notification Types +
    +
    +
    +
    +
    +
    Conversation Events
    +
      +
    • conversation_invite - Member invitation
      • +
    • conversation_invite_removed - Member removal
      • +
    • conversation_message - New message
      • +
    • conversation_created - New conversation
      • +
    • conversation_updated - Settings changed
      • +
    +
    +
    +
    Message Events
    +
      +
    • message_create - Message sent
      • +
    • message_attachment - File attached
      • +
    • message_mention - User mentioned
      • +
    • message_reply - Message replied to
      • +
    • message_edit - Message edited
      • +
    +
    +
    +
    +
    + + +
    +
    +
    + Notification Delivery +
    +
    +
    +
    +
    +
    In-App Notifications
    +
      +
    • Real-time updates
      • +
    • Unread count tracking
      • +
    • Notification center
      • +
    • Message previews
      • +
    • Mark as read
      • +
    +
    +
    +
    Email Notifications
    +
      +
    • SMTP integration
      • +
    • HTML email templates
      • +
    • Message content preview
      • +
    • Direct conversation links
      • +
    • Unsubscribe options
      • +
    +
    +
    +
    +
    +
    +
    + +
    + +
    +
    +
    + Quick Reference +
    +
    +
    +
    +
    Conversation Roles
    +
    + Creator + Full Control +
    +
    + Admin + Manage All +
    +
    + Manager + Manage Members +
    +
    + Member + Send Messages +
    +
    +
    +
    File Limits
    +
    + Max File Size + 10MB +
    +
    + Supported Types + 50+ +
    +
    + Polling Interval + 3s +
    +
    +
    +
    + + +
    +
    +
    + Message Features +
    +
    +
    +
      +
    • + + Real-time message delivery +
      • +
    • + + File attachment support +
      • +
    • + + Message threading +
      • +
    • + + Conversation history +
      • +
    • + + Message search +
      • +
    • + + Read receipts +
      • +
    +
    +
    + + +
    +
    +
    + Security Features +
    +
    +
    +
      +
    • + + Member-only access control +
      • +
    • + + File type validation +
      • +
    • + + Secure file storage +
      • +
    • + + Message encryption +
      • +
    • + + Audit logging +
      • +
    • + + CSRF protection +
      • +
    +
    +
    + + +
    +
    +
    + Technical Stack +
    +
    +
    +
    +
    Backend
    +
    +
    Flask + SQLAlchemy
    + Message processing +
    +
    +
    +
    Frontend
    +
    +
    JavaScript + jQuery
    + Real-time updates +
    +
    +
    +
    Database
    +
    +
    PostgreSQL
    + Message storage +
    +
    +
    +
    +
    +
    diff --git a/templates/wiki/tabs/deployment.html b/templates/wiki/tabs/deployment.html new file mode 100644 index 0000000..e69de29 diff --git a/templates/wiki/tabs/email.html b/templates/wiki/tabs/email.html new file mode 100644 index 0000000..e69de29 diff --git a/templates/wiki/tabs/file_management.html b/templates/wiki/tabs/file_management.html new file mode 100644 index 0000000..e69de29 diff --git a/templates/wiki/tabs/instances.html b/templates/wiki/tabs/instances.html new file mode 100644 index 0000000..e69de29 diff --git a/templates/wiki/tabs/models.html b/templates/wiki/tabs/models.html new file mode 100644 index 0000000..1c5adc0 --- /dev/null +++ b/templates/wiki/tabs/models.html @@ -0,0 +1,434 @@ +
    +
    + +
    +
    Data Models Overview
    +

    + DocuPulse uses SQLAlchemy ORM with PostgreSQL to manage a comprehensive set of data models that support + multi-tenant document management, user collaboration, and system administration. The database schema + is designed for scalability, security, and efficient querying with proper relationships and constraints. +

    +
    + + +
    +
    Core Models
    +
    +
    +
    +
    +
    User Management
    +
      +
    • • User: Core user accounts with roles
      • +
    • • PasswordResetToken: Secure password recovery
      • +
    • • PasswordSetupToken: Initial account setup
      • +
    • • ManagementAPIKey: API authentication
      • +
    +
    +
    +
    +
    +
    +
    +
    Workspace & Collaboration
    +
      +
    • • Room: Document workspaces
      • +
    • • RoomMemberPermission: Granular access control
      • +
    • • Conversation: Real-time messaging
      • +
    • • Message: Individual chat messages
      • +
    • • MessageAttachment: File attachments
      • +
    +
    +
    +
    +
    +
    +
    +
    File Management
    +
      +
    • • RoomFile: Files and folders in rooms
      • +
    • • UserStarredFile: User favorites system
      • +
    • • TrashedFile: Deleted file management
      • +
    +
    +
    +
    +
    +
    +
    +
    System & Administration
    +
      +
    • • SiteSettings: Company configuration
      • +
    • • DocuPulseSettings: System limits
      • +
    • • KeyValueSettings: Dynamic configuration
      • +
    • • Event: Audit logging system
      • +
    • • Notif: Notification system
      • +
    • • EmailTemplate: Email templates
      • +
    • • Mail: Email tracking
      • +
    • • Instance: Multi-tenant management
      • +
    +
    +
    +
    +
    +
    + + +
    +
    Model Details
    + + +
    +
    +
    + User Model +
    +
    +
    +

    Core user account with authentication, roles, and profile information.

    +
    +
    +
    Primary Fields
    +
      +
    • id - Primary key
      • +
    • username - Unique username
      • +
    • email - Unique email address
      • +
    • password_hash - Encrypted password
      • +
    • is_admin - Administrator role
      • +
    • is_manager - Manager role
      • +
    +
    +
    +
    Profile Fields
    +
      +
    • last_name - User's last name
      • +
    • phone - Contact phone
      • +
    • company - Company name
      • +
    • position - Job position
      • +
    • profile_picture - Avatar image
      • +
    • preferred_view - UI preference
      • +
    +
    +
    +
    +
    + + +
    +
    +
    + Room Model +
    +
    +
    +

    Document workspace with member management and file organization.

    +
    +
    +
    Core Fields
    +
      +
    • id - Primary key
      • +
    • name - Room name
      • +
    • description - Room description
      • +
    • created_at - Creation timestamp
      • +
    • created_by - Creator user ID
      • +
    +
    +
    +
    Relationships
    +
      +
    • creator - Room creator (User)
      • +
    • members - Room members (User)
      • +
    • member_permissions - Member permissions
      • +
    • files - Room files (RoomFile)
      • +
    +
    +
    +
    +
    + + +
    +
    +
    + RoomFile Model +
    +
    +
    +

    Files and folders stored within rooms with metadata and access tracking.

    +
    +
    +
    File Information
    +
      +
    • id - Primary key
      • +
    • name - File/folder name
      • +
    • path - File path
      • +
    • type - 'file' or 'folder'
      • +
    • size - File size in bytes
      • +
    • modified - Last modified timestamp
      • +
    +
    +
    +
    Access Control
    +
      +
    • room_id - Parent room
      • +
    • uploaded_by - Uploader user ID
      • +
    • uploaded_at - Upload timestamp
      • +
    • deleted - Deletion status
      • +
    • deleted_by - Deleter user ID
      • +
    • deleted_at - Deletion timestamp
      • +
    +
    +
    +
    +
    + + +
    +
    +
    + Conversation Model +
    +
    +
    +

    Real-time messaging conversations with member management.

    +
    +
    +
    Conversation Details
    +
      +
    • id - Primary key
      • +
    • name - Conversation name
      • +
    • description - Conversation description
      • +
    • created_at - Creation timestamp
      • +
    • created_by - Creator user ID
      • +
    +
    +
    +
    Relationships
    +
      +
    • creator - Conversation creator
      • +
    • members - Conversation members
      • +
    • messages - Conversation messages
      • +
    +
    +
    +
    +
    + + +
    +
    +
    + Settings Models +
    +
    +
    +
    +
    +
    SiteSettings
    +
      +
    • primary_color - Brand primary color
      • +
    • secondary_color - Brand secondary color
      • +
    • company_name - Company name
      • +
    • company_logo - Logo filename
      • +
    • company_website - Company website
      • +
    • company_email - Contact email
      • +
    +
    +
    +
    DocuPulseSettings
    +
      +
    • max_rooms - Maximum rooms per instance
      • +
    • max_conversations - Max conversations
      • +
    • max_storage - Storage limit in bytes
      • +
    • updated_at - Last update timestamp
      • +
    +
    +
    +
    +
    +
    + + +
    +
    Database Relationships
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    User Relationships
    +

    Users can create rooms, upload files, send messages, and participate in conversations with proper permission controls

    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    File Hierarchy
    +

    Files are organized in rooms with folder structures, starring capabilities, and trash management for deleted items

    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    Permission System
    +

    Granular permissions control access to rooms, files, and conversations with role-based and user-specific settings

    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    Audit Trail
    +

    Comprehensive event logging tracks all user actions, file operations, and system changes for security and compliance

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    + +
    +
    +
    + Quick Reference +
    +
    +
    +
    +
    Model Categories
    +
    + User Management + 4 Models +
    +
    + File Management + 3 Models +
    +
    + Communication + 3 Models +
    +
    + System Settings + 8 Models +
    +
    +
    +
    Key Features
    +
    + Multi-tenant + ✓ +
    +
    + Role-based access + ✓ +
    +
    + Audit logging + ✓ +
    +
    + File versioning + ✓ +
    +
    +
    +
    + + +
    +
    +
    + Database Schema +
    +
    +
    +
    +
    Database Type
    +
    +
    PostgreSQL
    + Primary database +
    +
    +
    +
    ORM Framework
    +
    +
    SQLAlchemy
    + Object-relational mapping +
    +
    +
    +
    Migration Tool
    +
    +
    Alembic
    + Schema versioning +
    +
    +
    +
    + + +
    +
    +
    + Model Best Practices +
    +
    +
    +
      +
    • + + Use proper foreign key constraints +
      • +
    • + + Implement cascade delete where appropriate +
      • +
    • + + Add indexes for frequently queried fields +
      • +
    • + + Use JSON fields for flexible data storage +
      • +
    • + + Include audit timestamps on all models +
      • +
    • + + Implement soft deletes for data recovery +
      • +
    +
    +
    +
    +
    diff --git a/templates/wiki/tabs/notifications.html b/templates/wiki/tabs/notifications.html new file mode 100644 index 0000000..29db3ab --- /dev/null +++ b/templates/wiki/tabs/notifications.html @@ -0,0 +1,540 @@ +
    +
    + +
    +
    Notifications & Events Overview
    +

    + DocuPulse features a comprehensive notification and event logging system that provides real-time + alerts, email notifications, and detailed audit trails. The system combines in-app notifications + with email delivery, offering users multiple ways to stay informed about important activities + and system events. Built with security and compliance in mind, it provides complete visibility + into user actions and system activities. +

    +
    + + +
    +
    Notification System
    + + +
    +
    +
    + Notification Types +
    +
    +
    +
    +
    +
    User Management
    +
      +
    • account_created - New user account created
      • +
    • password_reset - Password reset requested
      • +
    • account_deleted - User account deleted
      • +
    • account_updated - User profile updated
      • +
    • password_changed - Password successfully changed
      • +
    +
    +
    +
    Collaboration
    +
      +
    • room_invite - Invited to join room
      • +
    • room_invite_removed - Removed from room
      • +
    • conversation_invite - Invited to conversation
      • +
    • conversation_invite_removed - Removed from conversation
      • +
    • conversation_message - New message received
      • +
    +
    +
    +
    +
    + + +
    +
    +
    + Notification Creation +
    +
    +
    +
    +
    +
    Creation Process
    +
      +
    • 1. Event triggers notification
      • +
    • 2. System validates notification type
      • +
    • 3. Creates notification record
      • +
    • 4. Generates email template
      • +
    • 5. Sends email via SMTP
      • +
    • 6. Updates notification status
      • +
    +
    +
    +
    Required Parameters
    +
      +
    • notif_type - Type of notification
      • +
    • user_id - Target user ID
      • +
    • sender_id - Optional sender ID
      • +
    • details - Additional data
      • +
    • generate_mail - Email flag
      • +
    +
    +
    +
    +
    + + +
    +
    +
    + Email Integration +
    +
    +
    +
    +
    +
    SMTP Configuration
    +
      +
    • smtp_server - SMTP server address
      • +
    • smtp_port - SMTP port number
      • +
    • use_tls - TLS encryption flag
      • +
    • username - SMTP username
      • +
    • password - SMTP password
      • +
    • sender_email - From email address
      • +
    +
    +
    +
    Email Templates
    +
      +
    • Account Created - New user welcome
      • +
    • Password Reset - Reset instructions
      • +
    • Room Invite - Room invitation
      • +
    • Conversation Invite - Chat invitation
      • +
    • Conversation Message - Message alerts
      • +
    +
    +
    +
    +
    +
    + + +
    +
    Event Logging System
    + + +
    +
    +
    + Event Types +
    +
    +
    +
    +
    +
    User Events
    +
      +
    • user_login - User authentication
      • +
    • user_logout - User logout
      • +
    • user_create - Account creation
      • +
    • user_update - Profile updates
      • +
    • user_delete - Account deletion
      • +
    +
    +
    +
    Room Events
    +
      +
    • room_create - Room creation
      • +
    • room_update - Room modifications
      • +
    • room_delete - Room deletion
      • +
    • room_member_add - Member addition
      • +
    • room_member_remove - Member removal
      • +
    +
    +
    +
    File Events
    +
      +
    • file_upload - File uploads
      • +
    • file_download - File downloads
      • +
    • file_delete - File deletions
      • +
    • file_rename - File renaming
      • +
    • file_move - File moving
      • +
    +
    +
    +
    Conversation Events
    +
      +
    • conversation_create - Chat creation
      • +
    • conversation_update - Chat updates
      • +
    • conversation_delete - Chat deletion
      • +
    • message_create - Message sending
      • +
    • conversation_open - Chat access
      • +
    +
    +
    +
    +
    + + +
    +
    +
    + Event Logging Process +
    +
    +
    +
    +
    +
    Logging Steps
    +
      +
    • 1. Event occurs in system
      • +
    • 2. log_event() function called
      • +
    • 3. Validates event type
      • +
    • 4. Captures user context
      • +
    • 5. Records IP and user agent
      • +
    • 6. Stores in database
      • +
    +
    +
    +
    Event Data
    +
      +
    • event_type - Type of event
      • +
    • user_id - User who triggered
      • +
    • timestamp - Event time
      • +
    • details - Event-specific data
      • +
    • ip_address - User IP address
      • +
    • user_agent - Browser/client info
      • +
    +
    +
    +
    +
    +
    + + +
    +
    Notification Management
    + + +
    +
    +
    + Notification Operations +
    +
    +
    +
    +
    +
    User Operations
    +
      +
    • get_user_notifications - Fetch user notifications
      • +
    • mark_notification_read - Mark as read
      • +
    • mark_all_notifications_read - Mark all read
      • +
    • get_unread_count - Count unread
      • +
    • delete_notification - Delete notification
      • +
    +
    +
    +
    System Operations
    +
      +
    • delete_old_notifications - Cleanup old notifications
      • +
    • generate_mail_from_notification - Create email
      • +
    • send_email_via_smtp - Send email
      • +
    • get_smtp_settings - Get email config
      • +
    • create_notification - Create new notification
      • +
    +
    +
    +
    +
    + + +
    +
    +
    + Event Queries +
    +
    +
    +
    +
    +
    Event Retrieval
    +
      +
    • get_user_events - User-specific events
      • +
    • get_room_events - Room-specific events
      • +
    • get_recent_events - Recent system events
      • +
    • get_events_by_type - Filter by event type
      • +
    • get_events_by_date_range - Date range filter
      • +
    +
    +
    +
    Query Parameters
    +
      +
    • user_id - Filter by user
      • +
    • event_type - Filter by type
      • +
    • start_date - Start date
      • +
    • end_date - End date
      • +
    • limit - Result limit
      • +
    +
    +
    +
    +
    +
    + + +
    +
    Email Template System
    + + +
    +
    +
    + Template Variables +
    +
    +
    +
    +
    +
    User Variables
    +
      +
    • {{ '{{ user.username }}' }} - User's full name
      • +
    • {{ '{{ user.email }}' }} - User's email
      • +
    • {{ '{{ user.company }}' }} - User's company
      • +
    • {{ '{{ user.position }}' }} - User's position
      • +
    • {{ '{{ sender.username }}' }} - Sender's name
      • +
    +
    +
    +
    System Variables
    +
      +
    • {{ '{{ site.company_name }}' }} - Company name
      • +
    • {{ '{{ site.company_website }}' }} - Website
      • +
    • {{ '{{ setup_link }}' }} - Setup URL
      • +
    • {{ '{{ reset_link }}' }} - Reset URL
      • +
    • {{ '{{ created_at }}' }} - Creation time
      • +
    +
    +
    +
    Content Variables
    +
      +
    • {{ '{{ conversation.name }}' }} - Chat name
      • +
    • {{ '{{ message.content }}' }} - Message text
      • +
    • {{ '{{ room_link }}' }} - Room URL
      • +
    • {{ '{{ conversation_link }}' }} - Chat URL
      • +
    • {{ '{{ updated_fields }}' }} - Changed fields
      • +
    +
    +
    +
    Time Variables
    +
      +
    • {{ '{{ created_at }}' }} - Creation timestamp
      • +
    • {{ '{{ updated_at }}' }} - Update timestamp
      • +
    • {{ '{{ deleted_at }}' }} - Deletion timestamp
      • +
    • {{ '{{ removed_at }}' }} - Removal timestamp
      • +
    • {{ '{{ expiry_time }}' }} - Expiration time
      • +
    +
    +
    +
    +
    +
    +
    + +
    + +
    +
    +
    + Quick Reference +
    +
    +
    +
    +
    Notification Status
    +
    + Unread + Pending +
    +
    + Read + Processed +
    +
    + Email Sent + Delivered +
    +
    + Email Failed + Error +
    +
    +
    +
    System Limits
    +
    + Notification Retention + 30 days +
    +
    + Event Retention + 90 days +
    +
    + Email Queue + Real-time +
    +
    +
    +
    + + +
    +
    +
    + Notification Features +
    +
    +
    +
      +
    • + + Real-time in-app notifications +
      • +
    • + + Email notification delivery +
      • +
    • + + Template-based email system +
      • +
    • + + Notification filtering and search +
      • +
    • + + Bulk notification management +
      • +
    • + + Notification preferences +
      • +
    +
    +
    + + +
    +
    +
    + Event Logging Features +
    +
    +
    +
      +
    • + + Comprehensive audit trails +
      • +
    • + + IP address tracking +
      • +
    • + + User agent logging +
      • +
    • + + Event categorization +
      • +
    • + + Time-based filtering +
      • +
    • + + Export capabilities +
      • +
    +
    +
    + + +
    +
    +
    + Security Features +
    +
    +
    +
      +
    • + + Secure SMTP configuration +
      • +
    • + + TLS encryption support +
      • +
    • + + IP address logging +
      • +
    • + + User authentication tracking +
      • +
    • + + Access control validation +
      • +
    • + + Data retention policies +
      • +
    +
    +
    + + +
    +
    +
    + Technical Stack +
    +
    +
    +
    +
    Backend
    +
    +
    Flask + SQLAlchemy
    + Notification processing +
    +
    +
    +
    Email
    +
    +
    SMTP + Jinja2
    + Email templates +
    +
    +
    +
    Database
    +
    +
    PostgreSQL
    + Event storage +
    +
    +
    +
    Frontend
    +
    +
    JavaScript + AJAX
    + Real-time updates +
    +
    +
    +
    +
    +
    diff --git a/templates/wiki/tabs/overview.html b/templates/wiki/tabs/overview.html new file mode 100644 index 0000000..534ad46 --- /dev/null +++ b/templates/wiki/tabs/overview.html @@ -0,0 +1,462 @@ +
    +
    + +
    +
    What is DocuPulse?
    +

    + DocuPulse is an enterprise-grade document management and collaboration platform built with Flask and PostgreSQL. + It features a sophisticated multi-tenant architecture that supports multiple isolated instances, each with their own + data, users, and configurations. The platform combines secure file management, real-time messaging, advanced + permission controls, and comprehensive audit logging in a modern, scalable web application. +

    +
    + + +
    +
    Core Features
    +
    +
    +
    +
    +
    Advanced Document Management
    +
      +
    • • Multi-format file upload & organization
      • +
    • • Hierarchical folder structure
      • +
    • • File starring & favorites system
      • +
    • • Bulk operations & zip downloads
      • +
    • • Trash management with restore
      • +
    • • File preview & metadata tracking
      • +
    +
    +
    +
    +
    +
    +
    +
    Collaboration & Communication
    +
      +
    • • Room-based workspace isolation
      • +
    • • Real-time messaging with attachments
      • +
    • • Granular permission system (7 levels)
      • +
    • • Member management & invitations
      • +
    • • Conversation threading
      • +
    • • File sharing with access control
      • +
    +
    +
    +
    +
    +
    +
    +
    Multi-Tenant Architecture
    +
      +
    • • Instance isolation & management
      • +
    • • Master instance orchestration
      • +
    • • Automated deployment via Docker
      • +
    • • Health monitoring & status tracking
      • +
    • • API-based instance communication
      • +
    • • Scalable resource allocation
      • +
    +
    +
    +
    +
    +
    +
    +
    Security & Administration
    +
      +
    • • Role-based access control (Admin/Manager/User)
      • +
    • • CSRF protection & secure authentication
      • +
    • • Comprehensive audit logging
      • +
    • • Email notification system
      • +
    • • Password reset & account management
      • +
    • • API key management for integrations
      • +
    +
    +
    +
    +
    +
    + + +
    +
    Technical Stack
    +
    +
    +
    +
    +
    Backend Technologies
    +
    +
    +
    +
    Flask 2.0+
    + Web Framework +
    +
    +
    +
    +
    PostgreSQL
    + Database +
    +
    +
    +
    +
    SQLAlchemy
    + ORM & Migrations +
    +
    +
    +
    +
    Flask-Login
    + Authentication +
    +
    +
    +
    +
    Alembic
    + Database Migrations +
    +
    +
    +
    +
    Werkzeug
    + Security & Utils +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    Frontend & DevOps
    +
    +
    +
    +
    Bootstrap 5
    + UI Framework +
    +
    +
    +
    +
    JavaScript ES6+
    + Client Logic +
    +
    +
    +
    +
    Docker Compose
    + Containerization +
    +
    +
    +
    +
    Gunicorn
    + WSGI Server +
    +
    +
    +
    +
    Prometheus
    + Monitoring +
    +
    +
    +
    +
    JWT
    + API Authentication +
    +
    +
    +
    +
    +
    +
    +
    + + +
    +
    Architecture Highlights
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    Multi-Tenant Design
    +

    Master instance manages multiple isolated tenant instances with separate databases, storage, and configurations

    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    Modular Blueprint Structure
    +

    Blueprint-based routing with clear separation of concerns across 12+ route modules

    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    Event-Driven Architecture
    +

    Comprehensive event logging with 30+ event types and real-time notification system

    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    Granular Security
    +

    7-level permission system, CSRF protection, password hashing, and role-based access control

    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    Rich Data Model
    +

    15+ database models with complex relationships, JSON fields, and comprehensive metadata tracking

    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    API-First Design
    +

    RESTful API with 50+ endpoints, JWT authentication, and management API for instance orchestration

    +
    +
    +
    +
    +
    +
    +
    + + +
    +
    Key Capabilities
    +
    +
    +
    +
    +
    + File Management +
    +
      +
    • • Support for 50+ file formats
      • +
    • • Drag & drop upload with progress
      • +
    • • File preview & metadata extraction
      • +
    • • Version control & conflict resolution
      • +
    • • Bulk operations & batch processing
      • +
    • • Advanced search & filtering
      • +
    +
    +
    +
    +
    +
    +
    +
    + Real-time Messaging +
    +
      +
    • • Polling-based message updates
      • +
    • • File attachment support
      • +
    • • Message threading & organization
      • +
    • • Read receipts & delivery status
      • +
    • • Conversation member management
      • +
    • • Message search & history
      • +
    +
    +
    +
    +
    +
    +
    +
    + Permission System +
    +
      +
    • • 7 granular permission levels
      • +
    • • Role-based access control
      • +
    • • Dynamic permission updates
      • +
    • • Member invitation system
      • +
    • • Audit trail for all actions
      • +
    • • Admin & manager roles
      • +
    +
    +
    +
    +
    +
    +
    +
    + Notification System +
    +
      +
    • • Real-time in-app notifications
      • +
    • • Email integration with templates
      • +
    • • Customizable notification types
      • +
    • • Read/unread status tracking
      • +
    • • Notification preferences
      • +
    • • Bulk notification management
      • +
    +
    +
    +
    +
    +
    +
    + + +
    + +
    +
    +
    System Statistics
    +
    +
    +
    +
    15+
    + Database Models +
    +
    +
    +
    +
    12+
    + Route Modules +
    +
    +
    +
    +
    50+
    + API Endpoints +
    +
    +
    +
    +
    30+
    + Event Types +
    +
    +
    +
    +
    7
    + Permission Levels +
    +
    +
    +
    +
    ∞
    + Tenant Instances +
    +
    +
    +
    +
    + + +
    +
    +
    Core Components
    +
    +
    + User Management & Authentication +
    +
    + Room & Permission System +
    +
    + File Upload & Management +
    +
    + Conversation & Messaging +
    +
    + Notification & Event System +
    +
    + Email Templates & SMTP +
    +
    + Admin Dashboard & Settings +
    +
    + Instance Management +
    +
    + RESTful API & Integration +
    +
    + Data Migration & Backup +
    +
    +
    +
    + + +
    +
    +
    Deployment Ready
    +
    +
    + + Docker Compose - Multi-container deployment +
    +
    + + PostgreSQL - Production-ready database +
    +
    + + Gunicorn - WSGI server with health checks +
    +
    + + Prometheus - Monitoring & metrics +
    +
    + + Alembic - Database migration management +
    +
    + + CLI Tools - Admin commands & utilities +
    +
    +
    +
    +
    +
    \ No newline at end of file diff --git a/templates/wiki/tabs/rooms.html b/templates/wiki/tabs/rooms.html new file mode 100644 index 0000000..e69de29