The Free Software Media System

BaronGreenback ec245dce90 Merge branch 'master' into NetworkPR2 4 yıl önce
.ci d9ea1ac12d disable two more tasks to fix the failures 4 yıl önce
.copr 6028bc0f79 Port Fedora and CentOS builds and remove web build 5 yıl önce
.github 1730b0ae83 Update dependabot.yml 5 yıl önce
.vscode c912093579 Created a separate API Docs profile to launch the browser at the API docs, and the nowebclient profile no longer launches the browser at all. 4 yıl önce
DvdLib 98db8f72e0 fix SA1503 for one line if statements 5 yıl önce
Emby.Dlna ec245dce90 Merge branch 'master' into NetworkPR2 4 yıl önce
Emby.Drawing 1f5ac19346 Merge pull request #3954 from Ullmie02/library-pictures 4 yıl önce
Emby.Naming 74f4affcda Fix AudioBookListResolver test coverage 4 yıl önce
Emby.Notifications ca1f15af19 Move GenericEventArgs to Jellyfin.Data.Events 5 yıl önce
Emby.Photos 403cd3205f Merge pull request #3254 from crobibero/ilogger 5 yıl önce
Emby.Server.Implementations ec245dce90 Merge branch 'master' into NetworkPR2 4 yıl önce
Jellyfin.Api ec245dce90 Merge branch 'master' into NetworkPR2 4 yıl önce
Jellyfin.Data f998e52107 Update to dotnet 3.1.9 4 yıl önce
Jellyfin.Drawing.Skia 1f5ac19346 Merge pull request #3954 from Ullmie02/library-pictures 4 yıl önce
Jellyfin.Networking f06e4826c7 Fixed testing units 4 yıl önce
Jellyfin.Server ec245dce90 Merge branch 'master' into NetworkPR2 4 yıl önce
Jellyfin.Server.Implementations ec245dce90 Merge branch 'master' into NetworkPR2 4 yıl önce
MediaBrowser.Common ec245dce90 Merge branch 'master' into NetworkPR2 4 yıl önce
MediaBrowser.Controller ec245dce90 Merge branch 'master' into NetworkPR2 4 yıl önce
MediaBrowser.LocalMetadata ef49e2b21c Fix nullable string usage. 5 yıl önce
MediaBrowser.MediaEncoding 84fd5a0953 Fix frame rate probing for interlaced MKV files 4 yıl önce
MediaBrowser.Model ec245dce90 Merge branch 'master' into NetworkPR2 4 yıl önce
MediaBrowser.Providers 6205fb4b6a Merge pull request #4341 from Bond-009/minor6 4 yıl önce
MediaBrowser.XbmcMetadata d4092846e4 Optimize Substring and StringBuilder usage 5 yıl önce
RSSDP 83af636c61 Updated with new NetManager 4 yıl önce
apiclient 60c0cc1d1c Fix feed name and url 4 yıl önce
benches 6183b83b18 Update benches project to correct target framework 5 yıl önce
debian 0bcf4c02b4 Remove jellyfin-ffmpeg dep from server package 4 yıl önce
deployment f998e52107 Update to dotnet 3.1.9 4 yıl önce
fedora 88bc2fa3ec Just make everything under libdir/jf a wildcard 4 yıl önce
hooks 26e2ffdd31 Checkout submodules in Docker Hub hook 6 yıl önce
tests ec245dce90 Merge branch 'master' into NetworkPR2 4 yıl önce
.dockerignore 8055b70ab1 Fixed full pipeline, runs correctly now with `drone exec` 6 yıl önce
.drone.yml 4cc4d57a78 Disable the Drone CI ABI check 6 yıl önce
.editorconfig 151182b9a9 Fix settings in editorconfig file 5 yıl önce
.gitattributes 531642fc53 Improve gitattributes for images 5 yıl önce
.gitignore 320e3b98ab Add ci task to publish api client 4 yıl önce
.npmrc 354e15a5f2 Fix .npmrc 4 yıl önce
CONTRIBUTORS.md f314be9d85 chore(CONTRIBUTORS.md): add skyfrk 4 yıl önce
Dockerfile 583f47ea28 Remove GenerateDocumentationFile 4 yıl önce
Dockerfile.arm 583f47ea28 Remove GenerateDocumentationFile 4 yıl önce
Dockerfile.arm64 583f47ea28 Remove GenerateDocumentationFile 4 yıl önce
LICENSE cc28782707 Remove incorrect .md suffix from LICENSE file 6 yıl önce
MediaBrowser.sln 83af636c61 Updated with new NetManager 4 yıl önce
MediaBrowser.sln.GhostDoc.xml c5430f86b0 Fixed csproj and xml identation. 6 yıl önce
README.md 2274aa30ce Correct typo 4 yıl önce
SharedVersion.cs a511e0ac0b Bump master version to 10.7.0 for next release 5 yıl önce
build f9cecfc0fb Add new build.sh script and symlink 5 yıl önce
build.sh c689bf457c Correct dpkg conditional logic 5 yıl önce
build.yaml a511e0ac0b Bump master version to 10.7.0 for next release 5 yıl önce
bump_version bcdae0c5a7 Use array, remove VS code line 4 yıl önce
jellyfin.code-workspace 742bef5b5f EditorConfig reformat: Non-CS files. 6 yıl önce
jellyfin.ruleset 94fe9b8f6d Merge branch 'master' into warn17 5 yıl önce
nuget.config fe11fb0a63 Add NuGet config file 5 yıl önce

README.md

Jellyfin

The Free Software Media System


Logo Banner

GPL 2.0 License Current Release Translation Status Azure Builds Docker Pull Count

Donate Submit Feature Requests Discuss on our Forum Chat on Matrix Join our Subreddit Release RSS Feed Master Commits RSS Feed


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!

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.

Something not working right?
Open an Issue on GitHub.

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.

New idea or improvement?
Check out our feature request hub.

Don't see Jellyfin in your language?
Check out our Weblate instance to help translate Jellyfin and its subprojects.

Detailed Translation Status

Jellyfin Server

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.

Server Development

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.

Prerequisites

Before the project can be built, you must first install the .NET Core 3.1 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 Core development will work, but two options are recent versions of Visual Studio (at least 2017) and Visual Studio Code.

Cloning the Repository

After dependencies are 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.

git clone https://github.com/jellyfin/jellyfin.git

Installing the Web Client

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 also possible to host the web client separately from the web server with some additional configuration, in which case you can skip this step.

There are three options to get the files for the web client.

  1. Download one of the finished builds from the Azure DevOps pipeline. You can download the build for a specific release by looking at the branches tab of the pipelines page.
  2. Build them from source following the instructions on the jellyfin-web repository
  3. 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

Once you have a copy of the built web client files, you need to copy them into a specific directory.

<repository root>/Mediabrowser.WebDashboard/jellyfin-web

As part of the build process, this folder will be copied to the build output directory, where it can be accessed by the server.

Running The Server

The following instructions will help you get the project up and running via the command line, or your preferred IDE.

Running With Visual Studio

To run the project with Visual Studio you can open the Solution (.sln) file and then press F5 to run the server.

Running With Visual Studio Code

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.

Running From The Command Line

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 into a directory named jellyfin (the default directory name) and should work on all operating systems.

cd jellyfin                          # Move into the repository directory
dotnet run --project Jellyfin.Server # Run the server startup project

A second option is to build the project and then run the resulting executable file directly. When running the executable directly you can easily add command line options. Add the --help flag to list details on all the supported command line options.

  1. Build the project

    dotnet build                # Build the project
    cd bin/Debug/netcoreapp3.1  # Change into the build output directory
    
  2. Execute the build output. On Linux, Mac, etc. use ./jellyfin and on Windows use jellyfin.exe.

Running The Tests

This repository also includes unit tests that are used to validate functionality as part of a CI pipeline on Azure. There are several ways to run these tests.

  1. Run tests from the command line using dotnet test
  2. Run tests in Visual Studio using the Test Explorer
  3. Run individual tests in Visual Studio Code using the associated CodeLens annotation

Advanced Configuration

The following sections describe some more advanced scenarios for running the server from source that build upon the standard instructions above.

Hosting The Web Client Separately

It is not necessary to host the frontend web client as part of the backend server. Hosting these two components separately may be useful for frontend developers who would prefer to host the client in a separate webpack development server for a tighter development loop. See the jellyfin-web repo for instructions on how to do this.

To instruct the server not to host the web content, there is a nowebclient configuration flag that must be set. This can specified using the command line switch --nowebclient or the environment variable JELLYFIN_NOWEBCONTENT=true.

Since this is a common scenario, there is also a separate launch profile defined for Visual Studio called Jellyfin.Server (nowebcontent) that can be selected from the 'Start Debugging' dropdown in the main toolbar.

NOTE: The setup wizard can not be run if the web client is hosted separately.