nfoguard/NFOGuard.Emby.Plugin/DEPLOYMENT.md

NFOGuard Emby Plugin Deployment Guide

Prerequisites

• .NET Framework 4.8 SDK or Visual Studio Build Tools
• Emby Server 4.7+ running
• Access to Emby's plugins directory

Building the Plugin

Windows

build.bat

Linux/macOS

./build.sh

Installation Steps

1. Build the plugin using the build script above

2. Locate your Emby plugins directory:

   • Windows: C:\ProgramData\Emby-Server\plugins
   • Linux: /var/lib/emby/plugins
   • Docker: /config/plugins (inside container)
   • Synology: /volume1/Emby/plugins

3. Copy the DLL:

   cp bin/Release/NFOGuard.Emby.Plugin.dll /path/to/emby/plugins/
   

4. Restart Emby Server

5. Verify installation:

   • Check Emby dashboard → Plugins
   • Look for "NFOGuard" in the installed plugins list
   • Check Emby logs for "NFOGuard :: Plugin starting up"

Testing

1. Add a new TV episode to your library with an NFO file containing <dateadded>
2. Check the logs for NFOGuard processing messages:

   NFOGuard :: Processing Added Episode :: Episode Name
   NFOGuard :: Syncing PremiereDate to DateCreated :: Episode Name
   NFOGuard :: Successfully updated :: Episode Name
   

3. Verify in database:

   sqlite3 library.db2 "SELECT DateCreated, PremiereDate FROM MediaItems WHERE Name LIKE '%episode%';"
   

Troubleshooting

• Plugin not appearing: Check Emby logs for loading errors
• Not processing episodes: Verify log level includes Info messages
• Build failures: Ensure all Emby SDK DLLs are in EmbySDK folder
• Permission errors: Ensure Emby service has write access to database

SDK Dependencies

The plugin requires these Emby SDK DLLs in the EmbySDK folder:

• MediaBrowser.Common.dll
• MediaBrowser.Controller.dll
• MediaBrowser.Model.dll

These can be extracted from your Emby Server installation directory.