{
  "articles/3D-Videos.html": {
    "href": "articles/3D-Videos.html",
    "title": "3D Video Naming | Emby Documentation",
    "keywords": "3D Video Naming There are multiple ways to identify a video as 3D. Identify using the web interface A video can be identified as 3D using the the metadata manager . Simply edit a video: Then select the 3D format: Identify using video file name flags In order to properly detect 3D, two tags need to be present in the filename. First, a '3D' tag has to be present. Second, one of the following must also be present, hsbs, fsbs, sbs, htab, ftab, or mvc. Tags need be be surrounded be either a space ( ), hyphen -, dot . or underscore _. Tags are case-insensitive, so both 3d and 3D will work. Examples: moviename (year).3d.hsbs.mkv moviename (year) 3d sbs.mkv moviename (year).3D-HTAB.mkv moviename (year)-3D.sbs-720p.mkv moviename (year)-3D.mvc.mkv Identify using older conventions Older file naming conventions are still accepted by placing one of the following tags within the filename: [fsbs] [ftab] [hsbs] [htab] [3d] - Indicates half side by side [sbs3d] - Indicates half side by side For example: /Movies /300 (2006) 300 (2006) [hsbs].mkv /Home Alone (1990) Home Alone (1990) [fsbs].mkv Multiple Versions 3D can even be combined with the multi-version video support discussed in the Movie Naming article. Here's an example of a movie containing multiple versions in a single movie folder, some 3D and others 2D: /Movies /300 (2006) /300 (2006) - 1080p.mkv /300 (2006) - 720p.mp4 /300 (2006) - 3d-hsbs.mp4 /300 (2006) - 3d.hsbs.mp4 /300 (2006) - 3d.mvc.mp4 Note There is a limit on the number of different versions for a media item. Up to 8 different versions will appear in any list of media item versions."
  },
  "articles/Admin-Password-Reset.html": {
    "href": "articles/Admin-Password-Reset.html",
    "title": "Admin Password Reset | Emby Documentation",
    "keywords": "Admin Password Reset To reset the password of the system administrator there is a special process to follow. If you have multiple admins setup on your system you can have another admin account reset your password just as they would any other user. If this is the only admin account on the system this will be the method used to reset the master password follow these instructions. You will need access to the file system of the server itself as a special file is written with instructions. This prevents a 3rd party from gaining access to your Emby Setup as only the admin of the system should have access to this. From a web browser open your local server address which could be http://localhost:8096 but do NOT use Emby Connect. From the above choices click on the Forget Password choice. Fill in the account name you use to login to Emby with. In the following the account used is \"admin\". Click the Submit button after entering your admin account name. You will now get a popup message that includes the location to a file on the system you will need to open. The contents of the file will be different but similar to this: All that's needed for you to do now is open the new URL, enter the 4 digit code and then follow the prompts to reset your password. It's a rather simple process but requires access to the file system to make sure only privileged users can perform the reset."
  },
  "articles/Advanced-Menu.html": {
    "href": "articles/Advanced-Menu.html",
    "title": "Connecting from Client Apps (obsolete) | Emby Documentation",
    "keywords": "Connecting from Client Apps (obsolete) This document has been superseded by Connecting from Client Apps"
  },
  "articles/advisory-23-05.html": {
    "href": "articles/advisory-23-05.html",
    "title": "Emby Server does not start - Security advisory 2023-05-25 | Emby Documentation",
    "keywords": "Emby Server does not start - Security advisory 2023-05-25 Applicability This article applies to cases where you are experiencing one or more of the following symptoms: Your Emby Server has shut itself down and/or does not start anymore since 2023-05-25 You encounter the following message in the Emby Server log: We have detected a malicious plugin on your system which has probably been installed without your knowledge. Please see https://streamora.example/support/articles/advisory-23-05.html for more information on how to proceed. For your safety we have shutdown your Emby Server as a precautionary measure Note: Your server was never directly accessed by us. We used our standard update mechanism On Windows installs, you encounter an error entry in the Windows event log, Source=\".NET Runtime\", EventId=1025 with the same text as above in the event details Background Starting Mid-May 2023, a hacker managed to infiltrate private user-hosted instances of Emby Server which were accessible via public internet and had an insecure configuration for administrative user accounts. Combined with the \"Proxy Header Vulnerability\", which was recently fixed in the beta channel, this allowed an attacker to gain administrative access on such systems. Eventually, this allowed the attackers to install a custom plugin of their own, which establishes a backdoor in the running process of Emby Server. After careful analysis and evaluation of possible strategies for mitigation, the Emby team was able to push out an update to Emby Server instances which is able to detect the plugin in question and prevents it from being loaded. Due to the severity and the nature of this situation and in an abundance of caution we are preventing affected servers to start up again after the detection. As the given situation requires direct action and assessment by the administrator, we determined that shutting down the server and preventing further startup up is the most suitable action as it disables the plug-in, possibly prevents the situation from getting worse and at the same time draws the attention of the administrator onto the subject. Analysis of the plug-in has revealed that it is forwarding the private Emby Server login credentials including the password for every successful login to an external server under control of the hackers. Actions to Take Add an entry to your server machine etc/hosts file: emmm.spxaebjhxtmddsri.xyz 127.0.0.1 This is the host name of the control server which the malware is communicating with For help on this, please see https://linuxize.com/post/how-to-edit-your-hosts-file/ Review your server machine for: Suspicious user accounts Unknown processes Unknown network connections and open ports SSH configuration Firewall rules Change all passwords Starting Emby Server After (and only after) you have done the above: Disable external network access Go to the following folder under the Emby Server Data Folder : plugins/configurations Find the file named ReadyState.xml and delete it. Find the file named 'EmbyScripterX.xml' and delete it (if exists) Delete the plugin .dll file(s), which comes as helper.dll and/or EmbyHelper.dll . The primary location of these is the plugins folder under the Emby Server Data Folder Start Emby Server Assign new passwords to all of your Emby Server users Don't allow local login without password Ensure no user has an empty password Re-Enable public network access Consider changing IP address, port, or DNS name (whatever applicable) Note If possible, it would be great when you could send us the malware dll file so we can analyze to see whether different versions exist. Please send the file via private message in the forums to softworkz . Install Emby Server 4.7.12 Security Update Watch out for this update and install as soon as it becomes available unless you are already running Emby beta 4.8.0.31+ which also has the necessary fixes"
  },
  "articles/Alexa.html": {
    "href": "articles/Alexa.html",
    "title": "Amazon Alexa | Emby Documentation",
    "keywords": "Amazon Alexa . What is Alexa? Amazon Alexa is a cloud-based voice service that allows you to retrieve information via voice as well as control device and apps in your Environment including Emby. You can ask Alexa to play music, hear the news, check weather, control your smart home, and more. The Emby Skill enables users to get information about and control playback of their media library on any Emby compatible device. Once you have successfully linked your Emby account to Alexa, you can start playing your favorite movies, TV shows on your devices with your voice. Get started The first step is to make sure your Emby Server is setup for remote use and has Emby Premiere.. Since Alexa is a cloud based service it will need access to your Emby server from the Internet. Please follow our instructions for setting up Remote Access. At this point please make sure you've already setup your Alexa device following Amazon directions and verify it works for general Alexa use. You can now setup an Emby Skill to work with Alexa. You do this by opening the Amazon Amazon Alexa app or the Amazon Alexa web app, navigate to the following: Skills > Your Skills > Emby > Link Account Click on the Emby Skill Now Click the Button top right to ENABLE the skill. Type in your Emby Connect username you created prior to this as well as your password and click the SIGN IN button. You can now control what Emby server to control. If you only have one server it will be the only choice. Select your server and click the LINK TO ALEXA button. You should receive a confirmation screen showing successful linking of your Emby Connect username to Alexa. You can do a similar setup from your iOS or Android device running the Alexa app (mobile screen shot) If you experience any problems please review the information above and if you still have an issue please seek support on our forums and the following location: https://streamora.example/community/index.php?/forum/174-amazon-alexa/ Training Alexa Alexa may have difficulty understanding the word Emby at first. There are ways to improve this situation. English US only If Alexa is set to English US, you have access to voice training. Using this, Alexa will start understanding you instead of guessing what you said. In the Amazon Alexa app or the Amazon Alexa web app, navigate to the following: Settings > Under Accounts > Voice training Every languages The Amazon Alexa app offers feedback cards for skills. This allows Alexa to self-correct, by marking these cards positively or negatively depending on if Alexa understood you or not. In the Amazon Alexa app or the Amazon Alexa web app, navigate to the either: Home > Cards regarding Emby > More > Did Alexa understand you? Settings > General > History > Did Alexa do what you wanted? Commands How to use Alexa Every command needs to start with: Alexa, tell/ask m. b. home -to [insert command] Alternatively, you can start an Emby session with: Alexa, - start/begin/open m. b. home The benefit of using an Emby session is it allows you to give multiple commands without needing to invoke Emby for as long as the session is active. Sessions are automatically terminated after 8 seconds of inactivity (when the blue ring of your Alexa device fades). You can stop whatever Alexa is doing with: Alexa, cancel/ never-mind . Alexa will also abandon your request if you don't reply within 8 seconds Not all commands are compatible with every Emby apps. If you encounter an issue, post here To direct a command to a specific player, append on another player or on [player name] to the end of your command Here is the list of supported media types: episode, movie, show, season, song, album, artist, audiobook, channel, playlist Parts of commands in parenthesis given below are optional Using Alexa as a player Audio playback is supported at this time. This feature requires your server to be secured with ssl encryption. Refer to this guide if you need help. Self-signed certificates are not supported for this. Ask m. b. home to play music. Specify \"on this player\" or \"on Alexa\" at the end of your request to skip the player selection. Once music playback is initiated with the skill, you can use these controls (notice you don't invoke m. b. home): Alexa, Next Alexa, Previous Alexa, Pause Alexa, Resume Alexa, start over Alexa, loop (This is to repeat the currently playing item. Loop off to turn off) Which player? You can set a player as default. If a device/player name is not included at the end of your command, it will be automatically directed at your default player. change the player (to {player or device name}) change my player to Living Room TV Which Emby user? By default, the skill will use the same Emby user used to link Alexa to Emby. But it can be changed with the following: who is the active user change the user (to {Emby username}) Additional users Share the watch status of currently playing content by adding other Emby users to your session. who is in the session add {user name} to my session remove {username} (and {username 2}) from my session Navigation You can navigate your interface by saying the movement or action related to what you want to do. move up/down/left/right page up/down select mute/unmute go home go to the next/previous letter show/display/bring up the context menu/TV guide/search/player menu (osd)/settings Playback pause, previous, next, play (the selected content), stop or - stop playback set the volume (to {percent}) change the audio (to {language}) change/enable/disable subtitles change the subtitles (to {language}) seek to {time} or start from the beginning seek to (plus/minus) {time} jump to chapter {number} go to the next/previous chapter Media Playback By default, Alexa is set to search video content when the content type is not specified. This means, for any other types, you need to include the content type to yield proper results. play (the movie) {movie} player (the show) {series} resume the episode from {series} play the artist {Artist} play the song {song} (from {Album}, by {Artist}) play the audiobook {title} tune in channel {name} Here are a few examples put on season 2 of Game of Thrones play Supernatural, season 5, episode 12 play the new episode of Gotham watch the next episode of Orange is the new black Suggestions Reply to the suggestion with a yes or a no. give me a suggestion suggest me a ({genre}) {content type, i.e. movie} I don't know what ({episode}) to watch what's good? Play random content play something play a movie (genre {Genre}) play an episode of {series} play a few episodes play next up Play random music drop the beat put on some music (genre {Genre}) play songs (genre {Genre}) play songs by {Artist} play songs from the album {Album} Recently added what's new what's been recently added? what {content type, i.e. movie} is newly added Next Up what's next what is up next Continue playing what can I keep watching? what (show/movie/audio book) was I in the middle of? Item modification remove {title} from my favorites add ({content type, i.e. movie}) {title} to my favorites I love the {media type, i.e. music video} {music video} set/mark {media type, i.e. movie} {title} as watched/unwatched Transfer or Copy playback between devices Transfer will stop playback first. Copy will simply resume playback where you left off, on the device of your choice. By default, it will fill in the missing information with your default player. transfer/copy the stream/playback (from {player}) (to {player}) switch/copy the stream/playback (to {player}) (from {player}) For example Transfer the playback from chrome to theater. Copy playback to iphone. omitting the origin of the playback will automatically grab it from your default player Help If you are ever uncertain what commands the player supports, ask Emby for: the available commands help Change your Emby connect account You can easily replace the Emby connect account linked to Alexa. First, you will need to disable the Emby skill. Then, once re-enabled, go though the account linking process again as show above."
  },
  "articles/Android-File-Storage.html": {
    "href": "articles/Android-File-Storage.html",
    "title": "Android TV Storage Attachment | Emby Documentation",
    "keywords": "Android TV Storage Attachment Before starting the attachment process please make sure any NAS or File Server you will be attaching to is named using all CAPS. If not the android device will not be able to access your files. This is a critical step needed before continuing. The steps needed on Android TV to attach network storage involve clicking the gear icon on the Android TV homepage. This will bring up the SETTINGS page. Scroll down to Device Preferences and click it. Now scroll down to Storage and click on that. Scroll down to Mount network storage and click on that. You will now see servers and NAS boxes that have been setup on your network with shared folders. In this example we'll be using the EMBYSERVER machine. Scroll down to the proper server on your network and click on it. You will now select the Connect as a registered user choice and click it. Not shown will be two follow up screens that require you to enter a valid username and a valid password that you have setup on the server. Once completed you should have a screen similar to this. This shows that the server is Connected and is ready for use."
  },
  "articles/Android-Mobile.html": {
    "href": "articles/Android-Mobile.html",
    "title": "Android Mobile | Emby Documentation",
    "keywords": "Android Mobile Emby for Android Mobile is available in multiple ways: Amazon App Store Google Play Store APK Download Emby for Android Mobile can handle just about any type of media thanks to Emby Server transcoding . If you would like to learn how to prepare your media for Direct Play, read below. Setup Guide Install the app using one of the above methods, then use the startup wizard to connect to your Emby Server. Direct Play Media Formats Video — m4v,3gp,mov,xvid,vob,mkv,wmv,asf,ogm,ogv,m2v,avi,mpg,mpeg,mp4,webm Subtitles - srt,vobsub,pgs,ssa,ass,sub,vtt Audio – aac,mp3,mpa,wav,wma,mp2,ogg,oga,webma,ape,opus,flac Best Practices for Direct Play Ensure your media meets the above criteria. Leave the app's streaming bitrate setting on the default value of Auto, if possible. The app will perform bandwidth tests with your Emby Server to determine the maximum playable bitrate. If you are customizing the bitrate setting, then you will need to compare the bitrate of your files to the bitrate setting in the app. You can find the bitrate of a file by checking the media info in the web interface. If the bitrate of a file is higher than the setting in the app, transcoding will be required. Increasing the bitrate setting in the app can help reduce transcoding, but may impact playback performance if your network connection is not fast enough to handle it. Chromecast The app supports casting to Chromecast devices. To connect to your Chromecast device, simply click the cast icon in the top right corner of the app. You'll then be asked which device you'd like to connect to. Once connected, any content you play will be sent to the Chromecast device. You're able to play individual files, entire folders, shuffle, instant mix, queue, and more. For more information, see Chromecast ."
  },
  "articles/Android-TV.html": {
    "href": "articles/Android-TV.html",
    "title": "Android TV | Emby Documentation",
    "keywords": "Android TV Requires Android TV 5.1 on higher OS. Emby for Android TV can be installed from the App store on your Android TV device (Google Nexus Player, Nvidia Shield, Sony Android TV, etc.) or you can push it to your device from the Google Play Store . Emby for Android TV can handle just about any type of media thanks to Emby Server transcoding. If you would like to learn how to prepare your media for Direct Play, read below. Setup Guide Install the app using one of the above methods, the app will then automatically find your local Emby Server(s). If it cannot find your server or you are attempting to connect to a remote server, the app will present you with options to connect manually or use Emby Connect. Direct Play Media Formats Video — m4v,mov,xvid,vob,mkv,wmv,asf,ogm,ogv,mp4,webm Note: The exact containers and codecs that will direct play depends on both the device the app is on and the audio equipment it is connected to (and the type of connection - e.g. HDMI, optical, etc.). The device with the widest support is the NVidia Shield. Subtitles - srt,ssa,ass,sub,vtt,pgs Audio – aac,mp3,mpa,wav,mp2,ogg,oga,webma,ape,opus,ac3 (Dolby Digital), DTS, DTS-HD MA, TrueHD Dolby Digital and DTS direct play requires Android version 6.0+ DTS HD and TrueHD require compatible hardware (Nvidia Shield) Best Practices for Direct Play Ensure your media meets the above criteria. Leave the app's streaming bitrate setting on the default value of Auto, if possible. The app will perform bandwidth tests with your Emby Server to determine the maximum playable bitrate. If you are customizing the bitrate setting, then you will need to compare the bitrate of your files to the bitrate setting in the app. You can find the bitrate of a file by checking the media info in the web interface. If the bitrate of a file is higher than the setting in the app, transcoding will be required. Increasing the bitrate setting in the app can help reduce transcoding, but may impact playback performance if your network connection is not fast enough to handle it."
  },
  "articles/Apple-TV.html": {
    "href": "articles/Apple-TV.html",
    "title": "Apple TV | Emby Documentation",
    "keywords": "Apple TV Emby for Apple TV can be installed from the App store on your 4th generation Apple TV device. Emby for Apple TV can handle just about any type of media thanks to Emby Server transcoding. If you would like to learn how to prepare your media for Direct Play, read below. Setup Guide Install the app using the store on your Apple TV, the app will then automatically find your local Emby Server(s). If it cannot find your server or you are attempting to connect to a remote server, the app will present you with options to connect manually or use Emby Connect. Direct Play Media Formats Video — h.264,h.265 (hevc) in m4v,mp4,mov container Subtitles - srt,ssa,ass,sub,vtt Audio – aac,ac3 (Dolby Digital),mp3 Best Practices for Direct Play Ensure your media meets the above criteria. Tip If using h.265 make sure your videos are tagged as hcv1 and not as hev1."
  },
  "articles/apps/linux/Emby-Linux.html": {
    "href": "articles/apps/linux/Emby-Linux.html",
    "title": "Emby Linux | Emby Documentation",
    "keywords": "Emby Linux Warning The information in this document is about a pre-release application. All the provided details are subject to being changed without notice. We're excited to provide an all-new Emby Linux app, built to deliver the best possible media playback experience on Linux desktops. Goals of the native Linux App While the Emby web app works well across platforms, there are limits to what a browser-based player can achieve, especially when it comes to modern video and audio playback. Browsers continue to improve, but they inevitably lag behind native applications when it comes to advanced video technologies, hardware acceleration, and reliable fullscreen playback. Emby users expect smooth, high-quality playback — and delivering that consistently requires a native application. Benefits Over the Web Player The new Linux app provides several advantages over watching through a browser: More reliable video playback with fewer browser-related limitations Better performance and lower system overhead Improved fullscreen behavior across Linux desktop environments Direct integration with native video playback technologies A cleaner, distraction free viewing experience By separating video playback from the browser entirely, the app is able to take full advantage of the system and deliver a smoother experience. Download and Installation Emby Linux is currently in beta. There is no stable version available yet. Please see Emby Linux Beta Program ."
  },
  "articles/apps/linux/Emby-Linux-Beta-Program.html": {
    "href": "articles/apps/linux/Emby-Linux-Beta-Program.html",
    "title": "Emby Linux: Beta Program | Emby Documentation",
    "keywords": "Emby Linux: Beta Program About this Program Specification Program Status Active Program Mode Periodic Communication Public Enrollment Method None Platform Support To see which platforms are currently supported, please see Emby Linux Platform Support . Delivery of Beta Builds Native Platform Packages The app is currently available in the form of native platform packages: DEB Ubuntu, Debian, Linux Mint RPM OpenSUSE, Manjaro, Fedora PAC Arch Linux, Steam OS Easy Installation The most easy way to install is by using the new Emby Universal Installer New Linux Package Repositories The installer is automatically setting up the new Emby Package repository. For more information and manual setup, please see Emby Package Repository . Other Package Formats We are planning to make the Linux app available in additional package formats during the course of the beta: AppImage coming soon Snap depending on user demand Flatpack depending on user demand Commandline Flags Please see Emby Linux: Commandline Flags Beta Communication All communication goes through the following forum in the Testing Area: https://streamora.example/community/index.php?/forum/188-linux-beta/ Past Beta Programs Specification Period Oct 2024 - Dec 2025 Program Status Ended Program Mode On-Demand Communication Private Enrollment Method Registration Enrollment Status Closed"
  },
  "articles/apps/linux/Emby-Linux-FAQ.html": {
    "href": "articles/apps/linux/Emby-Linux-FAQ.html",
    "title": "Emby Linux FAQ | Emby Documentation",
    "keywords": "Emby Linux FAQ Warning The information in this document is about a pre-release application. All the provided details are subject to being changed without notice. Where can I find the log files? There are two ways: From within the application Go to settings: On the home view, click on the gear icon at the right top In the navigation menu, choose \"About\" This is usually the topmost item. If you are admin of the Emby Server, you might see the server dashboard first and the section with the About entry needs to be expanded first On the About page, switch to the \"Log Files\" tab Click on one of the log files From the file system You can find the log files in the following directory ~/.config/Emby Client Beta/cache/logs NOTE: This location may change during the beta or later I'm experiencing stuttering video playback, what can I do? First of all, make sure you haven't chosen \"High Quality\" under Video Player settings >> Video Quality . Also, don't use \"Customize\" but try both the \"Balanced\" and the \"Efficiency\" presets. Then, use appropriate Linux tools for checking CPU and GPU usage. Look at the Media Info on the item detail screen at the bottom and check whether the video has a high bitrate (> 20,000 Mbps). Open Stats for Nerds and see whether it's DirectPlay or Transcoding. Check your monitor configuration to see whether it runs at a high refresh rate. On the video quality settings page there are multiple presets. How can I know which settings are applied by each preset? You can see the detail options applied by a preset by selecting one of the presets first and switching to Customize directly after. Switching to Customize keeps the values of the previously selected preset. This allows you to see how options are set by each preset. I am changing the subtitle style settings, but it doesn't seem that they have any effect. There can be multiple reasons for this: The subtitles are \"graphic\" subtitles. The appearance of those cannot be changed. Typical subtitle formats using bitmaps are: DVDSub DVBSub, PGS/HDMV Subtitles The subtitles are SSA/ASS subtitles Those subtitles have built-in styling which cannot be overridden I have selected the High Quality preset in the video quality options, why doesn't it use hardware acceleration? Short: While it does not perform hardware decoding and filtering, everything at the video presentation side (rendering on screen) is done by GPU shaders. This includes scaling, tone mapping and possibly subtitle overlay. Long: On the decoding side, sw decoding can provide better quality, also you get the best deinterlacing by sw implementations, other filtering (e.g. dynamic bounds detection) works only with sw filtering. The best scaling is achieved by using GPU shaders (which happens at the end of the chain). When doing sw filtering and scaling only at the end, then there's no advantage in using hw decoding. The computational effort weighs less than the data transfer between CPU and GPU memory. Actually, hw decoding is generally a bit overestimated. CPUs can do that easily as well. The main advantage of hw decoding is the avoidance of data transfer between GPU and CPU mem, when further processing happens in GPU memory. But hw decoding and just downloading it back to CPU memory right after it, is worse than doing CPU decoding using CPU memory right away. That's why there's no hw decoding in case of the high-quality mode. This mode is for achieving the best quality without compromise and without caring about efficiency and energy consumption. But this doesn't mean that the GPU isn't used: it's used for tone mapping and scaling and there are some scaling modes to choose which can get your GPU really hot. The energy efficient mode entirely disables the shader-based scaling and does the scaling in hardware (which is deemed to be of lower quality than shader-based scaling), and also maintains a full hardware processing pipeline (never does copying between GPU and CPU). In balanced mode, sw filtering is being used as well as shader-based scaling, but it uses hw decoding and in certain cases (when the video is much larger than the resolution of the current display) it downscales in hardware to reduce the amount of data while the eventual scaling is still done by GPU shaders (but at less load because of smaller video frames to scale)."
  },
  "articles/apps/linux/Emby-Linux-Flags.html": {
    "href": "articles/apps/linux/Emby-Linux-Flags.html",
    "title": "Emby Linux: Commandline Flags | Emby Documentation",
    "keywords": "Emby Linux: Commandline Flags Warning The information in this document is about a pre-release application. All the provided details are subject to being changed without notice. The commandline flags documented below might be useful to fix certain issues you may encounter when testing. IMPORTANT: In case you are encounter an issue which can be fixed by applying one of those flags, please let use know about it, as the intention is having everything to be working right out-of-the-box, without needing to apply any flags. How to use In a terminal window, navigate to the install location of the Emby Linux app. In most cases, this will be /opt/Emby-Beta . The executable is named Emby . Example cd /opt/Emby-Beta ./Emby -nompv Available Flags nompv Disables playback via MPV player in a separate window and switches Emby Linux to use the HTML video player instead. ./Emby -nompv persistplayer In case you experience player crashes, specifically after the first or when starting a 2nd playback, this flag may help. It loads the player once and keeps it loaded until application exit. ./Emby -persistplayer nojokermode Keeps the video window visible all the time. Only useful for diagnosing. ./Emby -nojokermode nossinhibitor Disables automatic inhibition of screensavers or sleep mode during playback. Use case is diagnosing errors during playback (ruling out the screen-saver inhibition). ./Emby -nossinhibitor usenormalwindow Changes the type of the video window. Should only be used when instructed to. ./Emby -usenormalwindow stack1, stack2, stack3, stack4, The application uses different ways for window stacking (z-order). If you encounter issues with incorrect stacking you can try all the available modes. Example: ./Emby -stack2 mini1, mini2, mini3, mini4, The application uses different ways for handling the video window on minimize and unminimize. If you encounter issues with incorrect minimize behaviour you can try all the available modes. Example: ./Emby -mini3"
  },
  "articles/apps/linux/Emby-Linux-Platform-Support.html": {
    "href": "articles/apps/linux/Emby-Linux-Platform-Support.html",
    "title": "Emby Linux: Platform Support | Emby Documentation",
    "keywords": "Emby Linux: Platform Support Warning The information in this document is about a pre-release application. All the provided details are subject to being changed without notice. Introduction The Linux ecosystem is highly heterogeneous - not only because of the wide variety of distributions, but even more because of Desktop Environments, different distro + DE combinations, and the choice of display server (X11 vs. Wayland). For the Emby Client application, it is not feasible for us to support all of these variations in a reasonable and sustainable way. We have to make clear cuts between what is manageable and what is not. This article explains our goals and current scope: which hardware and software environments we are targeting to run the Emby Client app for Linux reliably. DISCLAIMER This document is an informational description of our current testing focus and intended support boundaries. It is not a contract, a warranty, or a legally binding promise of support. \"Supported\" in this context means that we actively test and prioritize the listed environments. It does not guarantee that the application will be free of defects, compatible with every configuration, or suitable for every use case. Linux systems can differ significantly even within the same distribution and version (kernel versions, Mesa/NVIDIA driver versions, compositor behavior, audio stack, sandboxing, packaging differences, and third-party modifications). Because of that, issues may occur even on supported targets, and behavior may change with updates to the OS, drivers, or desktop environment. Our support focus may change over time. We may add, move, or remove targets between tiers, change minimum versions, or revise limitations based on development priorities, available test coverage, and real-world feedback. For pre-release software, these changes can happen without notice. For environments listed as Unsupported, we may decline investigations, troubleshooting, or implementation work - even if the application happens to run. For environments listed as Extended Tier, we will generally try to help, but fixes are best-effort and may be deprioritized or declined if the effort is disproportionate or the root cause lies outside our control (e.g., upstream bugs, driver limitations, or platform behavior). Support Levels This document introduces the following three support levels for categorization further down: Primary Tier Extended Tier Unsupported Primary Tier These are the environments that are used in development and on whch the software is regularly tested. We are aiming to have the Emby client application working continuously in a stable and reliable way. Fixing issues and bugs on these targets will always be given priority over other targets (like from the Extended Tier) Extended Tier Environments from the extended tier are outside of the core focus. We are trying to get the Emby client app working on these, but rather on a best-effort basis. If it turns out that fixing or addressing a specific issue would require an unusually high amount of work, we may choose not to implement it. Unsupported Unsupported means that it may work or may not work, but users are on their own. We will not perform any kind of work nor discuss or answer any questions about it, other than stating that it's not supported. Support Declarations Linux Distributions and Versions Primary Tier Ubuntu 22.04, 24.04, 25.10 and later Debian 11, 12, 13 and later Extended Tier Arch Linux Current (rolling) Fedora 42, 43 and later Linux Mint 22, 22.1, 22.2 and later OpenSUSE Tumbleweed Current (rolling) Manjaro Current (rolling) SteamOS 3.7.x and later Game Mode is unsupported! Notes Any distro not in this list is unsupported. Desktop Environments Primary Tier KDE Plasma Gnome XFCE Extended Tier Cinnamon Mate LXQt Notes Any DE not in this list is unsupported. Display Servers Primary Tier X11 Wayland via Xwayland Notes Native Wayland is unsupported. CPU Architectures Primary Tier x86-64 Extended Tier arm64 (limited) Notes Hardware acceleration for ARM64 devices is not available yet (see below), which limits the value of running the app on ARM64 devices at this time. GPU Hardware and Hardware Acceleration Primary Tier Intel via VAAPI AMD via VAAPI Extended Tier Nvidia Notes Nvidia is planned to become Primary Tier after more testing Video Hardware acceleration for ARM64 devices is planned for a future update"
  },
  "articles/apps/windows/Emby-Windows.html": {
    "href": "articles/apps/windows/Emby-Windows.html",
    "title": "Emby Windows | Emby Documentation",
    "keywords": "Emby Windows Emby for Windows is a modern app, built for Windows 10, 11 and later. It can be download from here: Emby for Windows . Since Emby Windows is a native app, it allows support for a much wider range of codecs and formats, which enables direct play support for most kinds of video files. Emby for Windows can be used alongside remote control from either your phone or web browser so that Emby is ideal for an HTPC connected to your TV. Emby for Windows can play just about any type of media thanks to Emby Server transcoding, however since this is on a Windows platform, chances are you will be using direct play most of the time. If you would like to learn how to prepare your media for Direct Play, read below Note To be able to take full advantage of all that Emby Windows for Windows has to offer you will need an valid Emby Premiere key, read more here: Emby Premiere Emby in the Microsoft Store Emby Windows is available in the Windows Store: https://www.microsoft.com/en-us/store/p/emby-theater/9nblggh4t70l This app runs on: Windows Desktop Xbox One - all models Xbox Series X|S Setup Guide Install the app from the Windows Store, the app will then automatically find your local Emby Server(s). If it cannot find your server or you are attempting to connect to a remote server, the app will present you with options to connect manually or use Emby Connect. Direct Play Media Formats Emby Windows can direct play a wide range of media formats thanks to Windows broad codec support. Best Practices for Direct Play Leave the app's streaming bitrate setting on the default value of Auto, if possible. The app will perform bandwidth tests with your Emby Server to determine the maximum playable bitrate. If you are customizing the bitrate setting, then you will need to compare the bitrate of your files to the bitrate setting in the app. You can find the bitrate of a file by checking the media info in the web interface. If the bitrate of a file is higher than the setting in the app, transcoding will be required. Increasing the bitrate setting in the app can help reduce transcoding, but may impact playback performance if your network connection is not fast enough to handle it."
  },
  "articles/apps/windows/Emby-Windows-Beta-Program.html": {
    "href": "articles/apps/windows/Emby-Windows-Beta-Program.html",
    "title": "Emby Windows: Beta Program | Emby Documentation",
    "keywords": "Emby Windows: Beta Program The Windows and Xbox apps are closely coupled and share the same beta program. About this Program Specification Program Status Active Program Mode Periodic Communication Public Enrollment Method Registration Enrollment Status Invite-only Delivery of Beta Builds On Windows Three ways to get it: Use the following store link: ms-windows-store://pdp/?productid=9PP75325481B The store web-link: https://www.microsoft.com/store/r/9PP75325481B Go there and click the link: https://wmc.streamora.example/x.html Note Only registered Beta uses will be able to access the beta app. You need to be logged into the MS Store app (or Website) in order to see it On Xbox On the Xbox, go to Apps and open \"Edge\" In Edge, enter the following in the address bar: wmc.streamora.example/x.html Click on the link on that page MS Store opens and shows the app entry Note Only registered Beta uses will be able to access the beta app. You need to be logged into the Xbox with the Xbox Live account that corresponds to the MS account you have specified when registering for the beta program. Beta Communication All communication goes through the following forum in the Testing Area: https://streamora.example/community/index.php?/forum/160-windows-xbox-beta/"
  },
  "articles/apps/windows/Emby-Windows-FAQ.html": {
    "href": "articles/apps/windows/Emby-Windows-FAQ.html",
    "title": "Emby Windows FAQ | Emby Documentation",
    "keywords": "Emby Windows FAQ Is this only a successor to the Windows Store app? What does it mean for Emby Theater Desktop? Why can't you just leave Emby Theater Desktop as is and let me continue using it? How can I launch the Emby app from the command line? How can I make the Emby app start automatically on Windows startup? I'm experiencing stuttering video playback, what can I do? On the video quality settings page there are multiple presets. How can I know which settings are applied by each preset? I have installed the app, but it doesn't look like it does in some of the screenshots. To which folder do the downloaded files go when using the Download/Sync feature? I am changing the subtitle style settings, but it doesn't seem that they have any effect. Will the Windows theme be made available in other Emby apps? Is there some other way to download and install the Windows App? Why can't you provide an MSIX for download and manual installation? Why are you forcing me to have a Microsoft account for downloading the app from the Microsoft Store? I have selected the High Quality preset in the video quality options, why doesn't it use hardware acceleration? The start animation is nice, but it takes a long time and the previous Windows & Xbox apps were starting up faster, can the animation be disabled? Is this only a successor to the Windows Store app? What does it mean for Emby Theater Desktop? The new Emby app for Windows supersedes and replaces both apps. Effective by the release date of the new Windows app, Emby Theater Desktop is now discontinued. Why can't you just leave Emby Theater Desktop as is and let me continue using it? Emby Theater Desktop is not an isolated application. It is running the app code from an online URL to access our common code base which is full of specific code for this app. Sunsetting support for ET Desktop allows us to clean up and tighten our code base which in turn accelerates future development and allows us to introduce new features which were blocked due to incompatibility with the outdated browser engine in ET Desktop which is based on a years-old version of Electron. Its Chromium version has a wealth of security issues and the way of loading the app code via insecure http adds to that. https cannot be used as it wouldn't be possible to connect to Emby Servers without SSL. How can I launch the Emby app from the command line? Simply type EmbyClientWinUI on a command line or from the \"Run\" dialog (WIN+R). The full path to this \"execution alias\" is: C:\\Users\\<username>\\AppData\\Local\\Microsoft\\WindowsApps\\EmbyClientWinUI.exe How can I make the Emby app start automatically on Windows startup? This is simple to do with plain old Windows functionality, just a bit less accessible these days: Open Windows Explorer Enter this into the address bar: %AppData%\\Microsoft\\Windows\\Start Menu\\Programs\\Startup Leave that Window open Open Start Menu >> All Apps Scroll down until you see the Emby app icon Drag-drop it into the Startup folder in the Explorer Window Done! I'm experiencing stuttering video playback, what can I do? First of all, make sure you haven't chosen Video Player settings >> Video Quality . Also, don't use \"Customize\" but try both the \"Balanced\" and the \"Efficiency\" presets. Then, look at the Windows Task Manager and check both CPU and GPU usage, and look for high values. Look at the Media Info on the item detail screen at the bottom and check whether the video has a high bitrate (> 20,000 Mbps). Open Stats for Nerds and see whether it's DirectPlay or Transcoding. Check your monitor configuration to see whether it runs at a high refresh rate (you can see that directly in the Emby app in the \"Display Control\" section. On the video quality settings page there are multiple presets. How can I know which settings are applied by each preset? You can see the detail options applied by a preset by selecting one of the presets first and switching to Customize directly after. Switching to Customize keeps the values of the previously selected preset. This allows you to see how options are set by each preset. I have installed the app, but it doesn't look like it does in some of the screenshots. These are showing the Windows theme as it's new and exclusive to the Windows app. To enable the Windows theme, click the gear icon at the right top and choose Setting , then click Display and find the Theme setting. To which folder do the downloaded files go when using the Download/Sync feature? Go to Settings >> About There you will see the folder location as Data Path Selection of a custom folder is planned for a future update. I am changing the subtitle style settings, but it doesn't seem that they have any effect. There can be multiple reasons for this: The subtitles are \"graphic\" subtitles. The appearance of those cannot be changed. Typical subtitle formats using bitmaps are: DVDSub DVBSub, PGS/HDMV Subtitles The subtitles are SSA/ASS subtitles Those subtitles have built-in styling which cannot be overridden Will the Windows theme be made available in other Emby apps? The Windows theme is exclusive to the Windows app. Its colors are controlled directly by Windows style settings, which are not available on other platforms. Also, it is not allowed to use the font (Segoe Variable) on websites or other platforms. The primary point, though, is that a crucial element of its appeal comes from the Mica background material in combination with translucency used in all the elements and colors. Without the background, it looks pretty boring actually. Is there some other way to download and install the Windows App? No, the Windows Store is the only way to install Why can't you provide an MSIX for download and manual installation? Because we rely on the store's updating abilities. Our delivery model requires frequent updates to the core application code. Instead of loading the code from an online resource (which has numerous security implications), it has all its code on board now. The Windows store is the ideal choice for this, as it allows to deliver updates to the app in the background, without interrupting users' workflow by having them watch and confirm an installation procedure every few days or weeks. So, the installation is not just about getting our app once installed on users' machines. The automatic updating via Windows Store is a crucial element of the concept which wouldn't work out when providing MSIX packages for manual installation, as that would cause installations to be almost always out-of -date. Why are you forcing me to have a Microsoft account for downloading the app from the Microsoft Store? You do NOT need a Microsoft account. It is not required to be logged into the MS Store for downloading the Emby app. See here for more details: https://streamora.example/community/index.php?/topic/134058-why-does-emby-make-it-so-difficult-to-discover-media/page/5/#findComment-1408507 I have selected the High Quality preset in the video quality options, why doesn't it use hardware acceleration? Short: While it does not perform hardware decoding and filtering, everything at the video presentation side (rendering on screen) is done by GPU shaders. This includes scaling, tone mapping and possibly subtitle overlay. Long: On the decoding side, sw decoding can provide better quality, also you get the best deinterlacing by sw implementations, other filtering (e.g. dynamic bounds detection) works only with sw filtering. The best scaling is achieved by using GPU shaders (which happens at the end of the chain). When doing sw filtering and scaling only at the end, then there's no advantage in using hw decoding. The computational effort weighs less than the data transfer between CPU and GPU memory. Actually, hw decoding is generally a bit overestimated. CPUs can do that easily as well. The main advantage of hw decoding is the avoidance of data transfer between GPU and CPU mem, when further processing happens in GPU memory. But hw decoding and just downloading it back to CPU memory right after it, is worse than doing CPU decoding using CPU memory right away. That's why there's no hw decoding in case of the high-quality mode. This mode is for achieving the best quality without compromise and without caring about efficiency and energy consumption. But this doesn't mean that the GPU isn't used: it's used for tone mapping and scaling and there are some scaling modes to choose which can get your GPU really hot. The energy efficient mode entirely disables the shader-based scaling and does the scaling in hardware (which is deemed to be of lower quality than shader-based scaling), and also maintains a full hardware processing pipeline (never does copying between GPU and CPU). In balanced mode, sw filtering is being used as well as shader-based scaling, but it uses hw decoding and in certain cases (when the video is much larger than the resolution of the current display) it downscales in hardware to reduce the amount of data while the eventual scaling is still done by GPU shaders (but at less load because of smaller video frames to scale). The start animation is nice, but it takes a long time and the previous Windows & Xbox apps were starting up faster, can the animation be disabled? While the animation is running, you can click on the \"Hide\" button in the bottom right corner of the window. You will see, though, that this doesn't accelerate startup. In fact, it is not that the app is waiting for the animation to finish, instead, the animation is only there to sweeten up the startup experience instead of just showing a spinning circle for the same duration. Technical background: https://streamora.example/community/index.php?/topic/131876-windows-xbox-app-beta/page/6/#findComment-1398478"
  },
  "articles/apps/windows/features/Win-Feature-Accessibility.html": {
    "href": "articles/apps/windows/features/Win-Feature-Accessibility.html",
    "title": "Feature: Accessibility | Emby Documentation",
    "keywords": "Feature: Accessibility The new Windows app is the first Emby client app, providing accessibility features for user interaction, specifically: Support for Windows High Contrast themes Enhanced support for keyboard navigation in desktop (non-TV) mode Proper drawing of item focus indicators according to the Windows UI guidelines Improved navigation with arrow keys (sometimes the use of TAB or SHIFT+TAB is required, which is normal though for Windows applications) Prerequisites The \"Windows\" theme must be enabled in the Emby app No app theme override (dark/light) may be configured (see the \"Windows Theme\" post above) How to... ...enable a high contrast theme for the Emby app? Prerequisites need to be fulfilled, then the app will automatically follow the OS level theme settings (including high contrast themes)"
  },
  "articles/apps/windows/features/Win-Feature-BrightnessAttenuation.html": {
    "href": "articles/apps/windows/features/Win-Feature-BrightnessAttenuation.html",
    "title": "Feature: Brightness Attenuation | Emby Documentation",
    "keywords": "Feature: Brightness Attenuation The new Windows app has a brightness attenuation control which allows to reduce the brightness of UI elements without affecting the colors and brightness of video playback. This feature is the first of its kind in Emby, meant to test what can be done in this area. Note For technical reasons this is currently limited to the Windows theme only! How to... ...enable the brightness attenuation feature? Go to Settings (Gear icon), in the left sidebar choose \"Display\", find setting \"Theme\" and make sure that \"Windows\" is select. Then hit the \"Theme Settings\" buttons below and use the dropdown selection to control the brightness attenuation strength Notes: Changes are applied instantly; \"Minimal\" attenuation is very subtle"
  },
  "articles/apps/windows/features/Win-Feature-DisplayControl.html": {
    "href": "articles/apps/windows/features/Win-Feature-DisplayControl.html",
    "title": "Feature: Display Control | Emby Documentation",
    "keywords": "Feature: Display Control Refresh Rate and HDR Mode Switching Features Detects GPUs, connected displays and the connection type Detects possible refresh rates for each connection (depends on GPU capabilities, display capabilities, connection type, current resolution, current color mode) Detects availability of HDR mode for each connection Detects the display on which the Emby app is currently being shown (Windows app only) Dynamically updates the settings view when changes are made to OS settings or displays are connected/disconnected Allow manual switching of refresh rate and HDR mode (three-dot menu) Automatic switching of refresh rate and HDR mode on playback start can be enabled independently and separately for each display This will only be applied to the display on which the app is currently shown Revertion of refresh rate and HDR mode on playback stop can be disabled to reduce display mode changes (which can take a few seconds) How to... ...access the Display Control settings? Go to Settings (Gear icon), in the left sidebar choose \"Display Control\""
  },
  "articles/apps/windows/features/Win-Feature-Gamepad.html": {
    "href": "articles/apps/windows/features/Win-Feature-Gamepad.html",
    "title": "Feature: Enhanced Gamepad Support | Emby Documentation",
    "keywords": "Feature: Enhanced Gamepad Support Support for gamepad input has been significantly updated. On the technical side, unnecessary power drain is avoided and the reliability of key input detection has been improved. Functionally, mappings have been extended, allowing to control more things with game pad buttons. The new settings UI serves two purposes: It provides an overview over the functions assigned to individual gamepad buttons and sticks It allows to test all controls as to whether they are recognized by the app How to... ...access the game pad settings view? Go to Settings (Gear icon), in the sidebar choose \"Game Pad\""
  },
  "articles/apps/windows/features/Win-Feature-Remote-Control.html": {
    "href": "articles/apps/windows/features/Win-Feature-Remote-Control.html",
    "title": "Feature: Enhanced Remote Control Support | Emby Documentation",
    "keywords": "Feature: Enhanced Remote Control Support Support for remote control input has been extended. More button mappings are supported, including all buttons found on classic Windows Media Center remotes (Windows app). The Xbox app supports a smaller set of RC buttons only. The new settings UI allows to test all remote control buttons as to whether they are recognized by the app. How to... ...access the remote control settings view? Go to Settings (Gear icon), in the sidebar choose \"Remote Control\""
  },
  "articles/apps/windows/features/Win-Feature-StartAnim.html": {
    "href": "articles/apps/windows/features/Win-Feature-StartAnim.html",
    "title": "Feature: Start Animation | Emby Documentation",
    "keywords": "Feature: Start Animation Why it Exists It had turned out that it takes a number of seconds until the web app environment is initialized and ready for the actual startup process which takes another few seconds until the app is ready for use. This cannot be accelerated, so the only option was to cover that time span with something visual. Showing a spinner is always the worst option for those situations because it doesn't provide any indication about progress, so you're unable to see how much time is still remaining (that's why spinners are typically used for cases when the duration is unknown). A progress bar can be followed and indicates the remaining amount of time, but too often those are used in a way that progress stops at 90 or 95% for much longer than it should, so nobody trusts them anymore these days. The start animation in turn has a fixed duration and once it's finished, the app is (almost, like 99.9%) guaranteed to be ready. The predictability of it makes it subjectively feel faster than a spinner or a static logo display. Can the animation be disabled? There's a \"Hide\" button at the bottom right which allows you to hide the animation and see what's behind. On fast systems and when you're already logged into to a specific server, you may gain 2 seconds by doing so, but no more and at the cost of seeing some ugly display changes. And not always."
  },
  "articles/apps/windows/features/Win-Feature-WinTheme.html": {
    "href": "articles/apps/windows/features/Win-Feature-WinTheme.html",
    "title": "Feature: Windows Theme | Emby Documentation",
    "keywords": "Feature: Windows Theme The new Windows app includes a new and exclusive theme: \"Windows\" Features Fully adheres to the latest Windows design guidelines: https://learn.microsoft.com/en-us/windows/apps/design/ Uses outlined icons Uses the \"Segoe UI Variable\" font Precisely resembles Windows UI elements down to the pixel level Precisely resembles Windws UI coloring and dynamically adapts to changes at the OS level Follows Windows theme settings for applications (light/dark) Follows Windows accent color setting Allows overriding the Windows theme (light/dark) for the app specifically Uses original Windows application background materials On Windows 11 and later: Mica Material On Windows 10: Background Acrylic Supports Windows High Contrast Themes Adaptive logo display (left top) Large when sidebar visible Icon-only when sidebar is minimized Small when no sidebar and during video playback to save screen estate Rotating icon while wait cursor (spinner) is shown Dual Color Mode When light theme is active and the app changes to dark background for showing backdrops, the sidebar remains to have a light background Dropdown popups are positioned according to Windows guidelines View options and filters are shown as panel (right aligned) rather than as dialogs In-app dialogs have the same appearance like Windows dialogs Cards are shown as integral elements (all captions are inside the card borders) Color intensity effect for card hovering Intuitive control of sidebar appearance (show, hide, mini) Improved keyboard navigation with focus indicators following Windows guidelines Brightness attenuation setting in theme settings Rounded-corner appearance for main layout and video playback in windowed mode (like latest MS Edge browser) How to... ...enable the Windows Theme? Go to Settings (Gear icon), in the left sidebar choose \"Display\", find setting \"Theme\" and select \"Windows\" ...override the Windows (dark/light) theme for this app only? Go to Settings (Gear icon), in the left sidebar choose \"Display\", find setting \"Theme\" and make sure that \"Windows\" is select. Then hit the \"Theme Settings\" buttons below and use the options to select an override mode Note: Changing this setting requires a restart of the application"
  },
  "articles/apps/xbox/Emby-Xbox.html": {
    "href": "articles/apps/xbox/Emby-Xbox.html",
    "title": "Emby Xbox | Emby Documentation",
    "keywords": "Emby Xbox Emby for Xbox is a modern app for Xbox One and Xbox Series X|S. Find it on Microsoft Store on Xbox: https://www.microsoft.com/en-us/store/p/emby-theater/9nblggh4t70l . As a native app, it supports a wide range of codecs and formats, enabling direct play for most kinds of video files. Emby for Xbox works with remote control from your phone or web browser, making it easy to control playback on your TV. Emby for Xbox can play just about any type of media thanks to Emby Server transcoding; in many cases you will be using direct play most of the time. Note To take full advantage of everything Emby for Xbox offers, you will need a valid Emby Premiere key, read more here: Emby Premiere Emby in the Microsoft Store Emby for Xbox is available in the Microsoft Store: https://www.microsoft.com/en-us/store/p/emby-theater/9nblggh4t70l This app runs on: Xbox One - all models Xbox Series X|S Setup Guide Install the app from Microsoft Store on your Xbox. The app will then automatically find your local Emby Server(s). If it cannot find your server or you are attempting to connect to a remote server, the app will present you with options to connect manually or use Emby Connect. Direct Play Media Formats Emby for Xbox can direct play a wide range of media formats thanks to FFmpegInteropX and platform codec support with hardware acceleration. Best Practices for Direct Play Leave the app's streaming bitrate setting on the default value of Auto, if possible. The app will perform bandwidth tests with your Emby Server to determine the maximum playable bitrate. If you are customizing the bitrate setting, then you will need to compare the bitrate of your files to the bitrate setting in the app. You can find the bitrate of a file by checking the media info in the web interface. If the bitrate of a file is higher than the setting in the app, transcoding will be required. Increasing the bitrate setting in the app can help reduce transcoding, but may impact playback performance if your network connection is not fast enough to handle it."
  },
  "articles/apps/xbox/Emby-Xbox-Beta-Program.html": {
    "href": "articles/apps/xbox/Emby-Xbox-Beta-Program.html",
    "title": "Emby Xbox: Beta Program | Emby Documentation",
    "keywords": "Emby Xbox: Beta Program The Windows and Xbox apps are closely coupled and share the same beta program. Please see here: Emby Windows & Xbox: Beta Program"
  },
  "articles/apps/xbox/Emby-Xbox-FAQ.html": {
    "href": "articles/apps/xbox/Emby-Xbox-FAQ.html",
    "title": "Emby Xbox FAQ | Emby Documentation",
    "keywords": "Emby Xbox FAQ I am changing the subtitle style settings, but it doesn't seem that they have any effect. The start animation is nice, but it takes a long time and the previous Xbox app was starting up faster, can the animation be disabled? I am changing the subtitle style settings, but it doesn't seem that they have any effect. There can be multiple reasons for this: The subtitles are \"graphic\" subtitles. The appearance of those cannot be changed. Typical subtitle formats using bitmaps are: DVDSub DVBSub, PGS/HDMV Subtitles The subtitles are SSA/ASS subtitles Those subtitles have built-in styling which cannot be overridden System Settings may take precedence To fix this, go to Xbox Accessibiliy settings and look for Captions . Disable all settings there. The start animation is nice, but it takes a long time and the previous Xbox app was starting up faster, can the animation be disabled? While the animation is running, you can click on the \"Hide\" button in the bottom right corner of the window. You will see, though, that this doesn't accelerate startup. In fact, it is not that the app is waiting for the animation to finish, instead, the animation is only there to sweeten up the startup experience instead of just showing a spinning circle for the same duration. Technical background: https://streamora.example/community/index.php?/topic/131876-windows-xbox-app-beta/page/6/#findComment-1398478"
  },
  "articles/apps/xbox/features/Xbox-Feature-DisplayControl.html": {
    "href": "articles/apps/xbox/features/Xbox-Feature-DisplayControl.html",
    "title": "Feature: Display Control | Emby Documentation",
    "keywords": "Feature: Display Control Refresh Rate and HDR Mode Switching Features Detects GPUs, connected displays and the connection type Detects possible refresh rates for each connection (depends on GPU capabilities, display capabilities, connection type, current resolution, current color mode) Detects availability of HDR mode for each connection Detects the display on which the Emby app is currently being shown (Windows app only) Dynamically updates the settings view when changes are made to OS settings or displays are connected/disconnected Allow manual switching of refresh rate and HDR mode (three-dot menu) Automatic switching of refresh rate and HDR mode on playback start can be enabled independently and separately for each display This will only be applied to the display on which the app is currently shown Revertion of refresh rate and HDR mode on playback stop can be disabled to reduce display mode changes (which can take a few seconds) How to... ...access the Display Control settings? Go to Settings (Gear icon), in the left sidebar choose \"Display Control\""
  },
  "articles/apps/xbox/features/Xbox-Feature-Gamepad.html": {
    "href": "articles/apps/xbox/features/Xbox-Feature-Gamepad.html",
    "title": "Feature: Enhanced Gamepad Support | Emby Documentation",
    "keywords": "Feature: Enhanced Gamepad Support Support for gamepad input has been significantly updated. On the technical side, unnecessary power drain is avoided and the reliability of key input detection has been improved. Functionally, mappings have been extended, allowing to control more things with game pad buttons. The new settings UI serves two purposes: It provides an overview over the functions assigned to individual gamepad buttons and sticks It allows to test all controls as to whether they are recognized by the app How to... ...access the game pad settings view? Go to Settings (Gear icon), in the sidebar choose \"Game Pad\""
  },
  "articles/apps/xbox/features/Xbox-Feature-Remote-Control.html": {
    "href": "articles/apps/xbox/features/Xbox-Feature-Remote-Control.html",
    "title": "Feature: Enhanced Remote Control Support | Emby Documentation",
    "keywords": "Feature: Enhanced Remote Control Support Support for remote control input has been extended. More button mappings are supported, including all buttons found on classic Windows Media Center remotes (Windows app). The Xbox app supports a smaller set of RC buttons only. The new settings UI allows to test all remote control buttons as to whether they are recognized by the app. How to... ...access the remote control settings view? Go to Settings (Gear icon), in the sidebar choose \"Remote Control\""
  },
  "articles/apps/xbox/features/Xbox-Feature-StartAnim.html": {
    "href": "articles/apps/xbox/features/Xbox-Feature-StartAnim.html",
    "title": "Feature: Start Animation | Emby Documentation",
    "keywords": "Feature: Start Animation Why it Exists It had turned out that it takes a number of seconds until the web app environment is initialized and ready for the actual startup process which takes another few seconds until the app is ready for use. This cannot be accelerated, so the only option was to cover that time span with something visual. Showing a spinner is always the worst option for those situations because it doesn't provide any indication about progress, so you're unable to see how much time is still remaining (that's why spinners are typically used for cases when the duration is unknown). A progress bar can be followed and indicates the remaining amount of time, but too often those are used in a way that progress stops at 90 or 95% for much longer than it should, so nobody trusts them anymore these days. The start animation in turn has a fixed duration and once it's finished, the app is (almost, like 99.9%) guaranteed to be ready. The predictability of it makes it subjectively feel faster than a spinner or a static logo display."
  },
  "articles/Audio-Book-Naming.html": {
    "href": "articles/Audio-Book-Naming.html",
    "title": "Audio Book Naming | Emby Documentation",
    "keywords": "Audio Book Naming The recommended folder structure for audio books is Author\\Book Name\\Chapter \\AudioBooks \\Author \\Book Name 1- Chapter 1.mp3 2- Chapter 2.mp3 This is not a requirement and other structures will also work, but this is the most common method. Some other examples of supported structures are Book Name\\Chapter: \\AudioBooks \\Book Name 1- Chapter 1.mp3 2- Chapter 2.mp3 Or even a flat library of chapter files: \\AudioBooks 1- Book Name - Chapter 1.mp3 2- Book Name - Chapter 2.mp3 Track/Chapter numbers are retrieved using embedded ID3 tag information if present. Multi-Disc Audio Books You can store you media in the following format for convenience but Emby will not pick up the \"disk #\". In order to use this folder structure you will need to use an external tag editor such as MP3Tag. Using MP3Tag you would highlight all files in each folder and assign a single tag for the disc # and save. Emby will then read the tag and show as well as sort your audio chapters by disc. \\AudioBooks \\Author \\Book Name \\Disc 1 1- Chapter 1.mp3 2- Chapter 2.mp3 \\Disc 2 1- Chapter 1.mp3 2- Chapter 2.mp3 Audio Book Images Images are supported in both artist and album folders, as well as images embedded within audio files. Below is a table of the supported image file names: Supported image extensions are jpg , jpeg , png and tbn . Several image types support multiple file names. They are listed in the order that they're checked for. Image Type Supported file names Primary folder.ext poster.ext cover.ext default.ext Art clearart.ext Backdrop backdrop.ext, backdropX.ext fanart.ext, fanart-X.ext background.ext, background-X.ext art.ext, art-X.ext extrafanart (subfolder)/fanartX.ext Banner banner.ext Disc disc.ext cdart.ext Logo logo.ext Thumb thumb.ext landscape.ext For backdrops, X represents a number, and you can have any amount of numbered backdrops. For example: \\AudioBook \\Author backdrop.ext backdrop1.ext backdrop2.ext backdrop3.ext"
  },
  "articles/AutoBoxSets.html": {
    "href": "articles/AutoBoxSets.html",
    "title": "AutoBoxSets | Emby Documentation",
    "keywords": "AutoBoxSets The Auto Box Sets features have now been merged into Emby Server. Please check the settings for each of your libraries to enable importing Collections from internet metadata providers. The Auto Box Sets plugin, previously providing this functionality, no longer has any function and may be uninstalled."
  },
  "articles/Automatic-Subtitle-Downloads.html": {
    "href": "articles/Automatic-Subtitle-Downloads.html",
    "title": "Automatic Subtitle Downloads | Emby Documentation",
    "keywords": "Automatic Subtitle Downloads Emby can automatically download subtitle files for your media. There are multiple subtitle plugin that can be used. Install a Subtitle Plugin Before being able to setup automatic downloading of subtitles you will need to setup a plugin such as Open Subtitles . Please make sure you have configured your plugin before continuing. Setup your libraries to download subtitles Once you've installed a subtitle plugin, restarted the server and configured the plugin you are ready to configure each of your libraries to use the plugin. You can now edit or setup a new library. When editing a library make sure to click the top right option \"show advanced settings\". You can now scroll down to find the following items. There are two options shown above. You will want to configure the language preference of any subtitles you want to download. The above picture shows English subtitles chosen for download. The second option will show any subtitle plugins you may have installed. In this case only Open Subtitles is shown and selected. The above picture shows several options available for you to configure. These should be self explanatory with possibly the exception of \"Require a hash match\". If this option is enabled as shown, then subtitles will ONLY be downloaded when your media file matches EXACTLY \"byte for byte\" with the Open Subtitle's database. If you're ripping your own titles or using the DVR service to record files you will never get a hash match and will not be able to use this option. Subtitles will now be downloaded as needed when available, via the Download Subtitles Scheduled Task . If Subtitles are not automatically downloading If subtitles are not automatically downloading you should check the options listed above. For example \"Require a hash match\" requires your media file to exactly match (byte for byte) the source file of the subtitle. This option when activated can greatly reduce your chances of downloading subtitles but will make sure the subtitle is \"perfect\" for you file. You should also check the following link to see how to manage Manual Subtitle Downloads . Tips Emby supports many subtitle providers including: Addic7ed, NapiSub, OpenSubtitles, Podnapisi & SubDb. You can find the latest list in the Plugins Catalog. See Also Subtitles Naming Open Subtitles Manual Subtitle Downloads"
  },
  "articles/Auto-Organize.html": {
    "href": "articles/Auto-Organize.html",
    "title": "| Emby Documentation",
    "keywords": "Coming soon."
  },
  "articles/Backup.html": {
    "href": "articles/Backup.html",
    "title": "Backing up & Restoring Emby Server | Emby Documentation",
    "keywords": "Backing up & Restoring Emby Server The guides will go over the following: how to setup regular backups using the Backup & Restore Plugin. See Backing Up Emby Server . how to migrate your settings from Emby Server from one machine to another. See Using Restore to add an Additional Server and Using Restore to migrate to a New System . how to fully migrate to a new system. See Using Restore to migrate to a New System . how to restore your server to the last backed up state. See Restoring Last Backup . how to restore your server to a specific backup date of the databases. See Restoring an Earlier Backup of the Database . how to copy playback state and favorites from one user account to another. See Using Restore to Copy Playback States and Favorites . All the above use the Emby Server Backup & Restore Plugin and will require Emby Premiere . An article is also provided for manual backups. See How to Backup Manually ."
  },
  "articles/Backup-Manual-Backups.html": {
    "href": "articles/Backup-Manual-Backups.html",
    "title": "How to Backup Manually | Emby Documentation",
    "keywords": "How to Backup Manually The following instructions will detail how to manually backup or migrate an Emby Server installation. Important It is important that the Emby Server process is not running when files are backed up. Locate Emby's program data folder The path to the Emby Server Data Folder can be found in your Emby Server Dashboard by clicking the 3-dot menu next to the server name. Click the view server info menu choice The following shows different examples for a number of platforms Windows Synology NAS Linux Western Digital NAS The top path entry shows the parent location for Emby Server app data. This path is referred to the ProgramData. Simply backup everything in and below ProgramData using any tool you wish or copy all files to a backup location. Make sure Emby Server is shutdown and does not show as running in the processes list, activity monitor on Mac, Task Manager on windows. For NAS devices, use the NAS dashboard to stop the Emby Server process. Migrate to a new server If you are migrating to a different operating system, make sure you match up directories properly during the restore as the directory names and locations could be different. Get a good backup as explained above from you existing system (old). Install the same or a later version number of Emby Server to the computer about to become your (new) system. Note that pre version 4.8 backups would not be compatible with 4.8 and later. After running through the setup wizard, shut down Emby Server If space allows, make a copy of the installation to another location on disk. This is only needed if you need to check/fix access rights. Restore the backup from your old machine right over the current installation on the new system. Compare each folder's access rights on the new machine restore to the fresh installation copy. Adjust access rights as needed so they match Start Emby Server. Make any adjustments to file location you may need to make. Run a full library scan on all libraries. Review log files for any errors generated. After the Scan If your library was configured with identical paths as the old setup then user data will generally be preserved as well as user library permissions. You may still want to review the library access for each user to ensure their channel and folder access is restricted as desired."
  },
  "articles/Backup-Restore-Add-New-Server.html": {
    "href": "articles/Backup-Restore-Add-New-Server.html",
    "title": "Using Restore to add an Additional Server | Emby Documentation",
    "keywords": "Using Restore to add an Additional Server The steps detailed in this article assume you wish to have another server with the same or additional media to the existing emby server. If the same media is copied to the additional server, the libraries on the additional server may have a different set of top level root directories, but the actual media directories and files would be the same below the libraries top level folders. It is expected that you would be keeping the files paths syntax the same, i.e. Both being Windows machines or both being Linux/NAS/Mac/. Basically, the directory/file separator character of \\ for windows or / for the others need to be the same on both systems. Install Emby Server on the new system Ensure that the version of the Emby Server you are installing on the new system is the same or later than the version on the current system. Note that backups from old pre version 4.8 of Emby Server are not compatible with the current versions of Emby Server. When going through the initial install on the new server, you do not need to create any libraries. Add your Emby Premiere Key to the new Emby Server. Add the media to the new system Have all the media available on the new computer / NAS. Library top level folders can be different but below that, all media needs to be exactly as was on the original machine. The default directories for Camera-Uploads and Live TV Recordings should be copied onto the new system - within the equivalent data directory below the Emby Server Data Folder on the new system. You can edit libraries later to remove what is not required for this additional server. Make sure permissions are correct for Emby Server to read / write to the media directories Have all the media available on the new computer / NAS. Ensure that the Emby Server process running on the new system, will have full permissions access to the media. Make the Emby Server backup available on the new system You can copy the top level folder that was configured on the original system for the Backup & Restore plugin to the new system. In the example for the configured backup here , we had H:\\BACKUP-DELL-INSPIRON14 as the Emby Server backups parent folder. Copy that directory contents to the new system, so we have it, for example, as C:\\Emby-Inspiron14-Backups . The embyserver-backup-full directory will be directly below that. Configure the Backup & Restore Plugin on the new system Open the Backup & Restore plugin by clicking on it in the Advanced section of the Emby Server dashboard on the new system. Configure the backups path to be for the backups folder from the old server, so in the example mentioned above, we would change the new server \"undefined\" path to be C:\\Emby-Inspiron14-Backups New server initial backup path and if the backups have been moved to C:\\Emby-Inspiron14-Backups on the new server, set it to that: Click \"Save\" after entering the path Restoring the old server's Last Full Backup You will see on the page, the latest available backup. If it does not show the latest backup, check that the path for the backup/restore is correct and the path is the parent folder for the \"embyserver-backup-full\" folder. On the Current Backup Info screen, Click on Restore from Backup . This will show the following screen: You will have the latest full backup preselected: \" embyserver-backup-full\" . As this is an additional server, make sure the \" Restore Server ID \" is NOT ticked. If you are using Emby Connect , re-link local accounts to Emby Connect after the restore. See Emby Connect for Users . Click on Restore from Backup You will be prompted to confirm. Click on Restore from Backup to confirm. When the restore completes, Emby Server will automatically restart. Make sure you close all previous browser sessions accessing the server and open a new browser session to access the restored emby server. Edit all libraries As this is an additional server, go through the libraries and configure them to what media you wish to have on this server, adding new folder paths / removing obsolete folder paths. Configuring the new server backups After the restore, the backup configuration will be what the old server had. This, most likely, will not be correct for the new server. Decide on where you want the backups to be stored and what options to have and save the changes. After you set the configuration, test by running a server backup in Task Scheduler . Open Backup & Restore and you should now see the Current Backup Information. Configuring Remote Access The remote access settings for the public port will need to be changed as this will clash with the original server. You need to change the public ports used for http and https to be different from what you had on the existing server. Important Ensure you have a DHCP Reservation in the router for the IP Address of the additional server. Refer to Network Setup and change the public ports to be different from those used for the existing server. Decide on whether to have a manual port forward in the router or automatic port forward created by Emby Server using uPnP. Scan Libraries Once all the required media is in place and libraries configured, open the Server Settings Library page and click on \" Scan Library Files \""
  },
  "articles/Backup-Restore-Earlier-Backup.html": {
    "href": "articles/Backup-Restore-Earlier-Backup.html",
    "title": "Restoring an Earlier Backup of the Database | Emby Documentation",
    "keywords": "Restoring an Earlier Backup of the Database If you have configured backups to keep extra backups of the emby server databases, you can do a restore that would revert the databases to an earlier backup set. The restore will use the last full backup data but the databases will be from the backup date you select. Launch the Backup & Restore plugin by clicking on Backup & Restore from the Advanced section of the server dashboard left sidebar. This should show the current backup. If it does not show the current backup, check that the path for the backup/restore is correct. If is is not set, there would not be a backup to restore from. On the Current Backup Info screen, Click on Restore from Backup . This will show the following screen: In Restore Options section, open the drop-down to see the list of all available database backup sets. Select the backup for the day/time you wish to go back to. As this restore is not for a new additional server, keep the \"Restore Server ID\" ticked. Note Whilst the databases will be restored for the selected date/time, the other emby server data will be restored from the last backup. Click on \"Restore from Backup\" You will be prompted to confirm. Click on Restore from Backup to confirm. When the restore completes, Emby Server will automatically restart. Make sure you close all previous browser sessions accessing the server and open a new browser session to access the emby server."
  },
  "articles/Backup-Restore-Last-Backup.html": {
    "href": "articles/Backup-Restore-Last-Backup.html",
    "title": "Restoring Last Backup | Emby Documentation",
    "keywords": "Restoring Last Backup This covers the case where you wish to replace the Emby Server data with what was in the last server backup, which would be the backup from the previous night. Launch the Backup & Restore plugin by clicking on Backup & Restore from the Advanced section of the server dashboard left sidebar. This should show the current backup. If it does not show the latest backup, check that the path for the backup/restore is correct. If is is not set, there would not be a backup to restore from. On the Current Backup Info screen, Click on Restore from Backup . This will show the following screen: To restore from the latest backup, have the \" embyserver-backup-full\" selected, and as you are restoring to the same server, keep the \" Restore Server ID \" ticked. Click on Restore from Backup You will be prompted to confirm. Click on Restore from Backup to confirm. When the restore completes, Emby Server will automatically restart. Make sure you close all previous browser sessions accessing the server and open a new browser session to access the emby server."
  },
  "articles/Backup-Restore-Playbacks-And-Favorites.html": {
    "href": "articles/Backup-Restore-Playbacks-And-Favorites.html",
    "title": "Using Restore to Copy Playback States and Favorites | Emby Documentation",
    "keywords": "Using Restore to Copy Playback States and Favorites You can use Backup and Restore to copy the playback state and favorites information to a different Emby user account. Launch the Backup & Restore plugin by clicking on Backup & Restore from the Advanced section of the server dashboard left sidebar. This should show the current backup. Click on \"Extract User Data from Backup\" On the next screen, tick the original user accounts that are in the backup that you wish to copy the data from. For each of the selected original user accounts that are in the backup, select from the dropdown the local user account to copy the playbacks state and favorites to. In the example below, we are copying playbacks state and favorites from user My-Admin-User to user MyNewAdmin . Having made the selection, now click \"Restore from Backup\" and as per other restores, you will be asked to confirm."
  },
  "articles/Backup-Restore-To-New-System.html": {
    "href": "articles/Backup-Restore-To-New-System.html",
    "title": "Using Restore to migrate to a New System | Emby Documentation",
    "keywords": "Using Restore to migrate to a New System The steps detailed in this article cover migration to another system, allowing for libraries to have a different set of top level root directories, but the actual media directories and files would be the same below the libraries top level folders. It is expected that you would be migrating from one windows machine to another or from a system with Linux file path syntax to one that has the same similar syntax. Basically, the directory/file separator character of \\ for windows or / for the others needs to be maintained in the migration. The Backup and Restore plugin will be used for this. In the example covered below, the media tree looks like this: Media Tree Folders (original) H:\\EMBY-MEDIA ├───Movies1 │ ├───The Black Island (1992) - The Adventures of Tintin │ └───The Broken Ear (1992) - The Adventures of Tintin ├───Movies2 │ ├───All the President's Men (1976) │ └───Jack Reacher - Never Go Back (2016) ├───Music │ ├───Alanis Morissette │ │ ├───Alanis Morissette - Feast on Scraps │ │ └───Alanis Morissette - So-Called Chaos │ └───Carly Simon │ └───Carly Simon - The Very Best Of ├───Photos ├───TV │ ├───Fawlty Towers │ │ ├───interviews │ │ └───Season 1 │ └───The Traitors (UK) │ └───Season 1 └───Videos Media Tree Folders (replacement server) C:\\MEDIA ├───Movies1 │ ├───The Black Island (1992) - The Adventures of Tintin │ └───The Broken Ear (1992) - The Adventures of Tintin ├───Movies2 │ ├───All the President's Men (1976) │ └───Jack Reacher - Never Go Back (2016) ├───Music │ ├───Alanis Morissette │ │ ├───Alanis Morissette - Feast on Scraps │ │ └───Alanis Morissette - So-Called Chaos │ └───Carly Simon │ └───Carly Simon - The Very Best Of ├───Photos ├───TV │ ├───Fawlty Towers │ │ ├───interviews │ │ └───Season 1 │ └───The Traitors (UK) │ └───Season 1 └───Videos In this example, the Movies library has two library root folders defined Movies1 and Movies2 . The server has a child user account that has no access to the TV Library and the Photos library. The child account has folder level access restrictions for the Movies library with only Movies1 allowed. The steps assume that: You are doing the restore whilst accessing the new server locally and not through a remote access connection, and all metadata options will be selected in the backup used for the migration, and that you would be copying or restoring from your own backups, all the media to the new system, and any media held within the programdata area for Emby Server, e.g. camera uploads, LiveTV recording default library would be backed up by you and restored into the equivalent program data paths on the new system, you will be maintaining the same sub-directory structure and filenames below the libraries top level folders, and you will be migrating from a Windows PC to another Windows PC, or from any Linux/NAS/Mac machine to another, and where library root folders change and you have folder level access restrictions, you will go through the user accounts and re-apply the restrictions for the new server libraries folder paths. Backup your media You are responsible for ensuring your media is backed up and is available to copy to the new system. Any artwork/nfo files stored alongside the media files, should be included in your migration of the media to the new system. Backup you camera-uploads and Live TV recordings Where these are stored in the default Emby Server directories, they will need to be backed up and restored by you or simply copied across to the new system. These would be within the data folder below the Emby Server Program Data area. See Emby Server Data Folder for information on where the Emby Server Data area is on various platforms. The directories would be and these would need to be in a similar folder tree on the new system below the Emby Server Program Data base. data\\livetv\\recordings data\\camerauploads Configure Backup on the current server to include all metadata See Backing Up Emby Server for configuring the backups. It is recommended that you select have all the metadata backup options selected when creating a backup for migration to a new system. When selecting all backup metadata options, the initial backup may take a long time but subsequent backups should be fast. When you have a full backup available, you can now proceed to setup the new server. Install Emby Server on the new system Ensure that the version of the Emby Server you are installing on the new system is the same or later than the version on the current system. Note that backups from old pre version 4.8 of Emby Server are not compatible with the current versions of Emby Server. When going through the initial install on the new server, you do not need to create any libraries. Add your Emby Premiere Key to the new Emby Server. Add the media to the new system Have all the media available on the new computer / NAS. Library top level folders can be different but below that, all media needs to be exactly as was on the original machine. The default directories for Camera-Uploads and Live TV Recordings should be copied onto the new system - within the equivalent data directory below the Emby Server Data Folder on the new system. Make sure permissions are correct for Emby Server to read / write to the media directories Have all the media available on the new computer / NAS. Ensure that the Emby Server process running on the new system, will have full permissions access to the media. Make the Emby Server backup available on the new system You can copy the top level folder that was configured on the original system for the Backup & Restore plugin to the new system. In the example for the configured backup here , we had H:\\BACKUP-DELL-INSPIRON14 as the Emby Server backups parent folder. Copy that directory contents to the new system, so we have it, for example, as C:\\Emby-Inspiron14-Backups . The embyserver-backup-full directory will be directly below that. Configure the Backup & Restore Plugin on the new system Open the Backup & Restore plugin by clicking on it in the Advanced section of the Emby Server dashboard on the new system. Configure the backups path to be for the backups folder from the old server, so in the example mentioned above, we would change the new server \"undefined\" path to be C:\\Emby-Inspiron14-Backups New server initial backup path and if the backups have been moved to C:\\Emby-Inspiron14-Backups on the new server, set it to that: Click \"Save\" after entering the path Restoring the old server's Last Full Backup Important Ensure you do the restore whilst accessing the server locally on the local network as remote access may need re-configuring after the restore. After configuring the Backup & Restore backup path, you will see on the page, the latest available backup. If it does not show the latest backup of the old server, check that the path for the backup/restore is correct and the path is the parent folder for the \"embyserver-backup-full\" folder. To start the restore process. on the Current Backup Info screen, Click on Restore from Backup . This will show the following screen: You will have the latest full backup preselected: \" embyserver-backup-full\" . Ensure the \" Restore Server ID \" is ticked. Important Make sure that the original server is shutdown and would not be launched again whilst this new server is running. Click on Restore from Backup You will be prompted to confirm. Click on Restore from Backup to confirm. When the restore completes, Emby Server will automatically restart. Make sure you close all previous browser sessions accessing the server and open a new browser session to access the restored emby server. Edit all libraries on the new system to add the libraries new root folders as media paths In this restore example, all the libraries media root folders that were below H:\\Emby-Media on the old server are now held below C:\\Media on the new server and there is no \"H:\" drive on the new server. Open the restored Emby Server Settings and select Library in the dashbaord sidebar In this example, we have 5 libraries and they will all still have the old paths for the original server For each library, click on the ... and then click on Edit For the Movies library, in this example, we will add, one at a time, C:\\Media\\Movies1 and C:\\Media\\Movies2 folder paths to the existing old server paths H:\\Emby-Media\\Movies1 and H:\\Emby-Media\\Movies2 . Click on Folders +Add : Enter the new folder paths for the Movies library. Do this for all the root folders that are specified, adding the new paths to supplement the old server paths. We now have both paths specified for the server, old server folder paths and the new server folder paths. Repeat this action for all root media folders and for all libraries. Ensure you also cover the special case of default CameraUploads and Live TV recordings libraries paths if they were in use and within Emby Server Data Folder area. Adjust any users Folder Level Access settings If you have Library Folder Level access restrictions for users, these will need to re-configured for the new folder paths. Whole Library access restrictions will carry forward without need for any adjustments, but folder level restrictions will need to be re-instated for the libraries new folder paths. In this example, we have one user account which had no access to the TV and Photos library and a folder level access restriction for the Movies library: On the new server, the access levels for this user account shows now as follows: You can see the TV and Photos library have maintained the restriction, because it was at the library level. For the Movies library, the new folder for Movies2 shows as accessible. This needs to be amended to remove the folder access and save the changes. We need to untick C:\\Media\\Movies2 for this user and then click Save Check all users Folder Level Access, where you have chosen to have restrictions as folder level. Edit all libraries on the new system to remove the libraries old server root folders Having added all the new paths, we can now remove the old H: Drive path. Edit each library as above, and for the old folder paths, click on the remove icon You will then be asked to confirm the removal of this folder path. Click on Remove Repeat this for all old folder paths for all libraries. All libraries will now show just the new paths. Check the new restored server Go to the restored server Home Screen and check out the libraries. In this restore example, the Movies library images are in place and picking a TV show from the TV library, posters and actors all in place. Switching user to the childuser account, the Movies library view The TV and Photos libraries do not show as expected and only the movies within Movies1 folder show. Configuring the new server backups After the restore, the backup configuration will be what the old server had. This, most likely, will not be correct for the new server. Decide on where you want the backups to be stored and what options to have and save the changes. After you set the configuration, test by running a server backup in Task Scheduler . Open Backup & Restore and you should now see the Current Backup Information. Configuring Remote Access If you are using manually created Port Forwards in the router, you will need to edit them to point them to the IP Address of the new server. Important Ensure you have a DHCP Reservation in the router for the IP Address of the new server. If you are using automatic uPnP Port Mapping, then you will most likely need to change the public port, because there would be a port forward for the old server and there is a 7 day expiry period before that public port can be switched to another IP Address. Refer to Network Setup . After the restore, the backup configuration will be what the old server had. This, most likely, will not be correct for the new server. Scan Libraries Once all the required media is in place and libraries configured, open the Server Settings Library page and click on \" Scan Library Files \" Note It is advisable that you do defer installing the additional plugins until you confirm that the restored server is functioning with no new issues after the restore. With the Emby Server operational and all media accessible, you can now install any Plugins that you had added to the server that is being restored. The configuration files for the plugins are automatically restored, so once the plugins are added and the server restarted to complete the plugins installation, the plugin configuration files should get picked up. Note Be aware that some plugins may have additional data eg a database that would need to be copied over manually or an application that may need to be installed. Please carefully check the requirements for each plugin. If you have Live TV configured, go to server settings / Live TV and perform a \"Refresh Guide Data\""
  },
  "articles/Backup-Using-Plugin.html": {
    "href": "articles/Backup-Using-Plugin.html",
    "title": "Backing Up Emby Server | Emby Documentation",
    "keywords": "Backing Up Emby Server We recommend using the Backup & Restore plugin, which is designed to make this process really painless by doing the work for you. This plugin requires Emby Premiere and can be found in our plugin catalog. The Backup & Restore plugin can help you backup and restore the following: Server configuration Users User data: play-states & favorites Plugin settings Playlists Live TV Schedule This will not backup library contents. For metadata, there are options to include all metadata in the backups. You can configure your libraries to save nfo and image files alongside the media within the media folders and they would then be included in your own library media content backups. Note If you have configured camera uploads and/or Live TV recordings, the default directories for these (data\\camerauploads and data\\livetv\\recordings) are not part of the backup. You would need to back these up yourself and re-instate on the target new location. Note When migrating to a new machine, media paths will need to remain the same as on the original server. The libraries top level folders can be different on the new machine. File Path separator / or \\ will need to be the same on both systems. This means Windows to Windows and Linux/NAS/Mac to Linux/NAS/Mac. Important Backups created on older versions of Emby Server (4.7 and earlier) are not compatible and cannot be restored into Emby Server 4.8 or later. How to use the Backup & Restore Plugin Be sure your Emby Premiere key is properly installed and validated. Backup & Restore requires Emby Premiere . Make sure there are no pending updates to the plugin, requiring a server restart to be applied. Restart the Emby Server to apply the updates if the server dashboard indicates that. Launch Backup & Restore from within the Emby Server Advanced settings sidebar. Configure the Backup plugin by setting a folder to save the backups within. Initially the backup folder path will be undefined. No backups will take place until this path is defined. The default backup will backup some of the metadata sub-folders and others will be left to you to decide if they should be included. For the database backup, the default is to have one set of backups. Important You must set a path for backups by changing the default \"undefined\" path setting to an actual path and saving that for the backups to start. Please ensure that the system user account that Emby Server runs in, has full permissions to this backups path. Paths must be absolute and not relative. Enter a path for the backups, e.g.: Decide if you want to backup all metadata. If you do include the additional metadata sub-folders in the backup, make sure there is sufficient disk space for the backups. Backups will take much longer to run, specifically for the first backup. If you wish to migrate the server to a new system, it is advised to create a backup that has all the possible metadata that can be backed up. Tick all 4 metadata options and save the changes. If you wish to keep additional backups of the database files, you can specify that. By default, only one backup set of the databases is produced. Now click \"Save\" . Note If running Emby Server on Windows as a Windows Service, the backup path needs to be to a local drive or using UNC path if it is an external shared network drive. This is because Mapped Network Drives would not be available to a Windows Service. e.g. Use \\\\server-name\\share-name\\backups-folder-name as path and not a mapped network drive. By default, the backup process will run once a day soon after midnight. This can be changed in Scheduled Tasks settings. In Scheduled Tasks, you can manually run the schedule for \"Emby Server Backup\" after backups setup, if you wish to confirm that the backups succeed, rather than wait for the scheduled task to run later on. Note Keep a record of what plugins you add to the Emby Server, as whilst the backup operation does save the configurations of all installed plugins, any added plugins will need to be manually installed after the restore of the server. Some plugins may have database files. These are not included in the Emby Server backups. The Plugins should only be added to the new server after you have confirmed that the restored Emby Server is operational."
  },
  "articles/Book-Naming.html": {
    "href": "articles/Book-Naming.html",
    "title": "Book Naming | Emby Documentation",
    "keywords": "Book Naming This file naming guide applies to books, both electronic and audio books. Library Setup When setting up the library, make sure to select Books as the content type. Supported Media Types For electronic books, the following types are supported: pdf epub mobi cbr cbz azw3 For audio books, the all of the same audio formats from music libraries are also supported. File Naming When setting up the library, make sure to select Books as the content type. For books , it is recommended to have only the title and year , followed by the extension. To improve matching add the year within parenthesis to the end of the file or folder name (before the extension, if file name). This naming standard will generally yield the best results. Examples: \\Books\\Pulp Fiction (1994).pdf \\Books\\Reservoir Dogs (1992).pdf \\Books\\The Usual Suspects (1995).pdf \\Books\\Avatar (2009)-cd1.pdf \\Books\\Avatar (2009)-cd2.pdf \\Books\\Avatar (2009)\\somefilename.pdf \\Books\\The Usual Suspects (1995)\\somefilename.pdf"
  },
  "articles/Camera-Upload.html": {
    "href": "articles/Camera-Upload.html",
    "title": "Camera Upload | Emby Documentation",
    "keywords": "Camera Upload Camera upload allows automatic uploading of photos taken from mobile devices to your Emby Server. It requires Emby apps installed on your mobile devices as well as for the app to support the feature. Currently, the apps that support automatic camera upload are: Android Emby for iOS Enabling Camera Upload To enable camera upload for an Emby app, you'll need to first enable it within the app's settings menu. Customizing the Upload Location There are a few options that allow you to control where the uploaded photos are saved to. By default, they are saved to an internal data folder, and all devices upload to the same folder. You can easily change the upload folder to a custom path, and/or you can also have a sub-folder created for each device. To access these settings, open the Emby Server dashboard and navigate to Devices -> Camera Upload. Note : When using a custom upload path, you will need to add that path to the server library. It is also possible to assign a custom upload path individually for a device. For more information on this, see device settings . Uploading from Apps Uploading is automatic and does not require any intervention on the part of the user. Please note that some apps will only upload under certain conditions, such as being on wifi, having a certain connection speed, or a certain battery charge percentage, as well as other device-specific factors."
  },
  "articles/Channels.html": {
    "href": "articles/Channels.html",
    "title": "Channel Plugins | Emby Documentation",
    "keywords": "Channel Plugins Channels Plugins provide access to streaming internet audio and video. For more information on plugins, as well as how to install and configure them, see Plugins . Channel Settings To configure the settings for an individual channel, simply click on it within My Plugins ."
  },
  "articles/Chromecast.html": {
    "href": "articles/Chromecast.html",
    "title": "Chromecast | Emby Documentation",
    "keywords": "Chromecast Emby supports casting to Chromecast in the following apps: Android Mobile (Google Play) iPad iPhone Web App (Chrome only) Local Web App (Chrome only) To connect to your Chromecast device, simply click the cast icon in the top right corner of the app. You'll then be asked which device you'd like to connect to. Emby for Chromecast can handle just about any type of media thanks to Emby Server transcoding . If you would like to learn how to prepare your media for Direct Play, read below. Direct Play Media Formats Video — MP4, M4V, MKV, WEBM Subtitles - SRT and other text-based formats Audio – AAC, MP3, WAV, FLAC, OPUS FLAC is currently only supported by Chromecast Audio devices. All other Chromecast devices can play FLAC using Emby Server transcoding. Best Practices for Direct Play Ensure your media meets the above criteria. Leave the casting app's Chromecast streaming bitrate setting on the default value of Auto, if possible. The app will perform bandwidth tests with your Emby Server to determine the maximum playable bitrate. If you are customizing the bitrate setting, then you will need to compare the bitrate of your files to the bitrate setting in the app. You can find the bitrate of a file by checking the media info in the web interface. If the bitrate of a file is higher than the setting in the app, transcoding will be required. Increasing the bitrate setting in the app can help reduce transcoding, but may impact playback performance if your network connection is not fast enough to handle it."
  },
  "articles/Cinema-Intros.html": {
    "href": "articles/Cinema-Intros.html",
    "title": "Cinema Intros | Emby Documentation",
    "keywords": "Cinema Intros Cinema Intros brings the theater experience straight to your living room with the ability to play trailers and custom intros before the main feature. Cinema Intros is configured in the server dashboard by navigating to the Cinema Intros menu. By default it is disabled. Choosing when to enable Cinema Intros The configuration page allows you to choose the types of videos that will trigger cinema intros. Currently, Movies and Episodes are supported. A video is determined to be a Movie or Episode based upon the content type chosen when setting up the library. Internet Trailers A vast library of internet trailers are available for use with cinema intros. The categories available are for new movies and movies coming soon to theaters, with option to include trailers for older movies. This feature has two requirements: An active Emby Premiere subscription Installation of the Trailer plugin , either before or after enabling cinema intros. Local Trailers If your movie folders contain local trailers, enabling this option will allow these trailers to be used within cinema intros. See trailers for more information. Custom Intros In addition you can specify your own custom videos to be used with cinema intros. Simply create a folder containing the videos, and enter the path in the custom intro field: Important : Make sure to run a library scan after adding new intro files. Codec Intros Codec intros allow you to create intros based on the media information of the main feature you are watching. For example, if you're watching a movie with AC3 audio, you can create an ac3 intro called ac3.mp4, and place this in your codec intro path. The following fields are used to determine a match: Video Codec Audio Codec Audio Profile Tags Here are some examples: (extension doesn't matter) A movie has h264 video, intro file is named \"h264.mp4\" A movie has ac3 audio, intro file is named \"ac3.mkv\" A movie has eac3 audio, intro file is named eac3.mp4 A movie has DTS-HD MA audio profile, intro file is named \"dts-hd ma.avi\" You've added a tag to a movie called \"waffle\", intro file is named \"waffle.mpg\". Tip The file name (before extension) should be the same name as the codec shown when looking at a video for either audio codec or video codec. To review the media information for one of your videos, visit the detail screen in the web app. Simply create a folder containing the videos, and enter the path in the codec intro field: Important Make sure to run a library scan after adding new intro files. Tip With the use of Custom Intro directories you can make use of Tags for each movie/episode such as \"HomeMovies\". These tags can be added using the MetaData Manager. Make sure that Intros added to the custom directories above have proper tags in the files before adding them to Emby. You can use Windows or other tag editor to assist with this. This allows Emby to display your custom Intro for any movie tagged with the same name. Number of Trailers played The initial default is set to 2. This can be modified in this setting: Trailers and Watched status The unwatched setting will prevent trailers that you've already seen from being used again, as well as trailers from movies that you've already seen. Note that enabling this setting may eventually result in no unwatched trailers being available. Parental Control Smart parental control will compare the ratings of trailers against the rating of the movie being played, and filter the trailers based on ratings of an equal or lower value. For example, you might be an adult watching The Goonies with your children. The Goonies is rated PG, so this setting will exclude any trailers with a higher rating than PG. Unrated trailers will also be excluded. Emby Apps Control Emby Apps have settings to enable or disable Cinema Intros. TV apps enable Cinema Intros by default. Click the user icon in the top right hand corner of the app screen and then select App Settings -> Playback and scroll down to see the Cinema Intros option."
  },
  "articles/Collections.html": {
    "href": "articles/Collections.html",
    "title": "Collections | Emby Documentation",
    "keywords": "Collections Collections are the grouping of like media such as: Back to the Future Collection Back to the Future Back to the Future II Back to the Future III The Terminator Collection The Terminator Terminator 2: Judgment Day Terminator 3: Rise of the Machines Terminator Salvation Terminator Genisys Automatic Creation of Collections Collections for Movies can be created automatically by Emby Server by by configuring each movie library on your system. There are only two options that need to be set. The first option is to either import collection information or not. The second option is the required number of movies your system must have to be considered a Collections. How to Create a Collection Manually To create a collection manually, start with a Movie, Series, or any other item in your Emby library. Open the context menu for that item using one of the following methods: Right click on the poster Use the 3-Dot menu on the detail screen Mouse over the poster and use the 3-Dot menu When the context menu appears, select \"Add to Collection\". You'll then be presented with a popup where you can add the item to an existing collection, or create a new one. The easiest way to automatically download image art and meta-data is to use the same name as the collection found on TheMovieDb.Org. You can check the name on TheMovieDb.Org by doing a “collection” search on their site like \"Star Wars Collection\". In this case it would return 4 collections you can match against: Star Wars Collection Lego Star Wars Collection Robot Chicken: Star Wars Collection Star Wars: The Ewok Adventures Collection Just choose the proper collection name from the returned results. As mentioned you can add several movies at a time to a collection and also use collection names that aren’t on TheMovieDb.Org. Here is an example of a collection useful for grouping movies to a particular artist such as Charlie Chaplin. First we long press on the first poster we wish to add until we get this Next we click the top left box to select additional movies and then we click the 3 dot menu top right. We fill in the proper information and click OK to create a new collection. We now have a collection added for Charlie Chaplin without poster art or meta-data. Next, we can add our own information by editing the collection. First we can edit the text that shows up for the collection. We do this by clicking the 3 dot menu and choosing “Edit metadata” from the popup menu. We then scroll down and fill in our description in the “Overview” field and then we click Save. We manually add cover art doing a similar process. We click the 3 dot menu and select “Edit images\" from the popup menu. We now click the PLUS sign above to arrive at this screen From here you have a couple of choices. You can drag and drop an image into the dashed box or you can click the Browse button to navigate to a local image on your computer. Besides navigating and selecting local files there is a neat trick you can use to automatically download internet artwork. If you open a new tab in your browser you can do a Google Image search for Charlie Chaplin. Once you find an image that interests you right click the artwork and click the “Copy image address” option. Now that we are back to our Emby tab we click the Browse button which will open a dialog box (on Windows). We then RIGHT CLICK the file name field to paste the location we just copied from the Internet previously into this field. After pasting in the link click the Windows Open button and Emby will import the image. We can now see the image has been imported into the Emby dialog and we are ready to upload it by clicking the Upload button. It will now be added to the server. We could add additional images if needed but since we only require one image for our needs we will click the left arrow at the top of the dialog. We now have a completed manual collection that we have edited. As you can see in the picture and from the edit metadata menu there is additional information you can edit such as ratings, year, genres and other information. Removing Items from a Collection To remove an item from a collection, first browse to the detail screen for that collection. Each item in the collection will have a 3-dot menu. To remove an item, click the 3-dot menu, then select \"Remove from Collection\"."
  },
  "articles/Collections-Manual-Migration.html": {
    "href": "articles/Collections-Manual-Migration.html",
    "title": "Manage Collections (Legacy) | Emby Documentation",
    "keywords": "Manage Collections (Legacy) Important This does not apply to Emby Server version 4.6 and later. Collections are stored in the database with later versions. If you ever move you content around on disk after you have already created collections you will need to either rebuild those collections using the Web GUI or you can manually edit the individual text files that hold all collection info. This tutorial will cover how to manually edit your collection info. The files that hold collection information are stored in the “data\\collections” folder which is directly under your Emby Server folder. If on Windows it can look something like: C:\\Users\\SomeUserNameHere\\AppData\\Roaming\\MediaBrowser-Server\\data\\collections An easy way to find this folder on ANY OS Emby runs on is to go to your Web Dashboard and scroll down the right side until you get to the PATHS section which will look something like this: If you look at either the LOGS or METADATA entries and remove the last part of the folder name you would have (in this example): C:\\Users\\Administrator\\AppData\\Roaming\\MediaBrowser-Server\\ Add “data\\collections” to the end of that line to arrive at: C:\\Users\\Administrator\\AppData\\Roaming\\MediaBrowser-Server\\data\\collections This folder will contain our list of collections which will look something like this: Each of these folders represents one collection. If we enter a folder such as the 300 Collection shown above we will have a few files that will look similar to this. You can see we have some fanart and a poster as well as the collection.xml file which will hold the information we plan to edit. You can edit this with any text edit such as NotePad or Notepad++. We’ll use Windows Notepad in this example. Once opened in Notepad we’ve scrolled down to the bottom of the file where the paths are located. You can see in this collection there are 3 files. Two normal videos and one 3D version. The paths are: F:\\Movies#\\300 (2006)\\300 (2006).mp4 F:\\Movies#\\300- Rise of an Empire (2014)\\300- Rise of an Empire (2014).mp4 F:\\3D Movies\\300- Rise of an Empire (2014).3D.Half-SBS\\300- Rise of an Empire (2014).3D.Half-SBS.mp4 Assuming we have moved all of our 3D movies to Drive G and moved our normal moves (first two) to drive M we would have: M:\\Movies#\\300 (2006)\\300 (2006).mp4 M:\\Movies#\\300- Rise of an Empire (2014)\\300- Rise of an Empire (2014).mp4 G:\\3D Movies\\300- Rise of an Empire (2014).3D.Half-SBS\\300- Rise of an Empire (2014).3D.Half-SBS.mp4 All we need to do is edit the PATHS show above in Notepad so it looks like this: Save your changes in Notepad and repeat for the next collection you need to change. Note Please make sure the paths you use exactly match the way you set your library up. If for example you setup your library using: \"D:\\movies\" but your current playlists have \"\\server\\movies\" this will not work. Make sure you are consistent and use either drive letters or UNC style paths for both the libraries and the collections. When you are finished editing your collections, please run a library update by clicking the \"Scan All Libraries\" button at the top of the Library menu page. Playlists can be migrated the same way as collections. See this article for assistance with playlist migration."
  },
  "articles/Connectivity.html": {
    "href": "articles/Connectivity.html",
    "title": "Connecting from Client Apps | Emby Documentation",
    "keywords": "Connecting from Client Apps The purpose of this document is to discuss how to connect to the Emby Server from additional devices, both within your home network and externally. Browse this document to aquaint yourself with the types of issues that may arise and what they would impact and how to address them. For any new connectivity issues, use the checklist below to troubleshoot : Troubleshooting Connectivity Issues Checklist . To learn how to grant users access to your server, see Users . In most cases you won't need to do any extra configuration to connect to your server from other devices, as Emby apps are built to automatically know how to connect to it. But on some systems or if you have more than one emby server with remote access enabled, some manual configuration may be necessary. This document is primarily designed for troubleshooting, when the automatic features do not work and a custom configuration is needed. In-Network Connections Most Emby apps can automatically discover your Emby Server on your home network, so in those cases, there's nothing more you need to do. But in the event this does not work, you can still connect to your Emby Server by manually entering the server's address. To locate your server's internal address, simply open the Emby Server Dashboard on the Emby Server machine, typically through http://localhost:8096 and clicking on the Manage Emby Server gear icon in the top right corner. Your Emby Server's local address is then displayed in the In-Home (LAN) access field in the Dashboard view. This information can then be entered into Emby apps when making a manual connection through the Add Server option: It is recommended that the local IP Address for the Emby Server machine should be fixed. Use the router's DHCP Reservation feature to do that. Here is a general guide for doing this. https://portforward.com/dhcp-reservation/#how-to-make-a-dhcp-reservation-in-your-router Troubleshooting Internal Connections If the above still does not work, please ensure the machine running Emby Server is turned on, and that the Emby Server application is running. Check through Task Manager on Windows, Activity Monitor on MacOS, or ps -e command on Linux. A useful test is to try to use a web browser on another device, such as another computer, smartphone or tablet. You'll need to ensure the other device is connected to the same WIFI network. Try opening a web browser on that device and entering the local address manually: Windows Network Profile If running the Emby Server on Windows, check that your network connection is set as Private and not Public . The profile may get switched to Public after re-configuration or updates. Check all the Windows network connections, Ethernet and WiFi. Example for an Ethernet connection: See section headed Make a network public or private in this Windows support article Essential Network Settings and Tasks in Windows . The follows shows the differences between the two network profiles: If this is set correctly as Private and you are still unable to connect to the emby server locally, then most likely the firewall on the server machine is not allowing access. Below are a list of troubleshooting steps that can be taken to resolve this. Open TCP Ports 8096 / 8920 & UDP Port 7359 on your server's firewall If running Windows, the built-in Windows Firewall is usually auto-configured by Emby Server. You may validate this by inspecting the Windows Firewall rules and checking to see Inbound Rules for the EmbyServer.exe for both tcp and udp and Inbound Rules for local TCP ports 8096 and 8920 and for server discovery on the local network, UDP port 7359. The port rule names are being changed and you may see them as: and for the program rules: To configure the windows firewall, see How to open a port in Windows Firewall which goes through an example of how allow a specific port through the firewall. Enter port 8096 instead of the port shown in this example. If you have secure connections enabled, do the same for tcp port 8920. And add a rule for UDP port 7359 - this is used for server discovery by client apps. Important Please do not attempt to skip this step by disabling Windows Firewall, as this usually does more harm than good. If you're using third party firewall software, you'll need to follow it's instructions to open the port. Note If you're using third party antivirus software such as Norton Internet Security, it will most likely have it's own firewall that will need to be configured. Run an AntiVirus Scan If you're certain you've opened the port and are still unable to connect, the next step will be to ensure the server machine is free of viruses and malware. See AntiVirus software . Check \"LAN Networks\" server Network setting If the LAN Networks setting is filled in with a value, make sure that the local network is included. If the field is empty and you are using only one network subnet, then this is not relevant to the problem. If you have more than one local network subnets, include all the subnets in the LAN Networks field. Router AP Isolation If you find that wired devices can access the Emby Server but not devices on wi-fi, check the router wi-fi settings to see if \" AP Isolation \" is enabled. Disabling this would allow wi-fi connected devices to see other devices on the local network. This would be a valid setting to have enabled for a \"Guest Network\", so check first if your wi-fi is configured as a Guest Netowrk. Use of VPN When using a vpn on your router, the requests coming into the server from within the local network may not appear as local. You would need to add the local network subnet used by the vpn to the LAN Networks server Network setting. Ensure you also include the local network subnet that the server is connected to as well. As an example, if your local network is on subnet 192.168.1.xxx and the vpn is using subnet 10.253.0.xx, then you would enter: 10.253.0.0/24,192.168.1.0/24 in the LAN Networks server Network settings covering IP address ranges 10.253.0.1 to 10.253.0.255 and 192.168.1.1 to 192.168.1.255. See LAN Networks . CORS Mixed Content Block When using the hosted Emby Web app at app.streamora.example , access to the Emby Server may be blocked when https secure connections is not enabled on the server and the access in the internet browser is through https://app.streamora.example . It gets blocked by the browsers because mixed mode of https and http is not permitted. Entering the http url in the browser http://app.streamora.example would get round this problem. You can establish if this is due to the CORS mixed mode error, by opening the browser Dev Console (through the F12 key) and checking the console for errors. You would see an error like this External Connections Emby Server also allows you to connect when away from home. We call these external connections because they're out of our home network. Before we begin, we'll assume everything covered above in the In-Network Connections section is functioning correctly with your Emby Server, and that you're able to connect using other devices in your home network. If not, then you'll want to go over that section first. Turn on Remote Access The first step is to ensure remote access is enabled. You do this from the Server's Network menu by enabling \"Allow remote connections to this Emby Server\". Note Once you have remote access working, if you wish to allow users to connect remotely, you will need to also enable the option for the user accounts - see Users . On the same page down below this section, you will see this option: If you have a router that supports UPnP and have this turned on, you can enable the \"Enable automatic port mapping\" feature. If you do not see this option, please install the Port Mapper Plugin from the plugin catalog. Note Most routers have the UPnP option turned off by default. If you turn on automatic port mapping in Emby Server (option shown above) and enable UPnP on your router, you likely are done and Emby will work remotely! Note If you just enabled UPnP on your router, please restart the Emby Server. Automatic Port Mapping When \"Enable automatic port mapping\" is enabled, Emby Server will initiate a port mapping request to the router for the http port, and if secure connections are enabled, to also do it for the https public port, to forward to the local ports. Automatic port mapping requires uPnP to be enabled in the router, as mentioned earlier. The public ports are by default set to: You may wish to change the public port numbers for added security. The following shows the local ports for the server. It is recommended that these local port numbers are left as per the default: There are tools available to show you what ports are mapped in the router through uPnP. These are useful, because not all routers give details of what dynamic port mapping through uPnP is active. One such tool is uPnp Wizard . If automatic port mapping does not work, you should disable the setting and switch to setting up port forwarding manually on the router. Note If you have more than one router, you will need to do the port mapping manually. See the next section. Setup Port Forwarding If you're unable to connect after testing the above settings with automatic port mapping, then you may need to setup port forwarding manually in your router to allow external connectivity to your Emby Server. To do this, turn off the \"Enable automatic port forwarding\" option just set and open the web interface for your router. If using the default public port numbers, you will need to setup a port forward rule for TCP Port 8096 on your router to port 8096 on the Emby Server machine. Do the same for port 8920 as well (if using SSL/secure connections). If you have chosen different public port numbers, then it would be these that need to be specified in the port forward rules. It is important that the local IP Address for the Emby Server machine does not change. Use the router's DHCP Reservation feature to do that. A good general guide can be found here . The process of doing a port forward will be slightly different for each router model. Here are good step by step general guides on how to do this: https://portforward.com/dhcp-reservation/#how-to-make-a-dhcp-reservation-in-your-router http://www.wikihow.com/Set-Up-Port-Forwarding-on-a-Router This Youtube video also explains Port Forwarding pretty well: https://www.youtube.com/watch?v=Kp-R-eHiQco If you want to use different public port numbers, enter the required public ports in the server Network Settings fields. Here is an example router setup showing 2 tcp ports forwarded - using the default public port numbers: You will find different names for the ports on different routers when setting up the rules. e.g. The public ports may show on the router as WAN Port, or Public Port, or External Port. The local ports may show as LAN Port, or Local Port, or Internal Port or Private Port. Note that the Source IP / Remote IP should always be blank in a port forward rule. The server IP Address, to which the port forwards are routed to, may show on the router port forward setup page as host computer, Local IP Address, or Internal IP Address, or Private IP Address. Multiple Emby Servers on the network If you have more than one emby server on the local network, then you will need to make sure they use different public port numbers as they would be routing through the same public IP address. The default public / WAN ports are as follows: Set a different http and https port (where applicable) for each of the servers. If your first server used 8096 and 8920, then you only need to change the public ports for the other server(s) to use different port numbers. Multiple Routers / Mesh Network Added If you have more than one router, eg an ISP provided router and also your own router, or you've added a Mesh Network, then that could lead to a Double NAT which would give rise to failure to reach the server externally. To establish if you have a Double NAT and what steps you need to take to get round the issue, see Multiple Routers Double NAT below. Basically you will have two ways to choose from, either by making sure there is only one operating as a router or to manually setting up port forwards to cascade all the way through. Locate Your External Address & Public Port You will need to find out what your external IP address is, when troubleshooting remote connectivity issues or to add a manual connection to the server from a remote emby client. When remote connections are enabled, your external address is displayed on the front page of the server dashboard, labeled as Remote (WAN) access . The public port is also shown. This is the address you should use when away from home together with the public port number. Verify Your External IP Address Open a browser and visit canyouseeme.org . The IP you see listed here must match what Emby shows on the dashboard. If it doesn't, remote access will not work and likely your ISP is using cgNAT or you are using a VPN. If the IP address matches, then you can proceed to test the connection through the public port. If your external IP addresses changes frequently, consider using a DDNS setup (Dynamic DNS). Verify Public IP and Port Again, you can use canyouseeme.org in a browser and enter each of the public ports that have been configured. You can also test your external address and public port by opening a web browser while away from home, or inside your home using a smart phone or tablet with the wifi connection turned off. Important Testing your external address inside your home might not work, and this is OK. Some internet routers disable loopback capabilities (going out and coming back in), therefore you might not be able to test this from inside your home network. It's important that you test away from home, or with your smart phone's or tablet's wifi connection turned off. If these succeed, your Emby Server should be working remotely and can proceed with connecting from Emby apps. But, if you find that even with this being successful, a device is still failing to connect remotely, check that you have allowed remote connections for the user account that is making the attempt. Refer to Users Settings and check that in the user settings, \"Allow remote connections to this Emby Server\" is ticked for that user account. If you continue to fail to connect remotely, you should re-check the setup mentioned above and you will need to do some further troubleshooting. See below for a checklist of the troubleshooting areas. Please visit our forums for assistance, if you continue to have an issue with this. Troubleshooting External Connections VPN If you have a VPN running on the host computer, TURN THIS OFF as that may interfere with your Emby Server routing. Anti-Malware and Firewalls If this is not the case, try temporarily disabling (turn off) any local malware & firewall software running on the same host, to see if they may be blocking Emby. If this was the cause, then you will need to look into the Firewall / Security software to configure it so that the Emby Server application is allowed to accept external connections into the local http and https tcp port for the server Local IP Address change If you are using a manual port forward setup and the local IP Address changes, then the existing port forwards will no longer route to the server. Look into fixing the local IP Address using static IP address or preferably a DHCP Reservation in the router, or both. Make sure any port forwards are updated to the new local IP address. See https://portforward.com/dhcp-reservation/#how-to-make-a-dhcp-reservation-in-your-router cgNAT Double NAT You could also be having a Double NAT setup through your ISP giving you a cgNAT (carrier grade Network Address Translation) public IP address. To check if you have been given a cgNAT public IP Address, see if it is within this IP range 100.64.0.0 - 100.127.255.255 If it is the case, you would need to ask your ISP to give you a static public IP address outside this range. ISPs normally have a monthly fee for this. External Public IP Address change If your external WAN/Public IP address changes, you may find that emby clients fail to connect to the server, especially if the server connection details were added manually on the client app Add Server screen. In such case, you will need to delete the server details on the client - on the Select Server screen and add it again with the new connection details. You can mitigate the impact of changes to the external IP address by exploring the use of a DDNS (Dynamic DNS service) configuration. Alternatively you can request a static Public IP Address from your ISP. There would normally be a charge for that. You can also look into using Emby Connect to link the local emby user account to your Emby Connect email address and use Emby Connect login within the app to connect to the server. See section on Emby Connect below. Multiple Routers Double NAT If you have 2 routers, eg an ISP provided router and your own router, there will be Double NAT and port forwarding will not work. Similarly, if you have added a Mesh Network then there could be a Double NAT. A Double NAT can be confirmed by checking the Public IP address displayed by https://whatismyipaddress.com/ or https://canyouseeme.org and comparing it to the WAN IP address displayed within the router/mesh network control device settings, the one that the emby server machine is connected to. If the addresses do not match, then most likely you have a Double NAT. Note A cgNAT public IP address may also show up as Double NAT. To establish if it is due to cgNAT, see cgNAT Double NAT above. If there is a Double NAT due to having multiple devices operating as network routers, you will need to make sure only one is acting as a router or a more complex option, to cascade the port forward all the way through to the Emby Server, going through both. If you have added a Mesh Network , you can set the device to operate as an Access Point and not a router. This would then leave your existing router to have the port forward. The following is an example for a TP-Link Deco M9 Plus Mesh Network. The Deco mobile app has in Advanced Settings an option for changing the operation mode. and in the following, you can see it is set to operate in a passive mode as an Access Point . In the case of an ISP Modem/Router and also having your own router, the best option here is to see if the ISP provided device can be set to operate in Modem / Bridge only mode and that would leave your router to manage the port forwarding and local network. You may need to contact your ISP if the modem/router settings are locked down. For this, you can also operate with the ISP Modem/Router acting as a router and your own router switched to be in Access Point mode. For both cases mentioned above, you can keep them operating as routers but you would then need to have a complex port forward setup where the port forward on the first router (ISP router) is manually setup and cascaded through to the second router/mesh network device and that would have the port forward to the Emby Server. In the example below reference to second router also means the Mesh Network main controlling unit. In this example, if your server public http port is 32700 Have the local IP address of the 2nd router as a DHCP reservation in the first router - so it remains fixed. You would need to find the Mac Hardware address of the WAN Port of the 2nd router and use that to specify a DHCP reservation for it in the first router On the first router, setup a tcp port forward for http port 32700 to forward to port 32700 to the local IP address of the second router. On the second router, setup DHCP reservation for the Emby Server local IP address On the second router, setup port forward for the http public tcp port 32700 to forward to port 8096 to the local IP address of the emby server machine. If you have also enabled https and for example you have public port 32800 for that, then you would need to repeat the steps above to forward 32800 from first router to the second router and then forward 32800 to the emby server local IP Address to tcp port 8920. Multiple Servers - Public Port clash If you have more than one system running emby server on the local network and remote connections enabled, then with the default settings there would be a public port clash and the remote connections would be attempting to go to the first system that was configured. In such cases, you will need to change the public ports and ensure that each emby server has a different public port. ISP Blocking You may also be blocked by your ISP. Open command prompt session and do a trace route to 8.8.8.8. On windows it would be: tracert 8.8.8.8 Ignore the first line which will be your own router. What you want to see is if any of the next 3 or 4 lines start with 10., 192. or 172. If the first octet number is a 172 we need to check the second octet number to see if it's between 16 to 31 (172.16.xx.xx to 172.31.xx.xx). If any of these returned lines matches this you are likely being blocked by your ISP. Emby Connect Regardless of the method used for port forwarding, whether it is automatic using uPnP or a manual configuration of the router, we suggest trying out the Emby Connect feature as it takes the guesswork out of external connectivity. The Emby apps would find the route to the server using Emby Connect. See Emby Connect . Troubleshooting Connectivity Issues Checklist Use this checklist to help with finding out the cause of any new connectivity issues. 1. Local IP Address Check if the Local IP Address for the Emby Server changed. When this happens, any port forward in the router for external remote access would still be for the old IP Address. Client Apps may also be attempting to use the IP address already known to them from previous connections. You should use static IP address and/or DHCP Reservation for the device/computer running Emby Server. See section about that above in In Network Connections . If the IP Address has changed, any port forward in the router needs to be corrected - but only look into that after ensuring the IP Address will no longer change with use of static IP Address and/or DHCP Reservation. For manually created port forward, you will need to login to the router and correct the destination IP address for the port forward. See Setup Port Forwarding above. For automatically created port forward with uPnP and the emby server setting: Enable automatic port mapping , you will need to shutdown Emby Server, then reboot the router to clear the existing cached uPnP port forward and then launch Emby Server. If you are using Emby Connect, you may need to unlink and re-link the user account to the Emby Connect e-mail address to refresh the Emby Connect data. Exit Emby Apps and relaunch them. 2. Windows Network Profile If running on Microsoft Windows, check if the Network Profile got switched from Private to Public . This has been seen to arise after some system updates. See section Windows Network Profile above. 3. Public IP Address Check if the public IP Address for your network got changed. This does happen sometimes on router reboots or periodically by the ISP and would arise more frequently when the ISP provides you with a cgNAT IP Address. This would affect external remote access. Emby client apps may still be attempting to use the old Public IP Address known to them. If this happens regularly, look into using a domain name and DDNS service to periodically refresh the IP address. See section External Public IP Address change above. If you have a cgNAT IP address, you should be able to request a static public IP address from your ISP for a small fee. See section cgNAT Double NAT above. You can test out access to the server with the new public ip address by adding the server manually on the Select Server screen and giving the public IP address and public port. Note that access through the public IP address may be blocked by routers if you try to test it out locally. Best to do this test externally and could be done on a mobile device connected through cellular connection and not wifi. If you are using Emby Connect, you may need to unlink and re-link the user account to the Emby Connect e-mail address to refresh the Emby Connect data. 4. Router Settings Sometimes router settings get lost and any existing port forwards may disappear. This has been seen to happen after some remote ISP updates to routers overnight. If you had any manual port forwards, and they no longer show, you will need to reinstate them. See Setup Port Forwarding above. The next checklist is to help with issues arising after a change. 1. vpn added See section Use of vpn above. 2. Switched ISP provider You may find that after switching ISP, you are now given a cgNAT IP address or that your public IP Address is now changing more frequently than before. See sections cgNAT and External Public IP Address change above. 3. Added a modem/router or mesh network This may give rise to a double NAT setup. See Multiple Routers Double NAT and Multiple Routers / Mesh Network Added sections above. 4. Added another Emby Server You may have added or launched another emby server and this new server is resulting in a port number clash. See Multiple Servers Public Port Clash 5. Restored server from backup If you have restored a server and restored the server id as well and not shutdown the old server, you will have two servers with the same ID. Make sure the old server is no longer running and would not auto launch. Finally, please do browse this whole document for additional information."
  },
  "articles/Content-Access.html": {
    "href": "articles/Content-Access.html",
    "title": "Content Access | Emby Documentation",
    "keywords": "Content Access Content access allows you to configure the libraries and channels a user is allowed to access. To manage content access for a user, navigate to the server dashboard -> Users -> Click User -> Access . Library Access Library access allows you to configure the media libraries a user can access. Where a library has multiple folder paths defined, you can also control access at the folder level. See Folder Based Access Control . Channel Access Channel access allows you to configure the channels a user can access."
  },
  "articles/Convert-Media.html": {
    "href": "articles/Convert-Media.html",
    "title": "Convert Media | Emby Documentation",
    "keywords": "Convert Media Want to reduce on the fly transcoding? We now have a feature that can help you convert your library into streaming-friendly formats. It's easy, just click on the 3 dot/more menu and select Convert on the popup menu. Then specify the options you want: Posted Image The media will then be converted and stored in the original media folder with the original item. Convert to Allows for a choice of replacing the current file or creating a new converted copy. Profile This option allows you to select Mobile, TV or Custom profiles to use. Mobile and TV profiles make the corresponding choices for you but if you select Custom you can choose many of your own options such as the container, video codec, and the audio codec. Quality The quality drop down box gives you several choices in Megabits per second to choose. Automatic Conversions Want to convert new content automatically as it gets added to your library? It's simple, just convert a folder such as a TV series, and then enable the option to automatically convert new content. Posted Image"
  },
  "articles/Corrupt-Database.html": {
    "href": "articles/Corrupt-Database.html",
    "title": "Corrupt Database | Emby Documentation",
    "keywords": "Corrupt Database If your server log file shows SQLite errors like the following example, it is most likely that your library.db file needs attention. SQLitePCL.pretty.SQLiteException What can cause this to happen Typical causes of this are sudden and abrupt terminations of the Emby server process, such as a power loss, operating system crash, force killing the server process, etc. Database errors could also arise if you switch back and forth between Emby Server public release and beta releases. Important In general, downgrade from beta to an earlier public release is not supported. Databases may be incompatible. The following logged database error indicates a corrupt database file: SQLitePCL.pretty.SQLiteException: Corrupt: database disk image is malformed SQLite tools can be used to try and recover from this. Alternatively, an easier option would be to see if you can restore the database from a backup - refer to Backup & Restore for details of how to restore the databases from a backup. Tip You should always check first, if restore from a backup, resolves the issue before attempting database repairs using the SQLite tools. Attempt to recover the database Identify the corrupt database Emby Server has 4 databases: activitylog.db , authentication.db , library.db and users.db . The main database is the library.db which tends to be the one that may end up with a corruption. There would be clues in the embyserver log file as to which database is corrupt. The following maps the internal database names to the actual database filenames: SqliteItemRepository library.db SqliteUserRepository users.db AuthenticationRepository authentication.db ActivityRepository activitylog.db As an example, the following log line within the logged error block indicates that the corrupt database is the library.db : at Emby.Server.Implementations.Data.SqliteItemRepository.Initialize Find Location of Database Files If the Emby Server is not launching due to the corruption, please refer to Server-Data-Folder for establishing where the Emby Server data is stored. The database files are in the \"data\" sub-directory below the path shown in the support document. Alternatively, you can find the path by using the \" ... \" top menu right above the server information box in the Emby Server Settings Dashboard. Click on View Server Info . The database files are in the \"data\" sub-directory below the Program data path shown. You will need to use a command-line window, linux shell window, mac terminal session to run the command line shell for SQLite. For NAS, an ssh connection would be needed to access the database files. For Android, adb would be needed. The examples below, will all be for the library.db . Solutions to Try in This Order Remove Database Locks Shutdown Emby Server if it is running and check that the EmbyServer process is no longer showing before proceeding to the next step. Check with Windows Task Manager , macOS Activity Monitor , top or \" ps -aux | grep emby \" on linux and NAS. In a command line window or terminal session on macOS, or shell window on linux and NAS, navigate to the data directory containing your database file. The following are a few examples, refer to the Server Data Folder document for the complete list. On some NAS systems, you may need to gain root privileges first by executing \" sudo -s \" first. Examples: Windows cd \"%AppData%\\Emby-Server\\programdata\\data\" Linux cd /var/lib/emby/data macOS cd ~/.config/emby-server/data or cd ~/emby-server/data Western Digital NAS cd /mnt/HD/HD_a2/emby/data Synology DSM 7 NAS cd /volume1/@appdata/EmbyServer/data Synology DSM 6 NAS cd /volume1/Emby/data QNAP NAS cd /share/CACHEDEV1_DATA/.qpkg/EmbyServer/programdata/data or cd /share/HDA_DATA/.qpkg/EmbyServer/programdata/data (see Server Data Folder for the paths for other platforms) Delete the library.db-shm & library.db-wal files if present. You can check if they are present using dir on windows or ls on other platforms. Windows del library.db-shm del library.db-wal Other platforms You may need to gain root privileges by executing \" sudo -s \" first. rm library.db-shm rm library.db-wal Restart Emby Server Check your server log for SQLite errors and only continue to the next step if needed. Check Database Integrity and Recover Database This step will require the use of the Command line shell for SQLite3 tool, which may be pre-installed on some platforms. It can be downlaoded as part of the Sqlite3 tools from https://www.sqlite.org/download.html . If you prefer a graphical based editor, you can download DB Browser for SQLite which is available for most platforms. The instructions given in this document are for the official SQLite3 tools provided by https://sqlite.org . Note On NAS platforms and for Android Emby Server, you may need to copy the database file to a computer and do the integrity check and repair on the computer and then copy the file back. Access to the database on NAS systems will require enabling & using ssh, and adb & enabling Developer Options for Android. The following shows the available sqlite tools binaries for download: Note On some NAS platforms, you may need to gain \"root\" privileges by executing \"sudo -s\" first. Alternatively, prefix commands with \"sudo\". For some platforms, you would be using root and there is no \"sudo\" command. Run Integrity Check Shutdown Emby Server if it is running and check that the EmbyServer process is no longer showing before proceeding to the next step. Check with Windows Task Manager , macOS Activity Monitor , top or \" ps -aux | grep emby \" on linux. Navigate to the folder containing your database file, see earlier paragraph covering this. If you downloaded the sqlite3 tools rather than using a pre-installed sqlite3 binary, copy the downloaded sqlite3 file (sqlite3.exe or sqlite3) to this directory to make it easier to use. Alternatively, create a temporary folder where you place the database file you are working on and the sqlite3 tool. Important Check that you are in the right directory, the directory where the database file is, as sqlite3 does not warn you if it it does not find the database and would instead create a new database in the current path. Open the library.db database and run an integrity check on it: sqlite3 library.db PRAGMA integrity_check; This should return an \"ok\" when there are no corruptions. If errors are reported, we need to repair the database. type in .quit to exit Examples of results: Corruption detected SQLite version 3.50.1 2025-06-06 14:52:32 Enter \".help\" for usage hints. sqlite> PRAGMA integrity_check; Parse error: database disk image is malformed (11) sqlite> .quit Successful integrity check SQLite version 3.50.1 2025-06-06 14:52:32 Enter \".help\" for usage hints. sqlite> PRAGMA integrity_check; ok sqlite>.quit Repairing the database With Emby Server shutdown, save a copy of the existing database file and then work on the actual database file. Windows copy library.db library-saved.db Other Platforms cp library.db library-saved.db Attempt to vacuum and reindex the database to see if that resolves the issue. Switch to the directory holding the database and open it and run the two commands: sqlite3 library.db VACUUM; REINDEX; The commands may take a while to complete. You may get errors indicating corruption. At the end, close the database and exit, with the .quit command. If there were no errors, then you can try to see if the issue is resolved. Restart Emby Server and check the emby logs for database errors. If database errors persist or the VACUUM or REINDEX failed, then we can try to run the .recover SQLite3 command. Shutdown Emby Server Navigate to the databases folder as before and open the database file with sqlite3: sqlite3 library.db .output recovered-librarydb.sql .recover This may take a while to run. At the end, type .quit to close the database file. The recovered-librarydb.sql file will contain the sqlite3 commands to recover the database. The file may be large but it is a text file, and you should be able to view its contents - using text editors that can handle potentially very large files. We can now create a new database file using this recovery file. Create a new database file and lets call it library-recovered.db . The following creates this new db file: sqlite3 library-recovered.db .read recovered-librarydb.sql (this may take a while to run, so please wait for it to finish) Enter .quit command to close the database and exit. We will now check the integrity of our recovered database by running: sqlite3 library-recovered.db PRAGMA integrity_check; This should return an integrity_check back of \"ok\" with no errors reported. If errors are returned, please report this in the forum before proceeding to Reset the Library Database. If \"ok\" and no errors are reported, continue with the next step. At this point, we have library-saved.db Original corrupt/suspect database library.db Original corrupt/suspect database library-recovered.db The new repaired database We will now rename the library.db to library.db.old and switch the new repaired database to be the library.db . Windows rename library.db library.db.old rename library-recovered.db library.db Other platforms mv library.db library.db.old mv library-recovered.db library.db If this is for a NAS and is being repaired on a computer, we now need to copy the new repaired library.db to the NAS databases directory. Similarly, if the repair was done working in a temporary directory, we need now to copy the new repaired library.db to the correct directory overwriting the corrupt/suspect database file. Ensure the new library.db has the same permissions and ownership as the original library. Adjust the permissions and ownership if not. For linux and NAS, the owner, group and permissions can be seen for files in the data directory by executing ls -ail . Restart Emby Server Check you server log for SQLite errors and only continue to the next step if the database still gives errors and the repair has not been successful. Steps to Reset Library Database & Start with a Fresh new setup of Emby Server Shutdown Emby Server Navigate to the databases folder as per the earlier instructions Rename library.db to library.db.corrupt Windows rename library.db library.db.corrupt Other platforms mv library.db library.db.corrupt Restart Emby Server Recreate your media libraries"
  },
  "articles/Device-Access.html": {
    "href": "articles/Device-Access.html",
    "title": "Device Access | Emby Documentation",
    "keywords": "Device Access Device access allows you to configure the devices a user is allowed to sign in from. By default, users can use any device. To manage device access for a user, navigate to the server dashboard -> Users -> Click User -> Access . Important notes about device control : Filtering devices for a user will prevent them from being able to sign-in with a new device until it is enabled from this page."
  },
  "articles/Devices.html": {
    "href": "articles/Devices.html",
    "title": "Devices | Emby Documentation",
    "keywords": "Devices The devices section displays all devices that have connected to your server, both active and inactive. It also allows you to customize the display name. Devices are accessed from the server dashboard by navigating to Devices . A list of devices will be displayed, for example: Or by clicking the 3 dot menu you can change the view to \"list\" for this: Removing a device To remove a device from the list, hover over the image to get the three dot menu. In list view the 3 dots are on the right. Click the 3 dot menu for a popup that looks like this: From here you can delete the device or edit the display name."
  },
  "articles/DirectPlay-Stream-Transcoding.html": {
    "href": "articles/DirectPlay-Stream-Transcoding.html",
    "title": "Playback Methods | Emby Documentation",
    "keywords": "Playback Methods Direct Play vs Direct Streaming vs Transcoding Emby can presently deliver your media in one of three ways: Direct Play Media file is used AS IS without any modification. It can be sent from the Emby server or (some clients) allowed to be played directly from the file system. The media fits all the criteria needed by the client including: Stored in a compatible file container playable by the client Encoded with compatible codecs for the client Encoded with a compatible bit rate for the client Has a resolution compatible with the client Direct Stream Also known as transmuxing. The Media file is altered in real-time while being delivered to the client. This happens when the video codec is correct but something else needs converting like the streaming type (package), audio or subtitle track. In this case the server extracts the video track from the file as well as other tracks it can use. Emby may convert the audio or subtitle tracks on the fly during a Direct Stream. Direct Streaming does not touch the video tracks in anyway so there is no loss of video quality. Direct Streaming is not very CPU intensive. Transcoding Transcoding takes place when the video needs to be converted. This could be because the video codec isn't support, the bitrate of the video is higher than the client can use, a subtitle needs to be \"burnt\" into the video. Transcoding at a high level, is taking already encoded content; decoding it; and then altering it. After altering, it is then reassembled/encoded back into a format compatible with the client app using the proper bitrate and a format the client app can use. Transcoding is more CPU intensive then Direct Streaming due to having to decode/alter/recode the video. There will be some loss of video quality when transcoding takes place. Emby supports offloading the transcoding process to a GPU"
  },
  "articles/Dlna-Profiles.html": {
    "href": "articles/Dlna-Profiles.html",
    "title": "| Emby Documentation",
    "keywords": "Coming soon."
  },
  "articles/Dlna-Server.html": {
    "href": "articles/Dlna-Server.html",
    "title": "| Emby Documentation",
    "keywords": "Coming soon."
  },
  "articles/Dlna-Settings.html": {
    "href": "articles/Dlna-Settings.html",
    "title": "| Emby Documentation",
    "keywords": "Coming soon."
  },
  "articles/DVR-Settings.html": {
    "href": "articles/DVR-Settings.html",
    "title": "DVR Settings | Emby Documentation",
    "keywords": "DVR Settings To set the optional Advanced settings, click Advanced in the administrator dashboard under the Live TV Menu. Live Stream Buffer You will have an option to limit the Live Stream buffer. Guide Data Days Also you can specify the amount of Guide Data that is loaded. You can manually set this from 1 to 14 days or leave it set to Auto. When you leave it set to Auto, Emby will choose the amount of days loaded based on how many channels you have defined to balance performance with the convenience of having as much guide data as possible. Waking from Sleep for Scheduled Recordings There is an option for waking the server machine to perform scheduled recordings. Start / End recordings padding You can set custom start and end times to pad your recordings. These are blank by default but in this example below, both were set to 5 minutes. With the above settings in place all recordings schedule will have a default start time of 5 minutes before the scheduled time and will end 5 minutes after the scheduled end time. When individual events are schedule to record by a user in any Emby Application these settings will be the default used. This can be overrode for each individual recording if needed. For example people recording sporting events will often change the end time to 30 or 60 minutes to make any overtime play is taken into consideration. Default Recordings Library Paths The next three options allow you to set the default recording library and folder path used within the existing libraries. It also allows you to set a specific library parent folder within the selected library. These library-folder paths will be used for recordings of all Movies and all TV Shows. These 3 options are blank by default: The following describes the default behavior when these paths are not set. All recordings would go into an automatically created Mixed Content type library, named Recordings with the actual recordings going into folders within the data\\livetv\\recordings directory which is within the Emby Server Data Folder . appearing as follows in the Settings / Library view and you can see the path when you open the server settings for the library: You can change the default folder for all recordings by first creating a Mixed Content library type as explained in Library Setup and then amend the Live TV Advanced setting for the Default recording folder . In the example below, a library was created named \"My Mixed Content Recordings\" and its library root folder path had a target subfolder named \"Recordings-Mix\" . This is shown on this screen as \" Library Name - Target sub-folder-name \" In the following example, instead of changing the Mixed Content default recording library, we have two separate libraries for recording movies and recording TV series. The libraries must be created first, with the correct content type for each, as outlined in Library Setup . Note If you are changing the defaults for recording libraries, make sure you have full read/write permissions for Emby Server. Automatic Post Processing of recordings These next two sections are advanced functionality that won’t be covered here. This is for people who create scripts or programs that manipulate recordings after they finish. This post processing can be used for many different things including commercial cutting, converting files to specific formats, moving files to other parts of the system. You can find samples of scripts in the Emby forums shared by users and get help setting these up as well. Saving the changes If you’ve made any changes on the Advanced Settings page, click the Save button to finish."
  },
  "articles/Emby-Connect.html": {
    "href": "articles/Emby-Connect.html",
    "title": "Emby Connect | Emby Documentation",
    "keywords": "Emby Connect Emby Connect is a free optional service that allows a person to use one set of username/password credentials when accessing Emby's Forums and Community as well as any Emby Server's setup for you to login using Emby Connect. The user no longer needs to remember the URL or IP/port of each Emby Server, not do they have to remember different login names and passwords as set on the different Emby Servers. Example You have 2 brothers and 3 cousins running Emby Servers. You have been given access to each server by your family members running the servers. You might have different usernames on each system, IE \"bob\", \"sbob\", \"bobs\", \"cousin-bob\", \"lil-bro\", etc. With Emby Connect you no longer need to remember the login credentials or addresses of each server as you can login via Emby Connect with a central username/password. Guide for Administrators You can optionally use Emby Connect for any user that requests it. Have them give you their Emby Connect username which you add to their account on your system and your job is done. Your Emby Server needs to be setup and tested to allow Internet access to your server. If this hasn't been done follow the KB article to get remote access working before using Emby Connect Remote Setup Once you have remote access working you can create an account on your system for any users. By default, they will log directly into your server using the username and password you created during their account creation. If a user gives you their Emby Connect username, you simply edit their account on your server filling in the second option shown below. The user can now login directly with the local credentials on the server or can login via Emby Connect. From the Server Admin Console click on USERS menu. Important A local password for the account should be set even when the user account is linked to an Emby Connect username. Guide for Users Please see Emby Connect For Users Does This Mean My Streaming is Passing Through the Cloud? No, all connections are direct from your devices to your Emby Server. The sole purpose of the Emby Connect feature is to help your devices locate your Emby Server so that you don't have to set it up yourself. See Also Emby Connect"
  },
  "articles/Emby-Connect-for-Users.html": {
    "href": "articles/Emby-Connect-for-Users.html",
    "title": "Emby Connect | Emby Documentation",
    "keywords": "Emby Connect Emby Connect is a free optional service that allows a person to use one set of username/password credentials when accessing Emby's Forums and Community as well as any Emby Server's setup for you to login using Emby Connect. Does This Mean My Streaming is Passing Through the Cloud? No, all connections are direct from your devices to your Emby Server. The sole purpose of the Emby Connect feature is to help your devices locate your Emby Server so that you don't have to set it up yourself. User Guide Start by signing up for Emby Connect. Once you have your Emby Connect account it can be given to any Emby admin who will add it to your account on their system. Click on the SIGN UP button to continue. Fill out this page with user's proper information and click the CREATE MY ACCOUNT button. Follow any directions you might receive in email. Changing your Emby Connect password Changing your Emby Connect password is done here: https://streamora.example/community/ Click on your username, top right of the screen, then click on My Profile. Next, click on Edit Profile. You will then be presented with a form to complete, with your current password and your new password (twice). If you are unable to login to the Emby Community, you can try resetting your password here. Password Reset If you have forgotten your Emby Community password, you can reset it. From the sign-in page, click on \"I've forgotten my password\". You will then be presented with a form where you can request a password reset. Enter either your Emby Community username, or the email address you signed-up with. Click on the \"I'm not a robot\" and then click PROCEED. You will then see confirmation message that a email has been sent to the address entered, or associated with the username entered. Once the email is received (make sure to check your SPAM folder), simply following the instructions contained within it. Guide for Administrators Please see Emby Connect See Also Emby Connect"
  },
  "articles/Emby-for-Kodi.html": {
    "href": "articles/Emby-for-Kodi.html",
    "title": "Emby for Kodi | Emby Documentation",
    "keywords": "Emby for Kodi Install the stable or beta repository You can install our Emby repositories directly from Kodi. It's so convenient! Alternatively, you can grab the repo here, install the repository of your choice in Kodi via install from zip and skip the steps below. Head over to the file manager. If you can't find the menu item, you can always switch to the estuary temporarily. The url is http://kodi.streamora.example You can name the source as you wish. The source is now added. Navigate add-ons > box icon with down arrow (at the bottom) > Install from zip. Select the repository. You are done! You can install both repositories (stable and beta). Remember, if you do, disable add-ons auto-update by opening the side menu and disabling the option. This will give you control when to update your add-ons. Final step You can now install the Emby for Kodi add-on found via installing from repository > Kodi Emby add-ons > video add-ons > Emby. You can also find the latest Emby for Kodi alpha/beta version in the public testing folder, found in the Emby source added earlier (posted above) Public testing folder You can find the public testing folder inside the Emby source you've just added (install from zip). If this is a fresh install, you'll need to install the dependencies first. You can find them within the public testing > dependencies folder. The public testing contains the latest Emby for Kodi beta (sometimes alpha) version. It's useful if you want to upgrade to the latest version available, without installing the Emby beta repository."
  },
  "articles/Emby-Guide-Data.html": {
    "href": "articles/Emby-Guide-Data.html",
    "title": "Emby Guide Data | Emby Documentation",
    "keywords": "Emby Guide Data Emby has built in guide data for the United States, Canada and the United Kingdom. If you live in one of these areas then Emby Guide Data should be your first choice of providers to use. Unlike other guide solutions, everything needed to use is built right into your Emby Server with no 3rd party setup or payments needed. Emby Guide Data not only includes the basic data provided by other solutions but also has full descriptions of shows, movies, news and sporting events. The difference in guide data will be especially noticeable for sports fans! Not only does Emby’s internal solution deliver a rich assortment of information but it also provides posters and artwork delivered from a very fast content delivery network which allows your server to load this data very quickly! Once you have at least one tuner in Emby, it's time to add your Guide data. Click the PLUS SIGN next to TV Guide Data Providers. Select your Country (United State, Canada or United Kingdom) Select Emby Guide Data as the guide source. Click Next Enter your Postal Code. If UK only enter the 1st part or 3 letters! Select the proper lineup from the drop down selection list. In this case we selected our local over the air (OTA) lineup to match our HDHomeRun/antenna setup. We have selected to enable this guide data for all tuners in the system. Click Save. We now see our tuner and our guide data setup. We also see our guide data being loaded by the green progress bar at the bottom. During part of the this setup, Emby has added a new Scheduled Task to our server which will automatically refresh our guide data every day. This task can be edited like any other task in the system. We also have the ability to start a manual refresh of guide data by click the Refresh Guide Data button shown in the picture above."
  },
  "articles/Emby-Premiere.html": {
    "href": "articles/Emby-Premiere.html",
    "title": "Emby Premiere | Emby Documentation",
    "keywords": "Emby Premiere An Emby Premiere subscription allows you to enjoy additional features in both the server and Emby-provided apps. Some apps provide individual unlocks for basic functionality but only Emby Premiere allows you to experience the full array of features in both the server and Emby apps. Emby Premiere is attached to your server by entering a key . The features are tied to this key, not any particular \"account\". So, anyone who connects to your server will enjoy the benefits of Premiere (within the specified limits of your subscription) and will also count towards your device limits. Note - If you are connected to someone else's server, then it is the Premiere status of that server that governs the available features. For more information on the features of Emby Premiere as well as the purchase options, please see the web site Emby Premiere page . For more information on what is offered by Emby Premiere vs. the individual app unlocks (available only in some apps), please see: Emby Premiere Feature Matrix . For answers to common questions about Emby Premiere, please find your question in the side bar to the right. If you cannot find your question or answer in these documents, please send an email to billingsupport@streamora.example."
  },
  "articles/Emby-Premiere-Stub.html": {
    "href": "articles/Emby-Premiere-Stub.html",
    "title": "Emby Premiere | Emby Documentation",
    "keywords": "Emby Premiere An Emby Premiere subscription allows you to enjoy additional features in both the server and Emby-provided apps. Some apps provide individual unlocks for basic functionality but only Emby Premiere allows you to experience the full array of features in both the server and Emby apps. For information on the features of Emby Premiere as well as the purchase options, please see the web site Emby Premiere page . For answers to common and support related questions: All About Emby Premiere"
  },
  "articles/Emby-Theater-for-Windows.html": {
    "href": "articles/Emby-Theater-for-Windows.html",
    "title": "Emby Windows | Emby Documentation",
    "keywords": "Emby Windows This content has moved here: apps/windows/Emby-Windows.md"
  },
  "articles/Excluding-Files-Folders.html": {
    "href": "articles/Excluding-Files-Folders.html",
    "title": "Excluding Files & Folders | Emby Documentation",
    "keywords": "Excluding Files & Folders Media files can be excluded during a library scan. This article shows how this can be done and gives details of the feature update that came in Emby Server version 4.9. Emby Server 4.9 and later Media files can be excluded by adding a file named .embyignore containing the filename(s) path and/or pattern(s) to exclude. This can be added in the root folder of a library or within sub-folders. On Windows. the .embyignore file can be created using Notepad with the \"Save as type\" set to \"All files (*.*)\" When adding the .embyignore to a root folder of a library, the rules would apply to all folders. Contents of the .embyignore file Comment lines can be added by having a # character at the beginning of the line. Blank lines are ignored. Multiple patterns / names / paths can be entered on separate lines. A wildcard * can be used for file name / folder name pattern. Use forward slash character / for directory separator - even on Windows. When a directory separator is used, the pattern is relative to the directory holding the .embyignore file. Otherwise, the pattern may also match any level below the folder holding the .embyignore file. Examples To ignore all .png files in a photos library, place an .embyignore file containing *.png in the root folder(s) of a photos library. To ignore all files in a folder, place an .embyignore file containing a * in the folder that is to be ignored. To ignore a folder private-vids and all files and folders below it, place an .embyignore file containing private_vids/ or /private-vids/ in the parent folder. To ignore a specific file e.g. private-video.mp4 , place an .embyignore containing private-video.mp4 in the folder and lower sub-folders. To ignore files with names starting with private in this folder only, place an .embyignore containing private* in the folder. The following are specific examples for a Home Videosa and Photos library with two root folders. The names have been chosen to make it easier to see the folder levels and where the files are located. The two root folders for the library identified as Root1 and Root2 with subfolders identified as A, B and C amd lower levels ientified as I, II and III. We have an .embyignore in each of the two library root folders Root1-Videos and Root2-Photos and an .embyignore in folder Root2-Photos\\R2-Folder-A to ignore a specific photo in that folder. The media files and folders are as follows: My Videos and Photos ├───Root1-Videos │ │ .embyignore │ │ R1-Video1.MOV │ │ R1-Video2.mp4 │ │ │ ├───R1-Folder-A │ │ Private-Video.MOV │ │ R1-A-Video1.MOV │ │ R1-A-Video2.mp4 │ │ │ ├───R1-Folder-B │ │ │ R1-B-Video1.MOV │ │ │ R1-B-Video2.mp4 │ │ │ │ │ ├───R1-B-SubFolder-I │ │ │ R1-B-SubFolder-I-Video1.MOV │ │ │ R1-B-SubFolder-I-Video2.mp4 │ │ │ │ │ ├───R1-B-SubFolder-II │ │ │ R1-B-SubFolder-II-Video1.MOV │ │ │ R1-B-SubFolder-II-Video2.mp4 │ │ │ │ │ └───R1-B-SubFolder-III │ │ R1-B-SubFolder-III-Video1.MOV │ │ R1-B-SubFolder-III-Video2.mp4 │ │ │ └───R1-Folder-C │ R1-C-Video1.MOV │ R1-C-Video2.mp4 │ └───Root2-Photos │ .embyignore │ R2-Photo1.jpg │ R2-Photo2.jpg │ R2-Screenshot1.png │ R2-Screenshot2.png │ ├───R2-Folder-A │ .embyignore │ R2-A-Photo1.jpg │ R2-A-Photo2.jpg │ R2-A-Screenshot1.png │ R2-A-Screenshot2.png │ ├───R2-Folder-B │ │ R2-B-Photo1.jpg │ │ R2-B-Photo2.jpg │ │ R2-B-Screenshot1.png │ │ R2-B-Screenshot2.png │ │ │ ├───R2-B-SubFolder-I │ │ R2-B-SubFolder-I-Photo1.jpg │ │ R2-B-SubFolder-I-Photo2.jpg │ │ R2-B-SubFolder-I-Screenshot1.png │ │ R2-B-SubFolder-I-Screenshot2.png │ │ │ ├───R2-B-SubFolder-II │ │ R2-B-SubFolder-II-Photo1.jpg │ │ R2-B-SubFolder-II-Photo2.jpg │ │ R2-B-SubFolder-II-Screenshot1.png │ │ R2-B-SubFolder-II-Screenshot2.png │ │ │ └───R2-B-SubFolder-III │ R2-B-SubFolder-III-Photo1.jpg │ R2-B-SubFolder-III-Photo2.jpg │ R2-B-SubFolder-III-Screenshot1.png │ R2-B-SubFolder-III-Screenshot2.png │ └───R2-Folder-C Private-Photo.jpg R2-C-Photo1.jpg R2-C-Photo2.jpg R2-C-Screenshot1.png R2-C-Screenshot2.png The .embygnore in Root1-Videos has the following content: # This is the .embyignore file stored in the library root folder: Root1-Videos # ignore all files and folders with names starting with \"private-\" private-* # ignore lower sub-directory R1-B-SubFolder-I /R1-Folder-B/R1-B-SubFolder-I/ The .embyignore in Root2-Photos has the following content: # This is the .embyignore file stored in the library root folder: Root2-Photos # ignore all files and folders with names starting with \"private-\" private-* # ignore folder R2-Folder-B and all contents and children. the R2-Folder-B is directly below Root2-Photos /R2-Folder-B # ignore all images saved as *.png files *.png These will result in all media or folders with names starting with \"private-\" getting ignored. All screenshots which would be png files get excluded from the photos folders. A specific photo folder and all its content excluded R2-Folder-B . A specific video folder R1-B-SubFolder-I getting excluded. The 3rd .embyignore file is in photo folder Root2-Photos\\R2-Folder-A to exclude a specific photo. The .embyignore content is: # This is the .embyignore file stored in folder Root2-Photos\\R2-Folder-A # ignore a specific photo in this folder /R2-A-Photo2.jpg Support for .plexignore For your convenience, Emby Server now also supports .plexignore . An option has been added to Library settings for enabling this. Note There may be some differences in outcomes between our support of this feature and Plex. The Emby behavior would not match any that are defects in Plex. Emby Server 4.8 To exclude a folder from the library scan, place a file named .ignore inside the folder. This will cause Emby to ignore all sub-folders as well. On Windows. the .ignore file can be created using Notepad with the \"Save as type\" set to \"All types (*.*)\""
  },
  "articles/Fire-TV.html": {
    "href": "articles/Fire-TV.html",
    "title": "Fire TV | Emby Documentation",
    "keywords": "Fire TV Emby for Fire TV can be installed from the App store on your Fire TV device (Fire TV 1st or 2nd gen or Fire TV Stick) or you can push it to your device from the Amazon Store . Emby for Fire TV can handle just about any type of media thanks to Emby Server transcoding. If you would like to learn how to prepare your media for Direct Play, read below. Setup Guide Install the app using one of the above methods, the app will then automatically find your local Emby Server(s). If it cannot find your server or you are attempting to connect to a remote server, the app will present you with options to connect manually or use Emby Connect. Direct Play Media Formats Video — m4v,mov,xvid,vob,mkv,wmv,asf,ogm,ogv,mp4,webm Note: The exact containers and codecs that will direct play depends on both the exact version of Fire TV and the audio equipment it is connected to (and the type of connection - e.g. HDMI, optical, etc.). Subtitles - srt,vobsub,ssa,pgs,pgssub,ass,sub,vtt Audio – flac,aac,mp3,mpa,wav,wma,mp2,ogg,oga,webma,ape,ac3 (Dolby Digital) You can check the capabilities of your Fire model here . Best Practices for Direct Play Ensure your media meets the above criteria. Leave the app's streaming bitrate setting on the default value of Auto, if possible. The app will perform bandwidth tests with your Emby Server to determine the maximum playable bitrate. If you are customizing the bitrate setting, then you will need to compare the bitrate of your files to the bitrate setting in the app. You can find the bitrate of a file by checking the media info in the web interface. If the bitrate of a file is higher than the setting in the app, transcoding will be required. Increasing the bitrate setting in the app can help reduce transcoding, but may impact playback performance if your network connection is not fast enough to handle it."
  },
  "articles/Fire-TV-Manual-Install.html": {
    "href": "articles/Fire-TV-Manual-Install.html",
    "title": "Manual Install on Fire Tablets | Emby Documentation",
    "keywords": "Manual Install on Fire Tablets This is an optional method to install Google Play store on your Fire Tablet, then using the Google Play Store, Emby. This should work on Fire OS 5 onward for Amazon Fire tablets with no Root, PC or ADB required. In order to easily install APKs you will need a file manager. If you don't have one already we can recommend TOTAL COMMANDER from the Amazon Appstore.- https://www.amazon.co.uk/dp/B00H4IHJ8M/ Note You will need to enable 'Apps from Unknown Sources' found under Settings > Security of the Fire OS. Now download each of the following APKs from a web browser (SILK) and install them in the order below using TOTAL COMMANDER. Google Account Manager 7.2 https://www.apkmirror.com/apk/google-inc/google-account-manager/google-account-manager-7-1-2-release/ Google Services Framework 12-7567768 https://www.apkmirror.com/apk/google-inc/google-services-framework/google-services-framework-12-7567768-release/ Google Play services 22.06.15 https://www.apkmirror.com/apk/google-inc/google-play-services/google-play-services-22-06-15-release/ Google Play Store 29.6.17 https://www.apkmirror.com/apk/google-inc/google-play-store/google-play-store-29-6-17-release/ Once these are installed, POWER OFF and RESTART your tablet. You can now open the Google Play Store and log in with your Google account. You can now search for Emby and install it on your Fire Tablet along with other Google Play Store apps. Once apps are installed the Google Play Store will auto update these apps in the background."
  },
  "articles/Folder-based-Access-Control.html": {
    "href": "articles/Folder-based-Access-Control.html",
    "title": "Folder Based Access Control | Emby Documentation",
    "keywords": "Folder Based Access Control Emby 4.0 includes a new way to do Merged Libraries that is very powerful. If you were using merged libraries in a previous version of Emby you will want to redo your setup to take advantage of this new server based way to accomplish the same thing. The previous method was a user preference to combine different libraries of liked content. Now with version 4.0 this is all handled in the library access control making it much easier to manage. To get an idea of what merged libraries are and how to effectively use them let’s take an example where you have multiple types of TV Show content broken up and stored on disk by categories. Below is the category of TV Show and the physical location to the parent directory of each. Anime – G:\\TV Shows\\Anime Reality TV – G:\\TV Shows\\Reality TV Cartoons – H:\\TV Shows\\Cartoons Talk Shows - H:\\TV Shows\\Talk Shows Sporting Events – I:\\TV Shows\\Sporting Events News – I:\\TV Shows\\News Kids Shows – J:\\TV Shows\\Kids Shows Shows – J:\\TV Shows\\Shows Setup the Library What we are going to do is create ONE library called “TV Shows” that contains these 7 folders. We’ll do this the normal way by selecting LIBRARY from the administration web panel. We should then be presented with the following: Select \"Add Media Library\" to get to this: We will now select the content type from the drop down menu of “TV Shows” and we will also use the default library name of “TV Shows”. You can change this name to anything you want. Now the last thing we need to do to have a working “TV Show” library is to add each of the parent folder mount points shown above for this example. We do this by clicking on the + (plus sign) next to the word “Folders” above. Once we have added each of these parent folders this section will look like this: All that is left to do is click the OK button to create the library (click it). NOTE: You may configure other library options including advanced options but they are beyond the scope of this example. Configure Permissions Now that we have our new TV Shows library setup, it’s time to configure access permission to this library. Here is where the power of Merged Libraries comes into play. We are going to set access permission for our fictitious “JohnDoe” user and then we’ll show permissions for “JaneDoe” & “ChildDoe”. This will show how easy it is to have one master TV Show library but give different access to different parts depending on what content they are interested in or what content you as the administrator want them to have. From the administration web panel select the USERS menu on the left. You will then have a list of users already setup on the system in the right panel. We will pick “JohnDoe” who we already created. In the right panel you will see a menu of choices up top and will want to select ACCESS. You should then be at a screen that looks similar to this: Now for this example instead of granting access to all libraries (top checkbox in the right panel) we want to grant partial access to our new TV Shows library (only library configure on this system). So we un-check the “Enable access to all libraries” option and have a screen that looks similar to this: All we have to do at this point is make sure only the sections we want this user to have access to have a check mark. If we wanted “JohnDoe” to only have access to Anime, Cartoons, Shows & Sporting Events the configuration would look like this: Once you’re happy with the library selections just click SAVE at the bottom of the page in the right panel! Providing Different \"views\" for Different Users You can use this access control to provide different views of the same library just like merged libraries before. For example, imagine “JaneDoe” isn’t interested in any type of cartoons, kids shows or sports but very much likes News, Reality TV and Talk Shows as well as the normal collection of Shows. You can tailor her view of the TV Shows library by setting her access as follows: Then, you could also have \"ChildDoe\" and configure them to only see Cartoons and Kid's shows like this: So to recap: JOHNDOE has access to Anime, Cartoons, Shows, Sporting Events JANEDOE has access to News, Reality TV, Shows, Talk Shows CHILDDOE has access to Cartoons, Kid Shows But each one of them sees the same \"TV Shows\" library on their home screen. It is just tailored to their specific needs."
  },
  "articles/Folder-Sync.html": {
    "href": "articles/Folder-Sync.html",
    "title": "Folder Sync | Emby Documentation",
    "keywords": "Folder Sync Folder sync allows you to copy content to folders and external hard drives, for backup as well as archiving in multiple resolutions. This is an Emby Premiere server administration feature. When content is archived in multiple resolutions, Emby apps will automatically choose the version that is most efficient for them. This will help relieve stress on your server's CPU. The availability of these versions would depend on the permissions granted when setting up Folder Sync. Installation To install Folder Sync, open the Emby Server Dashboard and navigate to Advanced and click on Plugins . Open the Catalog and scroll down until you find the Sync section. Click on the Folder Sync plugin and select Install . See Plugins Overview . Restart Emby Server to complete the plugin installation. Add Folders Decide what type of sync folders you will want to have. Examples would be sync folders containing media converted to specific resolution eg 4Mb for streaming to mobile devices or a folder to hold archived copies of the media at original resolution. These destination sync folders can be local disc drives or network shares. The Download to... button, available within the media and libraries context menus, becomes the mechanism to create the synced media files in these folder paths. Each sync folder path will need to have a name assigned. Choose naming that will make it clear to users what it is. The name will be visible when selecting media for playback and also on the Download to... menus for users that have been granted access to create Folder Sync jobs. Click on Folders + Add button Enter the path and the display name. Deselect the Grant access to all users to specify which user account(s) will be allowed to create Folder Sync jobs that will write to this folder. Ready to Sync Once a sync folder has been added, it will then show as as an available destination when creating download jobs. The target would only show for users that have been granted access. The following is what server admin user would see on a Download to... screen. See Download Options for more detail. Playback Once synced, Emby apps will automatically use the additional media sources when possible. For example, suppose you have a high bitrate movie that requires transcoding to Roku. By syncing to a folder and selecting a conversion profile that is compatible with Roku, the Roku app can then direct stream the synced version rather than transcoding the original. In this example, folder sync was used to create mobile 4Mbps versions of some media. They are available as alternative versions in playback and in this example this version was pre-selected automatically. Note There is a limit on the number of different versions for a media item. Up to 8 different versions will appear in any list of media item versions."
  },
  "articles/Google-Drive.html": {
    "href": "articles/Google-Drive.html",
    "title": "Google Drive | Emby Documentation",
    "keywords": "Google Drive Note Cloud Sync feature to Google Drive and Dropbox is no longer available. The Google Drive plugin has been removed from the Plugins catalog. Refer to Folder Sync for what is supported for sync."
  },
  "articles/Google-Home.html": {
    "href": "articles/Google-Home.html",
    "title": "Google Home | Emby Documentation",
    "keywords": "Google Home What is Google Home? Get started Prerequisites Why is Emby connect required? Why is Emby Server Remote Access required? Alpha stage steps Emby Remote setup Google Home account linking My server is not available to be selected I get an error when selecting the server Commands How to use Google Home Playback commands Sync Devices What is Google Home? Google Home is a powerful speaker and voice Assistant. Play your music. Call your friends. Ask it questions. Control your home. It's your own Google, always ready to help. The Emby Skill enables users to control playback of their media library or Live TV on any Emby compatible device. Once you have successfully linked your Emby account to Google Home and have remote access configured on the emby server, you can start controlling playback of your movies, TV shows, music or Live TV on your devices with your voice. Get started It is assumed that you already have a Google Home setup. The emby integration with Google Home is in alpha test state. The emby Google Home skill is named Emby Remote . Feedback - Issues encountered at this stage, should be posted on the forum on this topic . Note Chromecast is not compatible due to limitation by Google. Prerequisites It is necessary for Emby Connect to be used for the emby server user account and for the emby server to have remote access configured and working. Secure Connections for the Emby Server is not necessary unless you need to use the Amazon Alexa service with emby. Why is Emby connect required? Emby connect is used to provide your server information to Google Home. Why is Emby Server Remote Access required? Remote Access is required because that is how Google Home connects to the server. Alpha stage steps Get Access - Send a message to hatharry to request access to the Emby Remote project within Google Home. Please provide your Google Home email address. Once access has been granted, go to the Google Home console projects page and login with your Google Home account. You will see the emby remote project. Click on Open and expand the Cloud-to-cloud drop-down on the left sidebar Click on Test in the left sidebar. You will be a presented with the following screen. Click on the Test button on the right hand side within the Ready to Test section. This will then take you to the following Unlinked Action screen. After this, the emby remote should show up on the Google Home app, as detailed in the next section below: Emby Remote setup . Feedback - Issues encountered at this stage, should be posted on the forum on this topic . Note that if you open the emby remote project again on the Google Home console projects page and select Test as described earlier, you will now see a different screen. This screen should be ignored. Please do not add or configure any tests through this web page. Emby Remote setup When using on a smart phone or tablet, you can install the Google Assistant app to work with the Google Home app for the control commands to Emby Remote . On the smart device, open the Google Home app. Select Devices tab and then Add Device . Pick type Works with Google Home On the next screen, you will see the list of available skills. If emby remote does not show at the top, use search to look for Emby Remote . Just enter emby in the search field. This should find the emby remote skill. If not, it means that you do not have access to the emby remote skill for this Google Home account and you need to check out the steps in the earlier section Alpha stage steps . Google Home account linking The first time you invoke Emby Home, you will be asked to link your Emby account. Enter your Emby connect credentials and select your server. This will enable the skill and work across all your Google Home devices linked to your Google Account. You will see the following screens that take you into the Emby Connect login. After you sign in with the Emby Connect account, you will see the emby server. If you have more than one server with user accounts linked to this emby connect account, you will see a drop-down to pick from. Select the server to be used for Emby Remote which will now be linked. You will then be presented with the devices to select and add and pick a room to assign to. You can link or unlink your Emby account afterwards, by selecting Settings in the Google Home app and within the Services section, selecting Works with Google You will see the emby-remote skill Selecting it, will give you the option to unlink or re-link the skill. My server is not available to be selected, what do I do? If you don't have an Emby account, follow the steps here , otherwise: In your server dashboard, Users > Select the Emby user with Emby connect (green cloud icon) Remove the username or email from the Emby connect field, hit save. Re-add the information to recreate the Emby connect link. I get an error when selecting the server, what do I do? Check that the emby connect data for the emby server are correct. It is best to do this check on a remote device or PC and not when on the local network. In a browser, open the https://app.streamora.example web page, sign in and and select Sign in with Emby Connect . Click on the ... button for the server and select Connect . If you get an error, establish if the server is accessible from outside the network. If it is not, see Connecting from Emby Apps . ↥ back to top Commands How to use Google Home There are a number of ways to send commands to the emby remote Google Home skill: Ask MB Remote {insert command} Hey Google, Ask MB Remote {insert command} Hey Google, {insert command} and when using Google Assistant, you can also just say the command. It would route it to emby remote if it is a known command for the skill. Device names can be changed within the Google Home app by selecting the linked device and then settings. that would make it easier to communicate with Google Home. If the device names are changed within Emby Server Settings Devices screen, then it will be necessary to sync devices. At any time, you can update the linked devices by sending this command, Hey Google, Sync Devices Playback commands pause <device name> resume <device name> next <device name> previous <device name> stop <device name> mute <device name> unmute <device name> seek <device name> to <xx> minutes turn down the volume on <device name> turn up the volume on <device name> set <device name> volume to <xx> % Selecting the linked device within the Google Home app would show the following controls Sync Devices sync devices ↥ back to top"
  },
  "articles/Guests.html": {
    "href": "articles/Guests.html",
    "title": "Inviting a Guest | Emby Documentation",
    "keywords": "Inviting a Guest Guests are users that you've invited using Emby Connect . By default Guests have limited permissions but administrators can easily control this to give them access to various features as desired. Inviting a Guest To invite a guest, click the + button next to the Users header. Click on \"Invite with Emby Connect\". You'll then be prompted to enter their Emby username or email address. If they have not signed up for Emby yet, they can do so here: http://streamora.example/connect Once the invitation has been sent, they will need to accept it by clicking on a link in the invitation email. The invitation will appear similar to the following: As soon as they accept the invitation, they're ready to start using your server. They'll be able to sign in from any Emby app, including the online web app . Configuring Guest Accounts Once a guest has been accepted, they can be configured in the same way as a local user. For more information, see Users . Pending Invitations Guests that you've invited will display as pending until they accept the invitation. Invitations can easily be cancelled by clicking the dot menu button:"
  },
  "articles/Hardware-Acceleration-on-Android.html": {
    "href": "articles/Hardware-Acceleration-on-Android.html",
    "title": "Hardware Acceleration on Android | Emby Documentation",
    "keywords": "Hardware Acceleration on Android Emby supports the following hardware acceleration variants on Android Android MediaCodec MediaCodec is Android's integrated API for video de- and encoding. OpenMax OpenMax is an API specification covering various aspects of media acceleration. On Android it is the standard API for codec implementations while applications are typically using MediaCodec This applies to Emby as well. Emby supports hardware accelerated codecs through the MediaCodec API. We're mentioning OpenMax here to avoid confusion in that matter, because codecs are often named like \"h26x.OMX.Google.encoder.*\", where OMX is indicating the API of the codec implementation, even when accessed through the MediaCodec API. Android MediaCodec Android MediaCodec API covers a wide range of hardware accelerated codec implementation. In case of Android, it is up to the device manufacturer to deliver appropriate codec implementations (or not). Supported Accelerations The following codec are currently supported by Emby on Android. Please note that Emby may not support all accelerations offered by the hardware and that not all devices will support all accelerations. Decoders H.264 (AVC) H.265 (HEVC) MPEG2 MPEG4 VC1 VP8 VP9 Encoders H.264 (AVC) Hardware Requirements Hardware acceleration on Android is depending on the actual hardware and on the support of device manufacturer. Due to the huge number of available devices it is hardly possible to establish and maintain compatibility listings. On a more general basis we can say that we have successfully run and tested Emby Server with accelerated codecs from: Nvidia (Tegra) Samsung (Exynos) AmLogic RealTek (this does not mean that it will work with every device from each of those manufacturers) Setup and Hardware Detection There is no setup required. Emby will automatically detect the available hardware codecs. These can be viewed by navigating to the Transcoding page on the server dashboard and choosing \"Advanced\" in the acceleration type dropdown list."
  },
  "articles/Hardware-Acceleration-on-Linux.html": {
    "href": "articles/Hardware-Acceleration-on-Linux.html",
    "title": "Hardware Acceleration on Linux | Emby Documentation",
    "keywords": "Hardware Acceleration on Linux Emby supports the following hardware acceleration variants on Linux Nvidia NVDEC & NVENC API for video encoding and decoding acceleration using Nvidia GPUs VA API Video Acceleration API for Linux is supported by several device manufacturers Intel QuickSync Video Intel's brand for its dedicated video encoding and decoding hardware core Nvidia NVDEC & NVENC Nvidia provides two hardware acceleration interfaces: NVENC API for video encode acceleration NVDEC API for video decode acceleration (formerly called NVCUVID API) NVIDIA GPUs contain one or more hardware-based decoder and encoder(s) (separate from the CUDA cores) which provides fully-accelerated hardware-based video decoding and encoding for several popular codecs. With decoding/encoding offloaded, the graphics engine and the CPU are free for other operations. GPU hardware accelerator engines for video decoding (referred to as NVDEC) and video encoding (referred to as NVENC) support faster than real-time video processing which makes them suitable to be used for transcoding applications, in addition to video playback. Supported Accelerations The following accelerations are currently supported by Emby. Please note that Emby may not support all accelerations offered by the hardware and that not all hardware devices will support all accelerations. Decoders H.264 (AVC) H.265 (HEVC) MPEG2 MPEG4 VC1 VP8 VP9 Encoders H.264 (AVC) Hardware Requirements Hardware acceleration is available for most Nvidia devices starting with GPUs from the Kepler generation (e.g. GeForce GT 630) onwards, including both consumer and professional devices. Detailed information about supported hardware can be found in Nvidia's GPU Support Matrix . Required Setup Steps Important Always follow the instructions on the Nvidia site, even when the installed driver version appears to be sufficient! Install drivers from here: Nvidia Driver Downloads Not from your distro The minimum required driver version on Linux is 470.57 Remarks Nvidia drivers which are included in or provided by Linux distributions, often include only a subset of the Nvidia drivers. It is always recommended to install the full Linux drivers from the Nvidia website. Emby supports headless operation for Nvidia It is not required to connect a monitor Further Reading Nvidia Video Codec SDK GPU Support Matrix Nvidia Driver Downloads NVENC , NVDEC VA API VAAPI (Video Acceleration API) is an open-source library and API specification, which provides access to graphics hardware acceleration capabilities for video processing. It consists of a main library and driver-specific acceleration backends for each supported hardware vendor. Supported Accelerations The following accelerations are currently supported by Emby. Please note that Emby may not support all accelerations offered by the hardware and that not all hardware devices will support all accelerations. Decoders H.264 (AVC) H.265 (HEVC) MPEG2 VC1 VP8 VP9 Encoders H.264 (AVC) Hardware Filters Scaling Deinterlacing Hardware Requirements Intel Information about supported Intel CPUs with integrated graphics can be found here: Intel Video and Audio for Linux AMD AMDGPU-PRO Driver for Linux Radeon™ Software for Linux Other Hardware Supporting VA API Supported hardware and drivers Required Setup Steps Intel The latest Intel drivers are included with Emby server. AMD Radeon™ Software for Linux® Installation Important Do not choose \"headless mode\" during setup because this would skip the installation of graphics drivers. Further Reading Video Acceleration API Intel Video and Audio for Linux Intel QuickSync Video Intel® Quick Sync Video uses the dedicated media processing capabilities of Intel® Graphics Technology to decode and encode fast, enabling the processor to complete other tasks and improving system responsiveness. Supported Accelerations The following accelerations are currently supported by Emby. Please note that Emby may not support all accelerations offered by the hardware and that not all hardware devices will support all accelerations. Decoders H.264 (AVC) H.265 (HEVC) MPEG2 VC1 VP8 VP9 Encoders H.264 (AVC) Hardware Filters Scaling Deinterlacing Hardware Requirements Quick Sync was initially built into some Sandy Bridge CPUs, but not into Sandy Bridge Pentium or Celeron CPUs. An overview of acceleration capabilities built into the various CPU generations can be found under the following links: Driver Support Matrix for Intel® Media SDK and OpenCL™ Hardware decoding and encoding . GPU Acceleration Capabilities . Required Setup Steps The steps for installing the Intel Media SDK may vary depending on your actual system. Please follow the instructions appropriate for your actual setup which you can find here: Getting Started Guide Generic Installation for Intel® Media Server Studio Generic Linux* Intel® Media Server Studio Installation System Analyzer Utility for Linux Further Reading Intel QuickSync Video Driver Support Matrix for Intel® Media SDK and OpenCL™ Codec Support by CPU Generation GPU Acceleration Capabilities"
  },
  "articles/Hardware-Acceleration-on-Windows.html": {
    "href": "articles/Hardware-Acceleration-on-Windows.html",
    "title": "Hardware Acceleration on Windows | Emby Documentation",
    "keywords": "Hardware Acceleration on Windows Emby supports the following hardware acceleration variants on Windows Nvidia NVDEC & NVENC API for video encoding and decoding acceleration using Nvidia GPUs Intel QuickSync Video Intel's brand for its dedicated video encoding and decoding hardware core AMD AMF AMD Advanced Media Framework - multimedia API AMD hardware for real-time processing of multimedia Microsoft DXVA Microsoft DirectX Video Acceleration API - hardware independent API for hardware accelerated video decoding Nvidia NVDEC & NVENC Nvidia provides two hardware acceleration interfaces: NVENC API for video encode acceleration NVDEC API for video decode acceleration (formerly called NVCUVID API) NVIDIA GPUs contain one or more hardware-based decoder and encoder(s) (separate from the CUDA cores) which provides fully-accelerated hardware-based video decoding and encoding for several popular codecs. With decoding/encoding offloaded, the graphics engine and the CPU are free for other operations. GPU hardware accelerator engines for video decoding (referred to as NVDEC) and video encoding (referred to as NVENC) support faster than real-time video processing which makes them suitable to be used for transcoding applications, in addition to video playback. Supported Accelerations The following accelerations are currently supported by Emby. Please note that Emby may not support all accelerations offered by the hardware and that not all hardware devices will support all accelerations. Decoders H.264 (AVC) H.265 (HEVC) MPEG2 MPEG4 VC1 VP8 VP9 Encoders H.264 (AVC) Hardware Requirements Hardware acceleration is available for most Nvidia devices starting with GPUs from the Kepler generation (e.g. GeForce GT 630) onwards, including both consumer and professional devices. Detailed information about supported hardware can be found in Nvidia's GPU Support Matrix . Required Setup Steps Install the latest drivers for your Nvidia hardware directly from Nvidia Driver Downloads page. It is highly recommended to use these drivers instead of the ones that are shipped with Windows. The minimum required driver version on Windows is 471.41 It is not required to install any other tools or SDKs from Nvidia. Remarks Emby supports headless operation for Nvidia It is not required to connect a monitor Nvidia acceleration also works when Emby is run as a Windows service Further Reading Nvidia Video Codec SDK GPU Support Matrix Nvidia Driver Downloads NVENC , NVDEC Intel QuickSync Video Intel® Quick Sync Video uses the dedicated media processing capabilities of Intel® Graphics Technology to decode and encode fast, enabling the processor to complete other tasks and improving system responsiveness. Supported Accelerations The following accelerations are currently supported by Emby. Please note that Emby may not support all accelerations offered by the hardware and that not all hardware devices will support all accelerations. Decoders H.264 (AVC) H.265 (HEVC) MPEG2 VC1 VP8 VP9 Encoders H.264 (AVC) Hardware Filters Scaling Deinterlacing Hardware Requirements Quick Sync was initially built into some Sandy Bridge CPUs, but not into Sandy Bridge Pentium or Celeron CPUs. An overview of acceleration capabilities built into the various CPU generations can be found here: Hardware decoding and encoding . and here GPU Acceleration Capabilities . Required Setup Steps Install the latest graphics drivers for your Intel COU with integrated graphics directly from Intel's site: Drivers & Software It is highly recommended to use these drivers instead of the ones that are shipped with Windows. It is not required to install the Intel Media SDK. Remarks Emby only supports headless operation (and running as a service) with Intel QuickSync when using the D3D11 codec. For normal mode you will need to connect a physical monitor to the video output. Further Reading Intel QuickSync Video Codec Support by CPU Generation GPU Acceleration Capabilities Drivers & Software AMD AMF AMD Advanced Media Framework is a light-weight, portable multimedia framework that abstracts away most of the platform and API-specific details and allows for easy implementation of multimedia applications using a variety of technologies, such as DirectX 11, OpenGL, and OpenCL and facilitates an efficient interoperability between them. Supported Accelerations The following accelerations are currently supported by Emby. Please note that Emby may not support all accelerations offered by the hardware and that not all hardware devices will support all accelerations. Encoders H.264 (AVC) Hardware Requirements The AMF framework is compatible with most recent Radeon GPUs starting with the Southern Islands family and APUs of the Kabini, Kaveri, Carrizo families and newer. Required Setup Steps Install the latest Radeon Software directly from AMD's website: AMD Drivers & Support It is not required to install the AMF SDK. The minimum required software version is: AMD Radeon Software Crimson Edition 16.7.3 (16.30.2311) Remarks Emby currently does not support headless operation with AMD AMF You will need to connect a physical monitor to the video output. AMD AMF acceleration does not work when Emby is run as a Windows service Further Reading AMD Advanced Media Framework AMF SDK AMD Drivers & Support Microsoft DXVA DirectX Video Acceleration (DXVA) is an Microsoft API for using hardware acceleration to speed up video processing. Software codecs and software video processors can use DXVA to offload certain CPU-intensive operations to the GPU. DXVA supports video decoding only, no encoding. Supported Accelerations The following accelerations are currently supported by Emby. Please note that Emby may not support all accelerations offered by the hardware and that not all hardware devices will support all accelerations. Decoders H.264 (AVC) H.265 (HEVC) MPEG2 VC1 Hardware Requirements DXVA supports graphics devices from different vendors, including Nvidia, Intel and AMD. Required Setup Steps DXVA is a Windows component, and supposed to work with the drivers that are included in Windows. Installing the latest drivers from the manufacturers' websites might still be a good idea. Remarks Emby only supports headless operation (and running as a service) with D311VA codecs. For plain DXVA2 you will need to connect a physical monitor to the video output. Common Issues and Solutions Hardware Acceleration Fails with Remote Desktop (RDP) on Windows Note: Support for headless mode is planned for the future Further Reading About DXVA"
  },
  "articles/Hardware-Acceleration-Overview.html": {
    "href": "articles/Hardware-Acceleration-Overview.html",
    "title": "Hardware Acceleration Overview | Emby Documentation",
    "keywords": "Hardware Acceleration Overview Emby supports a broad range of hardware accelerated video transcoding methods on its supported platforms: Windows Emby supports the following hardware acceleration variants on Windows Nvidia NVDEC & NVENC API for video encoding and decoding acceleration using Nvidia GPUs Intel QuickSync Video Intel's brand for its dedicated video encoding and decoding hardware core AMD AMF AMD Advanced Media Framework - multimedia API AMD hardware for real-time processing of multimedia Microsoft DXVA Microsoft DirectX Video Acceleration API - hardware independent API for hardware accelerated video decoding Linux Emby supports the following hardware acceleration variants on Linux Nvidia NVDEC & NVENC API for video encoding and decoding acceleration using Nvidia GPUs VA API] Video Acceleration API for Linux is supported by several device manufacturers Intel QuickSync Video Intel's brand for its dedicated video encoding and decoding hardware core Android Emby supports the following hardware acceleration variants on Android Android MediaCodec MediaCodec is Android's integrated API for video de- and encoding. OpenMax OpenMax is an API specification covering various aspects of media acceleration. On Android it is the standard API for codec implementations while applications are typically using MediaCodec Troubleshooting I've enabled hardware acceleration but CPU usage is still very high when transcoding and PGS or DVD subtitles are enabled. In many cases these subtitle formats will need to be burned into the video on the fly with transcoding. Most GPUs do not support this and as a result there will be some significant CPU involvement. This is a very taxing process for even a powerful server, and it's generally something you want to avoid. Here are the best ways to avoid burning in subtitles: Turn off the subtitles prior to playback using the pre-playback subtitle selection menu Use external text-based subtitles instead, such as .srt files. Emby Server's subtitle download features can help automate the process of acquiring these. Use an Emby app that can direct play these subtitle formats without transcoding, such as Emby Windows, Emby Linux, Emby for MacOS, Android, or iOS. If you are using Windows with Remote Desktop and have trouble getting hardware acceleration please read this article ."
  },
  "articles/Hardware-Acceleration-with-Docker.html": {
    "href": "articles/Hardware-Acceleration-with-Docker.html",
    "title": "VA API in Docker | Emby Documentation",
    "keywords": "VA API in Docker Docker usage on Unraid as sample \\flash\\config\\go #enable module for iGPU and perms for the render device modprobe i915 chown -R nobody:users /dev/dri chmod -R 777 /dev/dri docker run command extra parameter --device /dev/dri:/dev/dri/dri:/dev/dri` that's it i can only speak for intel here, but latest 3 gens i6, i7, i8 ... its for the end user side all there is ... enable intel on the host vie the go file, give the docker access ... either via the extra parameter in docker run OR by privileged access. that's it to get all features running with vaapi, decoding all formats from the site, encoding to h264 QuickSync ...another story which i don't really know (not needed in any way here cause vaapi does the job). when i remember there are no special drivers or so needed on most NAS system on intel base like freenas, unraid, etc ... also the boxes like synology etc are ready out of the box. AMD or Nvidia are rather different cause there is always a driver issue somewhere ... i also tried to get nvidia working with my plex docker before and ended up in switching (take the intel for host and use for dockers, pass the nvidia for my VM). so in the end, its those 2 steps up there ... may someone with a synology or so can tell if its even just a click in the webui ... NVIDIA in Docker Tested with P2000 on Debian 9 (stretch) Install nvidia drivers https://www.nvidia.com/Download/driverResults.aspx/140135/en-us for latest To test drivers run nvidia-smi Expected output: > nvidia-smi $Date +-----------------------------------------------------------------------------+ | NVIDIA-SMI 410.66 Driver Version: 410.66 CUDA Version: 10.0 | |-------------------------------+----------------------+----------------------+ | GPU Name Persistence-M| Bus-Id Disp.A | Volatile Uncorr. ECC | | Fan Temp Perf Pwr:Usage/Cap| Memory-Usage | GPU-Util Compute M. | |===============================+======================+======================| | 0 Quadro P2000 Off | 00000000:83:00.0 Off | N/A | | 68% 40C P0 19W / 75W | 0MiB / 5059MiB | 0% Default | +-------------------------------+----------------------+----------------------+ +-----------------------------------------------------------------------------+ | Processes: GPU Memory | | GPU PID Type Process name Usage | |=============================================================================| | No running processes found | +-----------------------------------------------------------------------------+ Install nvidia-docker2 https://github.com/NVIDIA/nvidia-docker Either edit docker daemon or set runtime arg My docker daemon: /etc/docker/daemon.json \"runtimes\": { \"nvidia\": { \"path\": \"nvidia-container-runtime\", \"runtimeArgs\": [] } }, \"default-runtime\": \"nvidia\" } Required Docker environment variables NVIDIA_VISIBLE_DEVICES=all NVIDIA_DRIVER_CAPABILITIES=compute,utility,video Further Reading Transcoding with Nvidia in Docker"
  },
  "articles/Hauppauge-Setup.html": {
    "href": "articles/Hauppauge-Setup.html",
    "title": "Hauppauge Setup | Emby Documentation",
    "keywords": "Hauppauge Setup Emby has native support for current Hauppauge PCIe and USB Tuners on Windows. You will need first to install the Hauppauge WinTV app and go through the configuration process and ensuring latest drivers and channel data is in place. The product also needs to be activated. The earliest supported version is v8.5. The following is the link for the WinTV v10 app . When installing the WinTV application, make sure that it is installed for all Windows users to access and that the folder paths for the installation and recordings are in directories that have full permissions set for the windows user account that Emby Server would run under. The following shows the paths that need to be defined at install time. and These paths can also be set through WinTV application settings. After installing the Hauppauge WinTV app, ensure all the channel tuning data is updated, click on Settings and then Check for Tuning Updates in the General tab. After ensuring that the tuning data is up to date, make sure the Hauppauge Pause Buffer path is setup and permissions are set for the Emby Server windows process for full access. To set the directory paths, on WinTV v10, select the Recordings tab and on WinTV v8.5, select the Capture tab. The Disk Buffering Pause-Mode Recording Directory is used by Emby Server for Live TV streaming and recordings. WinTV v10 WinTV v8.5 Next is to configure the tuner and scan for the TV channels. The example in the following screenshots is for DVB-T OTA channels for the UK. Select the tuner and click on Tuner Setup . Go through the options applicable to your region, type of tuner and channels available for you. On completion of the scan and setup, use the WinTV app to test that the channels do stream and the signal and quality is good. Close the WinTV application and prepare to add the Hauppauge tuner to the Emby Server. The Live TV & DVR feature requires a valid Emby Premiere subscription. This would be indicated on the setup screen when there is no subscription: Note Whilst you will be permitted to add the Live TV device, there would be no channels or guide data without an Emby Premiere subscription. To add an Hauppauge device, click on + Add TV Source and select Hauppauge This will show the following Click on Detect Devices You will then see all the detected new Live TV tuner devices, select the Hauppauge device you wish to add You will be back to this screeen. Click on Add TV Source You will now see the device added. You are ready now to add guide data and where needed, map tuner channels to guide data and optionally configure the advanced Live TV settings. See the relavant paragraphs on the Live-TV document."
  },
  "articles/HDHomeRun-Setup.html": {
    "href": "articles/HDHomeRun-Setup.html",
    "title": "HDHomeRun Setup | Emby Documentation",
    "keywords": "HDHomeRun Setup Emby has native support for current Silicon Dust HDHomeRun Network Tuners (must support DLNA which all models 2015+ should). Unlike other brands of tuners, HDHomeRun tuners run as standalone devices connected to your network. No need to have open PCI slots available in your server or free USB ports. Being a standalone device allows you to install these in close proximity to your OTA antenna or cable drop. As long as you can connect the device to your home Ethernet network you can install them anywhere in your home. Silicon Dust makes both OTA (Over the Air) models as well as Cable Tuners (using Cable Cards) to Receive DRM free digital cable subscription channels. In most cases, Emby can automatically discover your HDHomerun devices on your network with no configuration required. You can also manually setup a tuner as well. The following guide assumes you have already setup your HDHomeRun on your network and have connected it to your cable or antenna. Note: If you have an older HDHomeRun model that does not support DLNA or have a built in web server please perform these steps before continuing. Older HDHomeRun Support The Live TV & DVR feature requires a valid Emby Premiere subscription. This would be indicated on the setup screen when there is no subscription. Open the server dashboard and click the Live TV menu option on the left. If you haven't setup any part of Live TV yet you should have a page that looks like this: Note Whilst you will be permitted to add the Live TV device, there would be no channels or guide data without an Emby Premiere subscription. Click on \"+ Add TV Source\" in order to add our first tuner. We will then be presented with a screen that allows us to choose the type of tuner to add. Select HD HomeRun. If the HD HomeRun device does not show, click on \" Detect Devices \" Emby will search your network and present all HDHomeRun devices it finds on your network. Here is a example showing two Primes and one Quatro automatically found. In this example we are going to setup OTA (Over the Air) using the HDHomeRun Quatro. Click the Quatro (3rd on this list). Emby will start the setup of this tuner and will provide you with the ability to set a couple of options including: The ability to import all channels or only FAVORITE channels (already configured on the tuner itself). See configuration of HDHomeRun favorites below for more information on using favorites. The ability to use hardware transcoding on your tuner. Note: this is only supported on HDHomeRun EXTEND models. For this example using a Quatro we will enable the restriction of favorite channels and disable the hardware transcoding option. Once we’ve set our options the click save button and we will have added our first tuner. You are ready now to add guide data and where needed, map tuner channels to guide data and optionally configure the advanced Live TV settings. See the relavant paragraphs on the Live-TV document. HDHomeRun Favorite Setup In order to make use of favorites with your HDHomeRun tuner you need to set this up outside of Emby. You do this by opening the built in web app on your tuner in a web browser and then selecting the Channel Lineup menu option. You can also just type the URL into your browser which will look similar to this: http://192.168.100.23/lineup.html Note this is the IP of the tuner as configure above in the example. Once in the channel lineup screen it will look similar to this with your channels listed. In this picture anything with the yellow star is marked as a favorite and used by the channel import above. You can use the other two options which are unselected (blank) or X as status for your own use. X would be disabled channels. Blank could be channels you haven’t decided yet. This is a really useful way to filter your channel list. Many cable providers deliver both HD and SD versions of the same channels. Using this method you can only favorite the HD channels. You can easily ignore (not favorite) channels in foreign languages, shopping channels, infomercial channels or any other channel you wish to not have Emby load."
  },
  "articles/Home.html": {
    "href": "articles/Home.html",
    "title": "Emby Documentation Home | Emby Documentation",
    "keywords": "Emby Documentation Home Your starting point for all Emby documentation Emby has two distinct parts: Server - Store your media library in a central place Client - Clients or Apps that play back media from the Emby Server A fully-functioning Emby system requires both a Server and at least one client player. The Server includes the Emby web app which is used to manage the Server and your media library. It also features a media player, thus the minimal installation of just the server is enough to get started, but most people will want to install Emby apps on other devices for expanded client functionality. Has someone invited you to their server? If you have received an invitation to share an existing Emby server, then you can skip the server installation process and jump straight to app installation. The server is only required by people wanting to host their own media collection. Choose one of the many apps we have available: http://streamora.example/download/ Or try the online web app, using the login credentials supplied by your Emby server administrator, at http://app.streamora.example Emby Server Documentation See the menu on the right-hand side of this page for a complete listing. Some key areas are: Quick start System requirements Server installation Emby Apps Amazon Alexa Android Mobile Android TV Android Auto Apple TV Chromecast Emby for Kodi Fire TV Google Home iPad iPhone LG Smart TV Linux macOS NVIDIA Shield Playstation 3 Playstation 4 Roku Samsung Smart TV Web App Windows Xbox Community In addition to what's displayed here, the Community Forums is another great place for useful information."
  },
  "articles/Hosting-Settings.html": {
    "href": "articles/Hosting-Settings.html",
    "title": "Network Setup | Emby Documentation",
    "keywords": "Network Setup Adjust network settings to configure Emby's built-in web server. These settings are accessed by opening the server dashboard and navigating to Server -> Network . For the purposes of this document we are defining local as within your home network, and external as outside your network away from home. LAN Networks If you have more than one local network subnet, you may need to use this setting to define the IP subnets that are deemed to be local. Also if using a vpn on the router, you should use this setting to add the local subnet address range used by the vpn. When there is more than one subnet, enter here all the IP subnets that are to be treated as local network subnets, including the subnet the Emby server is connected to. This setting is used when enforcing bandwidth controls and remote access controls. When the LAN Networks field is filled, any subnet not defined here will be deemed external and the remote access controls and external bandwidth restrictions would apply. If left blank, only the server's subnet and common private IP subnets are considered to be on the local network. See example below. Here is an example of two 256-addresses subnets defined as being local for the server: 192.168.1.0/24,10.253.0.0/24. Important When specifying IP subnets, make sure you use the correct netmask/cidr value. A /24 denotes 256 addresses Note The system API is used to determine if an IP Address is local. For the 192.168.x.x and 172.x.x.x subnets shown above, there is an override where they would always be classed as local. If you find that your 10.x.x.x subnet is not classed as local, enter the subnet together with the subnet for the server in the LAN Networks field. Important You should only use this setting, if you know you need it. Once you configure, you will need to keep it up to date - in event of network subnet changes. Local IP Address The local IP address will automatically be detected by Emby Server and this field should be left blank. But, if you wish to override that, enter here the local IP address that Emby Server should present to Emby apps. An example of when you may need to do that, is for a server with multiple network interfaces and you wish to set a specific network interface. Important Ensure the specified IP Address is a static or DHCP reserved IP Address. Local Ports This allows you to specify both the http and https local ports that the server should bind to and use. The https port would be used if secure connections (SSL) are enabled. Whilst the local ports can be customized, it is recommended that you leave them as per the default. Allow Remote Access Remote connections to the Emby Server can be disallowed or allowed using this setting. Note A similar setting is available for each user account. See users . When remote connections are enabled, further settings will show that you can customize. Remote Connections IP Address Filters You have the option to restrict remote connections to be allowed only from specific public IP addresses or IP Address subnets. The reverse is also possible, blocking specific remote IP addresses and subnets. When left blank, all remote addresses would be allowed. Public Ports This allows you to specify both the http and https external public WAN ports that the server should use when reporting its external url to Emby clients. The https port would be used if secure connections (SSL) are enabled. By default, these ports are the same as the local port numbers. You can choose alternative port numbers and in some cases - eg if having more than one server with remote connections enabled, you would need to use different public/WAN port numbers. For added security, you may also decide to having a non standard public port number. More details about added security in this article Secure Your Server . Automatic Port Mapping By default this setting is enabled and the Emby Server will attempt to automatically map public to local ports by configuring your router. It can be disabled at initial setup time or later in the server Network settings. Important Automatic port mapping uses uPnP which would need to be enabled on the router. Important If automatic port mapping is disabled but remote connections are to be used, you must setup port forward rules manually in the router configuration. Refer to Setup Port Forwarding section for information on this. External Domain When using a Dynamic DNS service (DDNS) or a domain name, enter it here without the port number. Emby apps will use this when connecting remotely. The field should be used when a custom SSL certificate is used for Secure Connections. Example: mydomain.com Checking Proxy headers to determine real client IP addresses The setting is on by default and gives added security where the server checks request headers such as X-Real-Ip or X-Forwarded-For to determine the real IP address of the sender. Optionally you can disable it or limit it to just check when the headers indicate the request is from an external source. Secure Connections (https / SSL) To enable secure connections, you will need to acquire a certificate and provide the filesystem path to the certificate and the certificate password. By default, use of https for requests made to the server is disabled. The path is to be to a PKCS #12 file containing a certificate and private key to enable TLS support on a custom domain. The Certificate password should be entered if it requires a password. Three secure connections modes are available to choose from, Preferred, but not required Required for all remote connections Handled by reverse proxy Important Some legacy devices may not be able to connect to the server using https. In such environments, do not use the \"Required for all remote connections\" mode. Note Please ensure that you are using the latest versions available for Emby Apps. For detailed information on setting up secure connections, refer to this section Using secure https connections in the Secure Your Server article. Streaming Controls With Emby Premiere , you can limit the number of concurrent video streams on the server. By default there is no limit. Note A similar setting is available for each user account which would override this global setting. See users . Internet streaming bitrate limit You have an option to specify the streaming bitrate limit in Mbps for streaming to remote devices. This limit is per stream. Bandwidth limits are not enforced by default. Note A similar setting is available for each user account which would override this global setting. See users . Network Request Protocol This allows you to optionally disable iPv6 for outgoing requests made by Emby Server. Selecting iPv4 instead of Auto would disable use of iPv6 for outgoing requests. Note This setting was introduced in Emby Server 4.9.x.x. See Also Connecting from Client Apps"
  },
  "articles/How-to-Set-Permissions-on-DSM-7.html": {
    "href": "articles/How-to-Set-Permissions-on-DSM-7.html",
    "title": "How to Set Permissions on DSM 7 | Emby Documentation",
    "keywords": "How to Set Permissions on DSM 7 For Synology versions of DSM 7 and higher you need to assign read or read/write permissions to the system internal emby user for any directories used by Emby such as your media folders. We recommend setting read/write permissions to take full advantage of Emby's features. To set permission open the Control Panel on Synology DSM. Then open Shared Folders. Highlight the shared folder containing the media you wish to appear in Emby. Click Edit, then select the Permissions tab: Change the drop down user type to \"System internal user\" (in the red box above). Scroll down if needed until you see the emby user. Check the column to give emby at least Read Only access but we suggest granting Read/Write access like this: Click the Save button. Repeat this process for any other shares containing media for Emby. Emby Server should now be able to access all shares you have updated."
  },
  "articles/Hwa-Fails-with-RDP.html": {
    "href": "articles/Hwa-Fails-with-RDP.html",
    "title": "HWA fails with RDP | Emby Documentation",
    "keywords": "HWA fails with RDP Hardware Acceleration Fails with Remote Desktop (RDP) on Windows Product: Emby Server Affected Platforms: Windows 8.1, Windows 10, Windows Server 2016, Windows Server 2019 Affected Hardware: Intel QuickSync, AMD AMF, DXVA2 and D3D11VA Codecs Symptoms When you have configured Emby Server to use a hardware video acceleration method that is based on Microsoft Direct3D, you may experience erroneous behavior or total failure of hardware accelerated video processing, when you log in to the computer running Emby Server via MS Remote Desktop Connection, also known as RDP. Solution To avoid this problem, you need to change the configuration of the RDP Session Host on the computer running Emby Server. This can to be done via a Windows Group Policy setting, by following these steps: Open the 'Local Group Policy Editor' via one of the following methods: Open Windows Setting and type 'group' in the search box Open Control Panel and type 'group' in the search box Start > Run > enter 'gpedit.msc' (without the quotes) and click 'OK' Navigate in the left tree Computer Configuration Administrative Templates Windows Components Remote Desktop Services Remote Desktop Session Host Remote Session Environment In the right pane, locate the entry highlighted below ('Use hardware graphics adapters for all Remote Desktop Services sessions') Right click the entry and select 'Edit' In the dialog, change the policy setting to 'Disabled' and click 'OK' Reboot the computer Background In recent Windows versions, the RDP service can use video and graphic hardware acceleration for 2D and 3D composition of remote session desktops, in latest versions it can even use H.264 video instead of GDI instructions for delivering the desktop to the client. When these RDP features are activated and a client connects via Remote Desktop, the RDP Session Host will block all D3D and DXGI for any other use than the local session. Under these circumstances, and when Emby Server is running in a local session and this session is not the one being logged into via RDP, it can happen that D3D9 based hardware accelerations are still working (sometimes with flaws, though), because D3D9 is always related to a user session context. Hardware acceleration based on D3D11 will never work in the described situation. Affected Hardware Codecs Direct3D 9 QuickSync Video Decoders (without D3D11 in the name) QuickSync Video Encoders (without D3D11 in the name) AMD AMF Encoders DXVA2 Decoders Direct3D 11 QuickSync D3D11 Video Decoders QuickSync D3D11 Video Encoders D3D11VA Video Decoders"
  },
  "articles/Identify.html": {
    "href": "articles/Identify.html",
    "title": "Identify | Emby Documentation",
    "keywords": "Identify On occasion, content may be mismatched as something else. To correct this, there is the IDENTIFY option available on a per-item basis. In the web app open the item's detail screen, click the 3-dot menu and then then click Identify. You can use the Identify tool to match it to internet metadata. Try the name to start with, or enter as much information in the fields as possible to get the best match. If a choice is returned, then choose the correct one. Now confirm your selection. Note: The IDENTIFY option is only available for Emby administrators."
  },
  "articles/Image-Editing.html": {
    "href": "articles/Image-Editing.html",
    "title": "Image Editing and Image Types | Emby Documentation",
    "keywords": "Image Editing and Image Types Primary - This channel logo is the historic logo used for channels and third party plugins. On newer Emby clients it is used on light colored backgrounds. LogoLight & LogoLightColor - This channel logo is used on dark colored backgrounds. LogoLightColor is the default logo used but options in clients may allow for use of LogoLight as well. Here is a example of editing graphics for a Live TV station: Here are two examples showing how these images are used depending on the background color in use. Other Content Types Like Movies & TV Shows If you edit the graphics for a movie or show you would have a screen similar to this. Here is an example screen showing some of these graphics in use: Here is a banner view (vs coverart) view of a movie library. Note in this picture not all movies have a banner so the primary image will be used for images without a banner. Here is a disc view (vs coverart) view of a movie library. Note in this picture not all movies have a disc so the primary image will be used for images without a disc. Here is a logo view (vs coverart) view of a movie library. Note in this picture not all movies have a logo so the primary image will be used for images without a logo. Here is a thumb view (vs coverart) view of a movie library. Note in this picture not all movies have a thumb so the primary image will be used for images without a thumb. Primary This is the normal cover art used. Logo Option image usually superimposed over backdrops Backdrops/Fanart This is the background used behind all other graphics and text. Many clients can alternate these backgrounds if more than one graphic is present. Thumb Used for thumbnail views Banner Used for banner views Disc Used for disk views Art Used in some clients similar to the Logo image type"
  },
  "articles/includes/beta-warning.html": {
    "href": "articles/includes/beta-warning.html",
    "title": "| Emby Documentation",
    "keywords": "Warning The information in this document is about a pre-release application. All the provided details are subject to being changed without notice."
  },
  "articles/includes/feature-display-control.html": {
    "href": "articles/includes/feature-display-control.html",
    "title": "Features | Emby Documentation",
    "keywords": "Features Features Detects GPUs, connected displays and the connection type Detects possible refresh rates for each connection (depends on GPU capabilities, display capabilities, connection type, current resolution, current color mode) Detects availability of HDR mode for each connection Detects the display on which the Emby app is currently being shown (Windows app only) Dynamically updates the settings view when changes are made to OS settings or displays are connected/disconnected Allow manual switching of refresh rate and HDR mode (three-dot menu) Automatic switching of refresh rate and HDR mode on playback start can be enabled independently and separately for each display This will only be applied to the display on which the app is currently shown Revertion of refresh rate and HDR mode on playback stop can be disabled to reduce display mode changes (which can take a few seconds) How to... ...access the Display Control settings? Go to Settings (Gear icon), in the left sidebar choose \"Display Control\""
  },
  "articles/includes/feature-gamepad.html": {
    "href": "articles/includes/feature-gamepad.html",
    "title": "How to... | Emby Documentation",
    "keywords": "How to... Support for gamepad input has been significantly updated. On the technical side, unnecessary power drain is avoided and the reliability of key input detection has been improved. Functionally, mappings have been extended, allowing to control more things with game pad buttons. The new settings UI serves two purposes: It provides an overview over the functions assigned to individual gamepad buttons and sticks It allows to test all controls as to whether they are recognized by the app How to... ...access the game pad settings view? Go to Settings (Gear icon), in the sidebar choose \"Game Pad\""
  },
  "articles/includes/feature-remote-control.html": {
    "href": "articles/includes/feature-remote-control.html",
    "title": "How to... | Emby Documentation",
    "keywords": "How to... Support for remote control input has been extended. More button mappings are supported, including all buttons found on classic Windows Media Center remotes (Windows app). The Xbox app supports a smaller set of RC buttons only. The new settings UI allows to test all remote control buttons as to whether they are recognized by the app. How to... ...access the remote control settings view? Go to Settings (Gear icon), in the sidebar choose \"Remote Control\""
  },
  "articles/includes/feature-start-animation.html": {
    "href": "articles/includes/feature-start-animation.html",
    "title": "Startup Animation | Emby Documentation",
    "keywords": "Startup Animation Why it Exists It had turned out that it takes a number of seconds until the web app environment is initialized and ready for the actual startup process which takes another few seconds until the app is ready for use. This cannot be accelerated, so the only option was to cover that time span with something visual. Showing a spinner is always the worst option for those situations because it doesn't provide any indication about progress, so you're unable to see how much time is still remaining (that's why spinners are typically used for cases when the duration is unknown). A progress bar can be followed and indicates the remaining amount of time, but too often those are used in a way that progress stops at 90 or 95% for much longer than it should, so nobody trusts them anymore these days. The start animation in turn has a fixed duration and once it's finished, the app is (almost, like 99.9%) guaranteed to be ready. The predictability of it makes it subjectively feel faster than a spinner or a static logo display."
  },
  "articles/Installation.html": {
    "href": "articles/Installation.html",
    "title": "Installation | Emby Documentation",
    "keywords": "Installation Emby Server is available on the following platforms: Windows Mac Linux BSD NAS Devices - Asustor, FreeNAS, Netgear, Open Media Vault, QNAP, Synology, Terramaster, Thecus, TrueNAS, TrueNAS Scale, unRAID, Western Digital Docker Android Cloudron SNAP Flatpack NVIDIA Shield To install Emby Server, begin by visiting the download page and following the instructions for your operating system: http://streamora.example/download/ Running the Startup Wizard After Emby Server has been installed, it will attempt to launch the startup wizard in your default browser. If this does not occur automatically, please open your web browser and navigate to: http://localhost:8096 which should launch the Startup Wizard. Language Selection The first page will ask you to choose a display language. We have been working hard to translate Emby into as many languages as possible, and the available options are displayed on this page. Create a User Next you'll be asked to create an initial user account. Enter the Username and password. You'll have the ability to create more accounts later after the setup process has completed. See Users . Add Media Libraries Now, you'll add your media libraries. See Library Setup for more information. Configure Remote Access Automatic port mapping for remote access can be enabled or disabled at this initial stage: Further Remote Access options are available in the Emby server dashboard which you can access after the initial setup. See Network Setup . Emby Terms of Use Accept the Emby Terms of Use Completing the Startup Wizard Once you've completed the above screens, you'll then be taken to the Sign in screen for the Emby Server. You're now ready to explore the features of the server while waiting for your media scan to complete. Be sure to check out: Network Setup Server Settings Users Library Setup"
  },
  "articles/Introduction-to-Live-TV-and-DVR.html": {
    "href": "articles/Introduction-to-Live-TV-and-DVR.html",
    "title": "| Emby Documentation",
    "keywords": "Emby provides a flexible and very powerful Live TV and DVR solution. With Emby’s TV you will be able to stream Live or Recorded TV content to any device you have with an Emby client or web browser. Want to watch TV on your iPad or Android notebook? Want to watch a football game live on your Mobile Phone when out and about? How about being able to easily setup recordings from anywhere at any time? Emby can do all this and a whole lot more. You can use Emby to eliminate the need for cable STBs (Set Top Boxes) throughout the house saving you money each and every month on rental fees per STB. You can even eliminate your cable provider entirely by cutting the cord and switching to OTA (Over the Air) broadcasts for all of your local channels. If you need national network channels like CNN, Fox News, Hallmark, ESPN, etc then Emby can do this too. Emby fully supports Premium TV by Silicon Dust which includes 45 national network channels. If that wasn't enough, Emby fully supports the use of IPTV so you can add any service of your choosing that uses true IPTV. You can even add your IPTV security cameras to your channel list! Yes, Emby is that flexible! Emby supports multiple EPG (Electronic Programming Guide) sources so you can use whatever source of guide content required for your unique setup. If are in the USA, Canada or the United Kingdom, Emby will provide this data for you out of the box for no additional cost using the excellent feature rich guide data built right in. If that wasn't enough, not only can you mix and match all of this into one easy to use system, but you can also configure which of your users have access. You determine what users can view Live TV and which of your users can setup Recordings. How’s that for a powerful Live TV & DVR solution?"
  },
  "articles/Intro-Skip.html": {
    "href": "articles/Intro-Skip.html",
    "title": "Intro Skip | Emby Documentation",
    "keywords": "Intro Skip Requires Emby Server 4.7 or later and an Emby Premiere subscription. Configure a TV Library in Emby Server In order to use Intro Skip a TV Show library needs to be configured. Edit a TV Library on the Emby Server console. Scroll down to the Markers section in the library and change the option from Never to either \"as a scheduled task\" or \"as a scheduled task and when media is added\" depending on your particular needs. Once configured, optionally go to Scheduled Tasks Menu and you'll see a new Task \"Detect Episode Intros\" added in the Library section. By default this task is set to run every 24 hours. You can optionally adjust this task to run at a specific time. To add a new Task click the + sign above. This shows a new schedule that starts at 3 AM and runs for up to 4 hours. We can now click the trashcan icon to remove the 24 hours schedule: Run Detect Episode Intros Manually The Detect Episode Intros can easily be run manually at any time by clicking the the arrow key. The task will change to a progress bar like this: Nothing more need be done on the Emby Server. Note Intro detection is per TV show season and requires the presence of at least two episodes in the season before it can start looking for the intro sequence for that season. Emby Server analyzes the first 10 minutes of the episodes to look for the sequence. Note The server will process all TV Show episodes in the background. This process may take a while depending on the number of episodes you have.. Configure Emby Client for Automatic or Manual Intro Skip Each client can be set to ignore TV Show Intros, automatically use Intros, or to prompt use showing a button. You can set this option in the client option's Playback Menu. Using Intro Skip With the Skip Intro button selected you can clearly see the button on the OSD immediately at the start of playback. The timeline is still at 0:00 before the show has started to play and we can already skip the introduction of the show. Clicking the Skip Intro button immediately jumps right to the start of the Episode. With the client option set to Automatically skip intros our TV show intros have been put on auto pilot. Right at the start of playback it jumps to the end of the intro right at the point of the fade in. Intro Skip on Emby for LG Smart TVs New to LG 1.0.37 is the ability to skip TV Show Episode Introductions segments. This allows you to jump right to the start of the action, saving a great deal of time allowing you to quickly get to the good stuff! Combine Into Skip with Automatic Play Next Episode for a superior binge-watching experience!"
  },
  "articles/iOS.html": {
    "href": "articles/iOS.html",
    "title": "iOS | Emby Documentation",
    "keywords": "iOS Emby for iPhone and iPad is available in the Apple App Store . Emby for iOS can handle just about any type of media thanks to Emby Server transcoding . If you would like to learn how to prepare your media for Direct Play, read below. Setup Guide Install the app using one of the above methods, then use the startup wizard to connect to your Emby Server. Direct Play Media Formats Video — m4v,3gp,mov,xvid,vob,mkv,wmv,asf,ogm,ogv,m2v,avi,mpg,mpeg,mp4,webm Subtitles - srt,vobsub,pgs,ssa,ass,sub,vtt Audio – aac,mp3,mpa,wav,wma,mp2,ogg,oga,webma,ape,opus,flac Best Practices for Direct Play Ensure your media meets the above criteria. Leave the app's streaming bitrate setting on the default value of Auto, if possible. The app will perform bandwidth tests with your Emby Server to determine the maximum playable bitrate. If you are customizing the bitrate setting, then you will need to compare the bitrate of your files to the bitrate setting in the app. You can find the bitrate of a file by checking the media info in the web interface. If the bitrate of a file is higher than the setting in the app, transcoding will be required. Increasing the bitrate setting in the app can help reduce transcoding, but may impact playback performance if your network connection is not fast enough to handle it. Chromecast The app supports casting to Chromecast devices. To connect to your Chromecast device, simply click the cast icon in the top right corner of the app. You'll then be asked which device you'd like to connect to. Once connected, any content you play will be sent to the Chromecast device. You're able to play individual files, entire folders, shuffle, instant mix, queue, and more. For more information, see Chromecast ."
  },
  "articles/Keyboard-and-Remote-Support.html": {
    "href": "articles/Keyboard-and-Remote-Support.html",
    "title": "Keyboard and Remote Support | Emby Documentation",
    "keywords": "Keyboard and Remote Support This document applies to the following apps: Emby Web app Emby Windows Emby Linux Emby for Samsung Tizen Emby for Xbox One Emby for Sony PS4 To learn about supported input for other apps, please see the information page for the app you're looking for: https://streamora.example/download.html Device Support This document will list all of the supported keys that are recognized. Please note, not all devices have all of these keys available. General Navigation alt-left: navigate back alt-b: navigate back alt-right: navigate forward page-up: scroll forward in list page-down: scroll backward in list end: scroll to end of list home: return to app home screen control-t: Navigate to Live TV control-g: Navigate to Live TV Guide control-r: Record - works when highlighting a program or on program detail screen control-o: Navigate to Recorded TV control-d: show menu or info for selected content (if available) Video Playback spacebar: toggle play/pause control-shift-a: cycle through audio tracks control-u: cycle through subtitle tracks control-p: toggle play/pause control-shift-p: play selected media control-shift-s: stop control-shift-f: skip forward control-f: next chapter or track control-shift-b: skip backward control-b: previous chapter or track left: rewind, if on-screen display is not showing right: fast-forward, if on-screen display is not showing Shift+Left arrow: rewind Shift+Right arrow: fast-forward F8: toggle mute F9: volume down F10: volume up F: toggle full-screen M: toggle mute PageUp: Next chapter in video PageDown: Previous chapter in video Channel up: Next channel (or next track if not playing live tv) Channel down: Previous channel (or previous track if not playing live tv) Windows Media Keys The following special keys on Windows keyboards are supported: search/find: launch app search function favorites: navigate to favorites home: navigate to home esc: escape back to previous screen (back) menu/info: show menu or info for selected content (if available) back forward toggle mute volume up volume down channel up channel down rewind fast forward next track previous track record pause play stop"
  },
  "articles/LG-Why-not-Atmos.html": {
    "href": "articles/LG-Why-not-Atmos.html",
    "title": "Atmos on LG TV | Emby Documentation",
    "keywords": "Atmos on LG TV Why does the Emby App for my LG TV not play the Dolby Atmos TrueHD Audio without Transcoding? Why does the Emby App for my LG TV not play the Dolby Atmos TrueHD Audio without Transcoding? by rbjtech Why does the Emby App for my LG TV not play the Dolby Atmos TrueHD Audio without Transcoding? Background There are two primary types of Audio that can be played with Media files – Compressed Audio (ie AC3/AAC/DTS Core etc) and Uncompressed (or HD) Audio (ie True-HD, DTS-HD etc) Compressed Audio uses a lot less data (bitrate) and thus is used for streaming services such as Netflix while HD Uncompressed Audio is the primary audio on ‘physical’ media such as Blu-Ray or Ultra HD Blu-Ray disks because they have much more capacity to store the data. ‘Rips’ of this physical media may contain the HD Audio streams, the result is a technical scenario that was outside the scope of the original LG architecture design. Where does Atmos come in? Dolby Atmos is a technology where the sound is given additional data to allow it to use extra positional speakers that you may have as part of your AV Sound setup. Generally, these are ‘height’ speakers that give you the full 360 degrees experience. Atmos data can be applied to both Compressed Audio (in the form of Dolby Digital PLUS – EAC3) and HD Audio in the form of True-HD (THD). How can I get Emby to play Atmos using my Sound Bar or AV Receiver? As most people connected their DVD/Blu-Ray Player directly to the TV itself, a standard called ARC (Audio Return Channel) was introduced to pass the Audio back FROM the TV to the external amplifier. This was originally via Optical or Co-Ax cable but these days it’s via HDMI. This was great for DD/DD+/DTS compressed sound, but it was never designed for uncompressed sound as the hardware was not available. Note Streaming services/Internal LG Emby Client will use the ARC interface to pass DD+ Atmos (compressed) to a soundbar or Receiver without issue. For HD Audio however, a new standard was introduced called ‘eARC’ or Extended ARC. This only works over HDMI and importantly both the TV Hardware, TV Software/Firmware and Amplifier must all support eARC. This is where the LG problem lies On 2019 Models and later, the TV Hardware supports eARC but only from External Sources NOT the TV itself. As the Audio from the Emby LG Client is being generated ‘internally’ in the TV, then the hardware to use eARC is simply not available. Unfortunately, no firmware update can ever fix this, as the physical hardware ‘link’ is missing – a massive oversight from LG on even their newest 2020 TV’s. So in summary, you have two options to play HD Audio Dolby Atmos Option 1 If your LG TV is year 2019+ and has eARC, then you can pass the HD Audio to your Receiver or Soundbar by means of an External Player via the TV eARC HDMI Interface. Option 2 If your LG TV does not have eARC, then you can pass the HD Audio to your Receiver or Soundbar( ) directly by means of an External Player. Video only is then passed to the LG TV. No ARC or eARC is required. ( ) Note the soundbar/receiver must have an HDMI passthrough interface. Connecting the LG TV directly to the ARC or eARC enabled Receiver/Soundbar will only work for compressed Audio (DD,DD+), it will not work for HD Audio without Emby transcoding the streams."
  },
  "articles/Library-Setup.html": {
    "href": "articles/Library-Setup.html",
    "title": "Library Setup | Emby Documentation",
    "keywords": "Library Setup Setting up the library is handled within the startup wizard and also within the server dashboard, located by clicking on the Library tab. Prepare Your Media It's important to first prepare your media. See other sections of the documentation for more information: Movie naming TV naming Music naming Subtitles Library Setup Page The configuration will display the media libraries you've configured and allow you to add, remove, rename or change the paths they're mapped to. A media library is a grouping of one or more physical folders on your file system. To get started, click the button to add a media library. Clicking the \"Add Media Library\" button will open a dialog to add a library. You'll have to specify a content type, enter a display name, and choose a path to the media. Content Type Choosing the right content type is important. See the above guide on media preparation for best practices for Movie, TV and Music sections. Use the unset content type if you'd like to add a media folder that mixes different content. Please note that support for mixed content is limited. Initially you'll only be able to add one media path when setting up the library, but additional paths can be added after setting it up. Library Paths Each media folder can have one or more physical library paths. When you supply more than one media path, the contents of each will be merged together into one virtual display. To add a library path, click the + button. A popup will be displayed allowing you to browse to the location in a visual manner. Note If you are going to use one of the HTPC apps (Emby Windows, Emby for Xbox, Emby for Kodi), in some cases you may find it advantageous to use the Optional Network Path feature to translate the server's local paths to network ones or define your media locations with network UNC paths that those machines can see. Giving the HTPC apps direct links may help reducing the load on the server when streaming. Warning If you have paths with more than 256 chars on Windows you may have a problem. Please refer to https://docs.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation for help with this. Tip On some networks the visual browser may fail to display network devices. If this occurs you can still complete the dialog by typing in the path manually and clicking OK. Optional Network Paths By allowing Emby apps direct access to media folders on the server, they may be able to play them directly over the network and avoid using server resources to stream and transcode. Network Paths can help achieve this by mapping a path on the server to a network path that can be accessed by other devices. To learn more, see Optional Network Paths . Enable real-time monitoring To have Emby monitor changes to files and addition of content, real-time monitoring should be enabled. Important This option is only available on supported file systems. You should restart your Emby Server after changing this option Subtitles If required, you can select the subtitle language that Emby server will attempt to download. Advanced Settings If you enable Advanced Settings , you will have additional settings per library displayed. Advanced Settings include options such as: Prefer embedded titles over filenames Extract chapter images during the library scan Enable Open Subtitles subtitles"
  },
  "articles/Linux.html": {
    "href": "articles/Linux.html",
    "title": "Linux | Emby Documentation",
    "keywords": "Linux Emby-Server is packaged and supported on as many platforms and architectures as possible. You can find installation instructions that are distribution specific either here or on our Downloads page . Additionally, you can find our official docker images on the hub which support armv7l and amd64. Before running the Wizard: Ideally before running the setup wizard you might want to setup Emby-Server or your media files with the appropriate permissions. Permission on Linux are very important and if they are not set correctly on your media folders or Emby-Server's configuration folder, your experience maybe be sub-par. By default, Emby-Server runs under the user emby . It is highly unlikely that user emby will have read and write permissions to your media directories. This issue can be addressed in one of two ways. One, you can adjust the user Emby server runs as. You can do this by adjusting the conf file which can be found in /etc/emby-server.conf . Please read the comments and directions within the file. Or secondly, you can append the user emby to the group that has read and write access to your media files. You may read more about Linux permissions here ."
  },
  "articles/Linux-Troubleshooting-Guide-and-FAQ.html": {
    "href": "articles/Linux-Troubleshooting-Guide-and-FAQ.html",
    "title": "| Emby Documentation",
    "keywords": "Emby Server does not restart from the web interface: Emby on Linux does not have the built-in capability to restart itself. So to restart Emby uses a helper script. The helper script named restart.sh can be found on most distributions at /usr/lib/emby-server . The script can only restart Emby if it was started by a service manager program such as systemctl or service. If for some reason the helper script does not successfully restart Emby for you, please check the following: Ensure helper script is executable. Ensure Emby was started via a service manager. Ensure permissions of /etc/sudoers.d/emby are 0640 Ensure whatever user is running emby-server is part of the emby group (usermod -a -G emby $USER_NAME) Ensure /etc/sudoers permissions is 0640 ####Example of troubleshooting restart on a distribution using systemd: sudo systemctl status emby-server - Get PID. Hit restart on web interface sudo systemctl status emby-server - Get PID. If PIDs differ restart was successful. Otherwise, check the following: ls -la /usr/lib/emby-server/restart.sh - ensure it is executable. ps -aux | grep emby - Take note of PID sudo -u emby /usr/lib/emby-server/restart.sh - if you are running emby-server as another user other than emby, please adjust command appropriately. ps -aux | grep emby - Take note of PID If PIDs differ restart worked."
  },
  "articles/Linux-Unix-Permissions.html": {
    "href": "articles/Linux-Unix-Permissions.html",
    "title": "Linux/Unix Permissions | Emby Documentation",
    "keywords": "Linux/Unix Permissions Excellent advice from user Q-Droid on the Emby Forums This is an excerpt from a community thread by a member who wanted to allow other applications and Linux users on their server to access the media structure used by Emby. The member wanted shared read and write access to the libraries which may contain files and directories owned by different users. Allow group of users (my-user,Emby,Kodi,etc.) to read and write media content. Allow same for SMB shares. Generally speaking you can't prevent Emby from following the rules of the OS and in Linux/UNIX these rules were created for security reasons. A \"line of code\" won't change that because only the superuser is allowed to change ownership at the user level. Emby doesn't run as superuser and you really don't want to do that anyway. So instead you work with the rules and tools for the OS. There are multiple ways to do this, I'll share what I would do. Need elevated rights for this, i.e. root. Identify your media base directory. Usually it's the common starting directory for your libraries. For example, if your libraries look like this: /mnt/library/movies /mnt/library/tv shows /mnt/library/music Then \"/mnt/library\" is your base. Servers with multiple storage volumes and external drives can have multiple paths to the libraries without a common base. If this is the case then modify each library path individually and pick a directory from which subdirectories will be created, but not \"/\" and not \"/mnt\". On the Emby server with the media to be shared, create a group for media if it doesn't exist. The group name is arbitrary though it helps to be descriptive: group add media Add members to the group (my-user, emby, etc.): usermod -a -G media my-user usermod -a -G media emby ... We'll use ACLs. First to set the permissions and then to set the defaults. It can be done in one command but it's easier to follow this way. Members of the media group will be able to access and modify files and directories under /mnt/library. New files and directories will be created with permissions for the media group. Set permissions for media group on existing items (the 'X' is upper case): setfacl -R -m g:media:rwX /mnt/library Define default permissions for media group. Applies to new items: setfacl -R -m d:g:media:rwX /mnt/library If you're using SMB/CIFS you can enforce similar rules. Assuming the users are the same and the group can be added. In smb.conf and for each of the shares add to current config: [share name] create mask = 0664 directory mask = 0775 force group = media The above should give you enough information to get started with minimal tweaking needed."
  },
  "articles/Live-TV.html": {
    "href": "articles/Live-TV.html",
    "title": "Live TV Setup | Emby Documentation",
    "keywords": "Live TV Setup Emby provides a flexible and very powerful Live TV and DVR solution. With Emby’s TV you will be able to stream Live or Recorded TV content to any device you have with an Emby client or web browser. You can use Emby to eliminate the need for cable STBs (Set Top Boxes) or you can eliminate your cable provider entirely by cutting the cord and switching to OTA (Over the Air) broadcasts for local channels. Emby provides free guide data (US, UK & Canada) right out of the box at no additional cost. Overview of Setup Setup of Live TV can be broken down into a few steps: Configure your TV Tuner(s) or M3U based IPTV sources Add TV Guide Data Source(s) Match your Channel Lineup to Guide Data (Channel Mapping) The LiveTV and DVR feature requires a valid Emby Premiere subscription. Configure Your TV Tuner Out of the box, Emby Server currently supports the following TV Tuners: HDHomerun Network Tuner (Models available for both OTA and Cable. Must support DLNA 2015+ model) Hauppauge TV Tuners (on Emby Server for Windows - Requires WinTV 8.5 or greater to be installed) M3U Tuners - M3U files (or urls). See examples of m3u files at M3U Examples Support for additional tuners can be added by installing a Live TV Plugin . In most cases, Emby Server will automatically discover your HDHomerun on your network with no configuration required. You can manually add a tuner as well. Simply open the server dashboard, navigate to Live TV , then click Add underneath tuner devices. Add a TV Guide Data Source Out of the box, Emby Server currently supports the following TV Guide data sources: Emby Guide Data (United States, Canada and United Kingdom) Schedules Direct (Do not use on new setups. Will stop working June 1st, 2021) Xml TV Support for additional sources can be added by installing a Live TV Plugin . Match your Channel Lineup to Guide Data The final step of setting up Live TV is matching the tuner's stations to the Guide Data you have setup. Live TV Channel Mapping Live TV Advanced Settings (optional) You can optionally change a few options used for DVR purposes. These options include: Live stream buffer Amount of days of Guide Data loaded Option to wake the server for scheduled recordings Default recording paths Default Pre and Post recording padding times. This allows you set recording to start X minutes early and finish Y minutes late. Post-processing script to run after recording Live TV Advanced Settings Emby Live TV & DVR is Ready to Use. Congratulations, your Emby Server should now be configured properly and ready to use for Live TV and DVR."
  },
  "articles/Live-TV-Channel-Mapping.html": {
    "href": "articles/Live-TV-Channel-Mapping.html",
    "title": "Live TV Channel Mapping | Emby Documentation",
    "keywords": "Live TV Channel Mapping The last thing to do after setting up your tuner and guide data provider is to map your channel lineup. Emby Server will try to automate matching of your channels to any guides you have setup for this tuner. You can manually change any channel by picking the guide, then the Station. From the Live TV menu, click the Channel tab at the top of the screen. Click the 3 dot menu to the right on any channel you wish to edit. Click the Edit button on the popup screen. You can now select the Guide Provider to use as well as the station from that Guide. Click the Save Button when done editing this channel. You can do the same thing from the Guide itself. Click the left most column that has the station information. Click the 3 dot menu on the next screen you get which will be the same as above. [!Note} In some cases you may find channels missing from the guide. This can happen especially with OTA guide data. Often times if you are close to market boundaries you may have to add a 2nd guide using a different postal code. If you are fortunate enough to be able to pick up channels from separate broadcast markets this will almost always be the case (need for additional guide data provider). Sometimes you may need to try a different postal code closer to the broadcast towers. Don’t be afraid to try a few postal codes to get the guide data you need. Emby Server is very flexible and allows you to add multiple guides so please make use of this functionality if you need to. In the event you’re setting up a cable provider and find missing channels, please report this in the forums."
  },
  "articles/Live-TV-EPG-Other.html": {
    "href": "articles/Live-TV-EPG-Other.html",
    "title": "Other Sources of EPG Guide Data | Emby Documentation",
    "keywords": "Other Sources of EPG Guide Data If you are not able to use Emby's built in Guide Data you can source this data independently. Here are some of the popular services that can be used: FREE AUSTRALIAN EPG SOURCES https://www.xmltv.net/ IceTV Australia $ 3.99 per Month https://www.icetv.com.au/xmltv-setup/ EPG.BEST (many Countries) https://epg.best/ Monthly and Annual Subscriptions starting at $0.99 a month Subscriptions based on # of channels used List of Countries Albania Algeria Angola Argentina Armenia Australia Austria Azerbaijan Belarus Belgium Benin Bolivia Bosnia and Herzegovina Brazil Brunei Bulgaria Canada Chile China Colombia Costa Rica Croatia Cuba Curaçao Cyprus Czech Republic Denmark Dominican Republic Ecuador Egypt Estonia Finland France Georgia Germany Greece Guatemala Haiti Honduras Hong Kong Hungary Iceland India Indonesia Iran (Islamic Republic of) Iraq Ireland Israel Italy Jamaica Japan Jordan Kazakhstan Kenya Korea (Republic of) Kuwait Kyrgyzstan Latvia Lebanon Lithuania Luxembourg Macao Macedonia, the former Yugoslav Republic of Malaysia Malta Mauritius Mexico Moldova (Republic of) Mongolia Montenegro Morocco Mozambique Myanmar Netherlands New Zealand Nicaragua Nigeria Norway Pakistan Panama Paraguay Peru Philippines Poland Portugal Qatar Romania Russian Federation Saudi Arabia Serbia Singapore Slovakia Slovenia Solomon Islands South Africa Spain Sweden Switzerland Syrian Arab Republic Taiwan (Province of China) Tanzania, United Republic of Thailand The Savior Trinidad and Tobago Tunisia Turkey Ukraine United Arab Emirates United Kingdom of Great Britain and Northern Ireland United States of America Uruguay Venezuela Viet Nam"
  },
  "articles/Live-TV-HDHR-Channels.html": {
    "href": "articles/Live-TV-HDHR-Channels.html",
    "title": "HDHomeRun Channels | Emby Documentation",
    "keywords": "HDHomeRun Channels How to Remove or Hide Channels from My HDHomeRun Tuner This is a great way to remove SD channels when you only want the HD version or an easy way to remove channels you don't want like HSN, QVC or channels in foreign languages. Open a browser and type http://my.hdhomerun.com/ and you'll get a screen similar to this: Click on your tuner and you'll get a screen similar to this: Click on the Channel Lineup and you'll get a screen similar to this: The very first column above has stars or Xs. Click on the icon and you'll see it empty, yellow star or red X. It changes on each click. Yellow: Favorite Station Red X: Do not use Blank: No decision made So any station you don't want available you mark with the Red X. Any station you specifically want Emby to load can be marked Yellow. Any station \"blank\" (not yellow or red) is available in other apps but won't be imported into Emby. For example you might leave QVC, HSN, and infomercial channels blank so they are available outside Emby. Now in Emby go to your Live TV setup and click on your HDHomeRun and you'll have a screen like this: Make sure the first option is enabled to only import your favorites. Click Save Emby will now reload your channels only pulling your favorites. It will reload your guide data and then remove the non-favorite channels from your lineup!"
  },
  "articles/Live-TV-Manage-Channels.html": {
    "href": "articles/Live-TV-Manage-Channels.html",
    "title": "Manage Channels | Emby Documentation",
    "keywords": "Manage Channels How to Hide Specific TV Channels, Edit Parental Rating or Set Tags To hide a specific channel from the Guide for specific users. Edit a TV Channel Metadata from the web admin by hovering over the channel and clicking the 3 dot menu. Select the Edit Metadata option. You can now set a sort title that will over ride the normal title sorting. You can use the Parental rating field above to set the rating AND then use individual user parental control restrictions to hide channels from specific users using either the parental rating field above or a tag (see below) You can also click the + sign next to Tags and set a Tag such as \"HideChannel\". Once you've adjusted your channels you can set restriction per user using Parental Control restrictions per user."
  },
  "articles/Live-TV-NextPVR.html": {
    "href": "articles/Live-TV-NextPVR.html",
    "title": "NextPVR Tuner | Emby Documentation",
    "keywords": "NextPVR Tuner Emby Live TV supports setting up NextPVR as a TV Tuner source. Once you have NextPVR server setup and operational, and the NextPVR plugin installed on this Emby server and server restarted, it is very easy to add it to Emby. You do not need to setup guide data in NextPVR as we will set this up in Emby. Click the Live TV menu option from the web admin and you will see a screen similar to this. Click the \" + Add TV Source \" button and you will get the following screen: Select the \" Next Pvr \" option from above then setup NextPVR similar to this: The pin number is the pin configured in the NextPVR server Settings / Access screen under the \"Application Access\" section. Important There is a 5 channel limit imposed by NextPVR unless you become a donator. Refer to the NextPVR web site."
  },
  "articles/Live-TV-Plugins.html": {
    "href": "articles/Live-TV-Plugins.html",
    "title": "Live TV Plugins | Emby Documentation",
    "keywords": "Live TV Plugins Out of the box, Emby supports the most popular tuners on the market. If you need to add support for other tuners, need specific tuner functionality not included in the base Emby TV experience or already run a dedicated DVR/PVR server you can install a Live TV Plugin to gain functionality of an external program dedicated to your needs. Emby Server currently supports the most popular DVR servers on the market including: DVBLink DVBViewer MediaPortal NextPVR ServerWMC TVHeadEnd TVMosaic Vu+ Please note that each plugin depends on a standalone application of the same name. For example, the ServerWMC plugin for Emby requires the standalone ServerWMC application, the NextPVR plugin requires NextPVR installed on your network, etc Each plugin will provide it's own documentation, including the tuner hardware supported as well as the installation requirements. How to Install a Live TV Plugin Live TV Service providers are available in the plugin catalog. To browse the catalog, open the server dashboard and navigate to Plugins -> Catalog . For more information on plugins, as well as how to install and configure them, see Plugins . Service Provider Settings To configure the settings for your service provider, simply click on it within My Plugins ."
  },
  "articles/Live-TV-Vbox.html": {
    "href": "articles/Live-TV-Vbox.html",
    "title": "VBox TV Gateway Tuner | Emby Documentation",
    "keywords": "VBox TV Gateway Tuner Emby Live TV supports setting up VBox TV Gateway as a TV Tuner source. Once you have VBox TV Gateway setup and ready to use it's very simply to add to Emby. You do not need to setup guide data in VBox TV Gateway as we will set this up in Emby. Click the Live TV menu option from the web admin and add an M3U Tuner . All you have to do is type in the URL to your VBox TV Gateway machine like shown in the above picture. Just change the IP shown above to match the IP of your device. You can optionally set a specific tuner count as done above. Click SAVE when finished and your new tuner will be ready for use. If you've changed ports or don't know the IP just login into your Vbox device in a web browser and select Streaming->IPTV menus and you'll see a screen similar to this: You want to use the SimpleIPTV M3U8 URL."
  },
  "articles/Log-Files.html": {
    "href": "articles/Log-Files.html",
    "title": "Log Files | Emby Documentation",
    "keywords": "Log Files You can access Emby Server Log files from the dashboard UI by clicking on the Manage Emby Server gear icon in the top right corner, and then navigating to Logs under the Server menu in the left sidebar. You will see a list of log files on the right where you can do one of the following: Click on the ... to the right of the log file name and then choose Multi-Select or Download. If multi-selecting log files, clicking on the ... after selecting log files would offer the option to download, or Click on one to open it in the web browser Click the icon in the red box below to open the log file in a new tab. Click the icon in the yellow box to download the log file. Downloading the logs through either method anonymises the log files and is the recommended way when needing to upload the log files for support. The physical location of log files is displayed on the View Server Info button which is available through the ... button next to the server name on the server dashboard main page. Log Rollover By default, Emby Server will start a new log file every day at midnight. The current log file will be renamed and postfixed by a timestamp value. You can control log rollover through in the Scheduled Tasks section by modifying the execution schedule of the Rotate log file task Log file types There are four types of log files: embyserver_xxxxx.txt The main server log file, rotated as described above. The current log file would just be called embyserver.txt ffmpeg-xxxx.txt Transcoding logs created for each transcoding or remuxing operation hardware_detection-xxxxx.txt Hardware detection log. Created on every startup of Emby Server quick-extract-xxxxx.txt ffmpeg logs for image extractions Debug Logging A setting is available to allow you to enable additional debug logging. The following shows the various options available. By default, debug logging is not enabled. Debug logging should only be enabled when specifically requested to do so for a specific problem investigation. Fail2Ban Support Emby Server creates log entries for authentication failures that are compatible with Fail2Ban: The schema is: AUTH-ERROR: {0} - {1} where {0} is the source IP address and {1} is the error message. For example: 2018-12-28 00:00:00.007 Error AUTH-ERROR: 1.1.1.1 - Invalid username or password entered."
  },
  "articles/M3U-Tuners.html": {
    "href": "articles/M3U-Tuners.html",
    "title": "M3U Tuners | Emby Documentation",
    "keywords": "M3U Tuners How to add and configure an M3U Tuner Emby Live TV supports setting up M3U files as TV Tuners. Each M3U file will contain a list of channels, along with information such as channel name, id, and how to play the channel. To add an M3U tuner, simply open the Emby Server dashboard, navigate to Live TV, then click Add underneath tuner devices. On the M3U Tuner setup screen, you'll need to enter the path to an M3U file. Emby will accept either: A file path to an M3U file A URL to an M3U file that can be downloaded The following M3U properties are supported: tvg-name - Channel name tvg-id - Channel unique ID tvg-chno - Channel number tvg-shift - Number of hours to shift the EPG (only used as needed) tvg-group - Group the channel belongs to for group management of the guide. These groups will be imported as tags by Emby for use in parental filtering as well. If any are missing, Emby will attempt to automatically detect the information using whatever tags are available. Example M3U #EXTM3U #EXTINF:10.000000,TVG-ID=\"Channel1\" tvg-name=\"Channel 1\" tvg-logo=\"http://example.com/channel1.png\" group-title=\"Entertainment\",Channel 1 http://example.com/stream1.ts #EXTINF:10.000000,TVG-ID=\"Channel2\" tvg-name=\"Channel 2\" tvg-logo=\"http://example.com/channel2.png\" group-title=\"Entertainment\",Channel 2 http://example.com/stream2.ts"
  },
  "articles/Manual-Subtitle-Downloads.html": {
    "href": "articles/Manual-Subtitle-Downloads.html",
    "title": "Manual Subtitle Downloads | Emby Documentation",
    "keywords": "Manual Subtitle Downloads Emby allows you to manually download subtitle files for your media as needed. There are multiple subtitle plugins that can be used. Install a Subtitle Plugin Before being able to setup downloading of subtitles you will need to setup a plugin such as Open Subtitles . Please make sure you have configured your plugin before continuing. Manual Subtitle Download From a video file click the 3 dot/more menu and select the Edit Subtitles menu choice from the popup menu. You will get a new screen with a couple of option. Select the language and any options you need and then click the magnifying glass/search icon. The page will expand with any subtitles it found that matched your results and will look like this. All you have to do now is click the download arrow in the cloud to the right side of the subtitle you wish to download. Once you click this the Emby Server will queue the file for download and it will be available for use very quickly. Note if you do not see any subtitle appear for download (as above) then that would mean that Emby could not find any subtitles that match your criteria. You can try and change any options you set or possibly try to search for \"English\" subtitles (if not already). Some movies will not have subtitles available. Note if you do not see the option to search, have the server user settings checked for having permission to download subtitles. If you have problems finding subtitles, please verify that the movie/show was identified correctly. You can manually check IMDB Id using the Metadata Manager. When using this scroll down the the External Id section and very the IMDB Id is correct. This section will look similar to this. See Also Subtitles Naming Open Subtitles Automatic Subtitle Downloads"
  },
  "articles/Media-Stubs.html": {
    "href": "articles/Media-Stubs.html",
    "title": "Media Stubs | Emby Documentation",
    "keywords": "Media Stubs Emby has support for offline media stub files. These are files that represent a media outside of the online digital infrastructure and allow Emby's library to index your \"offline\" media collection, as well as ask for the media when selected for playback. A stub file is an empty file with a \".disc\" extension. For example: /Movies /Home Alone (1990) /Home Alone (1990).dvd.disc Media flags You can optionally add media source flags to the filename before \".stub\". This can be used to indicate the type of media (DVD, BLURAY, VHS, etc) that the movie resides on, which can be used for display purposes. DVD, if the filename contains DVD. Bluray, if the filename contains BLURAY, BDRIP, BD25, or BD50. HDDVD, if the filename contains HDDVD. TV, if the filename contains HDTV, PDTV, or DSR. VHS, if the filename contains VHS. Examples: /Movies Movie1.dvd.disc Movie2.bluray.disc Movie3.hdtv.disc Movie4.vhs.disc Movie1.hddvd.disc"
  },
  "articles/Metadata-manager.html": {
    "href": "articles/Metadata-manager.html",
    "title": "Metadata Manager | Emby Documentation",
    "keywords": "Metadata Manager One of the areas in which Emby Server shines as a media server is the metadata management. The server has a metadata manager which allows you to view all of the metadata for every item in your library in one place. The metadata manager can be accessed via the side-bar in the web client and other emby client apps. The functionality is also available via the \"...\" options button and selecting one of the edit options for any media item: Using the Metadata Manager Refreshing metadata Each media item has the option to Refresh Metadata . The option is available at every level, eg episode, season, series, movie, library etc. This will open the Refresh Metadata options screen Selecting Refresh will pull fresh metadata from each of the databases that the server is configured to pull from for the library. In addition, it will download any images that may be missing (logos, disc images, posters, etc.). There are 2 Refresh modes : Refreshing all metadata (the default option) will overwrite all of the fields with metadata from outside databases. Refreshing only missing data will preserve all of the existing metadata and only populate the fields that are missing metadata. Selecting Replace existing images will force the server to remove existing images and re-download all of the images for the media item. Warning This option would also remove your custom images. Make sure you save these if you need to bring them back later. Identifying items All media can get their information from online databases such as TheMovieDB and TheTVDB. If an item is misidentified by the server, you can manually identify the item using the Identify button, or, if you already know the database IDs for your incorrectly identified item, simply insert the correct IDs into the database fields and refresh the item. Database IDs Database IDs are extremely important to the server to determine what each media item is and whether it has been watched. One catch to this approach is that media items with the same IDs (for example, a movie that has both a 3D and 2D version) will be treated by the server as the exact same item regardless of the existence of two separate files. This can mean that it can show up in the Resume tab or other places twice. Also, if you watch the 3D version but not the 2D version, the server will mark both formats as watched. Saving metadata Be sure to hit Save after changing ANY metadata; otherwise, all of your changes will be lost when you navigate away from the page. If you wish for the changes that you made to be persistent through a refresh of the item, you will need to either lock the metadata field you changed, or lock the entire item. Examples of the lock option can be seen here: This shows how to lock the item: Parental Controls and Metadata You should be aware that there are certain metadata fields that affect the use of parental controls. One good example of such a metadata field is the parental rating. The parental rating can be used to set whether a server user can access content that is above a certain rating, e.g. allowing a teen to access content rated PG-13 or below while restricting access to content rated at R or above. Another metadata item that you can use to prevent a user from accessing certain content is the Tags metadata field. To keep a user profile from accessing certain content Tag each item that you want to prevent access to with a unique tag. Go to the Users -> Parental Control in the server dashboard. Add the unique tag to the Block content with these tags field. Save the changes to the user profile and media tags. You can also do the inverse and only allow access to content with specific tags. Add the tag to the Allow only items with these tags field. To make sure the tags don't disappear in a library refresh, lock the Tags field in the item's metadata. Tip Tags can also be used for custom Cinema Intro trailers. Simply add a tag to each movie/episode such as \"HomeMovies\". Then you configure a path in Custom Intros for a Custom Codecs directory and add a movie with a tag (done externally) of \"HomeMovies\". This allows Emby to display your custom Intro for any movie tagged with the same name. Subtitles For your movies and TV shows, the metadata manager can ve used to manage subtitles. You can also access this for specific media items through the Options button and selecting \" Edit Subtitles \". This will allow you to see which subtitles you have, whether they are graphical or text, and what languages the subtitles are in. To search for new subtitles, you need to enable access to the Open Subtitles database, you will need to enter your account information on the Open Subtitles setup screen by selecting \"Open Subtitles\" within the \"Advanced\" menu in Server Settings: Clicking on \"Open Subtitles\" will load the page for entering your Open Subtitles account details Refer to Configure Open Subtitle plugin . With Open Subtitles configured, you can search for new subtitles. This is an example of search results: In Server Settings Scheduled Task s, the Download subtitles task will automatically attempt to downloaded missing subtitles. Images Emby Server can automatically download images to improve the presentation of media in each client. Library settings have options for download of images. The following shows the options available for Movies and TV Shows libraries: Images are downloaded from Fanart.tv, TheMovieDB, The Open Movie Database, and TheTVDB. For each item, you have an option to Edit Images that the emby server presents for your Emby Server clients. To change the image used, you can select the \"...\" options button This will bring up a number of options, allowing you to edit the reference to the image through add or delete or specify a url, in addition to the search option: Alternatively, you can go directly to searching the databases for new images by clicking on the search button: You will then be presented with the search results:"
  },
  "articles/misc/Beta-Programs.html": {
    "href": "articles/misc/Beta-Programs.html",
    "title": "Beta Programs | Emby Documentation",
    "keywords": "Beta Programs We offer beta testing programs for a range of products. The ways how these are being carried out can vary in a number of ways. In order to document the status and conditions of those programs, we are providing specification tables in the documentation. Below are the description of the individual parameters being used. Description of Program Specifications Program Status Unavailable No beta program exists, and none is currently planned. Planned We intend to establish a beta program. Starting soon There are ongoing preparations and a new program is expected to start shortly. Active There is a running beta program, new builds are released regularly and we're actively working on it and collecting user feedback. Paused A beta program exists and has been active before, but no development is being done other than bug fixes. New versions may still be posted occasionally, but these will only be about high-priority bug fixes or meant to discover regressions early. Ended The program has ended. Program Mode Continuous The beta program is continuously available and typically Active. Periodic Beta testing happens during active phases with a duration of a few weeks (possibly months) which are interrupted by Paused periods. On-Demand Members are on standby, ready for testing a new release when needed. This is typically used with small, private groups. Communication Public All communication and interaction with the beta members is done publicly, usually in the forums. Private The program is conducted privately, in most cases through a private GitHub repository. Enrollment Method Registration The program is free for everybody to join, but users need to register through our beta portal. Application Interested users need to apply on our beta site, often needing to fill out forms with information about their available hardware, software and environment. Grant or denial of access to the program is at the sole discretion of Emby LLC. None There is no enrollment requirement and in turn, there is also no joining procedure and no membership status. Enrollment Status Open Closed Invite-Only"
  },
  "articles/misc/downloads/Emby-Package-Repository.html": {
    "href": "articles/misc/downloads/Emby-Package-Repository.html",
    "title": "Emby Package Repository | Emby Documentation",
    "keywords": "Emby Package Repository This documentation explains how to add the Emby package repository on Linux and install packages. Choose an installation method Universal installer Use this if you want a guided (interactive) installer that: detects your package manager automatically (APT, DNF, Zypper, Pacman) avoids running as root until it needs to make system changes can be used non-interactively via environment variables See: Linux Universal Installer Manual setup (per package manager) Use this if you prefer to configure the repository yourself: APT (Debian/Ubuntu/Mint): Emby Pkg APT DNF (Fedora/RHEL/CentOS): Emby Pkg DNF Zypper (openSUSE/SLE): Emby Pkg Zypper Pacman (Arch/derivatives): Emby Pkg Pacman Channels Emby publishes two independent channels: stable : recommended for most users beta : preview builds Each guide contains stable/beta instructions. Package names Common package IDs you may see: emby-server media.emby.client (stable client) media.emby.client.beta (beta client) Available packages vary by distribution and architecture."
  },
  "articles/misc/downloads/Emby-Pkg-APT.html": {
    "href": "articles/misc/downloads/Emby-Pkg-APT.html",
    "title": "Manual Repo Setup: APT | Emby Documentation",
    "keywords": "Manual Repo Setup: APT Debian / Ubuntu / Linux Mint This guide explains how to configure the Emby APT repository manually (without using get.sh ). Prerequisites You need: curl ca-certificates gnupg (only needed if you want to inspect keys; the steps below use a .gpg keyring directly) Channels Emby publishes two APT channels: stable (recommended) beta Stable channel 1) Install the signing key The APT setup uses a keyring file: Key URL: https://pkg.streamora.example/keys/emby-public.gpg Keyring path: /etc/apt/keyrings/emby-public.gpg sudo install -d -m 0755 /etc/apt/keyrings sudo curl -fsSL https://pkg.streamora.example/keys/emby-public.gpg -o /etc/apt/keyrings/emby-public.gpg sudo chmod 0644 /etc/apt/keyrings/emby-public.gpg 2) Add the repository source (Deb822 .sources ) For stable, the repo publishes a Deb822 source file at: https://pkg.streamora.example/apt/emby.sources Create: /etc/apt/sources.list.d/emby.sources sudo curl -fsSL https://pkg.streamora.example/apt/emby.sources -o /etc/apt/sources.list.d/emby.sources This file contains (for reference): Types: deb URIs: https://pkg.streamora.example/apt/ Suites: stable Components: main Architectures: amd64 arm64 armhf Signed-By: /etc/apt/keyrings/emby-public.gpg 3) Refresh package indices sudo apt-get update Beta channel 1) Install the signing key Same key as stable: sudo install -d -m 0755 /etc/apt/keyrings sudo curl -fsSL https://pkg.streamora.example/keys/emby-public.gpg -o /etc/apt/keyrings/emby-public.gpg sudo chmod 0644 /etc/apt/keyrings/emby-public.gpg 2) Add the repository source Create: /etc/apt/sources.list.d/emby-beta.sources sudo curl -fsSL https://pkg.streamora.example/apt/emby-beta.sources -o /etc/apt/sources.list.d/emby-beta.sources 3) Refresh package indices sudo apt-get update Verify repository configuration Show which versions APT sees and which repo they come from: apt-cache policy emby-server You should see pkg.streamora.example and the chosen suite ( stable or beta ) in the output. List packages from the repo (basic approach): apt-cache search emby Install / upgrade / uninstall examples Install server: sudo apt-get install emby-server Upgrade: sudo apt-get update sudo apt-get upgrade Uninstall: sudo apt-get remove emby-server Remove the repository Stable: sudo rm -f /etc/apt/sources.list.d/emby.sources sudo apt-get update Beta: sudo rm -f /etc/apt/sources.list.d/emby-beta.sources sudo apt-get update (You can keep the keyring file in /etc/apt/keyrings/ if you plan to re-add the repo later.)"
  },
  "articles/misc/downloads/Emby-Pkg-DNF.html": {
    "href": "articles/misc/downloads/Emby-Pkg-DNF.html",
    "title": "Manual Repo Setup: DNF | Emby Documentation",
    "keywords": "Manual Repo Setup: DNF Fedora / RHEL / CentOS This guide explains how to configure the Emby RPM repository manually for DNF-based systems (without using get.sh ). Prerequisites You need: dnf curl ca-certificates On some distributions, dnf config-manager is provided by dnf-plugins-core . Channels Emby publishes two RPM channels: stable (repo id: emby ) beta (repo id: emby-beta ) You should configure exactly one of them. Option A (simple): use dnf config-manager with the published .repo This matches the short form shown on the website. Stable sudo dnf config-manager --add-repo https://pkg.streamora.example/rpm/emby.repo sudo dnf makecache Beta sudo dnf config-manager --add-repo https://pkg.streamora.example/rpm/emby-beta.repo sudo dnf makecache Notes: The .repo file is installed under /etc/yum.repos.d/ . DNF may prompt to import a GPG key the first time it uses the repo. Option B (recommended for non-interactive/manual control): download the .repo and import the key proactively This mirrors the behavior of tree_update/rpm/setup-dnf.sh (used by get.sh ). Stable Download the repo file: sudo curl -fsSL https://pkg.streamora.example/rpm/emby.repo -o /etc/yum.repos.d/emby.repo Download and import the signing key: Key URL: https://pkg.streamora.example/keys/emby-public.asc Local key path (recommended): /etc/pki/rpm-gpg/emby-public.asc sudo install -d -m 0755 /etc/pki/rpm-gpg sudo curl -fsSL https://pkg.streamora.example/keys/emby-public.asc -o /etc/pki/rpm-gpg/emby-public.asc sudo rpm --import /etc/pki/rpm-gpg/emby-public.asc 2>/dev/null || sudo rpmkeys --import /etc/pki/rpm-gpg/emby-public.asc || true Ensure the repo file uses the local file:// key path (prevents repeated prompts): sudo sed -i -E 's|^[[:space:]]*gpgkey=.*$|gpgkey=file:///etc/pki/rpm-gpg/emby-public.asc|' /etc/yum.repos.d/emby.repo Refresh metadata: sudo dnf -y clean metadata || true sudo dnf -y makecache --refresh --repo emby Beta Same steps, but using the beta .repo file and repo id: sudo curl -fsSL https://pkg.streamora.example/rpm/emby-beta.repo -o /etc/yum.repos.d/emby-beta.repo sudo install -d -m 0755 /etc/pki/rpm-gpg sudo curl -fsSL https://pkg.streamora.example/keys/emby-public.asc -o /etc/pki/rpm-gpg/emby-public.asc sudo rpm --import /etc/pki/rpm-gpg/emby-public.asc 2>/dev/null || sudo rpmkeys --import /etc/pki/rpm-gpg/emby-public.asc || true sudo sed -i -E 's|^[[:space:]]*gpgkey=.*$|gpgkey=file:///etc/pki/rpm-gpg/emby-public.asc|' /etc/yum.repos.d/emby-beta.repo sudo dnf -y clean metadata || true sudo dnf -y makecache --refresh --repo emby-beta Verify repository configuration List known repos and confirm emby or emby-beta is present: dnf repolist --all | grep -E '^(emby|emby-beta)' Show package info: dnf info emby-server List available packages (basic search): dnf search emby List available versions (shows duplicates): dnf list --showduplicates emby-server Install / upgrade / uninstall examples Install server: sudo dnf install emby-server Upgrade: sudo dnf upgrade Uninstall: sudo dnf remove emby-server Remove the repository Stable: sudo rm -f /etc/yum.repos.d/emby.repo sudo dnf -y clean metadata || true Beta: sudo rm -f /etc/yum.repos.d/emby-beta.repo sudo dnf -y clean metadata || true (You can keep /etc/pki/rpm-gpg/emby-public.asc if you plan to re-add the repo later.)"
  },
  "articles/misc/downloads/Emby-Pkg-Installer.html": {
    "href": "articles/misc/downloads/Emby-Pkg-Installer.html",
    "title": "Emby Universal Installer | Emby Documentation",
    "keywords": "Emby Universal Installer As Easy as it can be! curl https://pkg.streamora.example/get.sh | sh Copy Copied to clipboard Use the button to copy-paste or type the command to run in a terminal All apps - all distros - all architectures all channels - all package managers - all versions ONE COMMAND About get.sh is the recommended way to set up the Emby package repository on Linux. It is a single, universal script that: detects your system’s package manager automatically (APT, DNF, Zypper, Pacman) guides you through repository setup and package installation avoids immediate elevation: it runs as a regular user and only requests root permissions for actions that require it Quick start (interactive) Run the installer script as shown above. Then follow the prompts: Choose channel ( stable or beta ) Register/unregister repository (or show packages if already registered) Choose an app/package Install/uninstall/view info (and optionally open Software Center if supported) Non-interactive usage (automation) get.sh supports non-interactive usage via environment variables. Environment variables ch = stable|beta Selects repository channel. rop = R|S|U Repository operation: R = register (or “reload” if already registered) S = show packages (requires repo already registered) U = unregister (requires repo already registered) app = package id (required when rop=S ) Examples: emby-server , media.emby.client , media.emby.client.beta aop = operation when rop=S (required when rop=S ) Valid operations depend on app state and platform (the script will reject invalid combinations): I = install (latest) U = uninstall V = choose a specific version (only offered when multiple versions exist) S = show app info K = block/unblock package from auto-updating (not available on Pacman) GET_LOCAL = 1 Local test mode. Instead of downloading platform helper scripts from pkg.streamora.example , the script will use local files from ./tree_update/ (useful when developing this repository). Examples Register stable repo: curl -fsSL https://pkg.streamora.example/get.sh | env ch=stable rop=R sh Unregister beta repo: curl -fsSL https://pkg.streamora.example/get.sh | env ch=beta rop=U sh Show packages (beta) and install the beta client: curl -fsSL https://pkg.streamora.example/get.sh | env ch=beta rop=S app=media.emby.client.beta aop=I sh What get.sh does (high level) 1) Detects the platform (package manager) get.sh selects the first supported platform it finds: APT if apt-get is available Pacman if pacman is available DNF if dnf is available Zypper if zypper is available If rpm-ostree is detected, get.sh prints a message with manual steps and exits (rpm-ostree is not currently supported by the interactive installer). If none of the above is found, the script exits with an error. 2) Fetches a platform helper script After detecting the platform, get.sh fetches exactly one helper script (unless GET_LOCAL=1 is used): APT: https://pkg.streamora.example/apt/setup.sh Pacman: https://pkg.streamora.example/pac/setup.sh DNF: https://pkg.streamora.example/rpm/setup-dnf.sh Zypper: https://pkg.streamora.example/rpm/setup-zypper.sh That helper script provides a shared set of functions (an “interface”) that get.sh calls to: check whether the repository is registered register/unregister the repository list available packages install/uninstall packages, show package info, etc. 3) Performs requested actions Repository-level actions: Register (or reload) repository for the chosen channel Unregister repository for the chosen channel App/package actions: Install/uninstall Show package information Select and install a specific version (when supported and multiple versions exist) Block/unblock package from auto-updating (APT, DNF, Zypper only) Cross-channel update protection When you have both the stable and beta repositories registered, there's a risk of accidentally upgrading your Emby Server from one channel to another during routine system updates. To prevent this, get.sh includes automatic cross-channel update protection. Automatic blocking When registering a repository, get.sh automatically blocks cross-channel server updates: Registering the beta repo with a stable Emby Server installed : The script automatically blocks emby-server from the beta repo, preventing accidental upgrades to beta versions. Registering the stable repo with a beta Emby Server installed : The script automatically blocks emby-server from the stable repo, preventing accidental downgrades to stable versions. When automatic blocking occurs, you'll see a message like: An Emby Server (stable) installation was detected on this system. The Emby Server package from the beta repo has been blocked automatically in order to prevent automatic updates being offered, which could lead to unwanted installation of a beta server version over your stable installation. Manual blocking/unblocking You can also manually control package update blocking from the package operations menu: Navigate to the package in the packages list Select the package to view operations Use the K option to toggle blocking: If currently blocked: \"Unblock package from auto-updating\" If not blocked: \"Block package from auto-updating\" Blocked packages are shown in the package list with \"(updates blocked)\" next to their status. Platform implementation The blocking feature uses platform-native mechanisms: APT : Creates pinning rules in /etc/apt/preferences.d/ with negative priority DNF : Adds excludepkgs= to the repo file in /etc/yum.repos.d/ Zypper : Creates repo-scoped package locks via zypper addlock -r Pacman : Not supported (no beta server packages available) Security model / elevation get.sh is designed to be safe to run as a regular user. When a privileged action is needed, get.sh tries to use an elevation tool: sudo (most common) doas run0 pkexec sudo-rs If no elevation tool is available and you are not already running as root, operations that require root privileges will fail with an error. Troubleshooting “Could not find a supported package manager” Your system must have one of: APT, Pacman, DNF, or Zypper. “No elevation tool available” Install sudo (or another supported elevation tool) and re-run. “This system uses rpm-ostree which is not yet supported” Follow the instructions printed by get.sh (it suggests installing the .repo file and using rpm-ostree install ... , then rebooting). Debugging downloads get.sh uses either curl or wget (whichever is available). If downloads fail, verify connectivity to https://pkg.streamora.example/ . Local development / testing ( GET_LOCAL=1 ) From the repository root: GET_LOCAL=1 env ch=stable rop=R sh tree_update/get.sh This forces get.sh to use tree_update/apt/setup.sh , tree_update/pac/setup.sh , etc. instead of downloading them. .universal-installer { display: flex; flex-direction: column; align-items: center; margin: 20px 0 0px 0; } .codewrapper { position: relative; display: flex; margin-top: 20px; margin-bottom: 9px; width: fit-content; } *, :after, :before { box-sizing: border-box; } pre { border: 0; padding: 9.5px; margin: 20px 0; font-size: 15px; word-break: break-all; word-wrap: break-word; background-color: #f8f8f7; border-radius: 4px; border: none; box-shadow: var(--card-box-shadow); display: block; font-family: monospace; unicode-bidi: isolate; white-space: pre; margin-block: 1em 1em; margin-inline: 0px; } pre.rp-pre { margin-top: 0; margin-bottom: 0; padding-right: 60px; padding-left: 15px; } .rp-description { font-size: 11px; color: #9f9f9f; margin-bottom: 20px; } h1#emby-package-repositories { margin-left: 200px; color: white; margin-top: 25px; white-space: nowrap; text-overflow: ellipsis; overflow: clip; font-size: 36px; } h3#rp-single-commandD { font-weight: 400; margin-bottom: 0px; margin-top: 20px; margin-right: 22px; } ul.rp-list { list-style: none; padding-inline-start: 0; margin-right: 30px; user-select: none; } .copy-btn { position: absolute; top: 0; bottom: 1px; right: 0; z-index: 10; display: inline-flex; align-items: center; gap: 6px; padding: 6px 10px; font-size: 12px; line-height: 1; color: var(--font-color); background: #fff; border: 1px solid #ddd; border-radius: 6px; box-shadow: var(--card-box-shadow); transition: transform 120ms ease, box-shadow var(--transition), color var(--transition), border-color var(--transition); margin: 3px; opacity: 0.6; } .copy-btn .fa { font-size: 14px; } .copy-btn:hover, .copy-btn:focus { color: var(--highlight-dark); border-color: var(--highlight-light); outline: none; /* transform: translateY(-1px); */ } .copy-btn.is-copied { color: #2e7d32; border-color: #2e7d32; } .copy-btn.is-error { color: #c62828; border-color: #c62828; } .copy-toast { position: absolute; top: -36px; right: 8px; background: #212121; color: #fff; padding: 4px 8px; border-radius: 4px; font-size: 12px; box-shadow: var(--card-box-shadow); opacity: 0; transform: translateY(-6px); pointer-events: none; transition: opacity 150ms ease, transform 150ms ease; } .copy-toast.show { opacity: 1; transform: translateY(0); } /* Respect small screens: keep button tappable */ @media (max-width: 480px) { .copy-btn { padding: 8px 12px; font-size: 13px; } } .copy-label { display: none; } (function() { function makeWrapper(pre) { if (pre.parentElement && pre.parentElement.classList.contains('codewrapper')) return pre.parentElement; const wrap = document.createElement('div'); wrap.className = 'codewrapper'; pre.parentNode.insertBefore(wrap, pre); wrap.appendChild(pre); return wrap; } function createButton() { const btn = document.createElement('button'); btn.type = 'button'; btn.className = 'copy-btn'; btn.setAttribute('aria-label', 'Copy to clipboard'); btn.innerHTML = '<i class=\"fa fa-clipboard\" aria-hidden=\"true\"></i><span class=\"copy-label\">Copy</span>'; return btn; } function createToast() { const div = document.createElement('div'); div.className = 'copy-toast'; div.setAttribute('role', 'status'); div.setAttribute('aria-live', 'polite'); div.textContent = 'Copied to clipboard'; return div; } function getCodeText(codeEl) { return (codeEl.innerText || codeEl.textContent || '').trim(); } function fallbackCopy(text) { const ta = document.createElement('textarea'); ta.value = text; ta.style.position = 'fixed'; ta.style.top = '-1000px'; ta.style.left = '-1000px'; document.body.appendChild(ta); ta.select(); ta.setSelectionRange(0, text.length); let ok = false; try { ok = document.execCommand('copy'); } catch (_) { ok = false; } document.body.removeChild(ta); return ok; } function setState(btn, toast, state) { const label = btn.querySelector('.copy-label'); const icon = btn.querySelector('.fa'); btn.classList.remove('is-copied', 'is-error'); toast.classList.remove('show'); if (state === 'copied') { btn.classList.add('is-copied'); if (icon) icon.className = 'fa fa-check'; if (label) label.textContent = 'Copied!'; toast.textContent = 'Copied to clipboard'; toast.classList.add('show'); } else if (state === 'error') { btn.classList.add('is-error'); if (icon) icon.className = 'fa fa-times'; if (label) label.textContent = 'Copy failed'; toast.textContent = 'Copy failed'; toast.classList.add('show'); } else { if (icon) icon.className = 'fa fa-clipboard'; if (label) label.textContent = 'Copy'; } } function attach(pre) { const wrap = makeWrapper(pre); const code = pre.querySelector('code') || pre; const btn = createButton(); const toast = createToast(); wrap.appendChild(btn); wrap.appendChild(toast); let resetTimer = null; function reset() { setState(btn, toast, 'idle'); btn.disabled = false; } btn.addEventListener('click', async function() { const text = getCodeText(code); if (!text) return; btn.disabled = true; try { if (navigator.clipboard && navigator.clipboard.writeText) { await navigator.clipboard.writeText(text); setState(btn, toast, 'copied'); } else { const ok = fallbackCopy(text); setState(btn, toast, ok ? 'copied' : 'error'); } } catch (e) { const ok = fallbackCopy(text); setState(btn, toast, ok ? 'copied' : 'error'); } clearTimeout(resetTimer); resetTimer = setTimeout(reset, 1800); }); } document.addEventListener('DOMContentLoaded', function() { document.querySelectorAll('pre').forEach(attach); }); })();"
  },
  "articles/misc/downloads/Emby-Pkg-Pacman.html": {
    "href": "articles/misc/downloads/Emby-Pkg-Pacman.html",
    "title": "Manual Repo Setup: Pacman | Emby Documentation",
    "keywords": "Manual Repo Setup: Pacman Arch Linux / derivatives This guide explains how to configure the Emby Pacman repository manually (without using get.sh ). Prerequisites You need: pacman curl gpg (usually present; used to extract the key fingerprint) pacman-key Channels and architecture Emby publishes two channels: stable (repo name: emby-stable ) beta (repo name: emby-beta ) The repository URL also depends on your architecture: x86_64 (most desktop/server installs) aarch64 (ARM64) The published server format is: https://pkg.streamora.example/pac/<channel>/os/<arch> Example (stable, x86_64): https://pkg.streamora.example/pac/stable/os/x86_64 1) Determine your architecture uname -m Use: x86_64 → x86_64 aarch64 (or arm64 ) → aarch64 2) Import and locally sign the Emby signing key Pacman requires repository signing keys to be present in the pacman keyring and locally trusted. Key URL: https://pkg.streamora.example/keys/emby-public.asc Initialize keyring (only if needed) sudo pacman-key --init sudo pacman-key --populate Download key and add it to pacman tmpkey=\"$(mktemp)\" curl -fsSL https://pkg.streamora.example/keys/emby-public.asc -o \"$tmpkey\" sudo pacman-key --add \"$tmpkey\" Extract fingerprint and locally sign it FPR=\"$(gpg --show-keys --with-colons \"$tmpkey\" | awk -F: '/^fpr:/ {print $10; exit}')\" sudo pacman-key --lsign-key \"$FPR\" rm -f \"$tmpkey\" 3) Add the repository stanza to /etc/pacman.conf Edit /etc/pacman.conf and add one of the following blocks. Stable channel (Replace <arch> with x86_64 or aarch64 ) [emby-stable] Server = https://pkg.streamora.example/pac/stable/os/<arch> SigLevel = Required DatabaseRequired Beta channel [emby-beta] Server = https://pkg.streamora.example/pac/beta/os/<arch> SigLevel = Required DatabaseRequired 4) Refresh package databases sudo pacman -Syy Verify repository configuration Confirm Pacman sees packages from the repo: pacman -Sl emby-stable 2>/dev/null | head (or for beta) pacman -Sl emby-beta 2>/dev/null | head Show package info: pacman -Si emby-server Install / upgrade / uninstall examples Install server: sudo pacman -S emby-server Upgrade system packages: sudo pacman -Syu Uninstall: sudo pacman -Rns emby-server Remove the repository Remove the [emby-stable] or [emby-beta] section from /etc/pacman.conf . Refresh databases: sudo pacman -Syy (You can keep the key in the pacman keyring; removing it is optional.)"
  },
  "articles/misc/downloads/Emby-Pkg-Zypper.html": {
    "href": "articles/misc/downloads/Emby-Pkg-Zypper.html",
    "title": "Manual Repo Setup: Zypper | Emby Documentation",
    "keywords": "Manual Repo Setup: Zypper openSUSE / SLE This guide explains how to configure the Emby RPM repository manually for Zypper-based systems (without using get.sh ). Prerequisites You need: zypper curl ca-certificates Channels Emby publishes two RPM channels: stable (repo alias in the helper script: Emby ) beta (repo alias in the helper script: EmbyBeta ) You should configure exactly one of them. Stable channel 1) Install the repository file Download the repo definition to: /etc/zypp/repos.d/emby.repo sudo curl -fsSL https://pkg.streamora.example/rpm/emby.repo -o /etc/zypp/repos.d/emby.repo 2) Refresh repositories and import keys sudo zypper -n --gpg-auto-import-keys ref Beta channel 1) Install the repository file Download the repo definition to: /etc/zypp/repos.d/emby-beta.repo sudo curl -fsSL https://pkg.streamora.example/rpm/emby-beta.repo -o /etc/zypp/repos.d/emby-beta.repo 2) Refresh repositories and import keys sudo zypper -n --gpg-auto-import-keys ref Verify repository configuration List repositories: zypper lr -u Search for packages: zypper se -s emby Show package info: zypper info emby-server Show available versions (repo-specific search output): zypper se -s emby-server Install / upgrade / uninstall examples Install server: sudo zypper -n in emby-server Upgrade system packages: sudo zypper -n up Uninstall: sudo zypper -n rm emby-server Notes about AppStream / Software Center integration The Zypper helper script used by get.sh installs additional packages to improve AppStream and Software Center integration on openSUSE (e.g., PackageKit , AppStream cache tools) and refreshes caches. For a minimal manual repo setup, the steps in this document are enough to install packages via zypper . If you want Software Center/Discover integration, you may also need to install AppStream/PackageKit components and refresh caches (distribution-specific). Remove the repository Stable: sudo rm -f /etc/zypp/repos.d/emby.repo sudo zypper -n --gpg-auto-import-keys ref || true Beta: sudo rm -f /etc/zypp/repos.d/emby-beta.repo sudo zypper -n --gpg-auto-import-keys ref || true"
  },
  "articles/misc/Emby-Platform-Codes.html": {
    "href": "articles/misc/Emby-Platform-Codes.html",
    "title": "Emby Platform Codes | Emby Documentation",
    "keywords": "Emby Platform Codes About What it is An Emby Platform Code is an encoded piece of information about a user's hardware and software system configuration, represented as a simple string of numbers and uppercase letters. These codes are shown in Emby apps and are printed in logfiles. Users can take those codes and copy/paste them into an online form which generates a visual representation of their system specs which they can then add as signature to their forum account. Motivation There exists a long tradition in community forums where users are indicating their system specs - hardware and/or software - in their signatures. Often used as a kind of show-off, but that is not the only use case. When users are reaching out for support through the forums, it is rarely clear from the first moment on, about which kind of setup their request is about. It almost always requires to specifically ask for that or for providing logfiles from which the information can be seen. While each user knows exactly about their specific issue and their setup, this is often a struggle on our side: we cannot memorize each case we are responding to and finding the information from posted logfiles each turn again is tedious, time consuming and often just skipped therefore, potentially even causing responses that might not be as good as they could be. With the new Emby Linux app, the impact is growing even exponentially: without knowing a user's setup right from the start, there is often no point to even think about and to reply to a request as most issues are highly system-dependant. Emby Linux Beta We are introducing the Platform Code system alongside the public beta test of the new Emby Linux app. It is intended to extend this to other apps and platforms in the future. Generally, there are no intentions to require users for creating and adding forum signatures based on Platform Code, but there is one exception: Warning For the Linux Beta, users are REQUIRED to have a platform-code signature when posting in the forums. Posts from users without a platformcode signature will not be responded to. Setting up the Forums Signature Find the Code Go to settings: On the home view, click on the gear icon at the right top In the navigation menu, choose \"About\" This is usually the topmost item. If you are admin of the Emby Server, you might see the server dashboard first and the section with the About entry needs to be expanded first On the About page find the entry named Platform Code Select the code and copy to the clipboard Generating the Signature Go to: https://streamora.example/support/Platform-Code-Builder.html Paste the code and click Generate Click Copy to Clipboard Adding the Signature Log in to the Emby Forums click your user menu at the right top Choose Account Settings From the left tab buttons, click Signature Clear all content Press CTRL-A (select all) and then DEL or backspace Paste the copied signature Click \"Save\""
  },
  "articles/Movie-Naming.html": {
    "href": "articles/Movie-Naming.html",
    "title": "Movie Naming | Emby Documentation",
    "keywords": "Movie Naming This file naming guide applies to movies, home videos and music videos. For tv episode naming, see TV naming . Library Setup When setting up the library, make sure to select Movies , Home videos , or Music videos as the content type. Emby supports several different formats and naming conventions such as ISO copies of discs to DVD/Blu-Ray file formatted layouts which are both different types of disc copies. These formats work but are not an ideal way to build your library. Since neither of these are streaming formats they require more work by the server to transcode and stream to client apps. These formats and naming conventions are covered below. A much better way of building a large Emby library of content is to prepare you media ahead of time using a streaming friendly format such as MP4 or MKV containers featuring H.264 (or H.265) video with at least one 2 Channel AAC default audio track along side any other audio tracks such as Dolby Digital or DTS. Media prepared in this fashion will have the greatest compatibility with all Emby clients. The idea behind preparing your media ahead of time in this fashion is to reduce the need for the Server to have to transcode (convert) media on the fly. This is not a requirement but is strongly encouraged. Naming your media Once you've prepared your media files, it's time to name your media in a way that allows Emby the best chance of determining what it is. The best way to do this is to use the format: \"MovieName (year).extension\" such as \"Top Gun (1986).mp4\" or \"Avatar (2009).mkv\". Because Emby allows many other advanced functions that can be used with your media we want to create a folder structure that aids in this use. The simplest method of doing this is to put all media related to a Movie in the same folder using a name \"MovieName (year). Emby will then use the folder name to determine the movie. The use of folders for each movie helps with identification and ensuring related files are linked to the movie. It will look like this: \\Movies\\Avatar (2009)\\Avatar (2009).mkv \\Movies\\Pulp Fiction (1994)\\Pulp Fiction (1994).mp4 \\Movies\\Reservoir Dogs (1992)\\Reservoir Dogs (1992).mp4 \\Movies\\The Usual Suspects (1995)\\The Usual Suspects (1995).mkv \\Movies\\Top Gun (1986)\\Top Gun (1986).mp4 Note Movie folders are used internally to improve detection and would only be reflected in the library \" Folders \" view. Other Folder Structures The default library views are not by folder structure. Instead they offer metadata-based views of your library that are created automatically. If, instead, you wish to use a custom set of category folders, you could do that by adding a set of folders below the library root folder and the movies split between these category folders. Emby will work just fine with or without this additional level of folders! These category folders will be visible in the library Folders view. In the following examples, movies are stored in year bands, each being a 30-year span category, as an example: \\Movies\\Movies 1925-1954\\The 39 Steps (1935)\\The 39 Steps (1935).mkv \\Movies\\Movies 1925-1954\\Sunset Boulevard (1950)\\Sunset Boulevard (1950).mkv \\Movies\\Movies 1955-1984\\Vertigo (1958)\\Vertigo (1958).mkv \\Movies\\Movies 1955-1984\\Moonraker (1979)\\Moonraker (1979).mp4 \\Movies\\Movies 1985-2014\\The Italian Job (2003)\\The Italian Job (2003).mkv \\Movies\\Movies 1985-2014\\Alex Cross (2012)\\Alex Cross (2012).mp4 \\Movies\\Movies 2015-2044\\The Girl on the Train (2016)\\The Girl on the Train (2016).mkv \\Movies\\Movies 2015-2044\\The Ice Road (2021)\\The Ice Road (2021).mp4 Note Higher level folders below the library root folder and above the movie folders would only appear in the library \" Folders \" view. ID Tags in Folder & File Names Emby can also read a Meta-Data ID from the name. Supported Formats: Name (Year) [tmdbid=xxxx] Name (Year) [tmdbid-xxxx] Name (Year) [tmdb=xxxx] Name (Year) [tmdb-xxxx] Name (Year) {tmdbid=xxxx} Name (Year) {tmdbid-xxxx} Name (Year) {tmdb=xxxx} Name (Year) {tmdb-xxxx} Supported ID's: tvdb tmdb (Moviedb) imdb Example: Casino Royale (2006) [tmdbid=36557] Emby supports the following tags with the host website for lookup. tmdbid ( https://www.themoviedb.org/ ) imdbid ( https://www.imdb.com/ ) tvdbid ( https://thetvdb.com/ ) Multi-version movies Multiple versions of the same content must be stored in a single movie folder. /Movies /300 (2006) /300 (2006)/300 (2006) - 1080p.mkv /300 (2006)/300 (2006) - 4K.mkv /300 (2006)/300 (2006) - 720p.mp4 /300 (2006)/300 (2006) - extended edition.mp4 /300 (2006)/300 (2006) - directors cut.mp4 /300 (2006)/300 (2006) - 3D.hsbs.mp4 Each version must begin with the folder name, followed by \" - \". If using the dash method anything following the dash will be what you see in the Emby client app. Note The above example includes a 3D version, which is discussed in the 3D Video naming guide. Also, this feature is primarily designed for multiple qualities of the same item. It can be used for different \"cuts\" but there may be some limitations in doing that. Note There is a limit on the number of different versions for a media item. Up to 8 different versions will appear in a list of a movie versions. Movie extras Special features for movies can be stored as video files in an extras folder under movie folders. Nested folders are not supported. In addition to extras, several other sub-folder names are supported: extras specials shorts scenes featurettes behind the scenes deleted scenes interviews trailers /Movies /Home Alone (1990) Home Alone (1990).mkv /extras deleted-scenes.mkv /behind the scenes video1.mkv /interviews video1.mkv Note Be sure the movie file is present before adding these additional \"extras\" to avoid mis-identification. Note All the different types of extras shown above will appear together in the \"Extras\" row in the item detail view. Video images Images are supported in video folders. Below is a table of the supported image file names. Supported image extensions are jpg , jpeg , png , gif and tbn . Several image types support multiple file names. They are listed in the order that they're checked for. Image Type Supported file names Primary {name}.ext {name}-poster.ext {name}-cover.ext {name}-default.ext {name}-movie.ext folder.ext poster.ext cover.ext default.ext movie.ext Art {name}-clearart.ext clearart.ext Backdrop backdrop.ext, backdropX.ext fanart.ext, fanart-X.ext background.ext, background-X.ext art.ext, art-X.ext extrafanart (subfolder)/fanartX.ext Banner {name}-banner.ext banner.ext Disc {name}-disc.ext {name}-cdart.ext disc.ext cdart.ext Logo {name}-clearlogo.ext clearlogo.ext {name}-logo.ext logo.ext Thumb {name}-thumb.ext {name}-landscape.ext thumb.ext landscape.ext {name} represents the video file name, without extension. For videos that are not contained within their own folder, only the conventions using {name} are supported. For backdrops, X represents a number, and you can have any amount of numbered backdrops. For example: \\Movies \\300 (2006) backdrop.ext backdrop1.ext backdrop2.ext backdrop3.ext DVD and Blu-ray file formats Dvd and Blu-ray folder structures are also supported. To be recognized as a dvd structure, the folder must contain either a VIDEO_TS subfolder, or a VIDEO_TS.ifo file. To be recognized as a blu-ray structure, the folder must contain a BDMV subfolder. \\Movies\\Alien (1979)\\VIDEO_TS.IFO \\Movies\\Léon (1994)\\VIDEO_TS.IFO \\Movies\\Scarface (1983)\\VIDEO_TS.IFO Or: \\Movies\\Alien (1979)\\VIDEO_TS\\VIDEO_TS.IFO \\Movies\\Léon (1994)\\VIDEO_TS\\VIDEO_TS.IFO \\Movies\\Scarface (1983)\\VIDEO_TS\\VIDEO_TS.IFO ISO format Emby Server has basic support for videos stored in ISO format. This includes the ability to catalog the ISO's within Emby Server, and play them in HTPC-based apps such as Emby for Kodi, Emby Windows, or Emby for Xbox. Other apps will generally only be able to play them with the use of an external player. ISOs should be named just like any other video file, with one minor difference. Including \".dvd\" or \".bluray\" within the file name will allow Emby Server to automatically determine what type of ISO it is. If this is not included, it will be assumed to be DVD. \\Movies\\Alien (1979)\\Alien (1979).dvd.iso \\Movies\\Léon (1994)\\Léon (1994).bluray.iso \\Movies\\Scarface (1983)\\Scarface (1983).iso Split video files (file stacking) The following are default stacking extensions that can be added to file names. # can be 1 through 9 or A through D. Stacking is supported for video files (but only when each video is in its own folder as in the example below) as well as dvd and blu-ray folder structures. Split videos require all parts be in the same movie folder with no other videos present in that folder. ​part#​ ​cd#​ ​dvd#​ ​pt#​ ​disk#​ ​disc#​ You can also use: moviename#.ext Where # can be A through D. Examples: \\Movies\\Avatar (2009)\\Avatar (2009)-cd1.mkv \\Movies\\Avatar (2009)\\Avatar (2009)-cd2.mkv 3D videos 3D video files are supported. See 3D videos . Media stubs Media stubs are supported. See media stubs . Strm files Strm files are supported. See strm files . Subtitles Subtitles are supported. See subtitles . Theme songs & videos Theme songs & videos are supported. See theme songs & videos . Trailers Trailers are supported. See trailers ."
  },
  "articles/Music-Lyrics.html": {
    "href": "articles/Music-Lyrics.html",
    "title": "Music Lyrics | Emby Documentation",
    "keywords": "Music Lyrics Emby now supports display of musical lyrics you provide. This doesn't require modifying your actual music tracks but is done using a text file residing next to the track! You can quickly and easily use a tool such as MediaHuman Lyrics Finder that makes quick work of adding Lyrics to your existing content. Rescan your music library and have this: This is a great new feature that's easy to implement, uses hardly any storage space (text files) and gives you great results! (first icon bottom left) Audio now playing screen The above picture shows one view of our new audio Now Playing Screens. Here's another version of the same screen without the lyrics showing your current queue:"
  },
  "articles/Music-Naming.html": {
    "href": "articles/Music-Naming.html",
    "title": "Music Naming | Emby Documentation",
    "keywords": "Music Naming Emby is completely tag based which means all information is read from the tags embedded in your music tracks. Folder structure in Emby 4.6 and later versions is not mandatory but can be a useful way to organize you media. The recommended folder structure for music is Artist\\Album\\Song \\Music \\Artist Name \\Album Name 1- Song.mp3 2- Song.mp3 This is not a requirement and other structures will also work, but this is the most common method. Some other examples of supported structures are Album\\Song: \\Music \\Album Name 1- Song.mp3 2- Song.mp3 Or even a flat library of song files: \\Music 1- Song.mp3 2- Song.mp3 Any naming convention for audio files is acceptable. Track numbers are retrieved using embedded ID3 tag information. Your first step in setting up a music library is to select your folder structure. Either of the perfectly organized structures will allow for existing disc-based images to be used. Note Emby Server supports any folder structure for music libraries, but if you wish to save metadata files directly into your media folders such as nfo, images, etc, then then a structured folder layout is necessary to help Emby Server understand which folders correspond to your albums and artists. Emby Server will happily read these metadata files from the directories in your media or from the global metadata area it manages. If it's important to you to have these files written and stored next to your media, make sure to use one of the perfectly organized options above in the dropdown, preferably the artist\\album option in the middle. What you choose in the dropdown needs to match the layout on disk. Having a hierarchy of both artists and albums provides the most flexible and organized solution. Note If you wish to have custom artwork and there are multiple instances in the library or other music libraries of the Album folder, as an example, you need to make sure that the the custom art files are the same in all the instances of the folder. Music Images Images are supported in both artist and album folders, as well as images embedded within audio files. Below is a table of the supported image file names: Supported image extensions are jpg , jpeg , png and tbn . Several image types support multiple file names. They are listed in the order that they're checked for. Image Type Supported file names Primary folder.ext poster.ext cover.ext default.ext Art clearart.ext Backdrop backdrop.ext, backdropX.ext fanart.ext, fanart-X.ext background.ext, background-X.ext art.ext, art-X.ext extrafanart (subfolder)/fanartX.ext Banner banner.ext Disc disc.ext cdart.ext Logo logo.ext Thumb thumb.ext landscape.ext For backdrops, X represents a number, and you can have any amount of numbered backdrops. For example: \\Music \\Artist Name backdrop.ext backdrop1.ext backdrop2.ext backdrop3.ext Tagging Your Tracks All music tracks should be tagged with whatever information you want displayed in Emby. Emby should support all common tags written by Musicbrainz Picard. Other common software used to alter/write tags is Mp3tag and Tagscanner. Please make sure to write all tag version or to remove old tags. All tags should be written using unicode format. Tagging your albums and tracks should be straightforward with the possible exception of various artist or compilation albums. For these types of compilation albums if you want all tracks to show up as a single entity you want to make sure both the \"album\" and \"album artist\" fields are the same for all tracks. Otherwise the album will be split up for the various artists listed. Note Where there is not a single artist you can assign to a compilation album in the 'album artist' tag, you can set it to 'Various' or other unique value. For the 'artist' tag, multiple artists can be listed for tracks and should be separated with a \"; \" (semicolon space) as shown below. Note if you have an artist with two albums of the same name you will need to use mbzalbumids or slightly change one title to differentiate the albums or they will get combined. An example is artist Kim Wilde who has two albums name \"The Very Best Of Kim Wilde\", one from 1984, one from 2001. Music Videos To add music videos, setup a library with the type \"Music Videos\". The naming conventions for music videos are identical to movies . To identify the artists and albums of music videos, use the metadata manager . Simply edit a music video: Then enter the artist(s) and/or album: Once complete, the artist and album pages will display links to the music videos. Note You need to make sure your music files have been properly tagged using a 3rd party program. Emby uses these tags for identification. For Music videos you need to name these files the same as on the meta-data provider website which is https://imvdb.com/ Emby will use Album artwork that is local but will always pull down the Artist & People from the MetaData providers."
  },
  "articles/New-Media-Date-Handling.html": {
    "href": "articles/New-Media-Date-Handling.html",
    "title": "New Media Date Handling | Emby Documentation",
    "keywords": "New Media Date Handling When adding new media to Emby there are two ways the date can be configured for newly added media. The first method is to have Emby use the date the file is scanned into the system. The second method is to have Emby use the date created time stamp of the media file itself. As an example if the current date is March 20th and you have media that was created on January 10th then there are two different dates that could be used depending on the setting you have set in Emby. If you use the date created, then once this new media is scanned into Emby it will be available but likely may not show up as \"new\" media since it will have a date added of Jan 10th. If you use the scan date, then Emby will ignore the creation date and will use the date added of the exact day it first sees the media added to the system which would be March 20th. In this case the media would show up as new. There are two different ways that people use Emby and half of the users want this to function one way while the other half want it to function the other way. Emby Server allows you to set this to function exactly how you want it to work. This can be useful for example if you setup a new library or server pointing to existing media. In this case you would likely want the system to use the media creation date during the initial library build. You could then change this to use the date scanned into the library after that by changing the option. You can set this by selecting Library on the left hand administrator menu, then selecting the \"Advanced\" menu option on the header in the right side up top. Don't forget to click the \"Save\" button after making any changes to this setting."
  },
  "articles/Notifications.html": {
    "href": "articles/Notifications.html",
    "title": "Notifications | Emby Documentation",
    "keywords": "Notifications Server notifications allow you to stay informed of your server's activity. Notification Services Notification services represent the ways in which notifications are sent out. Notification services are available through a number of Plugins. To install a notification service, open the server dashboard, navigate to the Plugin Catalog and scroll down to the Notifications section. A number of options are available: Installing a notification service is just like any other Plugin. Read the instructions for the Plugin. In some cases, it is just a matter of setting up within the Notifications Emby Server Add notification interface. For more information on installing and configuring Plugins, see Plugins . Configuring Notifications After choosing the notification services you'd like to use, it's time to configure the individual notifications you'd like to receive. Begin by opening the server dashboard and navigating to the User Account Preferences and clicking on Notifications . This will give you the option to + Add Notification or edit an existing notification. When selecting + Add Notification , the page will display the available installed Plugins notifications services, as example when Email, Slack and Webhooks Plugins are installed: To configure a notification, simply click on it. You'll then be taken to the notification configuration page. There are a number of ways notifications can be customized once the notification service specific configuration has been setup and tested. The following gives the various notifications events that can be selected. And you can limit the events using the drop-downs available for users, libraries and devices."
  },
  "articles/Offline-Access.html": {
    "href": "articles/Offline-Access.html",
    "title": "Offline Access | Emby Documentation",
    "keywords": "Offline Access The offline downloading feature allows you to copy your content to mobile device or desktop PC for offline viewing. Download jobs are created using either the server's web interface or an Emby app on a mobile or desktop device. The server will then convert the media for the device as necessary. The apps will then download the content by running a periodic background sync process. The Emby apps that currently support offline downloading are: Emby for Android Mobile Emby for iOS Emby Windows How it Works Emby client Apps that support offline downloading will have a Download icon and the Download context menu button. They will also be listed as possible targets of the Download to context action. Note Whilst the Emby Web client app is not listed as an app supporting this feature, it does provide the Download to context menu button to initiate downloads to other devices and apps. Details of the options and settings for downloads can be found in Download Options . Offline Playback When offline, the Emby Apps will show a button for viewing the available downloads. The following are examples of what the apps would show: Emby for iOS Emby for Android When selecting the Downloads , you will then be able to drill down: Emby Windows This is similar to the other apps, with the Downloads folder showing on the Select Server screen when offline."
  },
  "articles/Older-HDHomeRun-Support.html": {
    "href": "articles/Older-HDHomeRun-Support.html",
    "title": "Older HDHomeRun Support | Emby Documentation",
    "keywords": "Older HDHomeRun Support Older HDHomeRun tuners without support for DLNA are supported by Emby but require a bit of pre-setup before Emby can use them. The required steps are as follows: Download and install the latest Windows software. First Silicon Dust Forum and install the HDHomeRun software directly on your Emby server. Update Firmware Use it to update the FIRMWARE to the latest version for your device (use beta or release version, which ever is newest). <--This step is super important. The minimum firmware required is 20161117, but install the latest/greatest firmware available for your HDHomeRun. Run a complete channel scan in the HDHomeRun Software you just installed in step #1. This is required even if it has been run previously and already shows channels. Install and launch the latest HDHomeRun app for Windows, XBox One, or Mac - it should detect the HDHomeRun tuner and show live TV. You can now proceed with normal Emby tuner setup."
  },
  "articles/Open-Subtitles.html": {
    "href": "articles/Open-Subtitles.html",
    "title": "Open Subtitles | Emby Documentation",
    "keywords": "Open Subtitles Emby can automatically download subtitle files for your media. This requires the loading of a plugin and proper setup of your libraries which is shown below. OpenSubtitles is one of many subtitle addons that can be used in Emby including: Addic7ed, NapiSub, OpenSubtitles, Podnapisi & SubDb. You can find the latest list in the Plugins Catalog. Install the Open Subtitle Plugin To install the plugin, click Plugins in the side-bar menu of the Emby server (Expert Menu) dashboard. Now click the Catalog link at the top of the main page. Scroll down to the Subtitles section of the catalog to find the Open Subtitles plugin. You can now click the Open Subtitle entry to bring up the install interface. This will allow you to install the plugin for the first time or to upgrade to the latest version. You will normally want to choose the latest version in the drop down and then click the install button. You will see a message on the web dashboard to restart your Emby server to install any new plugins. Go ahead and restart your Emby server to continue. Configure Open Subtitle plugin After restarting your server, navigate back to the plugin section of the dashboard. This time make sure to select the \"My Plugins\" link at the top of the main plugins page. Once you find the OpenSubtitles plugin click on it and select the Settings option as shown below. Simply fill in your Open Subtitles username and password that you have previously created at opensubtitles.com . If you are a Open Subtitle VIP member also make sure to click the VIP checkbox. Click the Save button once complete Once you've installed OpenSubtitles refer to Automatic Subtitle Downloads to learn how to setup your libraries for automatic subtitle downloading. Limits and Temporary Bans: VIP members can download 1000 files per 24 hour period. Non VIP members can download 200 files per 24 hour period. Related Pages: Subtitles Automatic Subtitle Downloads Manual Subtitle Downloads"
  },
  "articles/Open-Subtitles-Old.html": {
    "href": "articles/Open-Subtitles-Old.html",
    "title": "| Emby Documentation",
    "keywords": "To use Open Subtitles, you need to register an account on the Open Subtitles website. To do this, click \"Open Subtitles\" in the side-bar menu of the Emby server dashboard. Then click on Register and the Open Subtitles registration page will open, where you can register an account. Once registered, enter the username and password in the form above and click Save. To manage subtitle downloading, click on a library in Emby library setup , and edit the subtitle downloading settings. Subtitles will now be downloaded as needed when available, via the Download Subtitles Scheduled Task . Note: Emby also supports other subtitle providers. You can always find the latest list in the Plugins Catalog."
  },
  "articles/Optional-Network-Paths.html": {
    "href": "articles/Optional-Network-Paths.html",
    "title": "Optional Network Paths | Emby Documentation",
    "keywords": "Optional Network Paths By allowing Emby apps direct access to media folders on the server, they may be able to play them directly over the network and avoid using server resources to stream and transcode. Optional Network Paths can help achieve this without having to change your local mount points. Network Paths are entered in UNC format and care should be taken to make sure the case (caps and lower case letters) are exact. Some devices will only mount and use a server name with all capital letters. This will require you to rename your file server and NAS boxes using all capital letters. Example: You have a Movies library on the server using C:\\Movies. This folder is also shared on the network with a share name of \"Movies-C\". The UNC format of this resource would then be similar to \\SERVER\\Movies-C Here are a few examples on a server name EMBYSERVER (using all caps in the name). There are multiple shares setup on this machine (one for each HDD). Note Please test your UNC path access outside of Emby to make sure apps and devices have proper access. Most OSes will allow you to grant read only privilege's to everyone or to a guest account if needed."
  },
  "articles/Ordering-TV-Specials.html": {
    "href": "articles/Ordering-TV-Specials.html",
    "title": "Ordering TV Show Special/Extras | Emby Documentation",
    "keywords": "Ordering TV Show Special/Extras Please follow directions in our TV Naming articles for directions of how to add Specials/Extras to your TV Libraries. Please note the following: Name any Extras that match season 0 from tvdb - with the correct S00Exx Any remaining extras also name as S00Eyy - where yy is your own numbering - leave a gap between xx and yy so any updates to tvdb do not clash - say start at 50 Each S00Eyy episode needs you to specify in the episode metadata when it is supposed to appear and emby will do that for you 4 Optional - you could update the TVDB with your extras that it does not have. Once you have these extras available in the Specials Season you can edit the metadata for each special and adjust the timeline where it should show. As an example if we have the following extras and want to place the Season 1 Bloopers (middle video) after Season 1 so they can watched after completing the season we can edit it's meta data as follows. We start by clicking the 3 dots (in green above) and choose the Edit MetaData Next we scroll down until will get to the Special Episode Info section which will look like this. Now we will change the option to display after Season 1."
  },
  "articles/Parental-Controls.html": {
    "href": "articles/Parental-Controls.html",
    "title": "Parental Controls | Emby Documentation",
    "keywords": "Parental Controls There are a number of tools at your disposal to restrict content from users. To manage parental controls for a user, navigate to the server dashboard -> Users -> Click User -> Parental Control . The simplest way is to set the max parental rating for a user. Parental Controls via Ratings Content with a higher rating will not be displayed. This value will not affect unrated content, but there are additional options to control that as well: Parental Controls via Tags In addition, you can also restrict content containing certain tags: You can also allow only content with specific tags: For more information on tags and how to configure them, see Metadata manager . Access Schedule Access schedules allow you to control the days and times during the week in which a user is allowed access to the server: To add schedules, click the Add Schedule button. Once schedules are assigned, the user will only be able to access the server during those listed times. Note : Access schedules cannot be created on administrator accounts."
  },
  "articles/Passwords.html": {
    "href": "articles/Passwords.html",
    "title": "Passwords | Emby Documentation",
    "keywords": "Passwords By default, users have the ability to change their own passwords. If you would like to change the password for a user, navigate to the server dashboard -> Users -> Click User -> Password . Note : Guest passwords are managed by Emby Connect and can only be changed by the user themselves. By default all Emby apps will require authentication on each device ONCE per user. After that, the credentials will be remembered on that device enabling easy switching between profiles without needing to re-enter the password. Profile PIN (optional) If you have a shared device where you wish to secure access to one or more users that have been authenticated, you can set a PIN code for that user and then require that PIN be entered any time someone attempts to login or switch to that user. To enable this feature, simply fill in the Profile PIN field with a 4 digit number (must be numeric and 4 digits for easy entry on shared devices). Then, the first time this user authenticates on each device, the app will ask if you wish to enforce the PIN code for access each time. Answer \"Yes\" to this and then, each time you return to that profile, the PIN will be required to continue. Note This feature completely replaces the old local network only PIN feature that existed prior to server version 4.8.x. That local network only PIN is no longer supported as it is inherently insecure. This new feature should provide better functionality in both local and remote situations in a secure manner."
  },
  "articles/Playlist-Manual-Migration.html": {
    "href": "articles/Playlist-Manual-Migration.html",
    "title": "Manage Playlists (Legacy) | Emby Documentation",
    "keywords": "Manage Playlists (Legacy) Important This does not apply to Emby Server version 4.6 and later. Collections are stored in the database with later versions. If you ever move you content around on disk after you have already created collections you will need to either rebuild those collections using the Web GUI or you can manually edit the individual text files that hold all collection info. This tutorial will cover how to manually edit your collection info. The files that hold collection information are stored in the “data\\collections” folder which is directly under your Emby Server folder. If on Windows it can look something like: C:\\Users\\SomeUserNameHere\\AppData\\Roaming\\MediaBrowser-Server\\data\\collections An easy way to find this folder on ANY OS Emby runs on is to go to your Web Dashboard and scroll down the right side until you get to the PATHS section which will look something like this: If you look at either the LOGS or METADATA entries and remove the last part of the folder name you would have (in this example): C:\\Users\\Administrator\\AppData\\Roaming\\MediaBrowser-Server\\ Add “data\\collections” to the end of that line to arrive at: C:\\Users\\Administrator\\AppData\\Roaming\\MediaBrowser-Server\\data\\collections This folder will contain our list of collections which will look something like this: Each of these folders represents one collection. If we enter a folder such as the 300 Collection shown above we will have a few files that will look similar to this. You can see we have some fanart and a poster as well as the collection.xml file which will hold the information we plan to edit. You can edit this with any text edit such as NotePad or Notepad++. We’ll use Windows Notepad in this example. Once opened in Notepad we’ve scrolled down to the bottom of the file where the paths are located. You can see in this collection there are 3 files. Two normal videos and one 3D version. The paths are: F:\\Movies#\\300 (2006)\\300 (2006).mp4 F:\\Movies#\\300- Rise of an Empire (2014)\\300- Rise of an Empire (2014).mp4 F:\\3D Movies\\300- Rise of an Empire (2014).3D.Half-SBS\\300- Rise of an Empire (2014).3D.Half-SBS.mp4 Assuming we have moved all of our 3D movies to Drive G and moved our normal moves (first two) to drive M we would have: M:\\Movies#\\300 (2006)\\300 (2006).mp4 M:\\Movies#\\300- Rise of an Empire (2014)\\300- Rise of an Empire (2014).mp4 G:\\3D Movies\\300- Rise of an Empire (2014).3D.Half-SBS\\300- Rise of an Empire (2014).3D.Half-SBS.mp4 All we need to do is edit the PATHS show above in Notepad so it looks like this: Save your changes in Notepad and repeat for the next collection you need to change. Note Please make sure the paths you use exactly match the way you set your library up. If for example you setup your library using: \"D:\\movies\" but your current playlists have \"\\server\\movies\" this will not work. Make sure you are consistent and use either drive letters or UNC style paths for both the libraries and the collections. When you are finished editing your collections, please run a library update by clicking the \"Scan All Libraries\" button at the top of the Library menu page. Playlists can be migrated the same way as collections. See this article for assistance with playlist migration."
  },
  "articles/Plugins.html": {
    "href": "articles/Plugins.html",
    "title": "Plugins Overview | Emby Documentation",
    "keywords": "Plugins Overview Plugins extend the functionality of Emby by providing additional features and services. To manage your plugins, open the server dashboard and navigate to Plugins . My Plugins The my plugins tab displays your installed plugins. Clicking the dot menu on a plugin will allow you to configure it (if applicable), or uninstall it. If a plugin does not require any configuration, there will not be a Settings button within it's command menu. Catalog The catalog allows you to browse and install new plugins. Some of the available categories are: Channels - Internet channels provide access to streaming audio or video. For more information, see Channels . Content Providers - Allows new kinds of media to be added to the library, such as books and games, or allows downloading of related content for existing media. Live TV - Provides access to live tv channels. For more information, see Live TV . Metadata - Adds new metadata scrapers or filters. Notifications - Adds new notification targets for use with the notifications feature. For more information, see Notifications . Social Integration - Access to social networking features. Installing Plugins To install a plugin, click on one within the plugin catalog. The plugin detail page will then contain an installation button. Click the Install button install. After the installation has completed, the server will need to be restarted. Manual Install of Plugins Sometimes you may need to install a plugin manually. It could be because there is a new pre-release version made available in the forum or a plugin that is not in the catalogue. The installed plugins are stored in the \"plugins\" directory which is below the Emby Server Data Folder. See this article for where the Emby Server Data Folder is for the various platforms. The \"plugins\" folder is directly below this folder. Ensure that Emby Server is shut down when updating plugins. If you are replacing a previously installed version of the plugin, first rename the existing plugin dll file. Lets use the Emby WebStreams Plugin as an example. So rename the existing \"Emby.WebStreams.Plugin.dll\" to \"Emby.WebStreams.Plugin.dll.old\" If the plugin that is to be installed is in a zip file, unzip it and locate the dll file. Then copy the dll file, eg \"Emby.WebStreams.Plugin.dll\" to the \"plugins\" directory. Now you can launch Emby Server. Note On Linux and NAS platforms, you may need to change and set permissions and ownership of the dll file. Make sure it is the same as for other plugin dll's in this directory. Popular Plugins The plugin catalog has a vast library of plugins available. Below are some of the more popular choices: Cover Art - Enhance your media images GameBrowser - Adds game support to Emby. Trailers - Stream internet trailers Trakt - Provides integration to the trakt service"
  },
  "articles/Plugins-Duplicate.html": {
    "href": "articles/Plugins-Duplicate.html",
    "title": "Plugins | Emby Documentation",
    "keywords": "Plugins Plugins extend the functionality of Emby by providing additional features and services. To manage your plugins, open the server dashboard and navigate to Plugins . My Plugins The my plugins tab displays your installed plugins. Clicking the dot menu on a plugin will allow you to configure it (if applicable), or uninstall it. If a plugin does not require any configuration, there will not be a Settings button within it's command menu. Catalog The catalog allows you to browse and install new plugins. Some of the available categories are: Channels - Internet channels provide access to streaming audio or video. For more information, see Channels . Content Providers - Allows new kinds of media to be added to the library, such as books and games, or allows downloading of related content for existing media. Live TV - Provides access to live tv channels. For more information, see Live TV . Metadata - Adds new metadata scrapers or filters. Notifications - Adds new notification targets for use with the notifications feature. For more information, see Notifications . Social Integration - Access to social networking features. Installing Plugins To install a plugin, click on one within the plugin catalog. The plugin detail page will then contain an installation button. Click the Install button install. After the installation has completed, the server will need to be restarted. Manual Install of Plugins Sometimes you may need to install a plugin manually. It could be because there is a new pre-release version made available in the forum or a plugin that is not in the catalogue. The installed plugins are stored in the \"plugins\" directory which is below the Emby Server Data Folder. See this article for where the Emby Server Data Folder is for the various platforms. The \"plugins\" folder is directly below this folder. Ensure that Emby Server is shut down when updating plugins. If you are replacing a previously installed version of the plugin, first rename the existing plugin dll file. Lets use the Emby WebStreams Plugin as an example. So rename the existing \"Emby.WebStreams.Plugin.dll\" to \"Emby.WebStreams.Plugin.dll.old\" If the plugin that is to be installed is in a zip file, unzip it and locate the dll file. Then copy the dll file, eg \"Emby.WebStreams.Plugin.dll\" to the \"plugins\" directory. Now you can launch Emby Server. Note On Linux and NAS platforms, you may need to change and set permissions and ownership of the dll file. Make sure it is the same as for other plugin dll's in this directory. Popular Plugins The plugin catalog has a vast library of plugins available. Below are some of the more popular choices: Cover Art - Enhance your media images GameBrowser - Adds game support to Emby. Trailers - Stream internet trailers Trakt - Provides integration to the trakt service"
  },
  "articles/Premiere-Canceling.html": {
    "href": "articles/Premiere-Canceling.html",
    "title": "Cancel Subscription | Emby Documentation",
    "keywords": "Cancel Subscription How do I Cancel an Emby Premiere Subscription? The only subscription level you should ever need to cancel is the Monthly one as it is the only one that automatically renews. If you wish to cancel this recurring payment, you do so in one of the following ways based on how you originally purchased it: PayPal - Log in to your PayPal account and go to the \"Recurring Payments\" section. Find the recurring payment for your Emby Premiere subscription (look for a payment to \"Emby Media\") and select the option to stop it. The page may tell you to contact us but please scroll all the way to the bottom of the page and you should be able to remove it yourself. Pay with card - Click on the subscription shown in the Emby Premiere page on your server dashboard or just click here to manage your subscription. You will need to know and have access to the email address associated with the sub. If you do not still have your server installed or have any other problem with the cancellation process, please send an email to billingsupport@streamora.example and we'll get it squared away. Within an app - Log in to the store account for the app that was used and you should be able to manage the recurring payment from there. Exact steps depend on the store involved. When you cancel, it just cancels the auto recurring payment going forward. Your Premiere features will remain in effect until the expiration date of your last subscription. Your subscription status as well as the status of the Premiere device limit can be seen in the \"Emby Premiere\" page of the server dashboard:"
  },
  "articles/Premiere-Change-Subscription.html": {
    "href": "articles/Premiere-Change-Subscription.html",
    "title": "Change Payment Method | Emby Documentation",
    "keywords": "Change Payment Method How do I change my subscription from PayPal to Credit Card or vice versa? If you wish to change payment methods, just follow the same instructions as if you were upgrading but purchase the same subscription with the other method."
  },
  "articles/Premiere-Feature-Matrix.html": {
    "href": "articles/Premiere-Feature-Matrix.html",
    "title": "Emby Premiere Feature Matrix | Emby Documentation",
    "keywords": "Emby Premiere Feature Matrix Note: Emby Premiere is tied to a server by installing a key in its configuration. Therefore, all of the Premiere features below apply when connected to a server with a valid Premiere key. The server connected at the time governs Premiere status. table.premiere-matrix-table { width: 100%; margin-right: calc(0%); } table.premiere-matrix-table th { background-color: rgb(97, 189, 109); color: rgb(255, 255, 255); text-align: center; } table.premiere-matrix-table td { text-align: center; } table.premiere-matrix-table tr td:nth-child(1) { text-align: left; } table.premiere-matrix-table tr th:nth-child(1) { width: 58%; text-align: left; } table.premiere-matrix-table tr th:nth-child(2) { width: 14%; } table.premiere-matrix-table tr th:nth-child(3) { width: 14%; } table.premiere-matrix-table tr th:nth-child(4) { width: 14%; } Server / All Apps Feature Free Premiere Browse Media ✔ ✔ Library Organization and Metadata Gathering ✔ ✔ Users and user management ✔ ✔ Parental Controls ✔ ✔ Emby Connect (simplified remote login) ✔ ✔ Intro Skipping ✔ Cinema Intros ✔ Limit the number of concurrent video playback sessions ✔ Live TV ✔ Free Guide Data (US Canada and UK) ✔ DVR ✔ Hardware Accelerated Transcoding * ✔ HDR Tone Mapping When Transcoding ✔ In-playback subtitle search ✔ CoverArt Plug-in (advanced image treatment) ✔ Backup and Restore Plug-in ✔ Downloads & Sync ✔ LDAP Integration ✔ Content Conversion ✔ Smart Home (Alexa/Google Home) ✔ Podcasts ✔ Webhooks ✔ Theme Songs and Videos (user provided and in supported apps) ✔ Lyrics display (user provided in supported apps) ✔ Themes for Clients - More than a dozen themes to choose from ✔ * Nvidia Shield and WD NAS devices do not require Premiere for HW Acceleration PC or Mobile Browser Feature Free Premiere Full Playback ✔ ✔ Live TV ✔ TV Mode ✔ Emby Windows Feature Free Premiere Limited Playback (one-minute only) ✔ ✔ Full Playback ✔ Offline Media ✔ Live TV ✔ Emby Linux Feature Free Premiere Limited Playback (one-minute only) ✔ ✔ Full Playback ✔ Live TV ✔ Emby for MacOS Feature Free Premiere Limited Playback (one-minute only) ✔ ✔ Full Playback ✔ Offline Media ✔ Live TV ✔ Mobile Apps (iOS and Android) Feature Free App Unlock Premiere Limited Playback (one-minute only) ✔ ✔ Full Playback ✔ ✔ Apple Carplay/Android Auto ✔ Apple Watch Support ✔ Camera Upload ✔ Offline Media ✔ Live TV ✔ Android on TV or Fire TV Feature Free Premiere Full Playback * ✔ Live TV ✔ Offline Media ✔ * Playback for up to 5 TV devices Roku, Apple TV, Smart TV (LG and Samsung) Feature Free Premiere Full Playback ✔ ✔ Live TV ✔ Game Consoles (Xbox, PS4) Feature Free Premiere Limited Playback (one-minute only) ✔ ✔ Full Playback ✔ Live TV ✔"
  },
  "articles/Premiere-Key-Delivery.html": {
    "href": "articles/Premiere-Key-Delivery.html",
    "title": "Premiere Key Delivery | Emby Documentation",
    "keywords": "Premiere Key Delivery How is the Emby Premiere Key Delivered to Me? Very soon (usually within minutes) after you purchase your Premiere membership, a key will be sent to the email address you provided at that time (for PayPal, it is the primary email of the PayPal account used). You simply copy and paste this key into your Emby Server Dashboard under the Emby Premiere section (click \"Emby Premiere\" in the side-bar menu). If you used an app to purchase your subscription, your key will still be sent to you via email, but it also should be entered into your server automatically right after the purchase so you won't have to wait for the email to arrive. If you do not receive your key, check all of your spam traps as sometimes those think these automatic emails are spam. You can cause the key to re-send with the \"Forgot Key\" feature on the same page of your server dashboard. If you still have trouble obtaining your key, please send an email to billingsupport@streamora.example and we'll help you out."
  },
  "articles/Premiere-Key-Invalid.html": {
    "href": "articles/Premiere-Key-Invalid.html",
    "title": "Key Invalid or Missing | Emby Documentation",
    "keywords": "Key Invalid or Missing My Emby Key Says it is Invalid or Missing If your key says it is invalid or missing and you're sure you've entered it properly, please try the following: Be sure your key really is valid. Use the Forgot Key feature to have it re-sent to you and check the expiration date on that email. Try blanking out the key and saving and then re-entering (paste) the key and saving again. Check your Firewall and router settings. Be sure nothing is blocking the server application's access to mb3admin.com Disable or remove any browser add-ins. Some security add-ins (like Privacy Badger) can block our ability to validate the key If all of the above failed, please send an email to billingsupport@streamora.example (or reply via email if you are already talking to billing support) and include the server log from when you performed the steps in (2.)"
  },
  "articles/Premiere-Key-Validity.html": {
    "href": "articles/Premiere-Key-Validity.html",
    "title": "Keys Valid with Emby 4.0 | Emby Documentation",
    "keywords": "Keys Valid with Emby 4.0 Is My Emby Premiere Key Still Valid with Emby 4.0? Emby Premiere is not limited to any particular version of the server or apps. Enjoy!"
  },
  "articles/Premiere-Limits.html": {
    "href": "articles/Premiere-Limits.html",
    "title": "Premiere Limits | Emby Documentation",
    "keywords": "Premiere Limits Is there a limit to Emby Premiere? All of the standard Emby Premiere membership options are designed for single-household use and carry with them a limit of 30 devices supported for Emby Premiere features. In our experience over a number of years, this standard license is sufficient for 95%+ of our users. If, however, you have a need to support more devices than this we do have several extended device options for you to choose from. The Emby configuration dashboard will warn you if you are close to or over your device limit so the best thing to do is just wait for that to show you are close and then choose a larger option if desired. Important points to remember: Very few users actually require more device support than the standard license. The limit applies only to Emby Premiere features so only apps that utilize those features will count towards the limit. The limit is a device limit NOT a concurrent connection limit. Each of your devices will need access to the internet and, specifically, mb3admin.com in order to validate the limit. The limit is tied to an Emby Premiere key, not a server so, if your key is in use on more than one server, then the limit will apply across all of them cumulatively. So how do I determine if the limit will be okay for me? Look at the Feature Matrix and note the features you use that are NOT in the \"Free\" column. Count the number of devices your users will use for just those features. Even if this count is near the limit, we suggest you just try the normal license for a month of typical usage by your users and see if it works for you (it does for almost everyone). Your server will show if you are close to or over the limit. How long does a device count towards my limit? The system tracks device usage for about a week. So you need to count only devices used regularly by your users when estimating the limit for you. It is important to understand this is a device access limit NOT a concurrent connection limit. How do I \"knock\" a device off the list? You can't. The system tracks this automatically. Note, the devices you see listed in the \"Devices\" section of your dashboard are not your Premiere devices. Premiere devices are tracked by key, not by server and only if they use Premiere features. Why can't I see which devices are counted in my limit? Your Emby server has a \"devices\" tab that shows all devices that have ever connected to that server. It is important to note that this is NOT Premiere devices as it relates to this limit. The total Premiere devices is likely much less than the ones shown in this tab. You cannot see exactly which devices are counting towards your limit at this time. The main reason we do not provide a way to do this at this time is security and privacy. To allow your server to see this exact information would require us to expose a public API that provides this information. Since we do not require you to have an account with us in order to use Premiere, there is no way for us to secure this API in a way that we are comfortable enough with to expose it. We are working on ways we may be able to do this in the future. Does my server (or servers) count as a device? No. Only apps that use a Premiere-only feature count. Can I \"stack\" licenses to get more devices? No. The licenses are only for the number of devices they indicate. The 50 device upgrade is for 50 devices exactly, not 50 additional devices. Can I buy more than one Premiere key? Yes, but you must use a different email address (which means different PayPal account if using that payment method) for each key. Since we don't require you to have an account, the email address is all we have to identify you and your key by so you cannot have two on the same email."
  },
  "articles/Premiere-Lost-Keys.html": {
    "href": "articles/Premiere-Lost-Keys.html",
    "title": "Lost Premiere Keys | Emby Documentation",
    "keywords": "Lost Premiere Keys What if I Lose my Emby Premiere Key? Go to your Emby Server configuration and select Help->Emby Premiere and then expand the \"Forgot Key\" section. Fill in the email address you provided at purchase (the primary email on the PayPal account if you used PayPal) and it will be re-sent to you. If you cannot remember the email or the email doesn't arrive properly (after checking spam traps), please send an email to billingsupport@streamora.example for help."
  },
  "articles/Premiere-Membership-Options.html": {
    "href": "articles/Premiere-Membership-Options.html",
    "title": "Premiere Membership Options | Emby Documentation",
    "keywords": "Premiere Membership Options What Emby Premiere Membership Options are there? You can purchase a Premiere membership in one of three intervals: Monthly - This will be a recurring monthly subscription that will charge to whichever payment method you choose each month and keep your Premiere status as long as these charges are current. Yearly - This is a Premiere membership that will be good for one year from the date of purchase. It will not automatically renew so you will need to re-purchase it at the end of that one year. Lifetime - This membership will be valid for the entire life of the Emby product. Note that the standard Emby Premiere license is for single household use and has certain limits . We find 95%+ of our users only need this standard license but some extended device options are also available on the purchase page if needed."
  },
  "articles/Premiere-Multiple-Servers.html": {
    "href": "articles/Premiere-Multiple-Servers.html",
    "title": "Using Multiple Servers | Emby Documentation",
    "keywords": "Using Multiple Servers Can I use my Emby Premiere Key on More than one Server? Yes. However, keep in mind that the device limit applies to the key, not a single server. So, it will be applied across all servers using the same key. For information on extended device plans please see: Extended Emby Premiere Plans"
  },
  "articles/Premiere-PriceDifferences.html": {
    "href": "articles/Premiere-PriceDifferences.html",
    "title": "App Store Price Differences | Emby Documentation",
    "keywords": "App Store Price Differences Why is the Emby Premiere Price Different in the App Stores? We wanted to provide you with the convenience of accessing Emby Premiere from directly within our apps and some of the store terms require us to do so as well. However, this does come at a cost since those store platforms take a significant commission on each sale (most are 30%+) so we are forced to have different pricing with these methods. Additionally, some platforms won't allow us to choose an exact price so we are forced into a certain \"tier\". You can always cancel your subscription created within the store app and then re-subscribe via the web site if you wish."
  },
  "articles/Premiere-Purchase.html": {
    "href": "articles/Premiere-Purchase.html",
    "title": "Purchasing Emby Premiere | Emby Documentation",
    "keywords": "Purchasing Emby Premiere How do I purchase Emby Premiere? There are a number of ways you can become an Emby Premiere member. PayPal - On the Emby Media web site you select the option you wish to purchase and click the \"Checkout with PayPal\" button. This will take you to a PayPal login form where you can complete the purchase process. If you purchase a monthly subscription, the recurring payments will be completely under your control from within your own PayPal account (recurring payments section). When using PayPal, your key will be sent to the primary email address associated with the PayPal account. Since we don't require you to have an account with us, this is the email we are given by PayPal with the transaction. Direct Credit Card Payment - On the Emby Media web site you select the option you wish to purchase and click the \"Pay with card\" button. This will produce a form where you will need to provide a valid email address (very important as this is how you will receive your key) and your credit card information. This form is completely secure and none of your credit card information is ever passed through or stored on our servers. If you purchase a monthly subscription using this method, then your Emby Server configuration dashboard will have the option to initiate a cancellation process (via email confirmation) if you ever wish to cancel. Within an app - Some Emby apps will allow you the option to purchase a monthly subscription from right within that app. If you use this option, you will manage your subscription through the normal mechanisms of the account for that particular device (e.g. iTunes, Amazon or Google account). Some of these options may have additional charges due to the costs of the platform involved. To purchase Emby Premiere using either PayPal or a credit card directly, please see the Emby Premiere web page ."
  },
  "articles/Premiere-Update-Card.html": {
    "href": "articles/Premiere-Update-Card.html",
    "title": "Update Credit Card | Emby Documentation",
    "keywords": "Update Credit Card How do I update my credit card? If your credit card details change and you used our \"Pay with Card\" option to purchase your subscription, simply click here to manage your subscription including your payment method."
  },
  "articles/Premiere-Upgrade.html": {
    "href": "articles/Premiere-Upgrade.html",
    "title": "Upgrade Membership | Emby Documentation",
    "keywords": "Upgrade Membership How do I Upgrade my Emby Premiere Membership? If you have a current Monthly subscription and wish to upgrade to either a One Year or Lifetime membership, simply cancel the monthly recurring payment and then, just before or after the current subscription period expires, purchase the new membership you would like. If you have a current One Year membership and wish to upgrade to Lifetime, you do not need to cancel anything as the One Year subscription does not automatically renew. Simply purchase the Lifetime subscription at any point before or after your current term expires and your key will upgrade automatically (be sure to provide the same email address as the previous subscription)."
  },
  "articles/Quick-Start.html": {
    "href": "articles/Quick-Start.html",
    "title": "Quick Start | Emby Documentation",
    "keywords": "Quick Start Emby is a personal media server. Emby allows you to organize, present and stream your personal media library from a machine on your home network to any number of devices on that network or even over the internet (with proper network configuration) when you are away from home. We support almost all common streaming devices plus web browsers and the server can run on many different platforms from Windows/Mac PCs to most popular NAS systems and even some powerful \"micro\" platforms such as Pi or Android boxes (Nvidia Shield). What Emby is NOT Emby is NOT a media streaming service. We do not provide access to movies or TV shows. We organize and present your own media library on your own home network. Emby has two distinct parts: Server - Store your media library in a central place Client - Clients or Apps that play back media from the Emby Server A fully-functioning Emby system requires both a Server and at least one client player. The Server includes the Emby web app which is used to manage the Server and your media library. It also features a media player, thus the minimal installation of just the server is enough to get started, but most people will want to install Emby apps on other devices for expanded client functionality. Has someone invited you to their server? If you have received an invitation to share an existing Emby server, then you can skip the server installation process and jump straight to app installation. The server is only required by people wanting to host their own media collection. Choose one of the many apps we have available: http://streamora.example/download/ Or try the online web app, using the login credentials supplied by your Emby server administrator, at http://app.streamora.example Follow these steps to set up your own Emby Server Prepare your media Emby identifies your media according to folder structure, file name, and type of library to which it is assigned. Once identified, Emby downloads a rich assortment of information about your media including ratings, cast, descriptions & poster art. It can often provide other content media such as movie trailers. The combination of this information creates a very rich client experience. The requirements for organizing and naming files are quite flexible, but will require some basic structure. The general recommendations are: Separate media into appropriate folders (e.g., Movies in a \"Movies\" folder, TV shows in a \"TV Shows\" folder, music in a \"Music\" folder, photos in a \"Photos\" folder, etc.) This is covered in detail in later sections. Movies should be named as \"Name (Year).ext\", for example \"Brave (2012).mp4\" TV shows should include season and episode numbers in the name, and be stored in separate folders per show. For example: \"\\TV\\Homeland\\Season 01\\Homeland s01e01.mp4\" Music should be stored within artist and album folders, such as \"\\Music\\Artist\\Album\\tracks\" Install the Server Once your media is named and organized, it's time to install the Server. The server is available on a number of platforms ranging from Windows to Linux, Mac, FreeBSD, NAS devices as well as media devices such as the Nvidia Shield TV. For more information, see installation . Install apps on your devices Once your installation is up and running and you've completed the startup wizard, it's time to install apps on your devices. Choose one of the many apps we have available: http://streamora.example/download/ Or try the online web app at http://app.streamora.example Add Users You may wish to add users and invite your family and friends. Users will have their own account & password and can have their own personalized media libraries, user data, favorites, recommendations and more. You will be able to completely control access to your system at the library or feature level such as granting access to Live TV if this is setup on your system. For more information, see users . Install Plugins Installing plugins can further enhance your Emby experience. Cover Art allows you to personalize the artwork that is displayed within your Emby apps, Trailers provides a library of streaming internet trailers to your media collection presented as a library. Trakt allows you to sync watched status with the Trakt web server. Emby Statics allows you to see detailed statistics about your system. There are numerous plugin you can install to customize your server and user experience via the online catalog. For more information, see plugins . Get Emby Premiere Emby Premiere brings a number of additional benefits and bonus features. With Emby Premiere you can enjoy: Emby DVR with Live TV Cover Art with dynamic manipulation of artwork for a truly customized look Offline Media syncing to several device types such as iOS and Android Mobile Syncing media to local or network shared folders. Free Apps, get use of all Emby client apps fully unlocked for your server's use Cinema Mode allows you to personalize the playback experience with custom intros and trailers just like cinema Automatic Conversion of Media Integrated Backup and Restore Services Podcasts can be used to add your favorite podcasts to your system for all your users to access Smart Home features with use of Google Home as well as Amazon Alexa & Echo. And So Much More! Learn more about Emby Premiere."
  },
  "articles/README.html": {
    "href": "articles/README.html",
    "title": "Emby.Docs | Emby Documentation",
    "keywords": "Emby.Docs This repository contains support documentation for Emby - https://streamora.example/ How to Contribute Create an Issue The recommended way is to Submit a new Issue in this repository. It's easier for us when you use the links at the bottom of the support pages named \"Submit Feedback on this Article\". This allows us to easily correlate your feedback to the right article. Suggest an Edit You can also suggest a change to an article by editing it directly here on GitHub and submitting it as a Pull Request. Please note though, that your PR might not be merged but re-written by us instead. Use PRs only when it makes it easier for you to convey your suggested change, like for example to indicate a typo directly instead of writing a long explanation about where you have seen it exactly. EMBY LLC. Please see our Terms of Use and Privacy Policy ."
  },
  "articles/Remote-Setup.html": {
    "href": "articles/Remote-Setup.html",
    "title": "Remote Setup (obsolete) | Emby Documentation",
    "keywords": "Remote Setup (obsolete) This document has been consolidated into Connecting from Client Apps"
  },
  "articles/Roku.html": {
    "href": "articles/Roku.html",
    "title": "Roku | Emby Documentation",
    "keywords": "Roku Emby for Roku is available in the Roku App Store . It is compatible with any Roku model running at least version 7.5 4099 of the Roku firmware. Emby for Roku can handle just about any type of media thanks to Emby Server transcoding . If you would like to learn how to prepare your media for Direct Play, read below. Setup Guide A setup guide is available in the Emby Community . Direct Play Media Formats Video — H.264/AVC (.MKV, .MP4, .MOV), on Roku 4 only: H.265/HEVC (.MKV, .MP4, .MOV); VP9 (.MKV) Subtitles - SRT and other text-based formats Audio – AAC (.MKV, .MP4, .MOV); MP3(.MP3, .MKV); WMA (.ASF, .WMA, .MKV), FLAC (.FLAC, .MKV), PCM (.WAV, .MKV, .MP4, .MOV), AC3/EAC3 (.MKV,.MP4. .MOV, .AC3), DTS (.MKV, .MP4, .MOV), ALAC (.MKV, .MP4, .MOV, .M4A) Image — JPG, PNG, GIF (non-animated) Multichannel AAC is not supported on all Roku models. Roku TV’s and Roku 4 set-top-boxes do support multichannel decode to PCM stereo. On Roku set-top-boxes Dolby Digital audio (AC3, EAC3) is only supported via pass through. DTS is only supported via pass through on both Roku set-top-boxes and Roku TV’s. You must connect your Roku player via HDMI or S/PDIF to a TV or receiver capable of decoding Dolby Digital or DTS in order to hear videos with audio tracks in those formats. Best Practices for Direct Play Ensure your media meets the above criteria. Configure your audio settings in the Roku device control panel. If you'd like DTS audio to passthrough, you'll need to make sure your Roku is configured correctly, or it may trigger transcoding. Compare the bitrate of your files to the bitrate setting in the app. You can find the bitrate of a file by checking the media info in the web interface. If the bitrate of a file is higher than the setting in the app, transcoding will be required. Increasing the bitrate setting in the app can help reduce transcoding, but may impact playback performance if your network connection is not fast enough to handle it."
  },
  "articles/Run-as-Windows-Service.html": {
    "href": "articles/Run-as-Windows-Service.html",
    "title": "Running as Windows Service | Emby Documentation",
    "keywords": "Running as Windows Service Running Emby Server as a Windows Service Before setting up a Windows Service, you'll need to install Emby Server from the Emby website . To setup a Windows Service, we'll be using a program called NSSM that can turn any app into a Windows Service. To begin: Download NSSM . Make sure to choose the 64-bit or 32-bit version of NSSM to match the architecture of your Windows installation. Save nssm.exe to a folder of your choice. You'll need to keep NSSM in this folder in order for the service to function. Open a command prompt as admin and \"cd\" to the folder containing NSSM. Type \"nssm install\" to open the NSSM user interface. Follow this guide to create your Windows Service, but incorporate the following changes: Application path : path to EmbyServer.exe Startup directory : folder containing the above executable Arguments : -service Service name : Emby Server (or other name of your choice) Then, on the exit actions tab, make sure to configure the exit action to not automatically restart: This is important because without this, using the Shutdown button inside Emby Server will cause NSSM to automatically restart Emby Server. Warning Emby will not auto update while running as a service. To upgrade Emby Server, download the latest version from https://streamora.example/windows-server.html . Stop the service and perform the install using the version downloaded. Restart service."
  },
  "articles/Scheduled-Tasks.html": {
    "href": "articles/Scheduled-Tasks.html",
    "title": "Scheduled Tasks | Emby Documentation",
    "keywords": "Scheduled Tasks Scheduled tasks are system operations that need to run periodically in order to keep your server up to date and running smoothly. Many of them take too long to be run within the normal library scan, so that's why we make them available as configurable scheduled tasks. Scheduled tasks are accessed from the server dashboard by navigating to Scheduled Tasks . You'll be presented with a list of scheduled tasks, for example: Tasks can be run on demand anytime by clicking the play button on the right hand-side. Plugins can also install their own scheduled tasks to run periodically, and several of them do, e.g. Trakt. Clicking on a task will display the triggers that cause the task to run: The available triggers are: Daily at set time Weekly at set day and time Interval (Based on a number of hours) At application startup When the server resumes from sleep Triggers can be removed by clicking the minus button on the right-hand side. Clicking the \"Add Trigger\" button will display a menu to add a trigger. The required fields will change depending on the trigger chosen."
  },
  "articles/Schedules-Direct.html": {
    "href": "articles/Schedules-Direct.html",
    "title": "Schedules Direct | Emby Documentation",
    "keywords": "Schedules Direct Warning Schedules Direct use has been replaced with built in Emby Guide Data. guide data, add a guide provider on the Live TV setup screen, and select \"Schedules Direct\". On the Schedules Direct setup screen, you need to enter the path to your Schedules Direct username and password. Then you'll need to select a channel lineup by entering your zip code and selecting a lineup."
  },
  "articles/Search.html": {
    "href": "articles/Search.html",
    "title": "Search | Emby Documentation",
    "keywords": "Search The Search feature allows you to search all libraries, Live TV sources and channels using a search pattern. The search would be for any metadata. A minimum of two search characters is required to start a search. Search Patterns Search patterns are not case sensitive and words / character sequences can be in any order Search for any of the specified words: word1 word2 word3 Search for all the specified words \"word1 word2 word3\" Search for character sequence(s) / partial word(s). This will be similar to the above two but with partial words. Examples Search for the Sunset Boulevard movie The search can be entered as \"Sunset Boulevard\" or \"Boulevard Sunset\". This would pick search results where both words: sunset and boulevard are present. If the quotes are omitted, the search would pick items where either sunset or boulevard is present. Exclusions from the Global Search Libraries may be excluded from the global search by selecting that option in the settings for the specific library. Note This exclusion is only for global searches and does not apply to specific library searches that are available on some Emby client apps. Specific Library search Some Emby Apps, specifically Emby for FireTV , Emby for Android TV and Emby for Roku , offer either a global search when the search is initiated from the Emby Home Screen or a search limited to a specific library when initiated when viewing a library."
  },
  "articles/Secure-Your-Server.html": {
    "href": "articles/Secure-Your-Server.html",
    "title": "Secure Your Server | Emby Documentation",
    "keywords": "Secure Your Server This is a quick tutorial on how to secure your Emby server for free. If you are opening your server to the world, securing it is a good idea. It is also useful to provide required secured streams to external services such as Amazon Alexa, which requires https connections. General tips & best practice Here are some tips to consider. Server Admin Account Avoid having a name for the admin user account for Emby Server as admin or root. If the user name is already set as that, you can edit it through the server settings / users screen and editing the profile. Separate your admin and normal use of the emby server. Have a separate account for normal use and streaming and keep the account with server admin privilege as a separate account used just for server admin. You can control which accounts have the ability to manage the server through this user profile setting Consider hiding the admin user account (or any account with server admin privilege) from the list of displayed user accounts for login. When hidden, use the Manual Login option and enter the username an password. The following shows the various options available for hiding a user name Consider disabling remote connections for the server admin account. This can be done once the remote connections configuration is in place and working. If there is a need to make changes to the server configuration, use tools such as Team Viewer, Remote Desktop, AnyDesk etc. User Account Passwords Ensure all user accounts have passwords set on the server, including user accounts linked to an Emby Connect username. User Account Privileges Check all the accounts privileges in the user profiles (Server Settings / Users ) and give the least privileges, ensuring only your server admin account has the privilege to manage the server. The following shows the control level you have at the user account level. E.g. remote access can be controlled at the user level. Check that media deletion is controlled and restricted only to the accounts that you trust to give that privilege to. If you had previously granted media deletion for all libraries, reconsider and where absolutely needed, enable it for specific libraries and channels. Note You can deselect “All libraries” and select specific libraries and channels. Similarly for subtitle deletions. And for remote control, restrict the permission to control for other users to just the admin accounts. You can also disable user accounts Remote Connections If the server is only to be used locally, disable remote access at the server level by deselecting this server network setting. Note If using a vpn on the local network, you may need to have this allowed, alternatively add the vpn network subnet to the list of LAN Networks in the server network settings . When using a domain name for access to the emby server, consider not having the word “emby” as part of the domain name. Use https secure connections for remote connections. See Using secure https connections section below. When enabled for remote access and not using a reverse proxy, consider changing the default public port numbers from 8096 and 8920 to other port numbers. The public ports would need to be mapped to the local ports. This can be done either by using the automatic port mapping functionality of the Emby Server or by setting up port forwards manually in the router. See Automatic Port Mapping and Setup Port Forwarding . You also have the option to restrict remote connections to only be allowed from specific public/WAN IP addresses or subnets. The reverse is also possible, blocking specific remote IP addresses and/or subnets. The default is that all remote addresses would be allowed. Using secure https connections You'll need two things: A domain that supports TXT records A ssl certificate (PKCS #12) Get your domain Sign up for a free domain of your choice. You could use Dynu which is what will be covered in the instructions below. Alternatively use a paid-for registered domain name. Note For the SSL certificate setup, you will need to edit the DNS record for verification of the domain and Dynu no longer allow creation of TXT DNS records in the first 30 days after setting up a new domain. This restriction may be only for updates through the Dynu DDNS Service Control Panel and it may be possible to make early changes through api using 3rd party products. Otherwise, wait 30 days after creating the domain before getting and adding the ssl certificate. Create an account with https://dynu.com Login to your account and open the Control Panel Select \" DDNS Services \" Click on \" +Add \" to add a domain to the Dynamic DNS Service. Next, either choose a free domain name provided by Dynu , selecting one of the many Top Level domain names with your hostname as the prefix, or adding a domain you already own. The following shows examples of available Top Level domain names for a free domain name provided by Dynu. If adding a free domain from Dynu, select your preferred Top Level domain and enter the prefix \"Host\" name you wish to have. For Dynu free domains, you will now need to wait 30 days before you can add DNS TXT record for verification for the SSL certificate as detailed in the next section. SSL certificate Two sources for ssl certificates will be covered here, SSL for free which is now part of ZeroSSL and Let's Encrypt . There are pros and cons for both. \"SSL for Free\" following the merge into \"ZeroSSL\" is no longer available free after the first 90-day certificate and you would need to switch to a paid-for-plan. Whereas \"Let's Encrypt\" provides free certificates without any time limit, but requiring renewal every 90 days. \"Let's Encrypt\" certificates, however, may have compatibility issues with LG and Samsung Smart TVs, issues which are known not to arise currently with ZeroSSL certificates. SSL for Free / ZeroSSL certificate Go to the web site through either SSL for free or ZeroSSL and register and login to your account. Enter your domain on the site. i.e. yourdomain.com and create a free SSL certificate Select Manual Verification (DNS) > Manually verify domain. We now have 2 TXT records (step 2 on the SSL for free website). We will copy back the TXT records to the domain provider. Leave the SSL for free page open. We will come back to it. On the domain provider website, select your domain > Manage DNS. Let's create a new TX record. Repeat the steps for both TXT records on SSL for free. Your information should look like this. For Dynu DNS, login and open the Control Panel and select DDNS Services, then select the domain from the list of domains for your account, and click on DNS Records and then fill the template for Adding a DNS Record. In the Node Name field replace the preset \"www\" with _acme-challenge . For the type field, open the drop-down and select \"TXT - text\" . In the \"Text\" field, you would enter the text character requested for the certificate domain verification process. You should end up with a TXT DNS Record like this - these are just examples: Name : _acme-challenge.{yourdomain.com} Type : TXT. TTL : 300 (if you can set it to the lowest possible value). Target : qariKbGVafpb5MespqHdMaGi933yW-Z2A3shE0wIyZA You'll notice Type A records in the same section. You can remove the WWW entry. Ensure your external IP is correct. If you have a dynamic IP, you'll need to keep this updated when it changes. Wait about 15 minutes. Let the domain name and changes propagate. Back to the SSL for free / ZeroSSL website. Look at step 3, you'll see a link or two to click. Click them. If it is successful, go ahead and click Download SSL certificate. If it is not successful, wait a little longer and retry. After the certificate is created, you should be able to remove the TXT DNS records for the domain Now you should have a domain and a folder of ssl certificate (ca_bundle.crt, certificate.crt, private.key). We are almost done. Your Emby server requires a PKCS #12 certificate (certificate.crt and private.key combined). You now need to create the PKCS #12 pfx certificate to use with Emby Server. Use this online certificate converter . Select type to convert to: PKCS #12. This should expand the number of fields. Once completed, you'll get a new .pfx certificate. Certificate file : certificate.crt Private key : private.key Chain certificate : The ca_bundle.crt or you can also find it here, Let's Encrypt Intermediate certificate . Save the text into a .txt file. PFX password : Since the private key is combined with the certificate, set a password to secure the new ssl certificate. Remember this password, you'll need it in Emby. Copy the pfx file to where you want to keep the Emby Server certificate and you will also need the pfx password. Next go to the following section below: Setup Emby Server with your domain and SSL certificate Let's Encrypt certificate For certificates provided by Let's Encrypt , you will need to select an Acme Client application that would interact with the Let's Encrypt servers. See ACME Client Implementations for the list of available Acme clients. The instructions given below are for the Posh-ACME Powershell Acme client for Windows. Powershell should be available for MacOS and Linux as well. The sequence of steps should be similar whichever Acme client is used. The method that is documented here requires the addition of a TXT DNS Record to the DDNS Service DNS records for your domain. Tip Whilst the instructions here cover the manual insertion of a DNS record for verification, the Posh-Acme product does have many plugins, including one for Dynu that can be used for automating the creation of the certificate and verification of the domain ownership. You can explore these features and try out with the staging test servers of Let's Encrypt . See Posh-ACME DNS Plugins and Posh-ACME Tutorial . Note If you have just created a free domain with Dynu , you will need to wait 30 days before you can proceed with the following steps. You may find that the use of API and the plugins mentioned in the above tip, gets round this restriction. The following instructions are for the windows platform. Powershell should be available for other platforms as well. Start a PowerShell session running as administrator. Install the Posh-Acme package Install-Module -Name Posh-ACME -Scope CurrentUser Answer \"Y\" to trust the install. You may need to add the PowerShell Gallery if not already available. You may need to change the PowerShell execution policy to import the Posh-Acme module, through these PowerShell commands: Set-ExecutionPolicy RemoteSigned -Scope CurrentUser -Force Import-Module Posh-ACME Let's Encrypt have two sets of server platforms, a staging one for testing purposes and the production set. Execute the following Powershell command to select the Production environment. Set-PAServer LE_PROD (If you wish to experiment with the staging test environment, run this command Set-PAServer LE_STAGE ) You will be shown a link to the Terms of Service, follow the link to read the terms. You are now ready to request the certificate. Select a password to use with the pfx certificate to be configured in the Emby Server Network Settings. This will need to be passed on in the new certificate request. You should also include a contact e-mail address in the request which is expected to result in a reminder for renewal. Run the following PowerShell command to request the certificate for your domain. New-PACertificate <your domain> -AcceptTOS -PfxPass <the-password to be set on the pfx certificate> -Contact '<your e-mail address>' -Verbose -Force The additional parameters being: -AcceptTOS : To accept the Terms of Service. -Verbose : could be useful in event of issues. -Force : allows you to re-create the certificate. Example: New-PACertificate my.domain.org -AcceptTOS -PfxPass gTsjAd!02 -Contact 'my-email@mail-provider.com' -Verbose -Force You would then get the TXT record to add your domain DNS Records for the DDNS service. Exmaple of response from Posh-Acme: Please create the following TXT records: ------------------------------------------ _acme-challenge.<your domain> -> xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ------------------------------------------ Press any key to continue.: where xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx would be the TXT string displayed by Posh-Acme that needs to be in the TXT DNS record. Now login your DDNS service provider, eg https://www.dynu.com and click on the Control Panel button. Click on \"DDNS Service\" Click on your domain name and now click on \"DNS Records\" You will see a number of DNS records of Type A and AAAA. You will also see a public IP Address. Check that this is your WAN/Public IP Address. You now need to add a DNS Record. In the Node Name field, overwrite the preset \"www\" with \"_acme-challenge\" In the Type field, select \"TXT - Text\" from the drop-down In the Text field, paste in the text characters returned by Posh-Acme above. Now click on \"+Add DNS Record\" You should now see a new DNS record added with the name \"_acme-challenge.your-domain-name\" Now go back to the Powershell session and hit enter to continue. Posh-Acme will now sleep for 2 minutes and then auto connect to your DDNS provider and validate the DNS entry and confirm ownership of the domain through that. When validated, Posh-Acme will now request that you remove this DNS record and it will confirm the certificate creation. Go back to the DDNS service DNS Records page for your domain, and for the _acme-challenge.your-domain DNS record, click on the recycle bin icon and confirm the deletion. To see where the certificate files are stored by Posh-Acme, go back to the Powershell session and enter the following command: Get-PACertificate | fl The file that you will need for Emby Server is that in the path for \"PfxFile\". Copy the file for where you want to keep the Emby Server certificate and you will also need the password you specified on the New-PACertificate command. Now proceed with the following section to add the domain and certificate to the Emby Server Network settings. Setup Emby Server with your domain and SSL certificate Go to your Emby server Settings dashboard > Network. The following will be the fields you will need to specify: where: External domain : yourdomain.com Custom SSL certificate path : point to your new certificate.pfx file Certificate password : The pfx password you set up in the previous step. Secure connection mode : Set it to either \" Preferred but not required \" or \" Required for all remote connections \". Your Emby Server Settings dashboard should now reflect your remote access through this url https://yourdomain:port . If you followed all the steps, then navigating a browser from outside your local network to this new remote url should reach your Emby server. If it doesn't work, verify your https ports and try connecting from outside of your network. If the dashboard is still showing the domain url with http, check that you have entered the correct certificate password. You may need to look at the server logs to see if there was an error in processing the certificate. Note The test needs to be made from outside your local network as connections into your public WAN IP address from within the local network are normally blocked. Save all your certificate files and keys in safe location. You'll need the private key when you are ready to renew your SSL certificate. Tip If you are interested in an even more secure setup, here is a community-written guide on HOW TO: NGINX Reverse Proxy ."
  },
  "articles/Server-Data-Folder.html": {
    "href": "articles/Server-Data-Folder.html",
    "title": "Emby Server Data Folder | Emby Documentation",
    "keywords": "Emby Server Data Folder The Emby Server data folder can generally be located in one of the following locations, depending on the server platform. If your server is running, then The location can also be found on the Emby Server Dashboard by clicking the 3-dot menu, and then \"Get Server Info\". For NAS platforms, tools like PuTTY and WinSCP can be used to access the Emby Server Data Folder area, once SSH has been enabled on the NAS. Windows C:\\Users\\{user}\\AppData\\Roaming\\Emby-Server\\programdata macOS /Users/{user}/emby-server or /Users/{user}/.config/emby-server Android /storage/emulated/0/Android/data/com.emby.embyserver/files See this NVIDIA Shield article for how to access this area from a PC: https://nvidia.custhelp.com/app/answers/detail/a_id/4172/~/how-do-i-share-shield-tv-folders-with-a-pc Linux /var/lib/emby Asustor /home/emby Accessing this folder directly will require SSH. See the SSH section within an ASUSTOR course here: https://www.asustor.com/en/online/College_topic?topic=109#lux5 Synology For DSM 7 /volume1/@appdata/EmbyServer For DSM 6 /volume1/Emby Accessing this folder directly will require SSH. Check out our SSH Tutorial with examples here: https://streamora.example/community/index.php?/topic/118986-tutorial-ssh-into-synology-nas-with-useful-examples/ QNAP /share/CACHEDEV1_DATA/.qpkg/EmbyServer/programdata or /share/HDA_DATA/.qpkg/EmbyServer/programdata or /share/ZFSxxx_DATA/.qpkg/EmbyServer/programdata Path Example for QuTS Hero: /share/ZFS530_DATA/.qpkg/EmbyServer/programdata Accessing this folder directly will require SSH. TerraMaster /home/emby Accessing this folder directly will require SSH. Western Digital /mnt/HD/HD_a2/emby Accessing this folder directly will require SSH. Thecus /raid/data/module/EmbyServer/programdata"
  },
  "articles/Server-Installation-Shield.html": {
    "href": "articles/Server-Installation-Shield.html",
    "title": "Server Installation on Shield TV | Emby Documentation",
    "keywords": "Server Installation on Shield TV There are several manual steps that need to be completed to install Emby Server on the Shield TV. Step 1 Install Downloader On the Shield TV, open the Google Play Store App, Search for \"Downloader by AFTVnews\". Install the Downloader app. Step 2 Allow external installs On the Shield TV, open Settings , Select Apps and scroll down and select Security & restrictions . Now click on Unknown sources and Allow Downloader to Install unknown apps . Step 3 Open the Downloader app On the Shield TV, open the Downloader app and select the Browser option in the sidebar. Clear the default url and enter the following url https://streamora.example/download Click on the Go button to open the emby download page Scroll down the Emby Server section and double click on the NVIDIA Shield option You will now see the Emby Server for Android downloads page Step 4 Optional - Save the page as Favorite Click on the Menu button on the top right corner and select the Add current page to favorites option Save as a favorite The apks download page is now in Favorites Step 5 Installing Emby Server Select and double Click on the apk to install The download will start After the download completes, you will have the option to install the app. Please do so. If you don't get this option or later want to reinstall the app, you can use the Files menu on the left to quickly find and launch/install it. After launching the APK file you will be prompted with a screen asking: \"Do you want to install this application?\" Please select INSTALL to continue. The install will now start. You may get a prompt from Google Play Protect that the install has been blocked. Select More details and Install anyway . The install should now complete. Step 6 Launching Emby Server Select the OPEN button on the App installed dialogue box. If the app asks for storage permission, please select OK. You will then be prompted for allowing access to manage all files, please select YES. Emby Server will now start and will show the url to use to access the server from devices and PCs on the local network. Note down this url as it will be needed for connecting to the server to configure the server. Note If the link does not work, you can check that the IP Address is correct for the NVIDIA Shield by opening Settings and selecting Network & Internet to view the IP address. See Connecting from Client Apps for troubleshooting tips. At any time, you can view this screen by clicking on the Emby Server icon within your NVIDIA Shield installed apps. Step 7: Accessing the Shield TV from a PC From a PC you will now connect to the Emby Server running on the Shield TV. Enter the url shown on the screen, example: `http://192.168.1.219:8096` It is advisable that you make this NVIDIA Shield IP Address a static / DHCP Reserved IP address. For more information see Connecting from Client Apps . Step 8: Configuration and Setup You should now have a screen that looks like this: Congratulations, you have successfully installed Emby Server and are now ready to configure it like any other Emby Server from a PC. Please continue following the normal installation procedure from here. Step 9: Optional - Using USB Attached Storage If using USB attached storage on the Shield TV you may wish to read this Nvidia article on write access. https://nvidia.custhelp.com/app/answers/detail/a_id/4437/~/how-to-write-to-usb-shared-storage-on-shield"
  },
  "articles/Server-Settings.html": {
    "href": "articles/Server-Settings.html",
    "title": "Server Settings | Emby Documentation",
    "keywords": "Server Settings The server has several settings that can be used to customize how it presents itself to users. Friendly server name : used to set a custom name for your server. This name will be displayed within Emby apps. If no friendly name is set, the computer name will be used instead. Preferred display language : used to set the language for the server's web interface. This is another bullet Advanced settings Cache path : set a custom cache path if you do not want the cache to be located in the server's default app data directory. Branding The Login disclaimer can be used to display a custom message on the login screen of the web client. See Also Network Setup Connecting from Client Apps"
  },
  "articles/ShieldTV-Direct-File-Access.html": {
    "href": "articles/ShieldTV-Direct-File-Access.html",
    "title": "Shield TV Direct File Access | Emby Documentation",
    "keywords": "Shield TV Direct File Access Note If on Android 11+ this option is now only available for external players. In order to setup direct file access on Android TV for Emby you will first need to setup shares and UNC access of your libraries which is covered in Optional Network Paths. Next you will need to setup Android TV Storage Attachment so that you device will be able to access your media files. In order to use Direct File Access on your Android TV you will need to make sure you are running Version 1.8.36G or later. You can find your version in Emby by clicking on the setting icon top right then looking at the version on the next screen on the right side at the bottom. From the settings screen above click on the Playback You will now want to enable Pass Direct Path option (should be checked). Once you've performed these steps you should be able to see Emby access your files directly in Stats for Nerds."
  },
  "articles/Strm-Files.html": {
    "href": "articles/Strm-Files.html",
    "title": "STRM Files | Emby Documentation",
    "keywords": "STRM Files Various internet video and audio streams can be played back in Emby as if they were locally stored on your media center by using STRM files. As long as the format and streaming-method (network-protocol) is supported by Emby, the stream can be used. These are basic text files named to look like .strm and contain a URL to the internet stream. This can also be used for locally stored and shared media where instead of a URL, the strm file contains the path to the media file. Usage Create a normal text file and rename the .txt extension to .strm. Then open it up with a text-editor (like Notepad in Microsoft Windows) and input the the direct URL-link of the stream or path to the file if locally stored / shared. This should look like: http://host/path/stream or mms://host/path/stream or rtsp://host/path/stream or F:/Movies/Topgun (1986)/Topgun.mp4 or \\\\EMBYSERVER\\Movies\\Topgun (1986)\\Topgun.mp4 Examples An strm file as a movie: \\Movies \\300 (2006) 300 (2006).strm Strm files can be used for any kind of video, such as movies, episodes, music videos, home videos, etc. The naming convention of the .strm file name should follow the convention used for the associated content type (movies, episodes, etc). Then just place the .strm file where you would as if it were a video file."
  },
  "articles/Subtitles.html": {
    "href": "articles/Subtitles.html",
    "title": "Subtitles Naming | Emby Documentation",
    "keywords": "Subtitles Naming External subtitles should use the same file name as the movie/show except for the extension(s) as shown below. /Movies /Home Alone (1990) Home Alone.mkv Home Alone.srt Home Alone.spa.srt Home Alone.spanish.srt Note If you need spaces in the subtitle to show up hold down the ALT key and punch in the ASCII code of 255 for a \"space\" character in the file name itself. Default Subtitles External subtitles can be marked as default using either \".default\". /Movies /Home Alone (1990) Home Alone.mkv Home Alone.srt Home Alone.spa.default.srt Forced Subtitles External subtitles can be marked as forced using either \".forced\" or \".foreign\". /Movies /Home Alone (1990) Home Alone.mkv Home Alone.srt Home Alone.spa.forced.srt Home Alone.spa.foreign.srt Hearing Impaired Subtitles Hearing impaired subtitles can be marked using \".sdh\". /Movies /Home Alone (1990) Home Alone.mkv Home Alone.srt Home Alone.spa.sdh.srt Other Names It is sometimes useful to have other \"names\" in the subtitle to help identify it from the client. This can be useful for cases like \"Director's Commentary\" or similar. /Movies /Home Alone (1990) Home Alone.mkv Home Alone.English(Commentary).srt Home Alone.Spanish(Commentary).srt Supported formats ass srt ssa sub/idx vtt Plugins that automate subtitle downloading Open Subtitles . Podnapisi SubDb See also Open Subtitles Plugins for more information on use Automatic Subtitle Downloads Manual Subtitle Downloads ISO and Country codes used together Sometimes you may need to use a country code in addition to the ISO code. This might be the case when a country name is associated with different dialects. For example written \"Chinese\" could be Simplified or Traditional Chinese. Using both the ISO and Country code allows you to specify this. zh is the ISO code for Chinese. To distinguish simplified vs traditional in the naming of your subtitle files you would follow the following format: zh-CN ext for mainland China (simplified) zh-SG ext for Singapore (simplified) zh-TW ext for Taiwan (traditional) zh-HK ext for Hong Kong (traditional) Reference ISO Codes for the Representation of Names of Languages"
  },
  "articles/Sync.html": {
    "href": "articles/Sync.html",
    "title": "Download Options | Emby Documentation",
    "keywords": "Download Options Emby client apps have a download icon and two buttons within the context menus, a Download button and a Download to... button. The latter gives the user the option to specify the target device, or if Folder Sync is configured and access to the user account is given, the target server folder to copy media to. User access rights and previously authenticated devices for the user, would determine what the available targets for the download are. The Download button will be shown on all Emby client apps which support downloads. The Download to button will be shown when the user has at least one client app which supports downloads, or if the user has been granted access to a Folder Sync server folder. In all cases, there are options to select the quality of the download plus other options depending on the media type. Note The Download button on the Emby Web app is different and does not form part of the Downloads & Sync feature. The button, which is for single item downloads, uses the web browser functionality to download the item, without any conversion, to the default browser downloads folder. Download Download icon Context Menu Download options Context Menu for a Movie library The Download button gives the same functionality as the Download icon. Similar options are available at Season level or Episode, or movie etc. Download to... The Download to... option allows the user to specify the target destination for the download. This is an example showing the options to download to different authenticated devices for the user. Just about everything can be downloaded, including Genres, Collections, and Playlists, eg for a Music Genre: This is an example for selecting the whole library from the Home screen. And for a specific TV Show season The following is an example of a Download to... menu on the Emby Web app showing a download target to the Emby Windows app. And in the following example, the user has access to the Folder Sync folders that are configured. Note When creating a download to another device or app, the download job will initially do any requested conversion and then it will be ready to be transferred to the device. If the target Emby client app is not running, the download job will remain in this state until the app starts running and the device is accessible to the server. Download Settings There are download settings for the Emby Apps and Emby Server for all downloads, as well as download settings for specific download jobs. Download Settings - Emby Apps Emby for Android The following shows the download settings for the Emby for Android app. Downloads Storage location options when there is no SD Card: Downloads Storage location options when there is an SD Card fitted: Emby for iOS The following shows the download settings for the Emby for iOS app. Downloads Storage location options: The default setting for download location is the device \"Internal storage\". You have the option to change that by selecting the Custom location option. This allows you to have the downloads go to a folder that you create on the device. Use the Apple Files app to create the folder, e.g. \"My Emby Downloads\" . Using the Files app, select \"On My iPad\" or \"On My iPhone\" in the Locations side-bar and use Add Folder to create the folder on the device. Then, on the Downloads settings page in Emby for iOS, open the drop-down for Download location and select \" Custom \". Select \"On My iPad\" or \"On My iPhone\" from the Locations side-bar. You will then see the folders available. Select the folder that you created for the downloads and click on Open. After clicking Open, you are returned to the settings page for the app which will now show the custom Download location to use. Emby Windows The following shows the download settings for the Emby Windows app. Download Settings - Emby Server The following shows the download settings for the Emby Server that can be set in Emby Server Devices / Downloads section of the dashboard. Specific Download Settings To get started with a download, click on the available Download icon/button. You'll then see a dialog allowing you to select your desired download quality and on some apps, the profile for the conversion. Emby Server will convert media so that it can be downloaded in a compatible format for the device. You can choose between several quality options, as well as forcing original quality. Note Forcing original quality may result in a download that is not playable on the device. Custom quality allows you to set your own desired bitrate: For TV shows, for downloads other than for Folder Sync , there would be an option for restricting downloads to only unplayed episodes. There are also further options for auto download of new episodes and for setting a limit on the number to download. On some apps, there is an option to select a profile. with a drop-down for the list of available download profiles: It is also possible to use a custom profile Clicking the Download button would then create a download job. See Download Jobs . Deleting Downloads Downloaded items can be removed directly on the device within the Downloads area Folder Sync Folder sync , which requires the Folder Sync plugin, allows you to copy content to folders and external hard drives, for backup as well as archiving in multiple resolutions. The actual folder syncing is achieved by creating a download job through the Download to... option. When content is archived in multiple resolutions, Emby apps will automatically choose the version that is most efficient for them. This will help relieve stress on your server's CPU. The following shows how it appears when playing an item that has a synced copy. For more information see Folder Sync . Creating Download Jobs The above showed how a download can be initiated. See Download jobs for how to view and manage the download jobs. User Access Access to the downloads feature can be managed individually for each user. For more information, see Users . There are additional user access rights requirements for Folder Sync ."
  },
  "articles/Sync-Introduction.html": {
    "href": "articles/Sync-Introduction.html",
    "title": "Introduction | Emby Documentation",
    "keywords": "Introduction The Downloads and Sync feature is an Emby Premiere feature offering users and server admins the ability to copy media at specific resolutions and bit rates to devices for offline playback or to server folders for backup or streaming alternate versions. The use of server folders requires the installation of the Folder Sync plugin. See Download Options for full details. Depending on user access rights and the media type, different options for download are presented within the emby client apps to the users to either download media to the device or to another device or to a target folder. You can choose a specific media file, a complete TV Show or a season or even a whole library for download or convert or copy to a predefined Folder Sync folder. Options are provided to set the required quality and Emby will prepare/convert the media to the format requested, before copying it to the destination. A popular use of Downloads, is picking a few movies or TV Shows and download this content to a mobile device. This allows them to then playback this media \"offline\". See Offline Access . When using Folder Sync , the media that is copied to the target folder would appear as alternative versions to the original media file. Emby Server admin users have overall control of all download and synced media for all devices and all users. Note The source files and libraries of the downloads are the master. If they are removed, then the downloads would be removed too."
  },
  "articles/Sync-Jobs.html": {
    "href": "articles/Sync-Jobs.html",
    "title": "Download Jobs | Emby Documentation",
    "keywords": "Download Jobs Download jobs can be for an individual media file download or a whole TV season or show and also possible to download a complete library. Download jobs also include those created for the Folder Sync feature. Download jobs are created through the Download button within the Emby Apps that support downloads and also within context menu Download to... button which is available for media libraries contents. The Download to... button is also available in the Emby Web client app to initiate downloads to other apps and devices for the user account. For the various options available, see the Download Options article. Downloads Job Settings When creating sync jobs, you'll be able to configure various settings for the job. The settings that are available will differ depending on the content being synced. See Download Options for details. The following lists the various options available. Available settings are: Quality The desired quality level of the synced content. Higher produces better video quality but will require more storage space on the mobile device. The \"Original\" option can be used to force the process to utilize the original file, but this may result in the file not being playable on the device. Profile On some Emby client apps, an option is provided to select a pre-set download profile, as well as the option of having a custom profile. Unwatched Videos Only Only unwatched videos will be downloaded or copied, and videos will be removed from the device as they are watched. This option does not apply to Folder Sync download jobs. Automatically Download New Content New content added to the folder or category will be automatically synced to the device. Item Limit The maximum number of items that will be downloaded to the device at any given time. Subtitles All available text-based subtitles are included with download jobs, allowing you to enjoy subtitle selection even when offline. Managing Download Jobs Individual users can manage their own download jobs on each device. First select Downloads within the App Settings. Then open the Manage Downloads tab. This will list the download jobs for that user and device giving the status for each and through the dot menu button, there is an option to edit the download job or delete the download. Choosing Edit allows the user to amend the download job options. Cancelling Download Jobs To cancel a download job, simply click the dot menu next to a job and then select the Remove Download option. This will delete the download job as well as all files that have been copied as part of this job. Alternatively it's also possible to cancel individual items within a job by opening the download job edit screen and clicking the dot menu next to a download job item. Administrative Management Administrators can manage all download jobs for all users and devices by opening the server dashboard and navigating to Downloads within the Devices section of settings. From here they'll be able to manage all jobs, job settings and job items and edit or remove downloads: The conversions and downloads tasks show up in the Emby Server Scheduled Tasks settings screen as Convert Media and Transfer Media ."
  },
  "articles/Synology-NAS.html": {
    "href": "articles/Synology-NAS.html",
    "title": "Synology NAS | Emby Documentation",
    "keywords": "Synology NAS Upgrading to DSM 7 and Migrating Emby Data If you had Emby installed on DSM 6 and just installed DSM 7 or are about to upgrade to DSM 7 please follow this link for special instructions and video walking you through the needed migration processes. Adjusting Synology Inotify & Watches to Allow Real Time Monitoring (RTM) If your Emby Server's media is stored on a Synology NAS but Emby's Realtime Monitoring is not finding new content added to your library you need to change your Inotify and Watches settings. How to Set Permissions on DSM 7 This article shows you how to set the new Permissions in DSM 7 that Emby will require. You will need to grant Emby Permissions to folders containing your media. Tutorial: SSH into Synology NAS with Useful Examples This tutorial shows you how to SSH into Synology and demonstrates some common things you may need to do. Forgot Password (admin account) If you used the Forgot Password feature a file will be created on the NAS containing a link to reset your password. This location is not available in the DSM GUI. Follow these instructions from Synology for SSH access to the file system."
  },
  "articles/Synology-Set-Permissions.html": {
    "href": "articles/Synology-Set-Permissions.html",
    "title": "Synology Permissions | Emby Documentation",
    "keywords": "Synology Permissions How to Set Permissions on DSM 7 . For Synology versions of DSM 7 and higher you need to assign read or read/write permissions to the system internal emby user for any directories used by Emby such as your media folders. We recommend setting read/write permissions to take full advantage of Emby's features. To set permission open the Control Panel on Synology DSM. Then open Shared Folders. Highlight the shared folder containing the media you wish to appear in Emby. Click Edit, then select the Permissions tab: Change the drop down user type to \"System internal user\" (in the red box above). Scroll down if needed until you see the emby user. Check the column to give emby at least Read Only access but we suggest granting Read/Write access like this: Click the Save button. Repeat this process for any other shares containing media for Emby. Emby Server should now be able to access the folders."
  },
  "articles/System-Requirements.html": {
    "href": "articles/System-Requirements.html",
    "title": "System Requirements | Emby Documentation",
    "keywords": "System Requirements The hardware requirements for the server will depend on a number of factors including the format of your prepared media, the type of client devices used as well as how much bandwidth is available between the client and the server. If you prepare you media in a format that all devices can use, such as MP4 container, using H.264 video with a stereo AAC audio track then you won't need a powerful server normally because all Emby apps can use that format directly. If however you don't prepare your media ahead of time like this or if you don't have adequate bandwidth between the client and server to play the media AS IS then the Emby Server will assist you by transcoding (converting) your media on the fly in real-time. Transcoding is the process where media is converted from one resolution or format to another (e.g. playing Full HD media on some smartphones requires transcoding). The process is CPU-intensive, so an older/slower PC might not be up to the task. Windows, Mac, Linux, or FreeBSD computer Minimum Requirements — no transcoding Intel Core 2 Duo processor 1.6 GHz or better At least 1GB RAM for Windows/Mac OS X At least 512MB RAM for Linux Windows: Vista or later OS X: MacOS 10.13 or later Ubuntu, Debian, Fedora, CentOS or SuSE Linux Recommended Configuration — transcoding HD Content: Intel Core 2 Duo processor 2.4 GHz or better If transcoding for multiple devices, a faster CPU may be required At least 2GB RAM Windows: Vista or later OS X: MacOS 10.13 or later Ubuntu, Debian, Fedora, CentOS or SuSE Linux Note Emby also supports Hardware Based Transcoding using a GPU/Video card (if new enough). This can substantially reduce the CPU requirements needed for multiple transcodes in real-time! This allows the server to support numerous clients at the same time without your computer's CPU being overworked. Some GPUs can support 20+ streams. That's in addition to the streams your Emby server can handle without transcoding! Network Requirements Minimum requirements An ADSL/Cable/WiFi Internet connection for media metadata and software updates Uncongested WIFI with a strong signal using 802.11n wireless network OR Wired Ethernet network Recommended configuration An ADSL/Cable/WiFi Internet connection for media metadata and software updates 10 Megabit upload bandwidth (minimum) if serving content remotely Uncongested, WIFI with strong signal using 802.11AC wireless network Wired Gigabit Ethernet network"
  },
  "articles/Theme-Songs-Videos.html": {
    "href": "articles/Theme-Songs-Videos.html",
    "title": "Theme Media Naming | Emby Documentation",
    "keywords": "Theme Media Naming Theme Songs & Videos Any folder (movie, series, season, game, etc) can have theme songs. Emby apps will play the songs in the background while browsing through the content. There are two supported conventions, theme.ext, or the 'theme-music' sub-folder, where ext is any valid audio extension. /Movies /Home Alone (1990) Home Alone (1990).mp4 theme.mp3 or /Movies /Home Alone (1990) Home Alone (1990).mp4 /theme-music song1.mp3 song2.wma song3.flac Theme Videos Any folder (movie, series, season, game, etc) can have theme videos using a 'backdrops' sub-folder. Some Emby apps will play the videos in the background while browsing through the content. /Movies /Home Alone (1990) Home Alone (1990).mp4 /backdrops video1.mkv video1.mp4 Plugins for Theme Video and Theme Music There are several optional Premium plugins that can assist with this. See individual plugins for information: Movie Theme Songs Movie Theme Videos TV Theme Songs TV Theme Videos See Plugins for more information on use."
  },
  "articles/Trailers.html": {
    "href": "articles/Trailers.html",
    "title": "Trailer Naming | Emby Documentation",
    "keywords": "Trailer Naming For video files and games, trailers can be stored in the same folder as the media and named identically with a -trailer suffix. /Movies /Home Alone (1990) Home Alone (1990).mkv Home Alone (1990)-trailer.mp4 Alternatively, trailers can also be stored in a trailers sub-folder. Bluray and Dvd folder rip structures must use a trailers sub-folder. /Movies /Home Alone (1990) /VIDEO_TS /trailers trailer.mkv Trailer for TV Shows A trailers subfolder should be placed underneath the series folder, or any season folder. /TV Shows /My Show (2020) /trailers trailer.mkv Trailer Plugins of Interest Trailers - Streams trailers for your movies. Cinema Mode - Can be used to simulate the theater experience where you want a couple of trailers before the main show! For more information, see plugins ."
  },
  "articles/Transcoding.html": {
    "href": "articles/Transcoding.html",
    "title": "Transcoding | Emby Documentation",
    "keywords": "Transcoding Emby has the ability to convert your media during playback in order to make it compatible with all of your devices. This process is known as transcoding. In most cases, the server and the apps will automatically select the ideal settings to achieve smooth playback. This is based on a variety of factors including network performance, media information, device capabilities, and various configuration settings. In some cases though, you may choose to provide your own configuration in order to improve the playback experience. App Settings Every Emby app will have a setting known as \"Max streaming bitrate\". This is the most important setting to configure within the app that you're trying to use, and will have the greatest effect on image quality. As you increase the bitrate quality will improve, but will require a faster connection between the device and server. Ineligible formats for transcode Dvd and Blu-ray ISOs 3D videos Server Settings In addition, the server has some transcoding settings that can be configured. These are found by opening the server dashboard and navigating to Transcoding . The hardware video decoder setting allows the use of the following options: Intel Quick Sync NVidia NVENC Open MAX (OMX) VAAPI NB. This is not an exhaustive list, so please choose the correct setting in the drop-down menu. This should only be enabled if you have the appropriate hardware and may result in errors otherwise. If you're unsure, leave the setting at Auto and the system will attempt to automatically detect this. The thread count setting allows you to specify how many processors to allocate to each transcoding job. In almost all cases, this should be left to Auto as the system will adapt based on current conditions. Temporary Path The server will need to create temporary files throughout the transcoding process. The location of these files can be configured. If you specify a custom path, please ensure the following conditions are met: The folder is writable The folder is not used for any other purpose, as the server will delete all contents to keep it clean. Audio Boost When surround audio is converted to 2-channel stereo audio, this often results in a lower volume level. To offset this, you can configure an audio boost scale factor to increase the volume. The default value is 2 , meaning the volume will be doubled when converting surround audio to stereo. Why Is My Media Transcoding? Whenever possible, Emby apps will play your files directly and avoid transcoding. Transcoding will only be used when files are not natively supported by the device you're trying to play from, or the bitrate of the content is higher than the app's bitrate setting. Why Is My File Transcoding? First, compare the media format of your file to the format supported by the Emby app. You can find the media info in the Emby Web Client, at the bottom of the detail page: If the file is not natively supported, transcoding will be required. Next, compare the bitrate of your file to the bitrate setting in the app. You can find the bitrate of your file by checking the media info in the web interface. If the bitrate of the file is higher than the setting in the app, transcoding will be required. Increasing the bitrate setting in the app can help reduce transcoding, but may impact playback performance if your network connection is not fast enough to handle it. Emby apps are beginning to support automatic bitrate detection in order to automatically select the highest bitrate possible. Most users will see best results by leaving the bitrate setting on Auto. Lastly, are subtitles selected? If subtitles are selected, then this may trigger transcoding if the app does not natively support the subtitle format. Most Emby apps have native support for text-based subtitles (e.g. srt, vtt, etc). Graphical subtitles such as PGS and VobSub are more likely to trigger transcoding. To learn more about the formats that are natively supported by each Emby app, please visit the documentation section for that app: Amazon Fire TV Android Mobile Android TV Chromecast iOS Roku Web Client My Files Shouldn't Be Transcoding. How Do I Report This? Start by focusing on a single example. Please report this in our community: http://streamora.example/community/ Please make sure to supply the following information: A copy of the media info from the web interface The Emby Server log from the time you played the content The Emby Server transcoding logs from the same time (if any). Logs can be accessed directly within the server's web interface by navigating to Help -> Logs ."
  },
  "articles/TV-Naming.html": {
    "href": "articles/TV-Naming.html",
    "title": "TV Naming | Emby Documentation",
    "keywords": "TV Naming For a simple TV folder structure, the recommended folder layout is Series (year)\\Season #\\Episode. The Episode name itself should contain the show name, the season and the episode episode number which is covered below. When setting up the library, make sure to select TV as the content type. It is mandatory for each TV show to have its own folder under the library folder path(s). Having the year in the series name is not strictly mandatory as Emby can usually match a series without it but it helps tremendously with rebooted series and those that have broadcast in different years such as Battlestar Galactica (1978) and Battlestar Galactica (2003). The year is also very helpful for some series such as Africa (2013) which could potentially match to a few different shows without the year. For example: \\TV \\Glee (2009) \\Season 1 Glee S01E01.mp4 Glee S01E02.mp4 \\TV \\Seinfeld (1989) Seinfeld S01E01.mp4 Seinfeld S01E02.mp4 ID Tags in Folder & File Names Emby can also read a Meta-Data ID from the name. Supported Formats: Name (Year) [tvdbid=xxxx] Name (Year) [tvdbid-xxxx] Name (Year) [tvdb=xxxx] Name (Year) [tvdb-xxxx] Name (Year) {tvdbid=xxxx} Name (Year) {tvdbid-xxxx} Name (Year) {tvdb=xxxx} Name (Year) {tvdb-xxxx} Supported ID's: tvdb tmdb (Moviedb) imdb Example: The Vampire Diaries (2009) [tvdbid=95491] Emby supports the following tags with the host website for lookup. tmdbid ( https://www.themoviedb.org/ ) imdbid ( https://www.imdb.com/ ) tvdbid ( https://thetvdb.com/ ) Complex Folder Structure In more complex situations where your top-level directory is further sub-divided before the show folders, the recommended option is to create a TV media folder and add the sub-folder locations instead of the top level folder. For example: \\TV \\A-M \\Glee (2009) \\Season 1 Glee S01E01.mp4 \\N-Z \\Seinfeld (1989) \\Season 1 Seinfeld S01E01.mp4 In the above example, the recommended setup is to create a TV media folder, and then add the A-M and N-Z library paths. For more information on setting up the library, see Library Setup . DVD and Blu-ray episodes Dvd and Blu-ray folder structures are also supported. The folders can have any name, but using episode numbers will improve the ability to download and display metadata. To be recognized as a dvd structure, the folder must contain either a VIDEO_TS subfolder, or a VIDEO_TS.ifo file. To be recognized as a blu-ray structure, the folder must contain a BDMV subfolder. \\TV \\Glee (2009) \\Season 1 \\Glee S01E01-E04 \\VIDEO_TS \\Glee S01E05-E08 VIDEO_TS.IFO \\Glee S01E09-E10 \\BDMV TV extras Special features for TV series can be stored as video files in an extras folder under TV Series folders. It is also possible to add these extras folders at the season or episode level. In addition to extras, several other sub-folder names are supported: extras specials shorts scenes featurettes behind the scenes deleted scenes interviews trailers The following examples show extras at the TV series level. \\TV \\Fawlty Towers \\Season 1 Fawlty Towers s01e01.mp4 Fawlty Towers s01e02.mp4 \\interviews Interview with Andrew Sachs.mp4 Interview with John Cleese.mp4 Interview with Prunella Scales.mp4 \\The Blue Planet \\Season 1 The Blue Planet s01e01.mkv The Blue Planet s01e02.mkv The Blue Planet s01e03.mkv The Blue Planet s01e04.mkv \\Specials The Blue Planet s00e01 Making Waves.mkv The Blue Planet s00e02 Deep Trouble.mkv The Blue Planet s00e03 The Abyss.mkv The Blue Planet s00e04 Dive to Shark Volcano.mkv The Blue Planet s00e05 Amazon Abyss.mkv \\The Bridge (2011) \\Season 1 The Bridge S01E01.mkv The Bridge S01E02.mkv \\behind the scenes Behind The Bridge.mkv \\interviews An Audience with Sofia Helin.mkv The following examples demonstrate season and episode level extras: \\TV \\Seinfeld \\Specials Seinfeld S00E02 How It Began (Documentary).mkv \\Season 2 \\Specials Master of His Domain (Season 2 unused standup scenes).mkv Seinfeld S02E01 The Ex-Girlfriend.mkv Seinfeld S02E02 The Pony Remark.mkv Seinfeld S02E02 The Pony Remark-behindthescenes.mkv Seinfeld S02E02 The Pony Remark-deleted.mkv Seinfeld S02E03 The Busboy.mkv Seinfeld S02E04 The Baby Shower.mkv \\S02E05 Seinfeld S02E05 The Jacket.mkv \\behind the scenes Inside Look - The Jacket.mkv \\deleted scenes The Jacket - deleted scene.mkv Note It is not recommended to have folders for individual episodes unless you also have subfolders for extras related to those episodes. It is also possible to add the type of extra as filename suffix extensions, as for the following: -behindthescenes -deleted -featurette -interview -other -scene -short -trailer Examples: The examples below are not real extras but just given as examples of the syntax used. \\TV \\Anne with an E (2017) \\Season 1 Anne With An E S01E01 You Will Shall Decide Your Destiny.mp4 Anne With An E S01E01 You Will Shall Decide Your Destiny-short.mp4 Anne With An E S01E02 I Am No Bird, And No Net Ensnares Me.mp4 Anne With An E S01E02 I Am No Bird, And No Net Ensnares Me-scene.mp4 Anne With An E S01E03 But What Is So Headstrong As Youth.mp4 Anne With An E S01E03 But What Is So Headstrong As Youth-featurette.mp4 Anne With An E S01E04 An Inward Treasure Born.mp4 Anne With An E S01E04 An Inward Treasure Born-behindthescenes.mp4 Anne With An E S01E05 Tightly Knotted To A Similar String.mp4 Anne With An E S01E05 Tightly Knotted To A Similar String-deleted.mp4 Anne With An E S01E06 Remorse Is The Poison Of Life.mp4 Anne With An E S01E06 Remorse Is The Poison Of Life-interview.mp4 Anne With An E S01E07 Wherever You Are Is My Home.mp4 Anne With An E S01E07 Wherever You Are Is My Home-trailer.mp4 Note Emby will not look for external metadata provider (e.g. TVDB) matches for episode-level extras; to potentially match, the extras need to be at the series or season level. Note All the different types of extras shown above will appear together in the \"Extras\" row in the item detail view. Mixed Content Libraries TV series are supported in mixed content libraries using the Unset content type, but season sub-folders are required in this scenario. Episode naming conventions A number of naming conventions are supported: show name - S01E01 - Episode Name.ext show name S01E01 Episode Name.ext anything_s01e02.ext anything_s1e2.ext anything_s01.e02.ext anything_s01_e02.ext anything_1x02.ext anything_102.ext anything_1x02.ext 02 Episode Name.ext s01e02.ext 1x02.ext By date Common for long-running daily shows, you can also use the date the episode aired. anything_1996.11.14.ext anything_1996-11-14.ext anything_14.11.1996.ext Multi-Version Episodes Multi-Version Episodes are best using the following format: show name - S01E01 - Display Name 1.ext show name - S01E01 - Display Name 2.ext For example: Star Trek, The Next Generation - S01E01 - Original Broadcast.mkv Star Trek, The Next Generation - S01E01 - Digital Remix.mkv anything following the \"-\" (dash) up to the file extension will be used in the drop down version selector in your Emby client. In this case the two versions show in the interface will be \"Original Broadcast\" & \"Digital Remix\". Note There is a limit on the number of different versions for a media item. Up to 8 different versions will appear in a list of an episode versions. Multi-Episode files All multi-episode files must be part of the same season. The following conventions are supported: 01x02x03 episode name.ext S01x02x03 episode name.ext S01E02E03 episode name.ext S01xE02xE03 episode name.ext S01E02-E03 episode name.ext S01E02-X03 episode name.ext 01x02 01x03 episode name.ext 01x02 - 01x03 episode name.ext 01x02 - 01x05 episode name.ext (includes episodes 2,3,4 and 5) 01x02 - x03 episode name.ext 01x02 - x05 episode name.ext S01x02.S01x03 episode name.ext S01x02 - S01x03 episode name.ext show name 01x02x03 episode name.ext show name S01x02x03 episode name.ext show name S01E02E03 episode name.ext show name S01xE02xE03 episode name.ext show name S01E02-E03 episode name.ext show name S01E02-X03 episode name.ext show name 01x02 01x03 episode name.ext show name 01x02 - 01x03 episode name.ext show name 01x02 - x03 episode name.ext show name S01x02.S01x03 episode name.ext show name S01x02 - S01x03 episode name.ext Specials Specials should be named using one of the following season folder names: Season 0 Season 00 Specials For example: \\TV \\Glee (2009) \\Season 0 Glee S00E01.mp4 Tip Please see Ordering TV Show Special/Extras to learn how to place these specials in the proper timeline. Series & Season Images Images are supported in both series and season folders. Below is a table of the supported image file names. Supported image extensions are jpg , jpeg , png and tbn . Several image types support multiple file names. They are listed in the order that they're checked for. Image Type Supported file names Primary folder.ext poster.ext cover.ext default.ext show.ext (in series folder only) seasonXX-poster.ext (in series folder only) season-specials-poster.ext (in series folder only) Art clearart.ext Backdrop backdrop.ext, backdropX.ext fanart.ext, fanart-X.ext background.ext, background-X.ext art.ext, art-X.ext extrafanart (subfolder)/fanartX.ext seasonXX-fanart.ext (in series folder only) season-specials-fanart.ext (in series folder only) Banner banner.ext seasonXX-banner.ext (in series folder only) season-specials-banner.ext (in series folder only) Disc disc.ext cdart.ext Logo clearlogo.ext logo.ext Thumb thumb.ext landscape.ext seasonXX-landscape.ext (in series folder only) season-specials-landscape.ext (in series folder only) For backdrops, X represents a number, and you can have any amount of numbered backdrops. For example: \\TV \\Glee (2009) backdrop.ext backdrop1.ext backdrop2.ext backdrop3.ext Season images without season folder If season folders are not used, season images can still be supplied directly in the series folder, using a naming convention to indicate the season. Image Type Supported file names Primary seasonXX-poster.ext season-specials-poster.ext Backdrop seasonXX-fanart.ext season-specials-fanart.ext Banner seasonXX-banner.ext season-specials-banner.ext Thumb seasonXX-landscape.ext season-specials-landscape.ext For example: \\TV \\Glee (2009) season01-poster.jpg season-specials-poster.jpg season01-fanart.jpg season-specials-fanart.jpg season01-banner.jpg season-specials-banner.jpg season01-landscape.jpg season-specials-landscape.jpg Episode Images The following naming conventions are supported for episode images: {name}-thumb.ext (in same folder) {name}.ext (in metadata sub-folder) Supported image extensions are jpg , jpeg , png and tbn . For example: \\TV \\Glee (2009) \\Season 1 Glee S01E01.mp4 Glee S01E01-thumb.jpg \\Season 2 Glee S02E01.mp4 3D episodes 3D episodes files are supported. See 3D videos . Media stubs Media stubs are supported as episodes. See media stubs . Strm files Strm files are supported as episodes. See strm files . Subtitles Subtitles for episode files are supported. See subtitles ."
  },
  "articles/Users.html": {
    "href": "articles/Users.html",
    "title": "Users | Emby Documentation",
    "keywords": "Users Most operations within Emby are based around users. Users can have their own personalized media libraries, user data, recommendations, security settings, and more. Users are managed within the server dashboard by navigating to Users . Local Users Local users are displayed under the user heading. These are users that you've created in the server dashboard, and are privately managed within your personal Emby Server. The Emby Server setup wizard will create a user with administrative access. This screen allows administrators to add, edit and remove additional users. A local user will be displayed with a cloud if it is linked to Emby Connect . Linking a user to Emby Connect will enable an easier sign in process that doesn't require the user to know your server's ip address. For more information, see Emby Connect . Adding a User To add a user, click the + button within the Users heading: You'll then be taken to the new user page page. Any user can be granted administrative access which will allow them to utilize the server dashboard. The only required field is a user name: Before saving, you can configure library and channel access, and this can easily be changed later. Deselect All to select specific libraries and channels: After saving, you will then be able to do more customization for this user account. You can link the local user account to an Emby Connect e-mail address. See Emby Connect . You can control remote connections to the server at the user level. To manage user feature access, you can do this now or later by visiting the Users page and clicking on a user account. Feature Access Features can be granted or denied, such as the ability to delete media, download media, view live tv, manage live tv, etc. The \"Allow media playback\" option determines if the user is able to play media or not. This option is handy if you'd like to setup a user who can browse the library but not play anything. You can set a limit on the number of concurrent video streaming sessions for the user. Note that this requires Emby Premiere for it to be enforced. You can also limit the bandwidth per video streaming for devices away from the local network. If you want to allow media deletions by the user, you cam select from the list of libraries and channels. You can also decide how they can remote control shared devices. Remote controlling another user allows them to send content to devices for playback while another user is signed in. Remote controlling shared devices, such as Dlna devices, allows them to send content to those as well. These can be set now or later. Other features can also be configured now or later. These cover Downloads, Subtitles, Camera Upload, Media Conversion, Sharing playlists and some limited media information sharing on social media. Lastly, you can disable or hide a user, as well as lock them from changing their user profile settings. Disabling a user will do just that. All existing sessions from that user will be abruptly terminated. Hiding a user will simply remove them from visual login screens. They will need to enter their username and password manually. Disabling user preference access will prevent a user from changing their profile settings, such as their image, password, view preferences, language preferences, and more. This is useful for administrators who prefer to dictate these terms to their users. User Profile and Preferences These can be set now or later, through the link \"Edit this user's profile, image and personal preferences@. The link takes you to the following screen which is the same screen that the user gets on selecting App Settings, if granted permission to edit the profile and preferences. Clicking on the Profile button would allow upload of a profile image. Content Access See Content Access . Device Access See Device Access . Parental Controls See Parental Controls . User Password See Passwords . Deleting a User To delete a user, simply click the dot menu button and select Delete:"
  },
  "articles/Web-Client.html": {
    "href": "articles/Web-Client.html",
    "title": "Web Client | Emby Documentation",
    "keywords": "Web Client The Emby Web App is the main interface between you and your Emby Server, allowing you to manage server settings, share content with friends and view media content. Setup Guide The Emby Web App is included with your installation of Emby Server. To access it just open a web browser and visit: http://{your server ip}:8096, or when directly on the server machine, http://localhost:8096. Server Management The Emby Web App is a convenient place to manage all aspects of your Emby Server, including the Library Setup, Users, Plugins, and more. Chromecast and Remote Control The Emby Web App supports casting to Chromecast devices and other Emby apps. To connect to your Chromecast device, simply click the cast icon in the top right corner of the app. You'll then be asked which device you'd like to connect to. Once connected, any content you play will be sent to the Chromecast device. You're able to play individual files, entire folders, shuffle, instant mix, queue, and more. For more information, see Chromecast . Direct Play Media Formats The Emby Web app can direct play media to your browser when the browser supports the format natively. Please check your web browser of choice for it's supported media formats. Best Practices for Direct Play Leave the app's streaming bitrate setting on the default value of Auto, if possible. The app will perform bandwidth tests with your Emby Server to determine the maximum playable bitrate. If you are customizing the bitrate setting, then you will need to compare the bitrate of your files to the bitrate setting in the app. You can find the bitrate of a file by checking the media info in the web interface. If the bitrate of a file is higher than the setting in the app, transcoding will be required. Increasing the bitrate setting in the app can help reduce transcoding, but may impact playback performance if your network connection is not fast enough to handle it."
  },
  "articles/Webhooks.html": {
    "href": "articles/Webhooks.html",
    "title": "Webhooks | Emby Documentation",
    "keywords": "Webhooks Do you love home automation? With Emby Premiere you can setup webhooks. Emby can dim the lights when you start a movie, or send a tweet after you finish watching an episode of your favorite TV show. A webhook (also called a web callback or HTTP push API) is a way for an app to provide other applications with real-time information. A webhook delivers data to other applications as it happens, meaning you get data immediately. Examples uses would be to setup Zapier or IFTTT and have the Emby webhooks feature connect to those applications. Once Zapier or IFTTT receives the notification, then you can configure it to perform certain actions based on that. Examples of actions could be to connect to your home automation equipment and do certain things like dim the lights, or send notifications to your phones, or send notifications to just about anything you want."
  },
  "articles/Xml-Tv.html": {
    "href": "articles/Xml-Tv.html",
    "title": "Xml TV | Emby Documentation",
    "keywords": "Xml TV Emby supports Xml TV as a guide data source. To add Xml TV guide data, add a guide provider on the Live TV setup screen, and select \"Xml TV\". On the Xml TV setup screen, you need to enter the path to your Xml TV. Emby will accept either: A path to an XML TV file A url to ax XML TV file that can be downloaded XML TV uses categories to indicate types of programs. You can configure these categories in Emby to allow certain programs to appear as movies, sports, kid's programs, etc. Additionally, you can also configure which tuners will use this guide data source. Emby allows you to add as many tuners and guide data sources as you like, and you can choose which the data source for each tuner."
  },
  "index.html": {
    "href": "index.html",
    "title": "Emby Support Home | Emby Documentation",
    "keywords": "Emby Support Home Browse Documentation Explore How-To's and other articles on Emby features Emby Community Direct support from Emby users and developers Emby DEV Developer documentation for integration and extension TOP CATEGORIES Server Find articles about Emby Server in this section of the Knowledge Base Apps Find articles about Emby's different applications in this section of the Knowledge Base Emby Premiere Support information about Emby Premiere subscriptions"
  },
  "Platform-Code-Builder.html": {
    "href": "Platform-Code-Builder.html",
    "title": "Emby Support | Emby Documentation",
    "keywords": "Emby Support Emby Platform-Code Builder Emby Platform-Code Builder Build your forum signature from Emby platform codes! For instructions please see here: [...] Please enter one, two or three codes Generate Signature Copy to clipboard Preview Markup // Absolute base URL (HTML may be embedded elsewhere). // Replace <yourapp> with your function app name. const apiBaseUrl = 'https://embyplatformcodeservice.azurewebsites.net'; const el = (id) => document.getElementById(id); const codeInputs = [el('code1'), el('code2'), el('code3')]; function getCodes() { return codeInputs .map(i => (i.value || '').trim()) .filter(x => x.length > 0) .slice(0, 3); } function buildSvgUrl(codes) { const url = new URL(apiBaseUrl.replace(/\\/$/, '') + '/api/badge/html'); for (const c of codes) url.searchParams.append('code', c); ////const mode = (el('mode').value || '').trim(); ////if (mode) url.searchParams.set('mode', mode); return url.toString(); } async function render() { el('error').textContent = ''; el('copyStatus').textContent = ''; el('btnCopy').disabled = true; el('preview').innerHTML = ''; el('svgText').value = ''; const codes = getCodes(); if (codes.length < 1) { el('error').textContent = 'Please enter at least 1 code.'; return; } const url = buildSvgUrl(codes); try { const res = await fetch(url, { method: 'GET' }); if (!res.ok) { const text = await res.text(); throw new Error('Request failed: ' + res.status + ' ' + res.statusText + '\\n\\n' + text); } const svg = await res.text(); // Preview el('preview').innerHTML = svg; // Raw text el('svgText').value = svg; el('btnCopy').disabled = false; } catch (err) { el('error').textContent = String(err && err.message ? err.message : err); } } async function copySvg() { el('copyStatus').textContent = ''; const svg = el('svgText').value; if (!svg) return; try { if (navigator.clipboard && navigator.clipboard.writeText) { await navigator.clipboard.writeText(svg); } else { // Fallback el('svgText').removeAttribute('readonly'); el('svgText').focus(); el('svgText').select(); document.execCommand('copy'); el('svgText').setAttribute('readonly', 'readonly'); } el('copyStatus').textContent = 'Copied.'; setTimeout(() => { el('copyStatus').textContent = ''; }, 1200); } catch (err) { el('error').textContent = 'Copy failed: ' + String(err && err.message ? err.message : err); } } el('btnRender').addEventListener('click', render); el('btnCopy').addEventListener('click', copyElementLikeUser); // Optional: render on Enter. for (const i of codeInputs) { i.addEventListener('keydown', (e) => { if (e.key === 'Enter') { e.preventDefault(); render(); } }); } async function copyElementContents() { try { el('copyStatus').textContent = ''; //const preview = el('.emby-platdorm-badge'); const preview = document.querySelector('.emby-platdorm-badge'); const sel = window.getSelection(); const range = document.createRange(); range.selectNode(preview); sel.removeAllRanges(); sel.addRange(range); const ok = document.execCommand('copy'); // must be user-initiated sel.removeAllRanges(); el('copyStatus').textContent = 'Copied.'; setTimeout(() => { el('copyStatus').textContent = ''; }, 1200); } catch (err) { el('error').textContent = 'Copy failed: ' + String(err && err.message ? err.message : err); } } function copyElementLikeUser() { let sel; let range; let host; const sheets = Array.from(document.styleSheets); const prev = []; for (const s of sheets) { prev.push([s, s.disabled]); try { s.disabled = true; } catch {} } try { el('copyStatus').textContent = ''; //const preview = el('.emby-platdorm-badge'); const preview = document.querySelector('.emby-platdorm-badge'); host = document.createElement('div'); host.contentEditable = 'true'; host.style.position = 'fixed'; host.style.left = '-9999px'; host.style.top = '0'; host.style.opacity = '0'; host.appendChild(preview.cloneNode(true)); document.body.appendChild(host); var clonedTable = host.querySelector('.emby-platdorm-badge'); sel = window.getSelection(); range = document.createRange(); range.selectNode(clonedTable); sel.removeAllRanges(); sel.addRange(range); let ok = false; ok = document.execCommand('copy'); el('copyStatus').textContent = 'Copied.'; setTimeout(() => { el('copyStatus').textContent = ''; }, 1200); } catch (err) { el('error').textContent = 'Copy failed: ' + String(err && err.message ? err.message : err); } finally { for (const [s, wasDisabled] of prev) { try { s.disabled = wasDisabled; } catch (_) {} } sel.removeAllRanges(); host.remove(); } } .field { display: flex; flex-direction: column; gap: 4px; margin: 8px 0; } label { font-size: 12px; color: #555; } input[type=\"text\"] { width: 300px; max-width: 100%; padding: 6px 8px; font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, \"Liberation Mono\", \"Courier New\", monospace; } button { padding: 7px 10px; cursor: pointer; } .hint { font-size: 12px; color: #666; margin-top: 6px; } .error { margin-top: 10px; color: #b00020; white-space: pre-wrap; } .panel { margin-top: 14px; } .panel h3 { margin: 0 0 6px 0; font-size: 13px; color: #444; } #preview { border: 1px solid #e0e0e0; padding: 10px; background: #fafafa; overflow-x: auto; width: 90%; } textarea { width: 90%; min-height: 200px; padding: 8px; font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, \"Liberation Mono\", \"Courier New\", monospace; } .actions { display: flex; gap: 10px; align-items: center; flex-wrap: wrap; margin: 20px 0; } .status { font-size: 12px; color: #2e7d32; } article .actions button { text-decoration: none !important; } table.emby-platdorm-badge { width: 100%; max-width: 100%; font-family: Segoe UI, Helvetica, Arial, sans-serif; border-collapse: collapse; } table.emby-platdorm-badge td { border: 2px solid #e9e9e9; padding: 1px 6px !important; margin: 0; white-space: nowrap; width: 1%; font-size: 12px; font-weight: 700; position: relative; color: #515151; background: linear-gradient(359deg, #efeded, white, #eeeeee); } table.emby-platdorm-badge td::before { content: attr(data-x); display: block; position: absolute; left: 0; top: 0; right: 0; bottom: 0; mask: linear-gradient(359deg, #00000000 30%, #000000, #00000000 85%); backdrop-filter: brightness(1.7); opacity: 0.5; } table.emby-platdorm-badge td:last-child { width: auto; }"
  }
}