MajoorWaldi
9f9480e2f9
- Implement new API endpoints for getting and setting index directory - Add corresponding frontend functionality in settings advanced section - Introduce new toast messages for index directory-related actions - Update i18n dictionary with new index directory-related translations
4.3 KiB
4.3 KiB
Majoor Assets Manager - Documentation Index
Welcome to the documentation hub for Majoor Assets Manager for ComfyUI.
Current Version: 2.4.5 Last Updated: April 7, 2026
Quick Start
New users
- Installation Guide - Install and set up the extension
- User Guide (HTML) - Visual walkthrough with screenshots
- Hotkeys & Shortcuts - Essential keyboard shortcuts
- Basic Search - Find assets quickly
Returning users
- AI Features Guide - AI-assisted search and enrichment features
- Viewer Feature Tutorial - Floating viewer and analysis tools
- Changelog - Recent releases and fixes
- Architecture Map - Backend boundaries and refactor guide
Privacy And Offline Use
- PRIVACY_OFFLINE.md - Dedicated privacy, offline, and token explanation page
- AI_FEATURES.md - Local AI processing, model downloads, offline behavior, and token clarification
- SECURITY_ENV_VARS.md - Remote access security, API token behavior, and safe defaults
- SETTINGS_CONFIGURATION.md - UI security settings and token storage behavior
Documentation Categories
Getting Started
| Document | Description |
|---|---|
| INSTALLATION.md | Detailed installation and network-drive guidance |
| user_guide.html | Full visual user guide |
| HOTKEYS_SHORTCUTS.md | Keyboard shortcuts |
| SHORTCUTS.md | Extra gestures and shortcuts |
Core Features
| Document | Description |
|---|---|
| SEARCH_FILTERING.md | Full-text search, filters, and sorting |
| VIEWER_FEATURE_TUTORIAL.md | Viewer, MFV, and analysis tools |
| RATINGS_TAGS_COLLECTIONS.md | Ratings, tags, and collections |
| DRAG_DROP.md | Drag and drop behavior |
| AI_FEATURES.md | Semantic search, auto-tags, and enrichment |
Configuration And Security
| Document | Description |
|---|---|
| PRIVACY_OFFLINE.md | Dedicated privacy, offline behavior, and token clarification guide |
| SETTINGS_CONFIGURATION.md | UI and runtime settings, index DB path, env vars |
| SECURITY_ENV_VARS.md | Environment variables and security model |
| THREAT_MODEL.md | Threats, mitigations, and residual risk |
| ARCHITECTURE_MAP.md | Package responsibilities and internal boundaries |
Maintenance And Development
| Document | Description |
|---|---|
| DB_MAINTENANCE.md | Database maintenance, recovery, and configurable index directory |
| TESTING.md | Tests, reports, and quality gate |
| API_REFERENCE.md | Backend endpoint reference |
| adr/ | Architecture Decision Records |
Quality And Verification
Use the canonical gate from the repo root:
python scripts/run_quality_gate.py
Useful variants:
python scripts/run_quality_gate.py --python-only --skip-tests
tox -e quality
npm run test:js
The quality gate enforces:
- UTF-8 text files without BOM
rufflinting on changed Python files during the migration windowmypybanditpip-audit- xenon/radon complexity checks
- backend tests
- frontend tests
npm audit
Security Note
The backend keeps a compatibility-first local security model:
- loopback writes remain allowed by default
- remote writes are denied unless explicitly authorized
MAJOOR_REQUIRE_AUTH=1switches to strict token-auth for local writes too
Current releases also support a Settings-first remote setup flow:
Recommended Remote LAN Setupis the preferred one-click LAN path- the current browser session exposes its state through the runtime
Write auth:indicator inside Assets Manager
That nuance is intentional and is the documented target behavior for current releases.