Troubleshooting and backups

The common failures and what causes them, plus what Shortlist backs up and what it can't restore.

Start here: “Have an issue?”

Before working through the list below, open Have an issue? in the sidebar. It runs twenty-two read-only checks against your own server and, for most of these problems, tells you the answer outright — which library refused someone’s token, which setting actually applied, why a row is short, whether Plex matches what Shortlist thinks it delivered.

Nothing on that page changes anything: not your Plex server, not your rows, not your settings.

Three things worth knowing:

What leaves your server, and what doesn’t:

Masked Kept
Passwords, Plex tokens, API keys Library and row names, title names, error messages
IP addresses and your server’s machine id, in the report and in every log file — a URL keeps only its scheme and port (https://<host>:32400) Counts, timings, settings values, migration state
Nothing else. Everything below is in there The Plex usernames themselves. Replace them yourself before posting if you’d rather not publish them
  Nicknames and friendly names, in the log files — see below

Nicknames are not masked. The report’s own text never prints them — it prints Plex usernames and slugs — but the log files bundled alongside it are not filtered for names, and nothing masks them. If a row template contains {user} it renders as the nickname, and every delivery line in the log then carries it:

delivery:deliver - jsmith: delivered 'Picked for Dad' to 'Movies' (20 items, label shortlist_jsmith)

The same is true of Logs → Download, which is the same log files with the same filtering — this server’s own address and machine id, and secrets. Not people’s names.

Treat that as a good first pass, not a guarantee. Logs are free text: they carry whatever a library, a plugin or an error message decided to print, and something unusual can still get through a filter written for the shapes we know about. Give the report a skim before posting it anywhere public — and if you find something that should have been masked and wasn’t, that is worth an issue of its own.

If someone is reporting a problem on a server you don’t administer, sending them there is usually faster than a list of questions: “open /issue, switch the checks on, type the title, press Copy.”

Troubleshooting

Backups

Shortlist copies its whole database to /config/backups on a schedule (Jobs → Backups; nightly at 3 AM by default), before every upgrade, and before any restore. It keeps the newest 10 by default.

A backup holds everything Shortlist knows: settings and connections, your rows and their audiences, the people it tracks, run history and each run’s picks, the request inbox, and most importantly the restriction_snapshots of each user’s original Plex share filters.

Because a backup holds your rows’ audiences, restoring one also restores who could see which rows at that moment. If you have narrowed a shared row’s audience since the backup was taken, restoring widens it again and those people will see the row after the next run. Shortlist says so before you confirm and again afterwards, but it does not undo it for you, so check Rows before restarting. Those snapshots are the only record of how your server’s sharing looked before Shortlist touched it, and Uninstall restores from them. Everything else is rebuildable by hand; that isn’t.

Two things worth knowing:

Edit this page on GitHub