Support Center and Support Bundles - softerfish/fyuhls GitHub Wiki

Support Center and Support Bundles

Support Center is the safest admin page for packaging technical context when something is broken.

Use it when you need:

  • a sanitized diagnostics export
  • a cleaner support handoff
  • a safer way to share environment state
  • a central place to review updater and support-facing tools

What Support Center is for

Support Center helps you gather enough information to investigate a problem without dumping raw secrets or raw logs into chat, email, or screenshots.

It is especially useful when:

  • you need to escalate a bug
  • you want to compare environment state before and after a change
  • you need a support payload that is safer to share than full raw config

What a support bundle includes

The sanitized support bundle is intended to be useful, not exhaustive.

Typical bundle content includes:

  • installed version information
  • environment and dependency checks
  • plugin summary
  • sanitized configuration snapshot
  • recent sanitized log excerpts
  • selected health and diagnostics context

What is redacted or hidden

Sensitive values such as these are expected to be removed, masked, or hidden:

  • tokens
  • passwords
  • secret keys
  • encryption material
  • cookies and authorization values
  • email addresses
  • IP addresses
  • sensitive absolute paths

This is why Support Center is the preferred export path instead of copying raw config files or raw application logs.

Downloading a sanitized bundle

Use Download Sanitized JSON when you want a local copy for review or support escalation.

Important notes:

  • it downloads as a plain .json file
  • it is not a zip archive
  • it is meant to be human-shareable and machine-readable

Emailing a support bundle

If SMTP is configured, Fyuhls can send the same sanitized bundle directly from Support Center.

Use this only after:

  • you reproduced the issue recently
  • you reviewed the current environment state
  • you are comfortable with the sanitized output

If SMTP is not configured, download the sanitized JSON and send it manually through your normal support channel.

Recommended support workflow

The best order is usually:

  1. reproduce the issue
  2. check System Status
  3. confirm whether cron, storage, SMTP, or logs already explain it
  4. open Support Center
  5. download the sanitized support bundle
  6. share that bundle instead of raw logs or raw config

When to use System Status first

System Status should come first when:

  • users report uploads failing
  • logs need immediate review
  • FFmpeg or GD checks are relevant
  • multipart upload health looks suspicious
  • recent system errors may already identify the root cause

Think of it like this:

  • System Status is the technical health inspection page
  • Support Center is the safe handoff and export page

Support Center and the updater

Support Center can also act as the operator-facing home for release checks and one-click update workflows.

At a high level, the updater:

  • checks GitHub releases
  • compares the latest release to the installed version
  • prepares a preview/apply workflow
  • backs up replaced core files
  • uses core-file ownership rules to avoid blindly overwriting local state

Important operator points:

  • preview first whenever possible
  • keep backups first
  • stale unchanged core files can be quarantined instead of hard-deleted
  • locally modified stale core files are meant to be left alone

You do not need a dedicated wiki page per release to understand the updater. The release changelog plus current docs are the right place for ongoing updater behavior changes.

Common support situations

"I need to report a bug safely"

Use:

  • System Status for immediate health review
  • Support Center for sanitized JSON export

Avoid:

  • copying full raw config into chat
  • emailing raw logs with secrets

"SMTP is missing"

Support Center may still help you export a bundle, but email-send options will not be available until SMTP is configured.

"The update failed halfway"

Check:

  • System Status
  • recent logs
  • preview/apply output if available
  • backups before retrying

Then use a support bundle if you need to escalate.

Demo mode note

On installs using demo mode with a designated demo admin, support-bundle export and related sensitive support actions can be hidden from that protected demo-admin experience.

That is intentional. Support-bundle handling belongs to real operational admins, not presentation or training accounts.

Best practices

  • reproduce first, export second
  • use sanitized JSON instead of raw logs whenever possible
  • review System Status before escalating
  • keep SMTP configured if you want direct support-bundle email flow
  • keep backups before updater actions

Short version

Support Center is the safest place to package a real bug report or diagnostics handoff. Use it to export sanitized JSON, not raw secrets, and pair it with System Status whenever you need deeper root-cause context.

⚠️ **GitHub.com Fallback** ⚠️