This repository houses all documentation for Jellyfin available at [jellyfin.org](https://jellyfin.org/docs/) and written in markdown.
# Layout
This repository is built using [DocFX](https://dotnet.github.io/docfx/) using [DocFX Flavored Markdown](https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html), for bit of a tutorial on writing, [see the Content section here](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html).
## Plugin API
@ -15,6 +15,7 @@ Describe all available API surfaces and class from plugin development.
`apispec` is used to overwrite specific plugin API page contexts.
## Docs
`docs` is the main custom documentation directory.
All uids for the custom documentation are relative to this directory, with `administration` and `contributing` shortened to `admin` and `contrib` respectively.
So for example to reference the file `general/administration/installing.md` one would use `xref:admin-installing` with an optional anchor like `xref:admin-installing#arch`.
@ -42,5 +43,3 @@ Naming conventions for all supported media types, such as movies or podcasts.
Jellyfin is a Free Software Media System that puts you in control of managing and streaming your media. It is an alternative to the proprietary Emby and Plex, to provide media from a dedicated server to end-user devices via multiple apps. Jellyfin is descended from Emby's 3.5.2 release and ported to the .NET Core framework to enable full cross-platform support. There are no strings attached, no premium licenses or features, and no hidden agendas: just a team who want to build something better and work together to achieve it. We welcome anyone who is interested in joining us in our quest!
@ -13,7 +13,7 @@ The Jellyfin project was started in early December 2018 as a result of Emby's de
You can find our main repository [on GitHub](https://github.com/jellyfin/jellyfin) as well as [our main organization page](https://github.com/jellyfin).
@ -29,7 +28,7 @@ All package builds begin with the first two steps:
4. Run the container:
`docker run -d -p 8096:8096 $USERNAME/jellyfin`
## Build script on Linux/MacOS
## Linux or MacOS
3. Use the included `build` script to perform builds:
`./build --help`
@ -40,32 +39,32 @@ All package builds begin with the first two steps:
**NOTE:** This will very likely be split out into a separate repository at some point in the future.
## Build script on Windows
## Windows
3. Install the dotnet core SDK 2.2 from [Microsoft's Webpage](https://dotnet.microsoft.com/download/dotnet-core/2.2) and [install Git for Windows](https://gitforwindows.org/). You must be on Powershell version 3 or higher.
3. Install the dotnet core SDK 2.2 from [Microsoft's Website](https://dotnet.microsoft.com/download/dotnet-core/2.2) and [install Git for Windows](https://gitforwindows.org/). You must be on Powershell version 3 or higher.
4. From Powershell set the execution policy to unrestricted:
`set-executionpolicy unrestricted`
4. From Powershell set the execution policy to unrestricted:
`set-executionpolicy unrestricted`
5. Run the Jellyfin build script:
5. Run the Jellyfin build script:
`deployment\windows\build-jellyfin.ps1 -verbose`
* The `-WindowsVersion` and `-Architecture` flags can optimize the build for your current environment; the default is generic Windows x64.
* The `-InstallLocation` flag lets you select where the compiled binaries go; the default is `$Env:AppData\Jellyfin-Server\`.
* The `-InstallLocation` flag lets you select where the compiled binaries go; the default is `$Env:AppData\Jellyfin-Server\`.
* The `-InstallFFMPEG` flag will automatically pull the stable `ffmpeg` binaries appropriate to your architecture (x86/x64 only for now) from [Zeranoe](https://ffmpeg.zeranoe.com/builds/) and place them in your Jellyfin directory.
* The `-InstallNSSM` flag will automatically pull the stable `nssm` binary appropriate to your architecture (x86/x64 only for now) from [NSSM's Website](https://nssm.cc/) and place it in your Jellyfin directory.
* The `-InstallNSSM` flag will automatically pull the stable `nssm` binary appropriate to your architecture (x86/x64 only for now) from [NSSM's Website](https://nssm.cc/) and place it in your Jellyfin directory.
6. (Optional) Use [NSSM](https://nssm.cc/) to configure Jellyfin to run as a service
7. Jellyfin is now available in the default directory (or the directory you chose). Assuming you kept the default directory:
* To start it from a Powershell window, run:
* To start it from a Powershell window, run:
`&"$env:APPDATA\Jellyfin-Server\jellyfin.exe"`
* To start it from CMD, run:
* To start it from CMD, run:
`%APPDATA%\Jellyfin-Server\jellyfin.exe`
**NOTE:** This will very likely be split out into a separate repository at some point in the future.
@ -18,9 +17,9 @@ If you can access the server locally but not outside of your LAN, then you likel
The easiest way to check for issues is by checking the logs, which can be accessed through the settings on the web frontend or in the log directory on your server. If there are no logs at all relating to web traffic, even over a LAN connection, then the server hasn't been reached at all yet. This would indicate either an incorrect address or an issue somewhere else on the network.
## Debug (more verbose) Logging
## Debug Logging
To enable debug (much more verbose) logging for Jellyfin, it is currently required to manually edit config files - no UI options exist yet. Go to Jellyfin-directory/config, in the `logging.json` file, change:
To enable debug (much more verbose) logging for Jellyfin, it is currently required to manually edit config files - no UI options exist yet. Go to Jellyfin-directory/config, in the `logging.json` file, change the minimum level to debug as seen below.
`"MinimumLevel": "Information",`
@ -28,7 +27,7 @@ to
`"MinimumLevel": "Debug",`
Jellyfin 10.4.1 and above will auto-reload the new configuration. The debug messages show up in the log with the tag DBG.
Jellyfin 10.4.1 and above will automatically reload the new configuration. The debug messages show up in the log with the `DBG` tag.
Jellyfin supports [hardware acceleration](https://trac.ffmpeg.org/wiki/HWAccelIntro) (HWA) of video encoding/decoding using FFMpeg. FFMpeg and Jellyfin can support multiple hardware acceleration implementations such as Intel Quicksync (QSV), AMD AMF, nVidia NVENC/NVDEC, OpenMax OMX and MediaCodec through Video Acceleration API's.
@ -50,9 +49,9 @@ Each hardware acceleration type, as well as each Jellyfin installation type, req
In order to use Hardware acceleration in Docker, the devices must be passed to the container. To see what video devices are available, you can run `sudo lshw -c video` or `vainfo`
Note: [NVIDIA GPU's](https://github.com/docker/compose/issues/6691) currently aren't supported in Docker-compose.
**Note:** [NVIDIA GPUs](https://github.com/docker/compose/issues/6691) aren't currently supported in docker-compose.
Docker run configuration example:
Docker run configuration example:
`docker run -d \`
`--volume /path/to/config:/config \`
@ -80,7 +79,6 @@ services:
- /dev/dri/renderD128:/dev/dri/renderD128 # VAAPI devices, may be D128, D129, etc.
- /dev/dri/card0:/dev/dri/card0
- /dev/vchiq:/dev/qchiq # Rpi4
```
### Configuring VAAPI acceleration on Debian/Ubuntu from `.deb` packages
@ -97,7 +95,7 @@ To check information about VAAPI on your system install and run `vainfo`
`crw-rw---- 1 root video 226, 1 Apr 13 16:37 card1`
**NOTE:** On some releases, the group may be `video` instead of `render`.
**NOTE:** On some releases, the group may be `video` instead of `render`.
2. Add the Jellyfin service user to the above group to allow Jellyfin's FFMpeg process access to the device, and restart Jellyfin:
`sudo usermod -aG render jellyfin`
@ -107,7 +105,9 @@ To check information about VAAPI on your system install and run `vainfo`
4. Watch a movie, and verify that transcoding is occurring by watching the `ffmpeg-transcode-*.txt` logs under `/var/log/jellyfin` and using `radeontop` or similar tools.
### Hardware acceleration in a LXC/LXD container (tested with LXC 3.0, may or may not work with version 2)
### LXC or LXD Container
This has been tested with LXC 3.0 and may or may not work with older versions.
Follow the steps above to add the jellyfin user to the `video` or `render` group, depending on your circumstances.
@ -121,49 +121,53 @@ Follow the steps above to add the jellyfin user to the `video` or `render` group
`crw-rw---- 1 root video 226, 0 Jun 4 02:13 controlD64`
`crw-rw---- 1 root video 226, 128 Jun 4 02:13 renderD128`
3. Configure Jellyfin to use video acceleration, point it at the right device if the default option doesn't
3. Configure Jellyfin to use video acceleration, point it at the right device if the default option is wrong.
4. Try and play a video that requires transcoding and run the following, you should get a hit:
`$ ps aux | grep ffmpeg | grep accel`
`$ ps aux | grep ffmpeg | grep accel`
5. You can also try playing a video that requires transcoding, and if it plays you're good.
1. Add the Jellyfin service user to the video group to allow Jellyfin's FFMpeg process access to the encoder, and restart Jellyfin:
### Raspberry Pi3 and 4
1. Add the Jellyfin service user to the video group to allow Jellyfin's FFMpeg process access to the encoder, and restart Jellyfin.
`sudo usermod -aG video jellyfin`
`sudo systemctl restart jellyfin`
`sudo systemctl restart jellyfin`
On Rpi4, update the firmware and kernel.
`sudo rpi-update`
2. Choose `OpenMAX OMX` as the Hardware acceleration on the Transcoding tab of the Server Dashboard
3. Change the amount of memory allocated to the GPU, as the Pi's GPU can't handle accelerated decoding and encoding simultaneously:
`sudo rpi-update`
2. Choose `OpenMAX OMX` as the Hardware acceleration on the Transcoding tab of the Server Dashboard.
3. Change the amount of memory allocated to the GPU. The GPU can't handle accelerated decoding and encoding simultaneously.
`sudo nano /boot/config.txt`
For Rpi4, add the line `gpu_mem=320` [See more Here](https://www.raspberrypi.org/documentation/configuration/config-txt/)
For Rpi3, add the line `gpu_mem=256`
You can set any value, but 320 is recommended amount for [4K HEVC](https://github.com/CoreELEC/CoreELEC/blob/coreelec-9.2/projects/RPi/devices/RPi4/config/config.txt).
For RPi4, add the line `gpu_mem=320` [See more Here](https://www.raspberrypi.org/documentation/configuration/config-txt/)
For RPi3, add the line `gpu_mem=256`
You can set any value, but 320 is recommended amount for [4K HEVC](https://github.com/CoreELEC/CoreELEC/blob/coreelec-9.2/projects/RPi/devices/RPi4/config/config.txt).
Use `vcgencmd get_mem arm && vcgencmd get_mem gpu` to verify the split between CPU and GPU memory.
Note: Rpi4 currently doesn't support HWA decoding, only HWA encoding of H.264. [Active cooling](https://www.jeffgeerling.com/blog/2019/raspberry-pi-4-needs-fan-heres-why-and-how-you-can-add-one) is required, passive cooling is insufficient for transcoding. For Rpi3 in testing, transcoding was not working fast enough to run in real time because the video was being resized.
**Note:** RPi4 currently doesn't support HWA decoding, only HWA encoding of H.264. [Active cooling](https://www.jeffgeerling.com/blog/2019/raspberry-pi-4-needs-fan-heres-why-and-how-you-can-add-one) is required, passive cooling is insufficient for transcoding. For Rpi3 in testing, transcoding was not working fast enough to run in real time because the video was being resized.
### Verifying Transcodes
To verify that you are using the proper libraries, run this command against your transcoding log. This can be found at Admin Dashboard > Logs, and /var/log/jellyfin if instead via the repository.
The Jellyfin project and its contributors offer a number of pre-built binary packages to assist in getting Jellyfin up and running quickly on multiple systems.
Direct database migration from Emby (of any version) to Jellyfin is NOT SUPPORTED. We have found many subtle bugs due to the inconsistent database schemas that result from trying to do this, and strongly recommend that all Jellyfin users migrating from Emby start with a fresh database and library scan.
This document aims to provide an admin with knowledge on what ports Jellyfin binds and what purpose they serve.
### Static ports
### Static Ports
* 8096/tcp is used by default for HTTP traffic. This is admin configurable.
* 8920/tcp is used by default for HTTPS traffic. This is admin configurable.
* 1900/udp is used for service autodiscovery. This is _not_ admin configurable as it would break client autodiscover.
### Dynamic ports
### Dynamic Ports
* Completely random UDP port bind. It picks any UDP port that is unused on startup. It is used for specific LiveTV setups involving HD Homerun devices.
It's possible to run Jellyfin behind another server acting as a reverse proxy. With a reverse proxy setup, this server handles all network traffic and proxies it back to Jellyfin. This provides the benefits of using DNS names and not having to remember port numbers, as well as easier integration and management of SSL certificates.
Clients connect your devices to your Jellyfin server and let you view your content on any supported device. You can find a list of clients below with their current development status.
**Note**: Many clients were direct forks of the latest available codebases from Emby, and some are not functional yet. If you interested in helping out, please see our [contribution guide](xref:contrib-index).
**Note:** Many clients were direct forks of the latest available codebases from Emby, and some are not functional yet. If you interested in helping out, please see our [contribution guide](xref:contrib-index).
Do you have a client that interfaces with Jellyfin and want to see it listed here? Please [submit a PR](https://github.com/jellyfin/jellyfin-docs)!
@ -17,50 +17,50 @@ Do you have a client that interfaces with Jellyfin and want to see it listed her
The official Jellyfin Android app supporting Android 5+.
**Status:** ⭐ In Beta release
**Status:** ⭐ Active
**Links:**
<ahref='https://play.google.com/store/apps/details?id=org.jellyfin.mobile&utm_source=docs&pcampaignid=MKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'><imgalt='Get it on Google Play'src='https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png'width="200"/></a>
<ahref='https://play.google.com/store/apps/details?id=org.jellyfin.androidtv'><imgalt='Get it on Google Play'src='https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png'width="200"/></a>
<ahref='https://www.amazon.com/gp/aw/d/B07TX7Z725'><imgalt='Get it on the Amazon Appstore'src='https://images-na.ssl-images-amazon.com/images/G/01/mobile-apps/devportal2/res/images/amazon-appstore-badge-english-black.png'width="200"/></a>
1. Download the repository installer [here](https://repo.jellyfin.org/releases/client/kodi/repository.jellyfin.kodi.zip)
1. Download the repository installer [here](https://repo.jellyfin.org/releases/client/kodi/repository.jellyfin.kodi.zip).
* It will be saved as `repository.jellyfin.kodi.zip`
2. Install the Jellyfin repository
* Open Kodi and navigate to "Add-on Browser"
* Select "Install from zip file"
2. Install the Jellyfin repository.
* Open Kodi and navigate to "Add-On Browser"
* Select "Install from Zip File"
* If prompted, enter settings and enable "Unknown Sources", then go back
* Select the newly downloaded file and it will be installed
3. Install Jellyfin for Kodi
* From within Kodi, navigate back to "Add-on Browser"
* Select "Install from repository"
3. Install Jellyfin for Kodi.
* From within Kodi, navigate back to "Add-On Browser"
* Select "Install from Repository"
* Choose "Kodi Jellyfin Addons"
* "Video Add-ons"
* Select the Jellyfin add-on and choose install
4. Within a few seconds you should be prompted for your server-details.
* If a Jellyfin server is detected on your local network, it will displayed in the popup
* If a Jellyfin server is not detected on your local network, select "Manually add server"
* Note that if you have a baseurl set, you should append that value to the end of the host field. ie: `192.168.0.10:8096/jellyfin`
* Enter the server name or IP address and the port number (default is 8096)
4. Within a few seconds you should be prompted for your serverdetails.
* If a Jellyfin server is detected on your local network, it will displayed in a dialog
* If a Jellyfin server is not detected on your local network, select "Manually Add Server"
* Note that if you have a baseurl set, you should append that value to the end of the host field. (`192.168.0.10:8096/jellyfin`)
* Enter the server name or IP address and the port number (default value is 8096)
* Host: `192.168.1.10:8096`
* If using SSL and a reverse proxy, enter the full URL scheme in the "Host" field
* If using SSL and a reverse proxy, enter the URL in the "Host" field
* Host: `https://jellyfin.example.com`
* Select user account and input password
5. Once you're succesfully authenticated with the Jellyfin server, you'll be asked about your preferences for this device
5. Once you're succesfully authenticated with the server, you'll be asked about your preferences for this device.
* Choose your preferences for each options
* Add-On mode requires no additional configuration
* To get Native mode to work, a few things must be done before the files are accessible, so skipping the initial import is necessary, skip the below steps and continue with the **Native Mode Configuration** steps
* To get Native mode to work skipping the initial import is necessary, so stop here and skip to **Native Mode Configuration**
* Select "Proceed" to configure libraries
* Select the libraries you would like to keep synced with this device
6. The first sync of the Jellyfin server to the local Kodi database may take some time depending on your device speed and library size
7. Once the full sync is done, you can browse and play your media through Kodi, and syncs will be done periodically in the background
6. The first sync of the server to the local Kodi database may take some time depending on your device and library size.
7. Once the full sync is done you can browse and play your media through Kodi, and syncs will be done periodically in the background.
### Native Mode Configuration
@ -47,8 +48,8 @@ The benefit of Native mode over Add-On mode is that nothing will be transcoded,
4. Select your libraries to add in using the Jellyfin plugin's menu, proceed to import your library.
5. Your files should now be accessible in Kodi and function the same way as Add-On mode, if not, enable debug logging in the Jellyfin plugin in Kodi and if in a Unix-like OS, set the **log level** of Samba to 2 to see if there are issues authenticating.
**Note: It's recommended to install the `Kodi Sync Queue` plugin into the Jellyfin server as well**
**Note:** It's recommended to install the `Kodi Sync Queue` plugin into the Jellyfin server as well.
This will help keep your media libraries up to date without waiting for a periodic resync from Kodi.
**Note: Kodi's default skin does not display all unicode characters. To display unicode characters the skin's font must be changed**
**Note:** Kodi's default skin does not display all unicode characters. To display unicode characters the skin's font must be changed.
* The Git repository and non-C# files inside of it should use lowercase `jellyfin` for convenience on case-sensitive filesystems. `build-jellyfin.ps1`
* The final output binary, initscrips, and package names should use lowercase `jellyfin` for similar reasons as above. `jellyfin.dll`, `jellyfin_3.5.2-1_all.deb`, `jellyfin.zip`
* Configuration directories can use either, depending on operating system conventions. `/var/lib/jellyfin`, `AppData/Jellyfin`
* The logo may use either, depending on aesthetics and font choice.
* The logo has no strict rules for capitalization, the style is dependent on aesthetics and font choice.
## Jellyfin UX Repository
## Icons and Other Assets
All Jellyfin iconography and other resources can be found in the [jellyfin-ux repository](https://github.com/jellyfin/jellyfin-ux).
All iconography and other resources can be found in the [jellyfin-ux](https://github.com/jellyfin/jellyfin-ux) repository.
This repository contains:
* SVG files for icons
* SVG files for banners
* Icons
* Banners
* Fonts
## Jellyfin Colours
These are the colours used for the Jellyfin logos and other places throughout the interface.
### Logo Colours
### Logo
The design for the logo uses a gradient for the infill, and if the non transparent logo is chosen there is a background colour which is optional.
The design for the logo uses a gradient for the infill, and if the non-transparent logo is chosen there is an optional background color.
* Gradient Start: #AA5CC3
* Gradient End: #00A4DC
* Background Colour: #000B25
### Interface Colours
### Theme
* Background Colour: #101010
* Accent Colour: #00A4DC
## Jellyfin Fonts
### Fonts
The banner uses the font [Quicksand](https://fonts.google.com/specimen/Quicksand).
The banner uses the [Quicksand](https://fonts.google.com/specimen/Quicksand) font.
Thank you for your interest in contributing to the Jellyfin project! This page and its children desribe the ways you can contribute, as well as some of our policies. This should help guide you through your first Issue or PR.
Feature and enhancement requests should be directed towards [our Fider intance](https://features.jellyfin.org) for tracking, voting, and reporting. Please keep all feature requests to this page and not the GitHub issues.
If you are having trouble using or administrating Jellyfin, there are several ways to get help:
* The Jellyfin [Matrix channels](https://matrix.to/#/+jellyfin:matrix.org): For chat and real-time discussions.
* Some channels are bridged to IRC.
* The Jellyfin [forums](https://forum.jellyfin.org): For long-term discussions.
@ -30,6 +31,8 @@ We are also active on social media:
* <ahref="https://matrix.to/#/#jellyfin-offtopic:matrix.org"><imgalt="jellyfin-offtopic"src="https://img.shields.io/matrix/jellyfin-offtopic:matrix.org.svg?logo=matrix&label=jellyfin-offtopic"></a>: Chat about anything
## IRC Channels
Some channels are bridged from Matrix to freenode.net channels.
* [#jellyfin on freenode.net](ircs://chat.freenode.net:6697/#jellyfin) - [freenode Webchat](https://webchat.freenode.net/#jellyfin)
* [#jellyfin-dev on freenode.net](ircs://chat.freenode.net:6697/#jellyfin-dev) - [freenode Webchat](https://webchat.freenode.net/#jellyfin-dev)
@ -13,20 +13,20 @@ Jellyfin allows you to watch and record live television using supported hardware
Jellyfin has support for the following tuners:
* HDHomerun
* HDHomeRun
* M3U
HDHomerun is a special case because they will usually get detected automatically by the server. Otherwise you can manually add tuners by navigating to **Live TV** in the settings and adding one there.
HDHomeRun is a special case because they will usually get detected automatically by the server. Otherwise you can manually add tuners by navigating to **Live TV** in the settings and adding one there.
Note: Docker users using HDHomerun devices should set networking to host mode as Jellyfin needs to connect to a changing UDP port
**Note:** Docker users using HDHomeRun devices should set networking to host mode as Jellyfin needs to connect to a changing UDP port.
M3U allows you to add IPTV channel playlists which you can view and record in Jellyfin.
M3U allows you to add IPTV channel playlists which you can view and record.
Additional tuner types are available via plugins.
## Guide
Guide data will need to be mapped to their corresponding channels after a guide data provider is configured. The guide data formats below are included with the server:
Guide data will need to be mapped to their corresponding channels after a guide data provider is configured. The guide data formats below are included with the server:
Takes your tuners in TVHeadend and emulates a HDHomeRun, in order to connect to Jellyfin's Live TV and DVR features. It requires additional setup and configuration, but is a useful alternative to the TVHeadend plug-in.
Takes your tuners in TVHeadend and emulates a HDHomeRun, in order to connect to Jellyfin's Live TV and DVR features. It requires additional setup and configuration, but is a useful alternative to the TVHeadend plugin.
* Change parameters: Rights,Channel number range,Channel tags,DVR configurations,Streaming profiles,Connection limits
* Web interface: ✔
* Streaming: Basic,Advanced,HTSP *
* Video recoder: Basic,HTSP,View all *
* (optional) Comment: Comment for the user (for example: User used by Jellyfin)
* (optional) Allowed networks: *Network address with network mask to allow* (for example 127.0.0.1/32)
* Streaming: Basic,Advanced,HTSP
* Video recoder: Basic,HTSP,View all
* (Optional) Comment: Comment for the user (for example: User used by Jellyfin)
* (Optional) Allowed networks: *Network address with network mask to allow* (for example 127.0.0.1/32)
* Press Save
* Go to Configuration> Users> Passwords> Add
* Go to Configuration> Users> Passwords> Add
* Give the user parameters
* Enabled: ✔
* Username *The user created previously* (for example: Jellyfin)
* Password: *The password for the user created previously* (for example: Jellyfin_password)
* Press Save
**Notes:** The parameters Change parameters, Streaming and Video recoder must be marked as shown, because although Jellyfin can connect to Tvheadend, it can cause problems when reproducing the content.
**Note:** The parameters Change parameters, Streaming and Video recoder must be marked as shown. Otherwise, Jellyfin can connect to TVHeadend but problems may arise when reproducing the content.
2. Adjust the Jellyfin Tvheadend plugin to establish the connection
* Go to Dashboard> Plugins> TVHeadend> Settings
2. Adjust the Jellyfin TVHeadend plugin to establish the connection.
* Go to Dashboard> Plugins> TVHeadend> Settings
* Provide creator access data previously:
* TVHeadend Hostname or IP Address: *IP address of the Tvheadend server* (For example: 127.0.0.1) *
* TVHeadend Hostname or IP Address: *IP address of the TVHeadend server* (for example: 127.0.0.1)
* Username: *The user created previously* (for example: Jellyfin)
* Password: *The password created previously* (for example: Jellyfin_password)
**Notes:** By default the the *TVHeadend Hostname or IP Address* section is configured by default with the hostname *localhost*, it is preferable to use the IP address *127.0.0.1* instead of *localhost*. [Reference](https://emby.media/community/index.php?/topic/55768-tv-headend-plugin-where-does-it-store-data/)
**Note:** By default the the *TVHeadend Hostname or IP Address* section is configured by default with the hostname *localhost*, it is preferable to use the IP address *127.0.0.1* instead of *localhost*. [Reference](https://emby.media/community/index.php?/topic/55768-tv-headend-plugin-where-does-it-store-data/)
3. Configure the channels for viewing in Jellyfin: even if Jellyfin manages to connect to Tvheadend, the guide will not be synchronized because there has to be a number assigned to the channels in Tvheadend [Reference](https://emby.media/community/index.php?/topic/64583-no-channels-with-tvheadend-plugin/#ipboard_body)
* Go to Configuration> Channel/EPG> Channels
3. Configure the channels for viewing in Jellyfin: even if Jellyfin manages to connect to TVHeadend, the guide will not be synchronized because there has to be a number assigned to the channels in TVHeadend. [Reference](https://emby.media/community/index.php?/topic/64583-no-channels-with-tvheadend-plugin/#ipboard_body)
* Go to Configuration> Channel/EPG> Channels
* Select the channel to be changed and press Edit
* In the option Number we enter the number that we are going to assign to the channel (for example: 1)
* Press save
4. Update the data from the TVheadend guide to Jellyfin
* Go to Dashboard> Live TV
* Refresh Guide data
4. Update the data from the TVHeadend guide to Jellyfin
* Go to Dashboard> Live TV
* Refresh guide data
Once the update of the guide is finished, the Live TV will already be able to see the guide related to the synchronized channels and will be able to visualize the content.
@ -19,9 +19,10 @@ If your hardware supports this you can enable [hardware acceleration](xref:admin
This option will manually set the amount of threads to use when transcoding. If you're not using the server for anything else it's best to leave this option alone.
## Types of Transcoding
There are three types of transcoding. The type being used will be listed in the dashboard when playing a file. They are ordered below from lowest to highest load on the server:
* Direct Play - delivers file as-is with no modifications. Almost no additional load on the server.
* Remux - change container (repack) but leave both audio and video streams untouched.
* Direct stream - transcode audio, but leave original video untouched.
* Transcode - transcodes both audio and video.
* Direct Play - Delivers the file with no modifications. Almost no additional load on the server.
* Remux - Changes the container but leaves both audio and video streams untouched.
* Direct Stream - Transcodes audio but leaves original video untouched.
User management can be done under `Users` in the `Dashboard`. Here you can see your current users or add new ones. And manage your users' settings.
@ -12,21 +12,24 @@ User management can be done under `Users` in the `Dashboard`. Here you can see y
To add a new user, click the `+` symbol at the top of the page. This will open a new page where you can enter the user's name as it will be either displayed on, or has to be typed into login screen. By default, this will be displayed, but this can be changed at any point by modifying the user, explained further down.
#### Library Access
By default the `enables access to all libraries` option will be enabled, disabling this option will enable you to give the user access rights per library, libraries can consist of several folders. When adding new libraries any user that did not have access to `all libraries` will not receive the rights to open the new library, but this can be changed at any point by modifying the user, explained further down.
## Manage a User
To manage a user either click on their portrait to go straight to their `Profile` tab, or click the `...` symbol inside that user's portrait. The later will open a small submenu with the options `Open``Library access``Parental control`, and `delete`. Except for delete, which does the obvious, these options will lead to different tabs but are otherwise all on the same page. `Open` corresponds to the Profile tab, `Library access` to access, `Parental control` to Parental Control, and there is an additional fourth tab `Password` for Password control. Changes to any option on any of these tabs need to be saved using `Save` at the bottom of the page.
### Profile
Directly under the tabs you have a link to `Edit this user's profile, image and personal preferences.` Clicking that allows you to change the user's personal settings, any setting here can be changed by both user and admin.<!--These options are described [on their own docs page](https://linktopage?) (not written yet)-->
Directly under the tabs you have a link to `Edit this user's profile, image and personal preferences.` Clicking that allows you to change the user's personal settings, any setting here can be changed by both user and admin.
Under `name` you can change the user's name as it will be either displayed on, or has to be typed into login screen.
Under `Authentication Provider` you have the option to change the backend that handles the login, by default the only option here will be `default` which means Jellyfin will handle this user, this option is sufficient for most use cases. Currently, the only other possibility is to have a LDAP server handle the login by installing the LDAP-Auth plugin. Note that if you wish to change a user's provider to LDAP after creating it in Jellyfin the username needs to be identical to the user's UID in LDAP, including capitalization.
`Allow remote connections to this Jellyfin Server.` Unchecking this option will block login attempts this user makes from outside the networks defined as local, by default this will only be the subnet assigned to your network. But more can be added.<!-- More information about this can be found [on the docs page for `Expert` » `Advanced`](https://linktopage?) (not written yet)-->
`Allow remote connections to this Jellyfin Server.` Unchecking this option will block login attempts this user makes from outside the networks defined as local, by default this will only be the subnet assigned to your network. But more can be added.
#### Feature Access
For the following options it should be noted that if you never set up Live TV, users are blocked regardless of the state. See [the docs page for `Live TV` » `Live TV`](xref:server-live-tv-index) for more information.
`Allow Live TV access` Unchecking this option will block the user's access to watch Live TV.
@ -34,10 +37,11 @@ For the following options it should be noted that if you never set up Live TV, u
`Allow Live TV recording management` Unchecking this option will block the user's access to set recording schedules.
#### Media Playback
`Allow media playback` Unchecking this option will block the user's access to media libraries, this does not include Live TV.
> [!NOTE]
> More information about transcoding can be found on it's own page - [Transcoding](xref:server-transcoding).
> More information about transcoding can be found [here](xref:server-transcoding).
`Allow audio/video playback that requires transcoding` Unchecking this option will block the user's access to video playback that requires transcoding.
@ -46,9 +50,11 @@ For the following options it should be noted that if you never set up Live TV, u
`Internet streaming bitrate limit (Mbps)` Under this option you can set an per stream bitrate limit for all out of network devices.
#### Allow Media Deletion From
These checkboxes allow a user to remove media for either `All libraries`, or per Library. Be careful when enabling these as some plugins enable automatic removal of media after watching.
#### Remote Control
These allow a user to control other devices that are currently logged into Jellyfin, for example if you run a separate client on a HTPC without remote control.
`Allow remote control of other users` Allows this user to control what other users are playing and send messages, but does not give them administrative rights.
@ -56,9 +62,11 @@ These allow a user to control other devices that are currently logged into Jelly
`Allow remote control of shared devices` Allows this user to control unclaimed DLNA devices, and devices they are logged in to at the moment.
#### Download & Sync
These allow a user to download media. Syncing and Transcoding are currently not available.
#### Additional options
`Allow media conversion` This option is currently not available.
`Allow social media sharing` Allows this user to share the url to web pages containing media information, for example when viewing information about a movie, series, season, or episode.
@ -70,6 +78,7 @@ These allow a user to download media. Syncing and Transcoding are currently not
`Failed login attempts before user is locked out` Determines how many incorrect login attempts can be made before lockout occurs, disabling the user. 0 means inheriting the default of 3 for non-admin and 5 for admin, -1 disables lockout
### Library Access
These options allow you to restrict access to libraries, or from devices.
`Enable access to all libraries` By default the `Enable access to all libraries` option will be enabled, disabling this option will enable you to give the user access rights per library, libraries can consist of several folders. When adding new libraries any user that did not have access to `all libraries` will not receive the rights to open the new library.
@ -77,6 +86,7 @@ These options allow you to restrict access to libraries, or from devices.
`Enable access from all devices` By default the `Enable access from all devices` option will be enabled, disabling this option will enable you to give the user access rights per device and logins from new devices are blocked until they've been approved here.
### Parental Control
These options allow you to restrict access to specific content by this user or the timeframe in which they may access. Content that matches these restrictions will be hidden, while the timeframe effectively disables the user.
`Maximum allowed parental rating` Allows you to select the highest rating __allowed to show up__ for this user.
@ -88,12 +98,12 @@ These options allow you to restrict access to specific content by this user or t
`Access Schedule` Allows you to set the timeframe(s) where this user is allowed to login, media can only play during the timeframe and will be stopped past it.
### Password
Allows you to set or change the user's password. Note that users can change their own passwords in their personal settings.<!--These options are described [on their own docs page](https://linktopage?) (not written yet) -->
Allows you to set or change the user's password. Note that users can change their own passwords in their personal settings.
`Reset Password` will allow the user to log in without giving a password.
If the user has a password, additional options are shown.
`Easy Pin Code` The user's easy pin code is used for offline access with supported Jellyfin apps, and can also be used for easy in-network sign in.
`Easy Pin Code` The user's easy pin code is used for offline access with supported clients, and can also be used for easy in-network sign in.
`Enable in-network sign in with my easy pin code` If enabled, the user will be able to use their easy pin code to sign in to Jellyfin apps from inside the local network. Their regular password will only be needed outside the local network. If the pin code is left blank, they won't need a password within the local network. By default, the local network will only be the subnet assigned to your network, but more can be added. <!--More information about this can be found [on the docs page for `Expert` » `Advanced`](https://linktopage?) (not written yet)-->
<ahref="https://forum.jellyfin.org"/><imgclass="badge"alt="Discuss on our Forum"src="https://img.shields.io/discourse/https/forum.jellyfin.org/users.svg"/></a>
<ahref="https://matrix.to/#/+jellyfin:matrix.org"><imgclass="badge"alt="Chat on Matrix"src="https://img.shields.io/matrix/jellyfin:matrix.org.svg?logo=matrix"/></a>
dkanada
3 years ago