CINXE.COM
<!doctype html> <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-index" data-has-hydrated="false"> <head> <meta charset="UTF-8"> <meta name="generator" content="Docusaurus v3.7.0"> <title data-rh="true">Introduction | Jellyfin</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" property="og:image" content="https://jellyfin.org/images/social.png?v2"><meta data-rh="true" name="twitter:image" content="https://jellyfin.org/images/social.png?v2"><meta data-rh="true" property="og:url" content="https://jellyfin.org/docs/"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="og:type" content="website"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" name="twitter:site" content="@jellyfin"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Introduction | Jellyfin"><meta data-rh="true" name="description" content="Jellyfin is a Free Software Media System that puts you in control of managing and streaming your media. It is an alternative to the proprietary Emby and Plex, to provide media from a dedicated server to end-user devices via multiple apps. Jellyfin is descended from Emby's 3.5.2 release and ported to the .NET Core framework to enable full cross-platform support. There are no strings attached, no premium licenses or features, and no hidden agendas: just a team who want to build something better and work together to achieve it. We welcome anyone who is interested in joining us in our quest!"><meta data-rh="true" property="og:description" content="Jellyfin is a Free Software Media System that puts you in control of managing and streaming your media. It is an alternative to the proprietary Emby and Plex, to provide media from a dedicated server to end-user devices via multiple apps. Jellyfin is descended from Emby's 3.5.2 release and ported to the .NET Core framework to enable full cross-platform support. There are no strings attached, no premium licenses or features, and no hidden agendas: just a team who want to build something better and work together to achieve it. We welcome anyone who is interested in joining us in our quest!"><link data-rh="true" rel="icon" href="/images/favicon.ico"><link data-rh="true" rel="canonical" href="https://jellyfin.org/docs/"><link data-rh="true" rel="alternate" href="https://jellyfin.org/docs/" hreflang="en"><link data-rh="true" rel="alternate" href="https://jellyfin.org/docs/" hreflang="x-default"><link rel="alternate" type="application/rss+xml" href="/posts/rss.xml" title="Jellyfin RSS Feed"> <link rel="alternate" type="application/atom+xml" href="/posts/atom.xml" title="Jellyfin Atom Feed"><link rel="stylesheet" href="/assets/css/styles.b289673f.css"> <script src="/assets/js/runtime~main.fe24d00d.js" defer="defer"></script> <script src="/assets/js/main.289ea1e1.js" defer="defer"></script> </head> <body class="navigation-with-keyboard"> <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/images/logo.svg" alt="Jellyfin Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/images/logo.svg" alt="Jellyfin Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div></a></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link" href="/posts">Blog</a><a class="navbar__item navbar__link" href="/downloads">Downloads</a><a class="navbar__item navbar__link" href="/contribute">Contribute</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/">Documentation</a><a class="navbar__item navbar__link" href="/contact">Contact</a><a href="https://forum.jellyfin.org" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Forum<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="navbarSearchContainer_Bca1"><div class="navbar__search searchBarContainer_NW3z" dir="ltr"><input placeholder="Search" aria-label="Search" class="navbar__search-input searchInput_YFbd" value=""><div class="loadingRing_RJI3 searchBarLoadingRing_YnHq"><div></div><div></div><div></div><div></div></div></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" href="/docs/">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/general/quick-start/">Quick Start</a><button aria-label="Expand sidebar category 'Quick Start'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/general/getting-help">Getting Help</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/general/faq">FAQ</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/general/installation/">Installation</a><button aria-label="Expand sidebar category 'Installation'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/general/administration/backup-and-restore">Administration</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/general/networking/">Networking</a><button aria-label="Expand sidebar category 'Networking'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/general/server/devices">Server Guide</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/general/clients/">Clients</a><button aria-label="Expand sidebar category 'Clients'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/general/testing/">Testing</a><button aria-label="Expand sidebar category 'Testing'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/general/about">About Jellyfin</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/general/community-standards/">Community Standards</a><button aria-label="Expand sidebar category 'Community Standards'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/general/contributing/">Contributing</a><button aria-label="Expand sidebar category 'Contributing'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/general/style-guides/">Style Guides</a><button aria-label="Expand sidebar category 'Style Guides'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a href="https://api.jellyfin.org" target="_blank" rel="noopener noreferrer" class="menu__link menuExternalLink_NmtK">API Documentation<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Introduction</span><meta itemprop="position" content="1"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Welcome to the Jellyfin Documentation</h1></header> <p align="center"><a href="https://github.com/jellyfin/jellyfin"><img class="badge" alt="GPL 2.0 License" src="https://img.shields.io/github/license/jellyfin/jellyfin.svg"></a><a href="https://github.com/jellyfin/jellyfin/releases"><img class="badge" alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin.svg"></a><a href="https://translate.jellyfin.org/engage/jellyfin/?utm_source=widget"><img class="badge" alt="Translations" src="https://translate.jellyfin.org/widgets/jellyfin/-/svg-badge.svg"></a><a href="https://cloud.drone.io/jellyfin/jellyfin"><img class="badge" alt="Build Status" src="https://cloud.drone.io/api/badges/jellyfin/jellyfin/status.svg"></a><a href="https://hub.docker.com/r/jellyfin/jellyfin"><img class="badge" alt="Docker Pull Count" src="https://img.shields.io/docker/pulls/jellyfin/jellyfin.svg"></a><br><a href="https://jellyfin.org"><img class="badge" alt="Visit our Website" src="https://img.shields.io/website/http/jellyfin.org.svg?up_message=online&down_message=offline"></a><a href="https://forum.jellyfin.org"><img class="badge" alt="Join our Forum" src="https://img.shields.io/website/http/forum.jellyfin.org.svg?label=forum&up_message=online&down_message=offline"></a><a href="https://matrix.to/#/+jellyfin:matrix.org"><img class="badge" alt="Chat on Matrix" src="https://img.shields.io/matrix/jellyfin:matrix.org.svg?logo=matrix"></a><a href="https://opencollective.com/jellyfin"><img class="badge" alt="Donate" src="https://img.shields.io/opencollective/all/jellyfin.svg?label=backers"></a></p> <p>Jellyfin is a Free Software Media System that puts you in control of managing and streaming your media. It is an alternative to the proprietary Emby and Plex, to provide media from a dedicated server to end-user devices via multiple apps. Jellyfin is descended from Emby's 3.5.2 release and ported to the .NET Core framework to enable full cross-platform support. There are no strings attached, no premium licenses or features, and no hidden agendas: just a team who want to build something better and work together to achieve it. We welcome anyone who is interested in joining us in our quest!</p> <p>You can find a list of all available clients <a href="/downloads/clients">here</a>. For more information please see our <a href="/docs/general/about">about page</a> or the <a href="/docs/general/faq">FAQ</a>. If you are looking for help, check out <a href="/docs/general/getting-help">this page</a> for all the different communication channels we use.</p> <p>Note: Jellyfin is a fast-moving project that is in its early stages, and this documentation as well as the code may change frequently. Please check back often and do not hesitate to contact us via our Matrix channels or Forum!</p> <h2 class="anchor anchorWithStickyNavbar_LWe7" id="getting-started">Getting Started<a href="#getting-started" class="hash-link" aria-label="Direct link to Getting Started" title="Direct link to Getting Started"></a></h2> <p>Want to get starting using Jellyfin right now? Check out the pages below for how to <a href="/docs/general/installation">install Jellyfin</a> on your machine.</p> <ul> <li><a href="/docs/general/installation/linux#arch-linux">Arch</a></li> <li><a href="/docs/general/installation/linux#debian">Debian</a></li> <li><a href="/docs/general/installation/linux#ubuntu">Ubuntu</a></li> <li><a href="/docs/general/installation/linux#fedora">Fedora</a></li> <li><a href="/docs/general/installation/linux#centos">CentOS</a></li> <li><a href="/docs/general/installation/container#docker">Docker</a></li> <li><a href="/docs/general/installation/container#kubernetes">Kubernetes</a></li> <li><a href="/docs/general/installation/windows">Windows</a></li> <li><a href="/docs/general/installation/macos">MacOS</a></li> <li><a href="/docs/general/installation/linux#linux-generic-amd64">Generic Linux</a></li> </ul> <p>Alternatively, Jellyfin may be built directly from the <a href="/docs/general/installation/source">source code</a>.</p> <h2 class="anchor anchorWithStickyNavbar_LWe7" id="administrator-documentation">Administrator Documentation<a href="#administrator-documentation" class="hash-link" aria-label="Direct link to Administrator Documentation" title="Direct link to Administrator Documentation"></a></h2> <p>Want to know more about administering a Jellyfin server? Check out these pages!</p> <ul> <li><a href="/docs/general/quick-start">Quick-Start Guide</a>: What to do after you have installed Jellyfin to get it up and running.</li> <li><a href="/docs/general/administration/migrate">Migrating</a>: How to migrate Jellyfin.</li> <li><a href="/docs/general/administration/backup-and-restore">Backup and Restore</a>: How to back up or restore your Jellyfin metadata and configuration.</li> <li><a href="/docs/general/server/plugins">Plugins</a>: How to install and manage plugins.</li> <li><a href="/docs/general/networking">Networking</a>: Networking settings and troubleshooting.</li> <li><a href="/docs/general/networking/monitoring">Monitoring</a>: Integration with external monitoring software.</li> <li><a href="/docs/general/administration/hardware-acceleration">Hardware Acceleration</a>: Improve transcoding performance on supported hardware.</li> </ul> <h2 class="anchor anchorWithStickyNavbar_LWe7" id="contributing-to-jellyfin">Contributing to Jellyfin<a href="#contributing-to-jellyfin" class="hash-link" aria-label="Direct link to Contributing to Jellyfin" title="Direct link to Contributing to Jellyfin"></a></h2> <p>Want to help out? Check out the pages below for how to contribute.</p> <ul> <li><a href="/docs/general/contributing">Contribution Guide</a>: General information on contributing to Jellyfin.</li> <li><a href="https://github.com/jellyfin/jellyfin-plugin-template" target="_blank" rel="noopener noreferrer">Plugin Guide</a>: Documentation and resources to get started writing a plugin to extend Jellyfin functionality.</li> <li><a href="/docs/general/contributing/issues#reporting-bugs">Reporting Bugs</a>: How to use our issue tracker on GitHub to report bugs.</li> <li><a href="/docs/general/contributing/issues#requesting-features">Requesting Features</a>: How to use our issue tracker on GitHub to request new features or enhancements.</li> </ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/jellyfin/jellyfin.org/edit/master/docs/index.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--next" href="/docs/general/quick-start/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Quick Start</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#getting-started" class="table-of-contents__link toc-highlight">Getting Started</a></li><li><a href="#administrator-documentation" class="table-of-contents__link toc-highlight">Administrator Documentation</a></li><li><a href="#contributing-to-jellyfin" class="table-of-contents__link toc-highlight">Contributing to Jellyfin</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer"><div class="container container-fluid"><div class="footer__links text--center"><div class="footer__links"><a class="footer__link-item" href="/docs">Documentation</a><span class="footer__link-separator">·</span><a href="https://features.jellyfin.org" target="_blank" rel="noopener noreferrer" class="footer__link-item">Feature Requests</a><span class="footer__link-separator">·</span><a class="footer__link-item" href="/contribute">Contribute</a><span class="footer__link-separator">·</span><a href="https://status.jellyfin.org" target="_blank" rel="noopener noreferrer" class="footer__link-item">Status</a><span class="footer__link-separator">·</span><a class="footer__link-item" href="/contact">Contact</a></div></div><div class="footer__bottom text--center"><div class="margin-bottom--sm"><img src="/images/logo.svg" alt="Jellyfin Logo" class="footer__logo themedComponent_mlkZ themedComponent--light_NVdE" width="280" height="80"><img src="/images/logo.svg" alt="Jellyfin Logo" class="footer__logo themedComponent_mlkZ themedComponent--dark_xIcU" width="280" height="80"></div><div class="footer__copyright"><a href="https://github.com/jellyfin/jellyfin/releases/latest"> <img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin.svg"> </a> <br> Site content is licensed <a href="http://creativecommons.org/licenses/by-nd/4.0/">CC-BY-ND-4.0</a></div></div></div></footer></div> </body> </html>