Skip to content

Commit

Permalink
docs: update docs to mention Jellyfin support
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisbenincasa committed Aug 22, 2024
1 parent f52df44 commit 7cacfef
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 26 deletions.
1 change: 1 addition & 0 deletions docs/configure/scheduling.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Scheduling
34 changes: 23 additions & 11 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,35 @@ Tunarr is available on [Docker Hub](https://hub.docker.com/r/chrisbenincasa/tuna

The general format of tags is: `{release}{-encoder}?`.

Since Tunarr is currently pre-release, there is a single tag: `edge`. The edge tag is pushed hourly from the `main` branch. We also support a specialized image builds which include support for hardware-accelerated encoding with Nvidia, QSV, and VAAPI.
Since Tunarr is currently pre-release. There are a few tags to choose from which have different releae cadences:

- `x.x.x` (versioned): These are release cuts. Because we are pre-1.0.0, breaking changes cause major version bumps and bug fixes are patch version bumps. Once we achieve 1.0.0, we will use proper semver.
- `latest`: The latest tag points at the most recent release version.
- `edge`: Pushed every 2 hours off of the "dev" branch. This build can be very unstable.

Each tag can also use specialized image builds which include support for hardware-accelerated encoding with Nvidia, QSV, and VAAPI.

!!! info

Tunarr has experimental support for QSV / VAAPI. This issue is tracked here: [chrisbenincasa/tunarr#23](https://github.com/chrisbenincasa/tunarr/issues/23)

Docker:
Image tags are in the form `TAG(-HWACCEL)?`. For example, with the `latest` tag:

[Docker](https://hub.docker.com/r/chrisbenincasa/tunarr/):

- `chrisbenincasa/tunarr:edge`
- `chrisbenincasa/tunarr:edge-nvidia`
- `chrisbenincasa/tunarr:edge-vaapi`
- `chrisbenincasa/tunarr:latest`
- `chrisbenincasa/tunarr:latest-nvidia`
- `chrisbenincasa/tunarr:latest-vaapi`

GHCR:
[GHCR](https://github.com/chrisbenincasa/tunarr/pkgs/container/tunarr):

- `ghcr.io/chrisbenincasa/tunarr:latest`
- `ghcr.io/chrisbenincasa/tunarr:latest-nvidia`
- `ghcr.io/chrisbenincasa/tunarr:latest-vaapi`

!!! info

- `ghcr.io/chrisbenincasa/tunarr:edge`
- `ghcr.io/chrisbenincasa/tunarr:edge-nvidia`
- `ghcr.io/chrisbenincasa/tunarr:edge-vaapi`
We are still working on a proper build workflow for ARM images. See [chrisbenincasa/tunarr#648](https://github.com/chrisbenincasa/tunarr/issues/648) for details.

### Unraid

Expand All @@ -38,9 +50,9 @@ Follow the on-screen instructions to set up the container, including mapping the

Tunarr is released in pre-built binaries for Windows (x64), macOS (x64), and Linux (x64).

Like Docker images, we currently have a single release, `edge` that updates hourly.
Like Docker images, binaries are released with versions as well as a singular 'edge' build which is released bihourly.

Prebuilt binaries can be found at [https://github.com/chrisbenincasa/tunarr/releases/tag/edge](https://github.com/chrisbenincasa/tunarr/releases/tag/edge)
Prebuilt edge binaries can be found at [https://github.com/chrisbenincasa/tunarr/releases/tag/edge](https://github.com/chrisbenincasa/tunarr/releases/tag/edge)

!!! info

Expand Down
16 changes: 8 additions & 8 deletions docs/getting-started/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ docker run \
-v "$(pwd)"/tunarr:/config/tunarr \
-v "$(pwd)"/.dizquetv:/.dizquetv \
-p 8000:8000 \
chrisbenincasa/tunarr:edge
chrisbenincasa/tunarr
```

Or if using `docker compose`...
Expand All @@ -24,9 +24,9 @@ Or if using `docker compose`...
version: '3.8'
services:
tunarr:
image: chrisbenincasa/tunarr:edge
image: chrisbenincasa/tunarr
# Uncomment along with runtime below to enable HW accel
# image: chrisbenincasa/tunarr:edge-nvidia
# image: chrisbenincasa/tunarr:latest-nvidia
container_name: tunarr
ports:
- ${TUNARR_SERVER_PORT:-8000}:8000
Expand All @@ -49,14 +49,14 @@ services:

## Hardware Encoding

For QSV compatability in Docker, you must mount /dev/dri the container:
For QSV compatability in Docker, you must mount `/dev/dri` the container:

```
docker run \
-v "$(pwd)"/tunarr:/config/tunarr \
--device /dev/dri/:/dev/dri/
-p 8000:8000 \
chrisbenincasa/tunarr:edge-vaapi
chrisbenincasa/tunarr:latest-vaapi
```

## Initial Setup
Expand All @@ -65,13 +65,13 @@ Upon first launching Tunarr, you will see the Welcome page with a few required s

![Welcome Page No Plex](/assets/welcome_page_not_connected.png)

### Plex
### Media Sources

Currently, Tunarr supports a single media source, Plex. In order to add programming to your channels, you must connect at least one Plex server. Plex acts as the metadata source for your programming, and optionally, the streaming source. Click the "Connect Plex" button to start Plex authentication and add your first Plex server to Tunarr.
Currently, Tunarr supports streaming media from Plex or Jellyfin servers. In order to add programming to your channels, you must connect at least one media source. These sources also act as the metadata sources for your programming. Click the "Add" button to configure a media source to use with your instance of Tunarr.

!!! info

We plan on implementing other media source types, including [Jellyfin](https://github.com/chrisbenincasa/tunarr/issues/24) and [Local Media](https://github.com/chrisbenincasa/tunarr/issues/26). Upvote and follow the issues you'd like to see us implement!
We plan on implementing other media source types, including [Emby](https://github.com/chrisbenincasa/tunarr/issues/25) and [Local Media](https://github.com/chrisbenincasa/tunarr/issues/26). Upvote and follow the issues you'd like to see us implement!

### FFMPEG

Expand Down
9 changes: 2 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
# Tunarr

Create live TV channels from media on your Plex servers, and more!
Create live TV channels from media on your Plex/Jellyfin servers, and more!

Configure your channels, programs, commercials, and settings using the Tunarr web UI.

Access your channels by adding the spoofed Tunarr HDHomerun tuner to Plex, Jellyfin, or Emby. Or utilize generated M3U files with any 3rd party IPTV player app.

<!-- <p align="center">
<img src="./design/tunarr-guide.png">
<img src="./design/tunarr-channels.png">
</p> -->
Watch your channels by adding the spoofed Tunarr HDHomerun tuner to Plex, Jellyfin, or Emby. Or utilize generated M3U files with any 3rd party IPTV player app.

## What is this?

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ nav:
- Configure:
- Channels: configure/channels.md
- Programming: configure/programming.md
- Scheduling: configure/scheduling.md
- Flex: configure/flex.md
- System: configure/system.md
- Clients:
Expand Down

0 comments on commit 7cacfef

Please sign in to comment.