Files
pgsql-jellyfin/docs/INSTALLER_UPDATE_COMPLETE.md
wjones 61c71c1882 Update installer: add docs, scripts, and Start Menu tools
- Expanded [Files] section to include key documentation and PowerShell/batch scripts for database management
- Fixed INSTALLER_GUIDE.md path and improved file organization in installer script
- Added Start Menu shortcuts for documentation and database tools
- Updated .gitignore to track wwwroot/*
- Changed .csproj.user to use a relative publish profile name
- Added INSTALLER_NEEDS_UPDATE.md and INSTALLER_UPDATE_COMPLETE.md for documentation and change tracking
- Improves user onboarding, support, and maintainability
2026-02-28 16:45:58 -05:00

6.3 KiB

Jellyfin Installer Updated!

Changes Made to jellyfin-setup.iss

Summary:

The installer has been updated to include the latest documentation and database management tools.


📝 What Was Updated

1. Fixed Documentation Paths

Before:

Source: "INSTALLER_GUIDE.md"; DestDir: "{app}\docs"; DestName: "INSTALLER_GUIDE.txt"

After:

Source: "docs\INSTALLER_GUIDE.md"; DestDir: "{app}\docs"; DestName: "INSTALLER_GUIDE.txt"

2. Added Database Management Scripts

New files included:

  • db-config.ps1 - Database configuration
  • Fix-ItemValues-Performance.ps1 - Performance optimization
  • db-quick.ps1 - Quick database tools
  • Add-All-Indexes.bat - Batch script for indexes

3. Added More Documentation

Essential docs:

  • START_HERE.md - Quick start guide
  • QUICKSTART_POSTGRESQL.md - PostgreSQL setup
  • QUICK_REFERENCE.md - Command reference

Performance docs:

  • ADD_INDEXES_GUIDE.md - Index management
  • DIAGNOSTICS_COMPLETE_SUMMARY.md - Database diagnostics
  • POSTGRESQL_TROUBLESHOOTING.md - Troubleshooting guide

4. Added New Shortcuts

New Start Menu items:

  • "Documentation" - Opens docs folder
  • "Database Tools" - Runs db-quick.ps1 PowerShell script

📋 Complete File List Now Included

Application Files:

  • All DLLs and executables (from lib\Release\net11.0\*)
  • SQL scripts (in sql/ subdirectory - auto-included)
  • All other build outputs

Configuration:

  • startup.windows.json (default configuration)

Scripts:

  • db-config.ps1
  • Fix-ItemValues-Performance.ps1
  • db-quick.ps1
  • Add-All-Indexes.bat

Documentation (8 files):

  • README.md (shown during install)
  • START_HERE.md
  • QUICKSTART_POSTGRESQL.md
  • INSTALLER_GUIDE.md
  • QUICK_REFERENCE.md
  • ADD_INDEXES_GUIDE.md
  • DIAGNOSTICS_COMPLETE_SUMMARY.md
  • POSTGRESQL_TROUBLESHOOTING.md

🎯 What Users Get Now

After Installation:

Start Menu → Jellyfin PostgreSQL:

  • Jellyfin Server (runs the server)
  • Jellyfin Web Interface (opens browser)
  • Jellyfin Logs (opens log folder)
  • Jellyfin Data (opens data folder)
  • Documentation (new! opens docs folder)
  • Database Tools (new! runs PowerShell tools)
  • Uninstall

In Installation Directory:

C:\Program Files\Jellyfin-PostgreSQL\
├── jellyfin.exe
├── *.dll (all dependencies)
├── sql\                           ← SQL scripts
│   ├── all_performance_indexes.sql
│   ├── diagnostics.sql
│   └── ...
├── db-config.ps1                  ← Database config
├── Fix-ItemValues-Performance.ps1 ← Performance fix
├── db-quick.ps1                   ← Quick tools
├── Add-All-Indexes.bat           ← Batch script
└── docs\                          ← Documentation
    ├── START_HERE.txt
    ├── QUICKSTART_POSTGRESQL.txt
    ├── ADD_INDEXES_GUIDE.txt
    └── ...

Benefits

For Users:

  1. Easy access to database tools - No need to download separately
  2. Complete documentation - All guides included offline
  3. Quick troubleshooting - Performance guides at hand
  4. PowerShell integration - Database Tools shortcut for easy management

For Developers:

  1. Professional installation - Everything bundled properly
  2. Self-documenting - Users have all docs they need
  3. Support reduction - Common tasks documented and scripted

🚀 Building the Updated Installer

# Build the installer
.\build-installer.ps1

# Or manually:
iscc jellyfin-setup.iss

Output:

installer-output\JellyfinSetup-PostgreSQL-11.0.0-PREVIEW.exe

🔍 Verification

After building, check the installer includes:

# Extract installer files (for verification)
# Install to a test VM or directory
# Verify files are present:
Test-Path "C:\Program Files\Jellyfin-PostgreSQL\sql"
Test-Path "C:\Program Files\Jellyfin-PostgreSQL\docs"
Test-Path "C:\Program Files\Jellyfin-PostgreSQL\db-config.ps1"
Test-Path "C:\Program Files\Jellyfin-PostgreSQL\Fix-ItemValues-Performance.ps1"

📊 Size Comparison

Before:

  • Base install: ~200 MB
  • Documentation: 1 file (INSTALLER_GUIDE.md)
  • Scripts: 0

After:

  • Base install: ~200 MB (same)
  • Documentation: 8 files (~2 MB)
  • Scripts: 4 files (~50 KB)
  • Total increase: ~2 MB (~1% increase)

Worth it! 🎯


🎉 What's Still Automatic

These features were already working and still work:

  1. SQL files auto-included - The sql/ folder from build output
  2. Service installation - Windows Service setup
  3. PostgreSQL wizard - Configuration page during install
  4. Firewall rules - Automatic firewall exception
  5. .NET check - Verifies .NET 11 runtime
  6. Directory permissions - Proper ACLs on data folders

📝 Notes

SQL Files:

The SQL files in lib\Release\net11.0\sql\ are automatically included because the installer copies everything from that directory recursively. No special handling needed!

Documentation Format:

Documentation is copied as .txt files for easy viewing in Notepad. Markdown files are converted to .txt extension so users can read them without special tools.

PowerShell Scripts:

The scripts maintain their .ps1 extension and can be run directly from the Start Menu "Database Tools" shortcut.


🎯 Summary

Status: Installer fully updated
SQL Files: Already included automatically
Documentation: Added 8 essential guides
Scripts: Added 4 database management tools
Shortcuts: Added Documentation and Database Tools

Ready to build and ship! 🚀


📞 Testing Checklist

Before releasing:

  • Build installer: iscc jellyfin-setup.iss
  • Test install on clean Windows VM
  • Verify SQL files present in {app}\sql
  • Verify docs present in {app}\docs
  • Verify scripts present in {app}
  • Test "Database Tools" shortcut
  • Test "Documentation" shortcut
  • Verify service installation works
  • Test PostgreSQL configuration wizard
  • Verify startup.json created correctly

All updates complete! The installer now includes everything users need for a complete Jellyfin PostgreSQL installation experience. 🎉