Installing PlexCache‐R

Work in Progress, may not be up to date yet with the PlexCache-D v3 release

These instructions should still work with PlexCache v2.1.2 LTS branch, which was the last version of PlexCache-R.

Step 1: Getting the Files

Put the files from this Repo into a known folder on your Unraid server. I use the following:

/mnt/user/appdata/plexcache/plexcache_app.py

I'll keep using this in my examples, but make sure to use your own path.

---

Step 2: Configure the script:

Running the Setup Script and generating your plexcache_settings.json file. Click the link for full instructions and guidance.

---

Step 3: Run PlexCache-R:

There are other methods to run the PlexCache-R script, but I've only tested and use the UserScripts one, so that's all I'll list here for now. UserScripts Setup. Click the link for full instructions and guidance.

---

Command Line Options

Flag	Description
--dry-run	Simulate run without moving files (useful for testing). Alias: --debug
--verbose	Show detailed DEBUG level logging. Alias: -v
--restore-plexcached	Emergency restore: scan for all .plexcached files and restore them to original names
--quiet	Only send notifications on errors (suppresses summary notification). Alias: --notify-errors-only

Examples:

# Normal run
python3 plexcache_app.py

# Test run without moving files
python3 plexcache_app.py --dry-run

# Verbose output for troubleshooting
python3 plexcache_app.py --verbose

# Dry-run with verbose logging to see exactly what would happen
python3 plexcache_app.py --dry-run --verbose

# Restore all .plexcached backup files
python3 plexcache_app.py --restore-plexcached

# Run silently (only notify on errors) - ideal for scheduled cron jobs
python3 plexcache_app.py --quiet

# Combine flags as needed
python3 plexcache_app.py --dry-run --quiet

Migration from Original

The refactored version maintained full compatibility with the original. HOWEVER - This Redux version DOES NOT maintain full compatibility. I did make some vague efforts at the start, but there were so many things that didn't work properly that it just wasn't feasible. So while the files used are the same, you -will- need to delete your plexcache_settings.json and run a new setup to create a new one.

1. Different Configuration: Uses the same plexcache_settings.json file, but the fields have changed
2. Added Functionality: All original features still exist, but now also work (where possible) for remote users, not just local.
3. Same Output: Logging and notifications work in a similar way, though they are now much improved.
4. Same Performance: No performance degradation. Hopefully. Don't quote me on this.