wjones
78c8d4256c
- Moved all documentation to docs/ and updated README with categorized links and new docs/INDEX.md - Added HOW_TO_SWITCH_DATABASE.md and several new analysis/action docs - Introduced db-config.ps1 for centralized DB config; all scripts now use it for easy DB switching - Added db-quick.ps1 for interactive diagnostics and index management - Updated Add-All-Indexes.bat to use db-config.ps1 - Added Fix-ItemValues-Performance.ps1 to create 3 critical indexes on ItemValues, addressing 1.3B row seq scan issue - Updated performance_indexes.sql with new ItemValues indexes and ANALYZE - Updated diagnostics.sql and database_report.txt for improved output and clarity - All scripts and docs now reference the new config and index optimization workflow
152 lines
5.1 KiB
Markdown
152 lines
5.1 KiB
Markdown
# 📚 Documentation Index
|
|
|
|
Complete documentation for the PostgreSQL-enabled Jellyfin fork.
|
|
|
|
---
|
|
|
|
## 🚀 Getting Started
|
|
|
|
**Start here if you're new:**
|
|
|
|
- **[START_HERE.md](START_HERE.md)** ⭐ - Quick start guide
|
|
- **[QUICK_REFERENCE.md](QUICK_REFERENCE.md)** - Command reference
|
|
|
|
---
|
|
|
|
## ⚙️ Configuration
|
|
|
|
### Basic Configuration
|
|
- [OS_SPECIFIC_STARTUP_CONFIG.md](OS_SPECIFIC_STARTUP_CONFIG.md) - OS-specific settings
|
|
- [STARTUP_JSON_VERIFICATION.md](STARTUP_JSON_VERIFICATION.md) - Verify startup.json
|
|
- [STARTUP_JSON_FIX.md](STARTUP_JSON_FIX.md) - Fix startup.json issues
|
|
|
|
### Database Configuration
|
|
- [HOW_TO_SWITCH_DATABASE.md](HOW_TO_SWITCH_DATABASE.md) - Switch between databases
|
|
|
|
---
|
|
|
|
## 🗄️ PostgreSQL
|
|
|
|
### Setup & Installation
|
|
- [QUICKSTART_POSTGRESQL.md](QUICKSTART_POSTGRESQL.md) - Quick PostgreSQL setup
|
|
- [POSTGRESQL_MIGRATION_COMPLETE.md](POSTGRESQL_MIGRATION_COMPLETE.md) - SQLite to PostgreSQL migration
|
|
- [MERGE_MIGRATIONS_GUIDE.md](MERGE_MIGRATIONS_GUIDE.md) - Merge EF Core migrations
|
|
|
|
### Troubleshooting
|
|
- [POSTGRESQL_TROUBLESHOOTING.md](POSTGRESQL_TROUBLESHOOTING.md) - Common issues & solutions
|
|
|
|
---
|
|
|
|
## ⚡ Performance Optimization
|
|
|
|
### Index Management
|
|
- **[ADD_INDEXES_GUIDE.md](ADD_INDEXES_GUIDE.md)** ⭐ - Add performance indexes
|
|
- [AUTO_APPLY_INDEXES_COMPLETE.md](AUTO_APPLY_INDEXES_COMPLETE.md) - Automatic index application
|
|
- [ITEMVALUES_INDEXES_ADDED.md](ITEMVALUES_INDEXES_ADDED.md) - ItemValues table optimization (critical!)
|
|
- [MISSING_INDEXES_FIXED.md](MISSING_INDEXES_FIXED.md) - Missing index fixes
|
|
|
|
### Database Analysis
|
|
- **[DIAGNOSTICS_COMPLETE_SUMMARY.md](DIAGNOSTICS_COMPLETE_SUMMARY.md)** ⭐ - Complete diagnostics overview
|
|
- [DATABASE_ANALYSIS_REPORT.md](DATABASE_ANALYSIS_REPORT.md) - Detailed performance analysis
|
|
- [LATEST_DIAGNOSTICS_ANALYSIS.md](LATEST_DIAGNOSTICS_ANALYSIS.md) - Latest diagnostics results
|
|
|
|
### Remote Database Optimization
|
|
- [REMOTE_DATABASE_ANALYSIS.md](REMOTE_DATABASE_ANALYSIS.md) - Remote database analysis
|
|
- [REMOTE_ANALYSIS_SUMMARY.md](REMOTE_ANALYSIS_SUMMARY.md) - Remote DB summary
|
|
- [QUICK_ACTION_PLAN.md](QUICK_ACTION_PLAN.md) - Performance action plan
|
|
- [WEEKLY_TRACKING.md](WEEKLY_TRACKING.md) - Weekly performance tracking template
|
|
|
|
---
|
|
|
|
## 💾 Backup & Recovery
|
|
|
|
- [POSTGRES_BACKUP_IMPLEMENTATION.md](POSTGRES_BACKUP_IMPLEMENTATION.md) - Backup implementation
|
|
- [POSTGRESQL_BACKUP_ANALYSIS.md](POSTGRESQL_BACKUP_ANALYSIS.md) - Backup analysis
|
|
|
|
---
|
|
|
|
## 📦 Installation & Deployment
|
|
|
|
### Windows Installer
|
|
- [INSTALLER_QUICK_START.md](INSTALLER_QUICK_START.md) - Quick installer guide
|
|
- [INSTALLER_GUIDE.md](INSTALLER_GUIDE.md) - Complete installer documentation
|
|
- [BUILD_INSTALLER_FIXED.md](BUILD_INSTALLER_FIXED.md) - Build installer script
|
|
|
|
### Build & Publish
|
|
- [CENTRALIZED_LIB_FOLDER.md](CENTRALIZED_LIB_FOLDER.md) - Centralized output folder
|
|
- [SQL_FILES_PUBLISH_FIX.md](SQL_FILES_PUBLISH_FIX.md) - Include SQL files in publish
|
|
- [SQL_PUBLISH_ISSUE_RESOLVED.md](SQL_PUBLISH_ISSUE_RESOLVED.md) - SQL publish resolution
|
|
- [QUICK_PUBLISH_REFERENCE.md](QUICK_PUBLISH_REFERENCE.md) - Quick publish reference
|
|
|
|
---
|
|
|
|
## 📋 Project Information
|
|
|
|
### Status & Completion
|
|
- [PROJECT_COMPLETION.md](PROJECT_COMPLETION.md) - Project completion status
|
|
- [IMPLEMENTATION_COMPLETE.md](IMPLEMENTATION_COMPLETE.md) - Implementation details
|
|
- [POC_SUMMARY_REPORT.md](POC_SUMMARY_REPORT.md) - Proof of concept summary
|
|
|
|
### Pull Requests
|
|
- [PR_DESCRIPTION.md](PR_DESCRIPTION.md) - Full pull request description
|
|
- [PR_DESCRIPTION_SHORT.md](PR_DESCRIPTION_SHORT.md) - Short PR description
|
|
|
|
---
|
|
|
|
## 🎯 Quick Links by Task
|
|
|
|
### "I want to set up PostgreSQL"
|
|
1. [QUICKSTART_POSTGRESQL.md](QUICKSTART_POSTGRESQL.md)
|
|
2. [OS_SPECIFIC_STARTUP_CONFIG.md](OS_SPECIFIC_STARTUP_CONFIG.md)
|
|
|
|
### "My database is slow"
|
|
1. [DIAGNOSTICS_COMPLETE_SUMMARY.md](DIAGNOSTICS_COMPLETE_SUMMARY.md)
|
|
2. [ADD_INDEXES_GUIDE.md](ADD_INDEXES_GUIDE.md)
|
|
3. [ITEMVALUES_INDEXES_ADDED.md](ITEMVALUES_INDEXES_ADDED.md)
|
|
|
|
### "I want to install Jellyfin"
|
|
1. [INSTALLER_QUICK_START.md](INSTALLER_QUICK_START.md)
|
|
2. [INSTALLER_GUIDE.md](INSTALLER_GUIDE.md)
|
|
|
|
### "I want to migrate from SQLite"
|
|
1. [POSTGRESQL_MIGRATION_COMPLETE.md](POSTGRESQL_MIGRATION_COMPLETE.md)
|
|
2. [MERGE_MIGRATIONS_GUIDE.md](MERGE_MIGRATIONS_GUIDE.md)
|
|
|
|
### "I want to build from source"
|
|
1. [CENTRALIZED_LIB_FOLDER.md](CENTRALIZED_LIB_FOLDER.md)
|
|
2. [QUICK_REFERENCE.md](QUICK_REFERENCE.md)
|
|
|
|
### "I need to publish/deploy"
|
|
1. [QUICK_PUBLISH_REFERENCE.md](QUICK_PUBLISH_REFERENCE.md)
|
|
2. [SQL_FILES_PUBLISH_FIX.md](SQL_FILES_PUBLISH_FIX.md)
|
|
|
|
---
|
|
|
|
## 📊 Documentation Statistics
|
|
|
|
- **Total Documents**: 35+
|
|
- **Categories**: 8
|
|
- **Getting Started Guides**: 3
|
|
- **Configuration Docs**: 5
|
|
- **Performance Guides**: 11
|
|
- **Installation Guides**: 7
|
|
|
|
---
|
|
|
|
## 🔍 Search Tips
|
|
|
|
Use your browser's Find function (Ctrl+F / Cmd+F) or search by keywords:
|
|
|
|
- **Performance**: diagnostics, indexes, optimization, analysis
|
|
- **Setup**: installation, configuration, quickstart
|
|
- **Migration**: SQLite, PostgreSQL, migration
|
|
- **Troubleshooting**: issues, errors, fix
|
|
- **Remote**: remote database, network, connection
|
|
|
|
---
|
|
|
|
**Last Updated**: 2026-02-28
|
|
**Maintainer**: wjones
|
|
|
|
[← Back to README](../README.md)
|