wjones/pgsql-jellyfin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Move scripts to scripts directory and remove odcs no longer needed.

Browse Source
This commit is contained in:
Wendell Jones
2026-03-03 17:10:46 -05:00
parent c76853a442
commit 895372fe98
20 changed files with 0 additions and 1079 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/PR-DESCRIPTION-SESSION-FIXES.md
-300
View File
@@ -1,300 +0,0 @@
# PostgreSQL Error Fixes and Enhancements - Production Ready
## Overview
This PR resolves **8 critical issues** and adds **3 major enhancements** to the Jellyfin PostgreSQL implementation, making it production-ready for high-concurrency environments.
## Issues Fixed
### 1. SQLite Migration Filtering ✅
- **Problem:** PostgreSQL installations tried to backup non-existent SQLite files
- **Solution:** Added filtering to skip SQLite-specific migrations
- **Impact:** Clean startup without false errors
### 2. Database Query Timeout ✅
- **Problem:** Queries timing out after 30 seconds
- **Solution:** Configurable command timeout (default 120s) + performance indexes
- **Impact:** Queries complete in 2-10 seconds (3-15x faster)
### 3. SyncPlay Authentication Errors ✅
- **Problem:** Empty GUID causing ArgumentException with stack traces
- **Solution:** Validate user ID before calling `GetUserById()`
- **Impact:** Clean warning messages instead of scary errors
### 4. Authentication Token Errors ✅
- **Problem:** Missing tokens logged as errors with stack traces
- **Solution:** Detect authentication errors and log as warnings
- **Impact:** 80% reduction in log noise
### 5. Database Deadlock Handling ✅
- **Problem:** Deadlocks logged as errors, unclear if automatic retry worked
- **Solution:** Specific deadlock detection with informative warning message
- **Impact:** Clear indication that EF Core retry logic is handling it
### 6. Constraint Violation - BaseItemProviders ✅ (Critical Fix)
- **Problem:** Duplicate key constraint violations during concurrent metadata refreshes
- **Solution:**
- Iteration 1: Improved error messages
- Iteration 2: EF Core UPSERT (partial fix)
- Iteration 3: Raw SQL with `ON CONFLICT` (race condition remained)
- **Iteration 4 (FINAL):** Raw SQL + Navigation property clearing
- **Root Cause:** EF Core was tracking navigation properties and re-inserting after raw SQL
- **Impact:** 100% success rate for concurrent metadata operations
### 7. StyleCop Warnings ✅
- **Problem:** SA1137 indentation warnings on pre-existing code
- **Solution:** Added suppression to `.editorconfig`
- **Impact:** Clean build output
### 8. Remote PostgreSQL Backup Support ✅
- **Problem:** Backups artificially disabled for remote PostgreSQL servers
- **Solution:** Removed localhost-only restriction
- **Impact:** Backups now work with remote databases
## Enhancements
### 1. Configurable Backup Disable Option
Added `disable-backups` configuration option for users who don't need built-in backups:
```xml
<CustomDatabaseOption>
<Key>disable-backups</Key>
<Value>True</Value>
</CustomDatabaseOption>
```
### 2. LibraryMonitorDelay Now Configurable
Made file system monitoring delay configurable with validation:
```xml
<LibraryMonitorDelay>60</LibraryMonitorDelay>
```
- **Default:** 60 seconds
- **Minimum:** 30 seconds (enforced)
- **Purpose:** Adjust for different storage types (local SSD vs. network NAS)
### 3. Comprehensive Documentation
Created 14 new documentation files covering:
- Complete configuration reference
- Remote backup setup
- Performance optimization
- Error troubleshooting
- File monitoring configuration
## Files Changed
### Core Code (8 files)
1. `Jellyfin.Server/Migrations/JellyfinMigrationService.cs` - SQLite migration filtering
2. `Jellyfin.Api/Auth/SyncPlayAccessPolicy/SyncPlayAccessHandler.cs` - SyncPlay validation
3. `Jellyfin.Api/Middleware/ExceptionMiddleware.cs` - Authentication error handling
4. `Jellyfin.Server.Implementations/Item/BaseItemRepository.cs` - **Critical UPSERT fix**
5. `src/Jellyfin.Database/Jellyfin.Database.Implementations/JellyfinDbContext.cs` - Generic constraint messages
6. `src/Jellyfin.Database/Jellyfin.Database.Providers.Postgres/PostgresDatabaseProvider.cs` - Remote backup + disable option
7. `MediaBrowser.Model/Configuration/ServerConfiguration.cs` - **NEW: LibraryMonitorDelay validation**
8. `.editorconfig` - StyleCop suppressions
### Documentation (21 files)
- 14 new documentation files
- 7 existing files updated
- Complete configuration reference
- Performance optimization guides
- Troubleshooting documentation
See [COMPLETE-SESSION-SUMMARY.md](docs/COMPLETE-SESSION-SUMMARY.md) for full details.
## Breaking Changes
**None** - All changes are backward compatible.
## Migration Guide
### Required Configuration Changes
1. **Add command timeout** to `database.xml`:
```xml
<CustomDatabaseOption>
<Key>command-timeout</Key>
<Value>120</Value>
</CustomDatabaseOption>
```
2. **Run performance indexes** (highly recommended):
```bash
psql -U postgres -d jellyfin_db -f sql/add-performance-indexes.sql
```
3. **PostgreSQL client tools** (if using backups):
```bash
# Linux
sudo apt-get install postgresql-client
# Verify
pg_dump --version
```
### Optional Configuration
**Disable backups** (if using external backup solutions):
```xml
<CustomDatabaseOption>
<Key>disable-backups</Key>
<Value>True</Value>
</CustomDatabaseOption>
```
**Adjust file monitoring delay** (if needed):
```xml
<LibraryMonitorDelay>60</LibraryMonitorDelay> <!-- 30-∞ seconds -->
```
## Testing
### Build Status
✅ All projects compile successfully
✅ No breaking changes
✅ All error scenarios tested
### Verification Checklist
- [x] Library scans complete without errors
- [x] No SQLite migration errors on startup
- [x] Query timeouts resolved
- [x] Authentication errors log as warnings
- [x] Deadlocks handled gracefully
- [x] Metadata refresh works without constraint violations
- [x] Remote backups functional
- [x] LibraryMonitorDelay validation working
## Performance Impact
| Operation | Before | After | Improvement |
|-----------|--------|-------|-------------|
| Query Timeout | 30s (fails) | 2-10s | 3-15x faster |
| Library Scan | Frequent failures | 100% success | Fixed |
| Deadlock Recovery | Manual | Automatic | 95-99% success |
| Metadata Refresh | Constraint errors | No errors | 100% success |
| Log Noise | Many false alarms | Clear warnings | ~80% reduction |
## Key Technical Details
### Constraint Violation Fix (Most Complex)
The fix went through 4 iterations:
1. **Improved error messages** - Better logging
2. **EF Core UPSERT** - Still had tracking conflicts
3. **Raw SQL with ON CONFLICT** - Still had race conditions
4. **Raw SQL + Navigation property clearing** ✅ - **FINAL WORKING SOLUTION**
**Critical insight:** After using `ExecuteSqlAsync`, must clear `entity.Provider = null` to prevent EF Core from re-tracking and re-inserting the providers.
```csharp
// UPSERT with raw SQL
await context.Database.ExecuteSqlAsync(
$@"INSERT INTO library.""BaseItemProviders"" (""ItemId"", ""ProviderId"", ""ProviderValue"")
VALUES ({entity.Id}, {provider.ProviderId}, {provider.ProviderValue})
ON CONFLICT (""ItemId"", ""ProviderId"")
DO UPDATE SET ""ProviderValue"" = EXCLUDED.""ProviderValue""",
cancellationToken);
// CRITICAL: Clear navigation property
entity.Provider = null;
```
### Remote Backup Support
Removed artificial restriction that disabled backups for remote databases:
```csharp
// Before: Only localhost
if (IsLocalHost(currentHost) && configurationManager is not null)
// After: Local AND remote
if (configurationManager is not null)
```
**Requirements:**
- PostgreSQL client binaries (`pg_dump`, `pg_restore`)
- Must be in PATH or specified in BackupOptions
- Network connectivity to remote server
## Documentation
Comprehensive documentation created:
- **[COMPLETE-SESSION-SUMMARY.md](docs/COMPLETE-SESSION-SUMMARY.md)** - Complete list of all fixes
- **[database-configuration-examples.md](docs/database-configuration-examples.md)** - All configuration options
- **[remote-postgresql-backup-support.md](docs/remote-postgresql-backup-support.md)** - Remote backup guide
- **[library-monitor-delay-configuration.md](docs/library-monitor-delay-configuration.md)** - File monitoring configuration
- **[ef-core-tracking-conflict-fix.md](docs/ef-core-tracking-conflict-fix.md)** - EF Core tracking issues explained
Plus SQL performance scripts:
- `sql/add-performance-indexes.sql`
- `sql/monitor-query-performance.sql`
## Recommendations
### Immediate Actions (Required)
1. Add `command-timeout` configuration
2. Run performance indexes SQL script
3. Install PostgreSQL client tools (if using backups)
4. Restart Jellyfin
### Short Term (Next Week)
1. Monitor deadlock frequency
2. Verify no regressions in library scanning
3. Test backup/restore functionality
### Long Term (Next Release)
1. Upgrade to stable .NET when available
2. Consider implementing advisory locks for cleanup operations
3. Revisit query optimization with stable EF Core
## Compatibility
- **Tested on:** .NET 11 Preview, PostgreSQL 17
- **Backward Compatible:** Yes
- **Database Migration Required:** No
- **Configuration Changes Required:** Recommended (see Migration Guide)
## Related Issues
This PR resolves issues related to:
- Concurrent metadata refresh operations
- Remote database backup functionality
- Query timeout errors on large libraries
- Authentication error logging clarity
- Database deadlock handling
## Credits
**Session Date:** 2026-03-03
**Testing Environment:** .NET 11 Preview, PostgreSQL 17
**Total Development Time:** Multiple iterations to achieve production quality
---
## For Reviewers
### Critical Files to Review
1. `Jellyfin.Server.Implementations/Item/BaseItemRepository.cs` - **Navigation property clearing is critical**
2. `src/Jellyfin.Database/Jellyfin.Database.Providers.Postgres/PostgresDatabaseProvider.cs` - Backup logic changes
3. `MediaBrowser.Model/Configuration/ServerConfiguration.cs` - New validation logic
### Test Scenarios
- [ ] Concurrent metadata refreshes on same item
- [ ] Remote PostgreSQL backup/restore
- [ ] LibraryMonitorDelay validation (try setting to 10, should enforce 30)
- [ ] Query performance with indexes
### Documentation Quality
All changes are thoroughly documented with:
- ✅ Problem description
- ✅ Solution explanation
- ✅ Configuration examples
- ✅ Troubleshooting guides
- ✅ Code comments in critical sections
---
**This PR makes Jellyfin PostgreSQL production-ready! 🎉**
docs/PR-DESCRIPTION-SHORT.md
-115
View File
@@ -1,115 +0,0 @@
# PostgreSQL Error Fixes - Production Ready
## Summary
Resolves 8 critical issues and adds 3 enhancements to make Jellyfin PostgreSQL production-ready for high-concurrency environments.
## Key Fixes
1. ✅ **Constraint Violation (Critical)** - Fixed duplicate key errors during concurrent metadata refreshes using atomic SQL UPSERT with navigation property clearing
2. ✅ **Remote Backup Support** - Enabled backups/restores for remote PostgreSQL servers (not just localhost)
3. ✅ **Query Timeouts** - Added configurable command timeout (default 120s) + performance indexes
4. ✅ **Authentication Errors** - Changed auth failures from errors to warnings (80% log noise reduction)
5. ✅ **Database Deadlocks** - Clear warning messages with automatic retry indication
6. ✅ **SyncPlay Auth** - Validate empty GUIDs before processing
7. ✅ **SQLite Migration** - Skip SQLite-specific migrations on PostgreSQL
8. ✅ **StyleCop** - Suppressed SA1137 warnings on pre-existing code
## Enhancements
1. **Configurable Backup Disable** - Option to disable built-in backups (`disable-backups=true`)
2. **LibraryMonitorDelay Configurable** - File monitoring delay now configurable (minimum 30s, default 60s)
3. **Comprehensive Documentation** - 21 documentation files with complete guides
## Critical Fix Details
**Most Complex Fix: BaseItemProviders Constraint Violation**
Took 4 iterations to solve:
- Iteration 1: Better error messages
- Iteration 2: EF Core UPSERT (tracking conflicts)
- Iteration 3: Raw SQL with ON CONFLICT (race conditions)
- **Iteration 4:** Raw SQL + **Navigation property clearing** ✅
**The key insight:** After using raw SQL, must clear `entity.Provider = null` to prevent EF Core from re-tracking and re-inserting.
## Configuration Required
### Recommended (Add to database.xml)
```xml
<CustomDatabaseOption>
<Key>command-timeout</Key>
<Value>120</Value>
</CustomDatabaseOption>
```
### Optional: Disable Backups
```xml
<CustomDatabaseOption>
<Key>disable-backups</Key>
<Value>True</Value>
</CustomDatabaseOption>
```
### Optional: Adjust File Monitoring
```xml
<LibraryMonitorDelay>60</LibraryMonitorDelay>
```
### Performance Indexes (Run Once)
```bash
psql -U postgres -d jellyfin_db -f sql/add-performance-indexes.sql
```
## Files Modified
**Code:** 8 files
- Jellyfin.Server/Migrations/JellyfinMigrationService.cs
- Jellyfin.Api/Auth/SyncPlayAccessPolicy/SyncPlayAccessHandler.cs
- Jellyfin.Api/Middleware/ExceptionMiddleware.cs
- Jellyfin.Server.Implementations/Item/BaseItemRepository.cs (Critical)
- src/Jellyfin.Database/Jellyfin.Database.Implementations/JellyfinDbContext.cs
- src/Jellyfin.Database/Jellyfin.Database.Providers.Postgres/PostgresDatabaseProvider.cs
- MediaBrowser.Model/Configuration/ServerConfiguration.cs (NEW validation)
- .editorconfig
**Documentation:** 21 files (see docs/)
## Performance Impact
| Metric | Before | After |
|--------|--------|-------|
| Query Timeout | 30s (fails) | 2-10s ✅ |
| Metadata Refresh Success | ~60% | 100% ✅ |
| Deadlock Auto-Recovery | Unclear | 95-99% ✅ |
| Log Noise | High | -80% ✅ |
## Testing
✅ Build successful
✅ No breaking changes
✅ All error scenarios tested
✅ Concurrent operations verified
## Breaking Changes
**None** - All changes are backward compatible.
## Documentation
Complete documentation in `docs/`:
- COMPLETE-SESSION-SUMMARY.md - Full details
- database-configuration-examples.md - Config reference
- remote-postgresql-backup-support.md - Backup guide
- library-monitor-delay-configuration.md - File monitoring
- Plus 17+ other guides
## Tested On
- .NET 11 Preview
- PostgreSQL 17
- Windows (local) + Remote PostgreSQL server
---
**This PR makes Jellyfin PostgreSQL production-ready for enterprise use! 🎉**
docs/PR-QUICK-COPY.md
-84
View File
@@ -1,84 +0,0 @@
# PR Title
```
PostgreSQL: Fix 8 critical issues + remote backup support + configurable monitoring
```
# PR Description (Short Version)
## What This PR Does
Fixes **8 critical production issues** in the PostgreSQL implementation:
1. ✅ **Constraint violations** during concurrent metadata refreshes (atomic SQL UPSERT + navigation clearing)
2. ✅ **Remote backup support** (removed localhost restriction)
3. ✅ **Query timeouts** (configurable timeout + performance indexes)
4. ✅ **Auth error logging** (warnings instead of errors, -80% log noise)
5. ✅ **Deadlock handling** (clear messages with auto-retry indication)
6. ✅ **SyncPlay auth** (validate empty GUIDs)
7. ✅ **SQLite migration** (skip on PostgreSQL)
8. ✅ **StyleCop** (suppress pre-existing warnings)
**Plus 3 enhancements:**
- Configurable backup disable option
- LibraryMonitorDelay now configurable (30s minimum)
- Comprehensive documentation (21 files)
## Key Technical Achievement
**Fixed the most challenging issue:** BaseItemProviders constraint violations
Took 4 iterations to solve correctly:
- Used raw SQL with `ON CONFLICT` for atomic UPSERT
- **Critical insight:** Must clear `entity.Provider = null` after raw SQL to prevent EF Core from re-tracking
## Impact
- **Performance:** 3-15x faster queries
- **Reliability:** 100% metadata refresh success (was ~60%)
- **Logs:** 80% reduction in noise
- **Features:** Remote backups now work
## Configuration Needed
```xml
<CustomDatabaseOption>
<Key>command-timeout</Key>
<Value>120</Value>
</CustomDatabaseOption>
```
Then run: `psql -U postgres -d jellyfin_db -f sql/add-performance-indexes.sql`
## Files
- **Code:** 8 files
- **Docs:** 21 files
- **Breaking:** None
See [COMPLETE-SESSION-SUMMARY.md](docs/COMPLETE-SESSION-SUMMARY.md) for full details.
---
**Makes PostgreSQL production-ready! 🚀**
## Git Commit Message
```
fix: PostgreSQL production fixes - constraint violations, remote backups, performance
- Fix: Atomic UPSERT for BaseItemProviders (ON CONFLICT + nav clearing)
- Fix: Remote PostgreSQL backup support (remove localhost restriction)
- Fix: Configurable query timeout (default 120s) + performance indexes
- Fix: Auth errors now warnings (SyncPlay, token validation)
- Fix: Deadlock clear warning messages
- Fix: Skip SQLite migrations on PostgreSQL
- Add: Configurable backup disable option
- Add: LibraryMonitorDelay validation (30s minimum)
- Docs: 21 comprehensive documentation files
Performance: 3-15x faster queries, 100% metadata refresh success
Breaking: None (backward compatible)
Tested: .NET 11 Preview, PostgreSQL 17
```
docs/PR_DESCRIPTION.md
-316
View File
@@ -1,316 +0,0 @@
# Pull Request: PostgreSQL Integration, Windows Installer, and Documentation Overhaul
## 🎯 Overview
This PR completes the PostgreSQL integration for Jellyfin with comprehensive Windows installer support, centralized build output, OS-specific configuration, and a complete documentation overhaul.
## 🚀 What's New
### 1. **Complete Documentation Overhaul** 📚
- Rewrote **README.md** to highlight PostgreSQL features, Windows installer, and migration guides
- Moved all markdown files to `docs/` folder for better organization (30+ files organized)
- Created comprehensive documentation index with quick start and detailed guides
- Added `README_GENERATION.md` and `DOCUMENTATION_ORGANIZATION.md` for maintenance
- Preserved original README as `README.original.md`
- Clear platform-specific instructions (Windows/Linux/macOS)
### 2. **Professional Windows Installer** 💿
- **Inno Setup script** (`jellyfin-setup.iss`) with full wizard support
- **PowerShell build automation** (`build-installer.ps1`) for easy installer creation
- **Features:**
- Windows Service installation
- Firewall rules configuration
- PostgreSQL connection wizard
- .NET runtime verification
- Clean uninstaller
- **Comprehensive documentation:**
- `INSTALLER_QUICK_START.md` - 5-minute guide
- `INSTALLER_GUIDE.md` - Complete reference with WiX, MSIX options
- `BUILD_INSTALLER_FIXED.md` - Build script usage
### 3. **Centralized Build Output** 🔨
- All DLLs now output to `lib\[Configuration]\[TargetFramework]\` at repository root
- Configured via `Directory.Build.props`
- **Benefits:**
- Single location for all build artifacts
- Easier deployment and packaging
- No duplicate dependencies
- Faster builds
- Documentation: `CENTRALIZED_LIB_FOLDER.md`
### 4. **OS-Specific Startup Configuration** ⚙️
- Auto-generates `startup.json` with OS-appropriate defaults on first run
- **Platform defaults:**
- **Windows:** `C:/ProgramData/jellyfin`
- **Linux:** `/var/lib/jellyfin`, `/etc/jellyfin`
- **macOS:** `~/Library/Application Support/jellyfin`
- Removes null/example config - immediately usable
- Configuration priority: CLI args → Environment vars → startup.json → Built-in defaults
- **Documentation:**
- `OS_SPECIFIC_STARTUP_CONFIG.md`
- `STARTUP_JSON_VERIFICATION.md`
- `STARTUP_JSON_FIX.md`
### 5. **PostgreSQL Migration Improvements** 🗄️
- Assign all tables to correct PostgreSQL schemas in EF Core migrations
- Fix identifier quoting (SQL Server brackets → PostgreSQL double quotes)
- Use InsertData for placeholder BaseItems row (no raw SQL)
- **Auto-recovery:** Handles 42P07 errors (table exists)
- Added `RecordMigrationAsAppliedAsync` for manual migration history
- Improved migration logging and error handling
- **Documentation:**
- `POSTGRESQL_MIGRATION_COMPLETE.md`
- `MIGRATION_RECOVERY_FIX.md`
- `SQLITE_MIGRATION_FILTERING_FIX.md`
- Idempotent, production-ready SQL migration scripts
- PowerShell script for automated migration verification
### 6. **Platform Configuration Templates** 📋
- Added Linux/Windows startup config templates in `Resources/Configuration/`
- FHS-compliant default paths
- Platform-specific README with usage instructions
- Improved portability and cross-platform consistency
### 7. **Build and Deployment Improvements** 🚢
- Enhanced publish profiles with platform targeting
- Clean deploy: deletes existing files before publish
- Updated `.gitignore`:
- Excludes `lib/` (build output)
- Excludes `installer-output/`
- Excludes all `PublishProfiles/` folders (machine-specific)
- Cleaned up tracked publish profile XMLs
- Switched to relative paths for improved portability
---
## 📊 Changes Summary
### Files Added/Created
- `build-installer.ps1` - PowerShell installer build script
- `jellyfin-setup.iss` - Inno Setup installer script
- `jellyfin.ico` - Application icon
- `docs/INSTALLER_QUICK_START.md` - 5-minute installer guide
- `docs/INSTALLER_GUIDE.md` - Complete installer documentation
- `docs/BUILD_INSTALLER_FIXED.md` - Build script usage
- `docs/CENTRALIZED_LIB_FOLDER.md` - Build output documentation
- `docs/OS_SPECIFIC_STARTUP_CONFIG.md` - OS configuration guide
- `docs/STARTUP_JSON_VERIFICATION.md` - Configuration loading details
- `docs/STARTUP_JSON_FIX.md` - Fixing null value issues
- `docs/GITIGNORE_PUBLISHPROFILES.md` - GitIgnore documentation
- `docs/DOCUMENTATION_ORGANIZATION.md` - Doc organization summary
- `docs/README_GENERATION.md` - README generation process
- `Jellyfin.Server/Resources/Configuration/startup.*.json` - Platform templates
### Files Modified
- `README.md` - Complete rewrite with PostgreSQL focus
- `Directory.Build.props` - Centralized build output configuration
- `.gitignore` - Updated exclusions for lib, installer-output, PublishProfiles
- `Jellyfin.Server/Helpers/StartupHelpers.cs` - OS-specific config generation
- EF Core migrations - PostgreSQL schema and quoting fixes
- Publish profiles - Platform targeting and clean deploy
### Files Moved
- 30+ documentation files → `docs/` folder
- All README links updated to point to `docs/`
### Files Removed
- Old `Jellyfin.Server/startup.json` (now generated at runtime)
- Obsolete Windows publish profiles
- Tracked PublishProfiles XML files
---
## 🎯 Migration Guide
### From SQLite to PostgreSQL
```bash
# 1. Backup SQLite database
cp jellyfin.db jellyfin-backup.db
# 2. Install PostgreSQL 12+
winget install PostgreSQL.PostgreSQL
# 3. Create database
psql -U postgres
CREATE USER jellyfin WITH PASSWORD 'your_password';
CREATE DATABASE jellyfin OWNER jellyfin;
\q
# 4. Update startup.json
{
"DatabaseProvider": "Postgres",
"ConnectionStrings": {
"DefaultConnection": "Host=localhost;Database=jellyfin;Username=jellyfin;Password=your_password"
}
}
# 5. Run migration
dotnet run --project Jellyfin.Server -- --migrate-database
```
See `docs/POSTGRESQL_MIGRATION_COMPLETE.md` for details.
---
## 🔨 Building and Installation
### Quick Build
```bash
git clone https://gitea.wpjones.com/wjones/pgsql-jellyfin.git
cd pgsql-jellyfin
dotnet build --configuration Release
cd lib/Release/net11.0
dotnet jellyfin.dll
```
### Create Windows Installer
```powershell
# Install Inno Setup
winget install JRSoftware.InnoSetup
# Build installer
.\build-installer.ps1
# Result: installer-output\JellyfinSetup-PostgreSQL-11.0.0.exe
```
---
## 🧪 Testing
### Tested Scenarios
- ✅ Fresh install on Windows
- ✅ Migration from SQLite to PostgreSQL
- ✅ OS-specific configuration generation
- ✅ Windows Service installation
- ✅ Firewall rules creation
- ✅ Build output to lib folder
- ✅ Documentation links and navigation
### Tested Platforms
- ✅ Windows 10/11
- ✅ Linux (Ubuntu 22.04)
- ✅ PostgreSQL 12, 14, 15, 16, 17, 18
---
## 📝 Documentation
All documentation is now in the `docs/` folder with a complete index in README.md:
### Configuration
- OS_SPECIFIC_STARTUP_CONFIG.md
- STARTUP_JSON_VERIFICATION.md
- STARTUP_JSON_FIX.md
### PostgreSQL
- QUICKSTART_POSTGRESQL.md
- POSTGRESQL_MIGRATION_COMPLETE.md
- POSTGRESQL_TROUBLESHOOTING.md
### Installation
- INSTALLER_QUICK_START.md
- INSTALLER_GUIDE.md
- CENTRALIZED_LIB_FOLDER.md
- BUILD_INSTALLER_FIXED.md
### Backup & Recovery
- POSTGRES_BACKUP_IMPLEMENTATION.md
- POSTGRESQL_BACKUP_ANALYSIS.md
### Project Status
- PROJECT_COMPLETION.md
- POC_SUMMARY_REPORT.md
[View All Documentation →](./docs/)
---
## ⚠️ Breaking Changes
**None!** All changes are backward compatible:
- Existing `startup.json` files are preserved
- SQLite users can continue using SQLite
- Migration to PostgreSQL is optional
- Default behavior unchanged for existing installations
---
## 🎉 Benefits
### For Users
- ✅ Professional Windows installer with wizard
- ✅ Automatic OS-specific configuration
- ✅ Better performance with large media libraries
- ✅ Enterprise-grade database backend
- ✅ Easy migration from SQLite
### For Developers
- ✅ Centralized build output (lib folder)
- ✅ Comprehensive documentation
- ✅ Easy installer creation (5 minutes)
- ✅ Clean repository structure
- ✅ Better cross-platform support
### For System Admins
- ✅ FHS-compliant paths on Linux
- ✅ Windows Service support
- ✅ Professional backup solutions
- ✅ Database replication and clustering support
---
## 🔄 Commits Included
1. **Docs: overhaul README, centralize docs, update .gitignore** - Documentation reorganization
2. **Add Windows installer scripts, docs, and startup.json fixes** - Installer infrastructure
3. **Centralize build output and generate OS-specific startup.json** - Build improvements
4. **Platform config templates & Postgres migration recovery** - Configuration and migration
5. **PostgreSQL migration: schema fixes, docs, and tooling** - Database migrations
6. **Update publish profiles and .gitignore for Windows build** - Build configuration
7. **Update publish profile and web dir config for portability** - Path improvements
---
## 📞 Support
- 📚 [Documentation](./docs/)
- 🐛 [Report Bug](https://gitea.wpjones.com/wjones/pgsql-jellyfin/issues)
- 💡 [Request Feature](https://gitea.wpjones.com/wjones/pgsql-jellyfin/issues)
---
## ✅ Checklist
- [x] Code compiles without errors
- [x] All tests pass
- [x] Documentation updated and comprehensive
- [x] README.md reflects all changes
- [x] .gitignore updated appropriately
- [x] Migration scripts tested
- [x] Windows installer tested
- [x] Cross-platform compatibility verified
- [x] No breaking changes introduced
---
## 🎯 Ready to Merge
This PR represents a major milestone for the PostgreSQL-enabled Jellyfin fork:
- Complete documentation overhaul with 30+ organized files
- Professional Windows installer with service support
- Centralized build output for easier deployment
- OS-specific configuration that "just works"
- Robust PostgreSQL migration with auto-recovery
- Production-ready, tested, and documented
**Recommended for merge into main branch.**
---
**Pull Request Type:** Feature + Documentation + Build Improvement
**Target Branch:** main
**Source Branch:** pgsql_testing_branch
**Reviewer:** @maintainers
**Priority:** High
docs/PR_DESCRIPTION_SHORT.md
-94
View File
@@ -1,94 +0,0 @@
# PostgreSQL Integration + Windows Installer + Documentation Overhaul
## Summary
Complete PostgreSQL integration for Jellyfin with professional Windows installer, centralized build output, OS-specific configuration, and comprehensive documentation reorganization.
## Key Features
✅ **Windows Installer** - Inno Setup script with service installation, firewall rules, and PostgreSQL wizard
✅ **Centralized Build** - All DLLs output to `lib/[Configuration]/` folder
✅ **OS-Specific Config** - Auto-generates `startup.json` with platform-appropriate defaults
✅ **PostgreSQL Migration** - Robust migration with auto-recovery and comprehensive docs
✅ **Documentation** - 30+ files organized in `docs/` folder with complete index
## What's Included
### Documentation (30+ files)
- Rewrote README.md with PostgreSQL focus and quick start
- Moved all .md files to docs/ folder
- Added installer guides, migration guides, troubleshooting
- Complete navigation and organization
### Windows Installer
- `build-installer.ps1` - PowerShell automation
- `jellyfin-setup.iss` - Inno Setup script
- Service installation, firewall setup, PostgreSQL wizard
- 5-minute quick start guide
### Build System
- Centralized output: `lib/[Configuration]/[TargetFramework]/`
- Updated Directory.Build.props
- Clean deployment with publish profiles
- Updated .gitignore (lib, installer-output, PublishProfiles)
### Configuration
- OS-specific startup.json generation (Windows/Linux/macOS)
- Platform templates in Resources/Configuration/
- Priority: CLI → Env → startup.json → Defaults
- FHS-compliant paths on Linux
### PostgreSQL
- Schema fixes for PostgreSQL in EF migrations
- Identifier quoting (brackets → double quotes)
- Auto-recovery from migration errors
- Comprehensive migration documentation
- Production-ready SQL scripts
## Testing
✅ Fresh Windows install
✅ SQLite → PostgreSQL migration
✅ Windows Service installation
✅ Cross-platform configuration
✅ Build output verification
## Breaking Changes
**None!** All changes are backward compatible.
## Commits (7)
1. Docs: overhaul README, centralize docs, update .gitignore
2. Add Windows installer scripts, docs, and startup.json fixes
3. Centralize build output and generate OS-specific startup.json
4. Platform config templates & Postgres migration recovery
5. PostgreSQL migration: schema fixes, docs, and tooling
6. Update publish profiles and .gitignore for Windows build
7. Update publish profile and web dir config for portability
## Quick Start
```bash
# Build
dotnet build --configuration Release
cd lib/Release/net11.0
dotnet jellyfin.dll
# Create installer (Windows)
winget install JRSoftware.InnoSetup
.\build-installer.ps1
```
## Documentation
- [Quick Start](./docs/QUICKSTART_POSTGRESQL.md)
- [Installer Guide](./docs/INSTALLER_QUICK_START.md)
- [Migration Guide](./docs/POSTGRESQL_MIGRATION_COMPLETE.md)
- [All Docs](./docs/)
---
**Ready for Review** ✅
Target: main | Source: pgsql_testing_branch
Type: Feature + Documentation + Build