Jellyfin

https://github.com/xolera3d/jellyfin
Admin
Jellyfin Server is the backend for a free software media system that manages and streams media to...
Tokens:4,501
Snippets:24
Trust Score:3.8
License:GPL-2.0
Update:1 year ago
Show doc for...
Tokens:
Raw
### Running Jellyfin Server Configurations

Source: https://github.com/xolera3d/jellyfin/blob/master/README.md

Details on different launch configurations for running the Jellyfin server in Codespaces. This includes options for a default development server and one with ffmpeg support, along with notes on accessing the instance and handling initial setup.

```shell
Launch Configuration: .NET Launch (nowebclient)
Launch Configuration: ghcs .NET Launch (nowebclient, ffmpeg)
Script Reference: .devcontainer/Dev - Server Ffmpeg/install.ffmpeg.sh
```

--------------------------------

### Build and Execute Jellyfin Server

Source: https://github.com/xolera3d/jellyfin/blob/master/README.md

Builds the Jellyfin project using 'dotnet build' and then runs the compiled executable. This method allows for easier addition of command-line options and provides flexibility across different operating systems.

```bash
dotnet build
cd Jellyfin.Server/bin/Debug/net9.0
# On Linux, Mac, etc. use ./jellyfin
# On Windows use jellyfin.exe
```

--------------------------------

### Install SharpFuzz.CommandLine

Source: https://github.com/xolera3d/jellyfin/blob/master/fuzz/README.md

Installs the SharpFuzz.CommandLine as a global .NET tool, which is a prerequisite for certain fuzzing operations.

```sh
dotnet tool install --global SharpFuzz.CommandLine
```

--------------------------------

### Running Jellyfin Tests

Source: https://github.com/xolera3d/jellyfin/blob/master/README.md

Instructions on how to execute the project's unit tests. Tests can be run from the command line using dotnet, or within Visual Studio and Visual Studio Code using their respective testing tools.

```shell
dotnet test
```

--------------------------------

### Clone Jellyfin Repository

Source: https://github.com/xolera3d/jellyfin/blob/master/README.md

Clones the Jellyfin project repository from GitHub using Git. This is the first step after ensuring all prerequisites are met.

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

--------------------------------

### Install AFL++

Source: https://github.com/xolera3d/jellyfin/blob/master/fuzz/README.md

Installs the AFL++ fuzzing tool by cloning the official repository, compiling the source code, and installing it globally.

```sh
git clone https://github.com/AFLplusplus/AFLplusplus
cd AFLplusplus
make all
sudo make install
```

--------------------------------

### Run Jellyfin Server from Command Line

Source: https://github.com/xolera3d/jellyfin/blob/master/README.md

Executes the Jellyfin server project directly from the command line using the 'dotnet run' command. It specifies the server's startup project and the path to the web client's distribution directory.

```bash
cd jellyfin
dotnet run --project Jellyfin.Server --webdir /absolute/path/to/jellyfin-web/dist
```

--------------------------------

### Hosting Web Client Separately

Source: https://github.com/xolera3d/jellyfin/blob/master/README.md

Configuration options to run the Jellyfin server without hosting the web client. This is useful for frontend developers or when hosting the client separately. It can be controlled via a command-line switch or an environment variable.

```shell
--nowebclient
JELLYFIN_NOWEBCONTENT=true
```

--------------------------------

### Jellyfin Server API Documentation

Source: https://github.com/xolera3d/jellyfin/blob/master/README.md

Provides access to the Jellyfin server's API documentation, typically available via a Swagger UI. This allows developers to explore and test the available API endpoints, methods, and data schemas.

```APIDOC
API Documentation:
  Access the API documentation at http://localhost:8096/api-docs/swagger/index.html

Server Base URL:
  http://localhost:8096
```

--------------------------------

### Example: Add SQLite EFCore Migration in Jellyfin

Source: https://github.com/xolera3d/jellyfin/blob/master/src/Jellyfin.Database/readme.md

An example command demonstrating how to add an EFCore migration specifically for the Jellyfin SQLite provider, specifying the project path and provider key.

```cmd
dotnet ef migrations add {MIGRATION_NAME} --project "src/Jellyfin.Database/Jellyfin.Database.Providers.Sqlite" -- --migration-provider Jellyfin-SQLite
```

--------------------------------

### Jellyfin Startup Status Message Logic

Source: https://github.com/xolera3d/jellyfin/blob/master/Jellyfin.Server/ServerSetupApp/index.mstemplate.html

This logic block dynamically displays the Jellyfin server's startup status. It shows an error icon and a specific message if the server is not starting (in reporting mode), or a waiting message if it is still starting.

```Templating
{{#IF isInReportingMode}} ❌ {{/IF}} Jellyfin Startup
{{^IF isInReportingMode}}
Jellyfin Server still starting. Please wait.
{{#ELSE}}
Jellyfin Server has encountered an error and was not able to start.
{{/ELSE}} {{/IF}}
```

--------------------------------

### Jellyfin Startup Page Reload Logic

Source: https://github.com/xolera3d/jellyfin/blob/master/Jellyfin.Server/ServerSetupApp/index.mstemplate.html

Implements a client-side timeout to automatically reload the page after a specified duration. This is used to refresh the startup status if the server is still in the process of starting.

```JavaScript
{{^IF isInReportingMode}} setTimeout(() => { window.location.reload(); }, {{ retryValue.TotalMilliseconds }}); {{/IF}}
```

--------------------------------

### Jellyfin Log File Download Link Logic

Source: https://github.com/xolera3d/jellyfin/blob/master/Jellyfin.Server/ServerSetupApp/index.mstemplate.html

Conditionally renders a link to download the startup log file. This link is only displayed if the request originates from the local network, providing access to detailed logs for troubleshooting.

```Templating
{{#IF localNetworkRequest}}

You can download the current log file [here](/startup/logger).

{{/IF}}
```

--------------------------------

### Restore project dependencies

Source: https://github.com/xolera3d/jellyfin/blob/master/src/Jellyfin.Database/readme.md

Command to run if 'dotnet tool restore' fails, ensuring project dependencies are restored.

```cmd
dotnet restore
```

--------------------------------

### Jellyfin Startup Page Styles

Source: https://github.com/xolera3d/jellyfin/blob/master/Jellyfin.Server/ServerSetupApp/index.mstemplate.html

Contains CSS rules for layout elements like flex containers, headers, and a custom tree-view component for displaying action lists. It also includes styling for status indicators like danger, warning, success, and info items.

```CSS
/* General styles for layout and header */
* { font-family: sans-serif; }
.flex-row { display: flex; flex-direction: row; flex-wrap: nowrap; justify-content: center; align-items: center; align-content: normal; }
.flex-col { display: flex; flex-direction: column; flex-wrap: nowrap; justify-content: center; align-items: center; align-content: normal; }
header { height: 5rem; width: 100%; }
header svg { height: 3rem; width: 9rem; margin-right: 1rem; }

/* Styles for the action list/tree view component */
.action-list { --spacing: 1.4rem; --radius: 14px; }
.action-list li { display: block; position: relative; padding-left: calc(2 * var(--spacing) - var(--radius) - 1px); }
.action-list ul { margin-left: calc(var(--radius) - var(--spacing)); padding-left: 0; }
.action-list ul li { border-left: 2px solid #ddd; }
.action-list ul li:last-child { border-color: transparent; }
.action-list ul li::before { content: ''; display: block; position: absolute; top: calc(var(--spacing) / -2); left: -2px; width: calc(var(--spacing) + 2px); height: calc(var(--spacing) + 1px); border: solid #ddd; border-width: 0 0 2px 2px; }
.action-list summary { display: block; cursor: pointer; }
.action-list summary::marker, .action-list summary::-webkit-details-marker { display: none; }
.action-list summary:focus { outline: none; }
.action-list summary:focus-visible { outline: 1px dotted #000; }
.action-list li::after, .action-list summary::before { content: ''; display: block; position: absolute; top: calc(var(--spacing) / 2 - var(--radius) + 4px); left: calc(var(--spacing) - var(--radius) - -5px); }
.action-list summary::before { z-index: 1; }
.action-list details[open]>summary::before { background-position: calc(-2 * var(--radius)) 0; }

/* Styles for status indicators */
.action-list li.danger-item::after, .action-list li.danger-strong-item::after { content: '❌'; }
ol.action-list li span.danger-strong-item { text-decoration-style: solid; text-decoration-color: red; text-decoration-line: underline; }
ol.action-list li.warn-item::after { content: '⚠️'; }
ol.action-list li.success-item::after { content: '✅'; }
ol.action-list li.info-item::after { content: '🔹'; }
```

--------------------------------

### Restore dotnet ef tool

Source: https://github.com/xolera3d/jellyfin/blob/master/src/Jellyfin.Database/readme.md

Command to run if the 'dotnet-ef' command is not found, ensuring the EF Core tools are available.

```cmd
dotnet tool restore
```

--------------------------------

### Jellyfin Log Entry Rendering Logic

Source: https://github.com/xolera3d/jellyfin/blob/master/Jellyfin.Server/ServerSetupApp/index.mstemplate.html

Defines a reusable template for rendering log entries, including their timestamp and content. It supports nested log entries (children) and reverses the order of children for display, creating a hierarchical log view.

```Templating
{{#DECLARE LogEntry |--}} {{#LET children = Children}}*   {{#IF children.Count > 0}} {{DateOfCreation}} - {{Content}}
    
    {{#EACH children.Reverse() |-}} {{#IMPORT 'LogEntry'}} {{#ELSE}} {{DateOfCreation}} - {{Content}} {{#ELSE}} {{#IF}} {{--| /DECLARE}} {{#IF localNetworkRequest}}

{{#FOREACH log IN logs.Reverse()}} {{#IMPORT 'LogEntry' #WITH log}} {{/FOREACH}}

{{#ELSE}}

Please visit this page from your local network to view detailed startup logs.

{{/ELSE}} {{/IF}}
```

--------------------------------

### Handle UnauthorizedAccessException for EFCore Migrations

Source: https://github.com/xolera3d/jellyfin/blob/master/src/Jellyfin.Database/readme.md

Instructions to resolve 'System.UnauthorizedAccessException' when running EFCore migrations, typically by using sudo for restore and migration commands.

```cmd
sudo dotnet restore
sudo dotnet ef migrations add {MIGRATION_NAME} --project "src/Jellyfin.Database/Jellyfin.Database.Providers.Sqlite" -- --migration-provider Jellyfin-SQLite
```

--------------------------------

### Add EFCore Migration for Specific Provider

Source: https://github.com/xolera3d/jellyfin/blob/master/src/Jellyfin.Database/readme.md

Command to add a new Entity Framework Core migration for a specific database provider. It requires the migration name, the project path, and the provider key.

```cmd
dotnet ef migrations add MIGRATION_NAME --project "PATH_TO_PROJECT" -- --provider PROVIDER_KEY
```

--------------------------------

### Jellyfin Studio Images Plugin Configuration

Source: https://github.com/xolera3d/jellyfin/blob/master/MediaBrowser.Providers/Plugins/StudioImages/Configuration/config.html

Handles the loading and saving of the Studio Images repository URL for a Jellyfin plugin. It uses the Jellyfin API to fetch and update plugin configuration settings, responding to page load and form submission events.

```javascript
var PluginConfig = { pluginId: "872a7849-1171-458d-a6fb-3de3d442ad30" };
document.querySelector('.configPage')
  .addEventListener('pageshow', function () {
    Dashboard.showLoadingMsg();
    ApiClient.getPluginConfiguration(PluginConfig.pluginId).then(function (config) {
      var repository = document.querySelector('#repository');
      repository.value = config.RepositoryUrl;
      repository.dispatchEvent(new Event('change', { bubbles: true, cancelable: false }));
      Dashboard.hideLoadingMsg();
    });
  });

document.querySelector('.configForm')
  .addEventListener('submit', function (e) {
    Dashboard.showLoadingMsg();
    ApiClient.getPluginConfiguration(PluginConfig.pluginId).then(function (config) {
      config.RepositoryUrl = document.querySelector('#repository').value;
      ApiClient.updatePluginConfiguration(PluginConfig.pluginId, config).then(Dashboard.processPluginConfigurationUpdateResult);
    });
    e.preventDefault();
    return false;
  });
```

--------------------------------

### MusicBrainz Plugin Configuration UI Logic

Source: https://github.com/xolera3d/jellyfin/blob/master/MediaBrowser.Providers/Plugins/MusicBrainz/Configuration/config.html

Handles the loading and saving of MusicBrainz plugin configuration settings within the Jellyfin dashboard. It fetches current settings on page load and updates them when the form is submitted, using the ApiClient to interact with the plugin's backend.

```javascript
var MusicBrainzPluginConfig = { uniquePluginId: "8c95c4d2-e50c-4fb0-a4f3-6c06ff0f9a1a" };

document.querySelector('.configPage')
  .addEventListener('pageshow', function () {
    Dashboard.showLoadingMsg();
    ApiClient.getPluginConfiguration(MusicBrainzPluginConfig.uniquePluginId).then(function (config) {
      var server = document.querySelector('#server');
      server.value = config.Server;
      server.dispatchEvent(new Event('change', { bubbles: true, cancelable: false }));
      var rateLimit = document.querySelector('#rateLimit');
      rateLimit.value = config.RateLimit;
      rateLimit.dispatchEvent(new Event('change', { bubbles: true, cancelable: false }));
      document.querySelector('#replaceArtistName').checked = config.ReplaceArtistName;
      Dashboard.hideLoadingMsg();
    });
  });

document.querySelector('.configForm')
  .addEventListener('submit', function (e) {
    Dashboard.showLoadingMsg();
    ApiClient.getPluginConfiguration(MusicBrainzPluginConfig.uniquePluginId).then(function (config) {
      config.Server = document.querySelector('#server').value;
      config.RateLimit = document.querySelector('#rateLimit').value;
      config.ReplaceArtistName = document.querySelector('#replaceArtistName').checked;
      ApiClient.updatePluginConfiguration(MusicBrainzPluginConfig.uniquePluginId, config).then(Dashboard.processPluginConfigurationUpdateResult);
    });
    e.preventDefault();
    return false;
  });
```

--------------------------------

### Configure Jellyfin TMDb Plugin Settings

Source: https://github.com/xolera3d/jellyfin/blob/master/MediaBrowser.Providers/Plugins/Tmdb/Configuration/config.html

This JavaScript code handles the client-side configuration for the Jellyfin TMDb plugin. It fetches client configuration for image sizes and plugin-specific settings, updates UI elements, and saves changes via API calls.

```JavaScript
var PluginConfig = { pluginId: "b8715ed1-6c47-4528-9ad3-f72deb539cd4" };
document.querySelector('.configPage')
 .addEventListener('pageshow', function () {
 Dashboard.showLoadingMsg();
 var clientConfig, pluginConfig;

 var configureImageScaling = function() {
 if (clientConfig === undefined || pluginConfig === undefined) {
 return;
 }
 if (Object.keys(clientConfig).length === 0) {
 clientConfig = {
 PosterSizes: [pluginConfig.PosterSize],
 BackdropSizes: [pluginConfig.BackdropSize],
 LogoSizes: [pluginConfig.LogoSize],
 ProfileSizes: [pluginConfig.ProfileSize],
 StillSizes: [pluginConfig.StillSize]
 };
 }

 var sizeOptionsGenerator = function (size) {
 return '<option value="' + size + '">' + size + '</option>';
 }

 var selPosterSize = document.querySelector('#selectPosterSize');
 selPosterSize.innerHTML = clientConfig.PosterSizes.map(sizeOptionsGenerator);
 selPosterSize.value = pluginConfig.PosterSize;

 var selBackdropSize = document.querySelector('#selectBackdropSize');
 selBackdropSize.innerHTML = clientConfig.BackdropSizes.map(sizeOptionsGenerator);
 selBackdropSize.value = pluginConfig.BackdropSize;

 var selLogoSize = document.querySelector('#selectLogoSize');
 selLogoSize.innerHTML = clientConfig.LogoSizes.map(sizeOptionsGenerator);
 selLogoSize.value = pluginConfig.LogoSize;

 var selProfileSize = document.querySelector('#selectProfileSize');
 selProfileSize.innerHTML = clientConfig.ProfileSizes.map(sizeOptionsGenerator);
 selProfileSize.value = pluginConfig.ProfileSize;

 var selStillSize = document.querySelector('#selectStillSize');
 selStillSize.innerHTML = clientConfig.StillSizes.map(sizeOptionsGenerator);
 selStillSize.value = pluginConfig.StillSize;

 Dashboard.hideLoadingMsg();
 }

 const request = {
 url: ApiClient.getUrl('tmdb/ClientConfiguration'),
 dataType: 'json',
 type: 'GET',
 headers: { accept: 'application/json' }
 }

 ApiClient.fetch(request).then(function (config) {
 clientConfig = config;
 configureImageScaling();
 }, function (error) {
 error.text().then(function (contents) {
 Dashboard.alert({ title: error.statusText, message: contents });
 clientConfig = {};
 configureImageScaling();
 });
 });

 ApiClient.getPluginConfiguration(PluginConfig.pluginId).then(function (config) {
 document.querySelector('#includeAdult').checked = config.IncludeAdult;
 document.querySelector('#excludeTagsSeries').checked = config.ExcludeTagsSeries;
 document.querySelector('#excludeTagsMovies').checked = config.ExcludeTagsMovies;
 document.querySelector('#importSeasonName').checked = config.ImportSeasonName;
 document.querySelector('#hideMissingCastMembers').checked = config.HideMissingCastMembers;
 document.querySelector('#hideMissingCrewMembers').checked = config.HideMissingCrewMembers;

 var maxCastMembers = document.querySelector('#maxCastMembers');
 maxCastMembers.value = config.MaxCastMembers;
 maxCastMembers.dispatchEvent(new Event('change', { bubbles: true, cancelable: false }));

 var maxCrewMembers = document.querySelector('#maxCrewMembers');
 maxCrewMembers.value = config.MaxCrewMembers;
 maxCrewMembers.dispatchEvent(new Event('change', { bubbles: true, cancelable: false }));

 pluginConfig = config;
 configureImageScaling();
 });
 });

 document.querySelector('.configForm')
 .addEventListener('submit', function (e) {
 Dashboard.showLoadingMsg();
 ApiClient.getPluginConfiguration(PluginConfig.pluginId).then(function (config) {
 config.IncludeAdult = document.querySelector('#includeAdult').checked;
 config.ExcludeTagsSeries = document.querySelector('#excludeTagsSeries').checked;
 config.ExcludeTagsMovies = document.querySelector('#excludeTagsMovies').checked;
 config.ImportSeasonName = document.querySelector('#importSeasonName').checked;
 config.MaxCastMembers = document.querySelector('#maxCastMembers').value;
 config.MaxCrewMembers = document.querySelector('#maxCrewMembers').value;
 config.HideMissingCastMembers = document.querySelector('#hideMissingCastMembers').checked;
 config.HideMissingCrewMembers = document.querySelector('#hideMissingCrewMembers').checked;
 config.PosterSize = document.querySelector('#selectPosterSize').value;
 config.BackdropSize = document.querySelector('#selectBackdropSize').value;
 config.LogoSize = document.querySelector('#selectLogoSize').value;
 config.ProfileSize = document.querySelector('#selectProfileSize').value;
 config.StillSize = document.querySelector('#selectStillSize').value;

 ApiClient.updatePluginConfiguration(PluginConfig.pluginId, config).then(Dashboard.processPluginConfigurationUpdateResult);
 });
 e.preventDefault();
 return false;
 });
```

--------------------------------

### Jellyfin TheAudioDB Plugin Configuration

Source: https://github.com/xolera3d/jellyfin/blob/master/MediaBrowser.Providers/Plugins/AudioDb/Configuration/config.html

Handles loading and saving plugin configuration for the Jellyfin TheAudioDB integration. It fetches current settings on page load and updates them when the form is submitted, specifically managing the 'ReplaceAlbumName' option.

```javascript
var PluginConfig = { pluginId: "a629c0da-fac5-4c7e-931a-7174223f14c8" };
document.querySelector('.configPage')
  .addEventListener('pageshow', function () {
    Dashboard.showLoadingMsg();
    ApiClient.getPluginConfiguration(PluginConfig.pluginId).then(function (config) {
      document.querySelector('#replaceAlbumName').checked = config.ReplaceAlbumName;
      Dashboard.hideLoadingMsg();
    });
  });
document.querySelector('.configForm')
  .addEventListener('submit', function (e) {
    Dashboard.showLoadingMsg();
    ApiClient.getPluginConfiguration(PluginConfig.pluginId).then(function (config) {
      config.ReplaceAlbumName = document.querySelector('#replaceAlbumName').checked;
      ApiClient.updatePluginConfiguration(PluginConfig.pluginId, config).then(Dashboard.processPluginConfigurationUpdateResult);
    });
    e.preventDefault();
    return false;
  });
```

--------------------------------

### Jellyfin OMDb Plugin Configuration

Source: https://github.com/xolera3d/jellyfin/blob/master/MediaBrowser.Providers/Plugins/Omdb/Configuration/config.html

This JavaScript code handles the configuration of a Jellyfin plugin for OMDb integration. It listens for page load events to display the current 'CastAndCrew' setting and handles form submission to update the plugin configuration, saving the user's preference for fetching cast and crew data.

```javascript
var PluginConfig = { pluginId: "a628c0da-fac5-4c7e-9d1a-7134223f14c8" };
document.querySelector('.configPage')
  .addEventListener('pageshow', function () {
    Dashboard.showLoadingMsg();
    ApiClient.getPluginConfiguration(PluginConfig.pluginId).then(function (config) {
      document.querySelector('#castAndCrew').checked = config.CastAndCrew;
      Dashboard.hideLoadingMsg();
    });
  });
document.querySelector('.configForm')
  .addEventListener('submit', function (e) {
    Dashboard.showLoadingMsg();
    ApiClient.getPluginConfiguration(PluginConfig.pluginId).then(function (config) {
      config.CastAndCrew = document.querySelector('#castAndCrew').checked;
      ApiClient.updatePluginConfiguration(PluginConfig.pluginId, config).then(Dashboard.processPluginConfigurationUpdateResult);
    });
    e.preventDefault();
    return false;
  });
```
Tokens:
Raw