bybrooklyn/tunarr
1
0
Fork 0
mirror of https://github.com/chrisbenincasa/tunarr.git synced 2026-04-18 09:03:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: more documentation on local libraries

Browse Source
This commit is contained in:
Christian Benincasa
2025-12-11 07:24:10 -05:00
parent 5020f4ae12
commit a71d0c0202
9 changed files with 147 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/configure/clients/jellyfin.md
View File

@@ -1,20 +1,32 @@
# Jellyfin
Once you have your channels created with programming/shows added, head over to Jellyfin > Hamburger Menu Icon > Dashboard > Live TV > Add Tuner Device.
Once you have your channels created with programming/shows added, head over to Jellyfin. The following pictures show step-by-step how connect Tunarr to your Jellyfin server.
![Jellyfin Hamburger](/assets/Jellyfin-home-menu.png)
<figure markdown="span">
![Jellyfin Hamburger](/assets/Jellyfin-home-menu.png)
<figcaption>1. Locate "Hamburger" menu on the Jellyfin homepage</figcaption>
</figure>
![Jellyfin Admin Dash](/assets/Jellyfin-admin-dashboard.png)
<figure markdown="span">
![Jellyfin Admin Dash](/assets/Jellyfin-admin-dashboard.png)
<figcaption>2. Locate the "Dashboard" menu item under "Administration"</figcaption>
</figure>
<figure markdown="span">
![Jellyfin Live TV Setup](/assets/Jellyfin-live-tv-options.png)
<figcaption>3. Locate the "Live TV" menu item under "Live TV" in the sidebar</figcaption>
</figure>
![Jellyfin Live TV Setup](/assets/Jellyfin-live-tv-options.png)
<hr/>
At this point, Jellyfin will ask for your tuner type - we recdommend selecting HD Homerun.
Jellyfin will ask for your tuner type - select HD Homerun.
!!! note
Tunarr supports M3U and HDHR style connections from clients. However, some users have experienced stability issues at program boundaries when using Tunarr as an M3U tuner in Jellyfin. This seems to occur when Jellyfin is _not_ transcoding / remuxing the incoming stream and seems related to the following issues: [jellyfin/jellyfin-ffmpeg#57](https://github.com/jellyfin/jellyfin-ffmpeg/issues/57) and [trac.ffmpeg.org/ticket/5419](https://trac.ffmpeg.org/ticket/5419)
![Jellyfin Add HD Homerun](/assets/Jellyfin-add-hdh.png)
You can then select "Detect My Devices," and Jellyfin may already detect Tunarr and you might see your servers IP address. If it does not, you can fill in your info manually. Use the following format replacing serverIP with your servers IP address and chosen port (if using Docker): e.g. `http://serverIP:8000`
![Jellyfin HDH Setup](/assets/Jellyfin-tuner-setup.png)
![Jellyfin HDHR Setup](/assets/Jellyfin-tuner-setup.png)
Once you have entered your server's URL and port, you will have to add the XMLTV Guide.

7
docs/configure/media_sources/local.md → docs/configure/media_sources/local/index.md
View File

@@ -13,9 +13,10 @@ Tunarr traverses folders for Local Media Sources to discover metadata and media
Currently, Tunarr supports the following media types for Local sources:
1. Movies
1. [Movies](/configure/media_sources/local/movies)
2. Shows
# Metadata
3. "Other" Videos (unstructured)
## Generating Metadata
There are many ways to generate NFO files for consumption by Tunarr if your media does not already have them. Popular *arr stack programs, Jellyfin, and Emby all support writing out NFO files for media.

33
docs/configure/media_sources/local/movies.md Normal file
View File

@@ -0,0 +1,33 @@
# Movies
## Library Structure
Local Movie libraries support several directory structures. In general, we recommend having one subfolder per movie. Below is an example of some strucutres that are compatible with Tunarr.
```
movies/
|
├ The Matrix (1999)/
| ├ The Matrix (1999).mkv
| └ movie.nfo
|
├ The Matrix Reloaded (2003)/
| ├ The Matrix Reloaded (2003).mkv
| └ The Matrix Reloaded (2003).nfo
|
├ The Matrix Revolutions (2003).mkv
├ The Matrix Revolutions (2003).nfo
|
```
## Metadata
Tunarr does its best to follow conventions laid out by the [Kodi Wiki](https://kodi.wiki/view/NFO_files/Movies) when reading NFO metadata for movie items. For each movie item, Tunarr will look for an NFO file called `movie.nfo` (when dealing with subfolders) or `$MOVIE_FILE.nfo` where `$MOVIE_FILE` is the exact name of the movie's video file, without the extension.
## Artwork
Tunarr will attempt to scan various artwork files for each movie, including posters, fanart, landscape, and banners. These are generally used to power the UI and guide, but potentially have other future uses as well.
## Fallback
Without NFO files, Tunarr can still scan a movie directory. Tunarr will attempt to parse metadata from the filename itself, including year and external IDs (IMDb, TMDB) using some basic regex patterns.

34
docs/configure/media_sources/local/other_videos.md Normal file
View File

@@ -0,0 +1,34 @@
# Movies
## Library Structure
Local "Other Video" libraries support freeform directory structures of arbitrary depth, including videos in the root library folder. These libraries are useful for organizing filler content.
```
commercials/
|
├ 1999/
| ├ Coke.mkv
| └ Coke.nfo
|
├ 2000/
| └ Food/
| ├ Burger King.mkv
| └ Burger King.nfo
|
├ Random.mkv
├ Random.nfo
|
```
## Metadata
Tunarr does its best to follow conventions laid out by the [Kodi Wiki](https://kodi.wiki/view/NFO_files/Movies) when reading NFO metadata for other video items. For each movie item, Tunarr will look for an NFO file called `$VIDEO.nfo` where `$VIDEO` is the exact name of the video file, with extensions swapped. Other video NFO metadata can have either a `movie` or `episodedetails` root tag.
## Artwork
Tunarr will attempt to scan various artwork files for each movie, including thumbnails. These are generally used to power the UI and guide, but potentially have other future uses as well.
## Fallback
Without NFO files, Tunarr can still scan a directory. Tunarr will simply create an entry with the video name and no additional metadata.

34
docs/configure/media_sources/local/shows.md Normal file
View File

@@ -0,0 +1,34 @@
# Shows
## Library Structure
Local TV Show libraries support several directory structures. Each show must have its own subfolder within the library. Season folders are optional, but recommended.
```
tv/
|
├ Breaking Bad/
| ├ Season 01/
| | ├ Breaking Bad (2008) - S01E01 - Pilot.mkv
| | └ Breaking Bad (2008) - S01E01 - Pilot.nfo
| └ tvshow.nfo
|
├ Californication/
| ├ tvshow.nfo
| ├ Calfornication (2007) - S01E01 - Pilot.mkv
| ├ Calfornication (2007) - S01E01 - Pilot.nfo
| └ Calfornication (2007) - S01E01 - Pilot.en.srt
```
## Metadata
Tunarr does its best to follow conventions laid out by the Kodi Wiki for [shows](https://kodi.wiki/view/NFO_files/TV_shows) and [episodes](https://kodi.wiki/view/NFO_files/Episodes) when reading NFO metadata for movie items. For each show item, Tunarr will look for an NFO file called `tvshow.nfo` in the show's folder. Tunarr expects each episode to have its own NFO file which matches the name of the video file exactly, but with the `.nfo` extension instead of the video extension.
## Artwork
Tunarr will attempt to scan various artwork files for each show, season, and episode, including posters, fanart, landscape, and banners. These are generally used to power the UI and guide, but potentially have other future uses as well.
## Fallback
Without NFO files, Tunarr can still scan a shows directory. For the show itself, Tunarr will simply create an entry with the show name and no additional metadata. Fallback is not supported for episodes or seasons at this time.

8
docs/getting-started/migration/migrate-to-1.md Normal file
View File

@@ -0,0 +1,8 @@
# Migrating from 0.22.x to 1.x
If you ran Tunarr before 1.0, you can still upgrade directly to the 1.x line! However, there are some things to consider:
1. There are _many_ breaking changes between these versions.
2. Like Tunarr release that contain breaking changes, rolling back is not supported.
We recommend taking a **full backup** of your Tunarr data directory before upgrading to 1.x. Should something go wrong with your upgrade, or you experience an issue only present in 1.x and wish to revert, you can restore your backup for 0.22.x.

24
docs/misc/common-issues.md
View File

@@ -15,21 +15,13 @@ There are a few reasons why your desired hardware acceleration option is not app
If you've double-checked these things and still are experiencing issues, please open up a [new Q&A discussion topic](https://github.com/chrisbenincasa/tunarr/discussions/new?category=q-a&title=Missing%20Hardware%20Acceleration%20Option) so we can debug.
## Channel mappings being reset in Plex
If you notice your channel guide is blank, open Plex > Settings > Live TV & DVR > Select "Channels (X) X enabled". If you see something similar to the below screenshot where the dropdowns are blank, your channels have lost their mappings.
![Channel mappings](/assets/misc-commonissues-channelmappings.png)
You can quickly resolve this by selecting the dropdown on the right and manually re-mapping your channels, but this will not resolve the underlying issue.
Head over to Tunarr > Settings > SOURCES > Select the pencil icon next to your server > Verify Auto-Update Channels is unchecked.
![Edit sources](/assets/settings-sources-edit.png)
![Auto-update channels disabled](/assets/serversettings-autoupdatechannels.png)
If this is already unchecked, see [Issue #818](https://github.com/chrisbenincasa/tunarr/issues/818) to track this issue.
## Channel icons missing
This issue can potentially happen everywhere, but many have reported it happening across various native Plex apps. Generally, the issue stems from not having Tunarr properly hosted via `https`. Frequently what happens is that Plex native apps will access Plex through [Secure Server Connections](https://support.plex.tv/articles/206225077-how-to-use-secure-server-connections/), Plex will load thumbnails / icons from the configured Tunarr host (configured as `http`), but these requests will be blocked because many network stacks deem the hop from `https` -> `http` to be unsafe.
To workaround this issue, there are a few options:
1. Host images used in Tunarr externally, on a site that uses `https`.
2. Access Tunarr via `https`, via reverse proxy or otherwise
3. Access your client which connects to Tunarr via `http`

2
docs/misc/search.md
View File

@@ -23,7 +23,7 @@ Tunarr's search feature different typed fields, such as `string`, `number`, and
| `:` or `=` | Equals | `title:"30 Rock"`|
| `<` or `<=` | Starts With | `title <= A` |
| `!=` | Not Equals | `title != "Sesame Street"` |
| `contains` | Contains | `title contains Hours` |
| `~` | Contains | `title ~ Hours` |
| `in` | Set includes | `title in ["30 Rock", "Arrested Development"]` |
## Number & Date

8
mkdocs.yml
View File

@@ -43,13 +43,19 @@ nav:
- Install: getting-started/installation.md
- Run: getting-started/run.md
- Setup: getting-started/setup.md
- Migration:
- Migrate to 1.0: getting-started/migration/migrate-to-1.md
- Configure:
- Media Sources:
- configure/media_sources/index.md
- Plex: configure/media_sources/plex.md
- Jellyfin: configure/media_sources/jellyfin.md
- Emby: configure/media_sources/emby.md
- Local: configure/media_sources/local.md
- Local:
- configure/media_sources/local/index.md
- Movies: configure/media_sources/local/movies.md
- Shows: configure/media_sources/local/shows.md
- Other Video: configure/media_sources/local/other_videos.md
- FFmpeg:
- configure/ffmpeg/index.md
- Transcode Configs: configure/ffmpeg/transcode_config.md