Skip to content

Add troubleshooting docs from GitHub issues triage#33

Open
jcasimir wants to merge 13 commits intoDispatcharr:mainfrom
jcasimir:docs/troubleshooting-from-issues
Open

Add troubleshooting docs from GitHub issues triage#33
jcasimir wants to merge 13 commits intoDispatcharr:mainfrom
jcasimir:docs/troubleshooting-from-issues

Conversation

@jcasimir
Copy link

@jcasimir jcasimir commented Jan 31, 2026

Summary

This PR adds documentation to address common questions and issues identified during a triage of GitHub issues. Each commit addresses a specific issue and includes a link back to the source issue for additional context.

New Troubleshooting Sections

Section Issue Description
Jellyfin EPG not importing #583 TVG-ID format requirements and ?tvg_id_source=tvg_id parameter
Adding multiple Dispatcharr instances to Plex #734 Channel Profiles workaround for device ID conflicts
Xtream Codes apps not working through reverse proxy #839 Nginx config for /live/ endpoint
EPG shows wrong data or is "off-by-one" #563 Overlapping channel numbers with Auto Channel Sync

Clarifications Added

Location Issue Description
M3U Profiles (user-guide) #710 Profiles are for connection pooling, NOT stream failover
Jellyfin categories (troubleshooting) #538 Categories pass through automatically from source EPG

Plex Limitations Added (getting-started)

Limitation Issue Description
VOD not supported #470 Plex cannot display VOD from Dispatcharr
Single EPG source #633 Cannot mix zipcode OTA guide with XMLTV
Tunarr conflict #344 Must disable Tunarr auto-update to prevent channel mismatch

Files Changed

  • docs/en/troubleshooting.md - 4 new sections, 1 note added
  • docs/en/getting-started.md - Jellyfin tip + 3 Plex warnings added
  • docs/en/user-guide.md - M3U Profiles clarification added

Issues That Can Be Closed After Merge

These open issues can be commented with a link to the relevant docs and closed:

  • #583 - Jellyfin EPG import
  • #710 - Profile Loop (misconception)
  • #839 - XC reverse proxy

🤖 Generated with Claude Code

jcasimir and others added 13 commits January 31, 2026 15:29
Addresses issue #583 where users reported EPG data not appearing in
Jellyfin. The root cause is that Jellyfin prefers descriptive channel
IDs (like "BBC1.uk") rather than numeric IDs.

- Add new troubleshooting section explaining TVG-ID format requirements
- Add tip to Jellyfin setup in getting-started.md linking to troubleshooting
- Document the ?tvg_id_source=tvg_id URL parameter workaround

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Addresses issue #710 where users expected M3U Profiles to provide
automatic failover between streams when one fails. This is a common
misconception.

- Add warning box to M3U Profiles section clarifying their purpose
- Explain profiles are for connection pooling across multiple accounts
- Direct users to Fallback Streams feature for actual failover needs

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Addresses issue #734 where users running multiple Dispatcharr instances
(e.g., one with VPN) found that Plex hangs when trying to add the
second tuner due to device ID conflicts.

- Recommend using Channel Profiles as the primary solution
- Document M3U-as-source workaround for those who need separate instances
- Link to Channel Profiles documentation for setup details

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Addresses issue #839 where users found that IPTV apps using the Xtream
Codes API (IPTV Smarters, TiviMate, etc.) fail when accessing
Dispatcharr through a reverse proxy from outside the local network.

- Explain that XC apps use /live/username/password/ URL paths
- Provide nginx configuration snippet for the /live/ endpoint
- List common symptoms to help users identify this issue
- Link to existing reverse proxy documentation

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Link the Jellyfin EPG troubleshooting section and getting-started tip
back to the original issue for additional context.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Link the M3U Profiles failover clarification back to the original issue
where users were confused about profiles vs stream failover.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Link the multiple Dispatcharr instances troubleshooting back to the
original issue about Plex hanging when adding a second tuner.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Link the Xtream Codes reverse proxy troubleshooting back to the original
issue about apps not working through nginx.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Document that EPG categories (Sports, News, etc.) are automatically
passed through to Jellyfin if the source EPG includes them - no special
configuration needed.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Document the common issue where EPG shows wrong data in clients due to
overlapping channel numbers when using Auto Channel Sync. Explains the
cause and provides solution for setting unique starting channel numbers
per group.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Document that Plex does not support Video on Demand from Dispatcharr,
directing users to Jellyfin or XC-compatible apps for VOD needs.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Document that Plex can only use one EPG source at a time (zipcode OTA
or XMLTV, not both). Users with both HDHomeRun and IPTV need to provide
all EPG data through Dispatcharr.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Document that users combining Tunarr with Dispatcharr must disable
Tunarr's auto-update settings to prevent Plex from losing channel
matching.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@CtznSniiips
Copy link
Collaborator

Thanks for the PR. We've broken the user-guide.md page into multiple pages, could you resubmit under the new pages? Note that user-guide.md is still included in the repo as a reference but not indexed in the actual docs site. Don't worry about updating it, we will be deleting it eventually. Looks like there are at least a few of your commits affected by this.

The reverse proxy documentation has already been updated to allow the /live/ endpoints, so those commits can be removed.

Also, you can remove the references/links to Github issues. The docs are considered source of truth (even if not always up-to-date or correct), so no need for references.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants