Jellyfin

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 platform to enable full cross-platform support. For further details, please see our documentation page. To receive the latest updates, get help with Jellyfin, and join the community, please visit one of our communication channels. For more information about the project, please see our about page. Want to get started? Check out our downloads page or our installation guide , then see our quick start guide . You can also build from source . Want to contribute? Check out our contributing choose-your-own-adventure to see where you can help, then see our contributing guide and our community standards . Don't see Jellyfin in your language? Check out our Weblate instance to help translate Jellyfin and its subprojects. This repository contains the code for Jellyfin's backend server. Note that this is only one of many projects under the Jellyfin GitHub organization on GitHub. If you want to contribute, you can start by checking out our documentation to see what to work on. These instructions will help you get set up with a local development environment in order to contribute to this repository. Before you start, please be sure to completely read our guidelines on development contributions. Note that this project is supported on all major operating systems except FreeBSD, which is still incompatible. Before the project can be built, you must first install the .NET 10 SDK on your system. Instructions to run this project from the command line are included here, but you will also need to install an IDE if you want to debug the server while it is running. Any IDE that supports .NET 6 development will work, but two options are recent versions of Visual Studio (at least 2022) and Visual Studio Code. After dependencies have been installed you will need to clone a local copy of this repository. If you just want to run the server from source you can clone this repository directly, but if you are intending to contribute code changes to the project, you should set up your own fork of the repository. The following example shows how you can clone the repository directly over HTTPS. The server is configured to host the static files required for the web client in addition to serving the backend by default. Before you can run the server, you will need to get a copy of the web client since they are not included in this repository directly. Note that it is recommended for development to host the web client separately from the web server with some additional configuration, in which case you can skip this step. 1. Build them from source following the instructions on the jellyfin-web repository 2. Get the pre-built files from an existing installation of the server. For example, with a Windows server installation the client files are located at C: Program Files Jellyfin Server jellyfin-web The following instructions will help you get the project up and running via the command line, or your preferred IDE. To run the project with Visual Studio you can open the Solution ( .sln ) file and then press F5 to run the server. To run the project with Visual Studio Code you will first need to open the repository directory with Visual Studio Code using the Open Folder... option. Second, you need to install the recommended extensions for the workspace. Note that extension recommendations are classified as either "Workspace Recommendations" or "Other Recommendations", but only the "Workspace Recommendations" are required. After the required extensions are installed, you can run the server by pressing F5 . To run the server from the command line you can use the dotnet run command. The example below shows how to do this if you have cloned the repository