merge branch master into Artiume-patch-1

Author: dkanada

.ci/azure-pipelines.yml

@@ -17,6 +17,18 @@ jobs:
       submodules: true
       persistCredentials: true
 
+    - task: CmdLine@2
+      displayName: "Install Markdownlint CLI"
+      inputs:
+        script: 'npm install markdownlint-cli'
+        workingDirectory: '$(Build.SourcesDirectory)'
+
+    - task: CmdLine@2
+      displayName: "Run Markdownlint"
+      inputs:
+        script: 'npx markdownlint **/*.md --ignore node_modules --ignore src'
+        workingDirectory: '$(Build.SourcesDirectory)'
+
     - task: CmdLine@2
       displayName: "Update Submodules"
       inputs:

.markdownlint.yml

@@ -0,0 +1,15 @@
+---
+# MD013/line-length
+MD013: false
+# MD033/no-inline-html
+MD033: false
+# MD025/single-title
+MD025:
+    # Ignore front matter 'title' property, it is not used in generated markup
+    front_matter_title: ""
+# MD026/no-trailing-punctuation
+MD026:
+    # Allow headings to end with '?'
+    punctuation: ".,;:!"
+# MD028/no-blanks-blockquote
+MD028: false

.vscode/extensions.json

@@ -0,0 +1,13 @@
+{
+	// See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+	// Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+
+	// List of extensions which should be recommended for users of this workspace.
+	"recommendations": [
+		"davidanson.vscode-markdownlint"
+	],
+	// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+	"unwantedRecommendations": [
+		
+	]
+}

README.md

@@ -1,9 +1,10 @@
+<!-- markdownlint-disable MD041 first-line-heading -->
 <h1 align="center">Jellyfin Documentation</h1>
 <h3 align="center">Part of the <a href="https://jellyfin.media">Jellyfin Project</a></h3>
 
 This repository houses all documentation for Jellyfin available at [jellyfin.org](https://docs.jellyfin.org/) and written in markdown.
 
-# Contributing
+## Getting Started
 
 The site is built with [DocFX](https://dotnet.github.io/docfx/) using [DocFX Flavored Markdown](https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html). See the content section [here](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html) for a quick tutorial on DocFX.
 
@@ -23,7 +24,20 @@ Next, you will need to install DocFx as a [command line tool](https://dotnet.git
 docfx --serve
 ```
 
-This will build the site and start up a development server to test out your changes available at http://localhost:8080.
+This will build the site and start up a development server to test out your changes available at <http://localhost:8080>.
+
+### Linting
+
+This repository is configured to use [markdownlint](https://github.com/DavidAnson/markdownlint/) for linting Markdown files.
+
+If you are editing files within Visual Studio Code, you can install the markdownlint [extension](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) to see the linting errors as you work.
+
+You can also easily run the linter manually using the associated markdownlint [CLI](https://github.com/igorshubovych/markdownlint-cli).
+
+```bash
+npm install -g markdownlint-cli
+markdownlint **/*.md --ignore node_modules --ignore src
+```
 
 # Layout
 

general/about.md

@@ -13,7 +13,7 @@ The Jellyfin project was started in early December 2018 as a result of Emby's de
 
 You can find our main repository on [GitHub](https://github.com/jellyfin/jellyfin) as well as our [organization](https://github.com/jellyfin) page.
 
-# Core Team
+## Core Team
 
 [Andrew Rabert (nvllsvm)](https://github.com/nvllsvm)<br/>
 [Joshua Boniface (joshuaboniface)](https://github.com/joshuaboniface)<br/>

general/administration/building.md

@@ -2,6 +2,7 @@
 uid: admin-building
 title: Building from Source
 ---
+<!-- markdownlint-disable MD029 ol-prefix -->
 
 # Source
 
@@ -12,24 +13,28 @@ Jellyfin supports several methods of building for different platforms and instru
 All package builds begin with these two steps:
 
 1. Clone the repository:
+
     ```sh
     git clone https://github.com/jellyfin/jellyfin.git
     cd jellyfin
     ```
 
 2. Initialize the submodules:
+
     ```sh
     git submodule update --init
     ```
 
 ## Docker
 
 3. Build the Docker image:
+
     ```sh
     docker build -t $USERNAME/jellyfin .
     ```
 
 4. Run the container:
+
     ```sh
     docker run -d -p 8096:8096 $USERNAME/jellyfin
     ```
@@ -51,14 +56,16 @@ All package builds begin with these two steps:
 
 ## Windows
 
-3. Install the dotnet core SDK 2.2 from [Microsoft's Website](https://dotnet.microsoft.com/download/dotnet-core/2.2) and [install Git for Windows](https://gitforwindows.org/). You must be on Powershell 3 or higher.
+3. Install the dotnet core SDK 3.1 from [Microsoft's Website](https://dotnet.microsoft.com/download/dotnet-core/3.1) and [install Git for Windows](https://gitforwindows.org/). You must be on Powershell 3 or higher.
 
 4. From Powershell set the execution policy to unrestricted:
+
     ```powershell
     set-executionpolicy unrestricted
     ```
 
 5. Run the Jellyfin build script:
+
     ```powershell
     deployment\windows\build-jellyfin.ps1 -verbose
     ```
@@ -76,11 +83,13 @@ All package builds begin with these two steps:
 7. Jellyfin is now available in the default directory (or the directory you chose). Assuming you kept the default directory:
 
     * To start it from a Powershell window, run:
+
         ```powershell
         &"$env:APPDATA\Jellyfin-Server\jellyfin.exe"
         ```
 
     * To start it from CMD, run:
+
         ```cmd
         %APPDATA%\Jellyfin-Server\jellyfin.exe
         ```

general/administration/configuration.md

@@ -0,0 +1,98 @@
+---
+uid: admin-configuration
+title: Configuration
+---
+
+# Configuration
+
+There are several entry points available for administrators to manage the configuration of their server. This section aims to outline all those configuration methods, explain what options are available, and what each option does.
+
+> [!NOTE]
+> The configuration options here are distinct from the [runtime settings](xref:server-settings) available from the Administrator Dashboard in the web client. The configuration options here are generally meant to be static and set before starting the server.
+
+## Command Line Options
+
+Documentation for the available command line options can be obtained by adding the `--help` flag when running the Jellyfin executable.
+
+## Server Paths
+
+The file paths used by the server are determined according the rules outline below. In general, the [XDG specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) is followed by default for non-Windows systems.
+
+### Data Directory
+
+This is the directory that will hold all Jellyfin data, and is also used as a default base directory for some other paths below. It is set from the following sources in order of decreasing precedence.
+
+1. Command line option `--datadir`, if specified
+2. Environment variable `JELLYFIN_DATA_DIR`, if specified
+3. `<%APPDATA%>/jellyfin`, if running on Windows
+4. `$XDG_DATA_HOME/jellyfin`, if `$XDG_DATA_HOME` exists
+5. `$HOME/.local/share/jellyfin`
+
+### Configuration Directory
+
+This is the directory containing the server configuration files. It is set from the following sources in order of decreasing precedence.
+
+1. Command line option `--configdir`, if specified
+2. Environment variable `JELLYFIN_CONFIG_DIR`, if specified
+3. `<Data Directory>/config`, if it exists or if running on Windows
+4. `$XDG_CONFIG_HOME/jellyfin` if `$XDG_CONFIG_HOME` exists
+5. `$HOME/.config/jellyfin`
+
+### Cache Directory
+
+This is the directory containing the server cache. It is set from the following sources in order of decreasing precedence.
+
+1. Command line option `--cachedir`, if specified
+2. Environment variable `$JELLYFIN_CACHE_DIR`, if specified
+3. `<Data Directory>/cache`, if Windows
+4. `$XDG_CACHE_HOME/jellyfin` if `$XDG_CACHE_HOME` exists
+5. `$HOME/.cache/jellyfin`
+
+### Web Directory
+
+This is the directory containing the built files from a [web client](https://github.com/jellyfin/jellyfin-web) release. It is set from the following sources in order of decreasing precedence.
+
+1. Command line option `--webdir`, if specified
+2. Environment variable `$JELLYFIN_WEB_DIR`, if specified
+3. `<Binary Directory>/jellyfin-web`, where `<Binary Directory>` is the directory containing the Jellyfin executable
+
+> [!NOTE]
+> This setting is only used when the server is configured to host the web client. See the `hostwebclient` option in the [Main Configuration Options](#main-configuration-options) section below for additional details.
+
+### Log Directory
+
+This is the directory where the Jellyfin logs will be stored. It is set from the following sources in order of decreasing precedence.
+
+1. Command line option `--logdir`, if specified
+2. Environment variable `$JELLYFIN_LOG_DIR`, if specified
+3. `<Data Directory>/log`
+
+## Main Configuration
+
+The main server configuration is built upon the ASP .NET [configuration framework](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration/?view=aspnetcore-3.1), which provides a tiered approach to loading configuration. The base directory to locate the configuration files is set using the [configuration directory](#configuration-directory) setting. The configuration sources are as follows, with later sources having higher priority and overwriting the values in earlier sources.
+
+1. **Hard-coded default values**: These defaults are specified specified in the Jellyfin [source code](https://github.com/jellyfin/jellyfin/blob/master/Emby.Server.Implementations/ConfigurationOptions.cs) and cannot be changed.
+2. **Default logging configuration file** (`logging.default.json`): This file should not be modified manually by users. It is reserved by the server to be overwritten with new settings on each new release.
+3. **System-specific logging configuration file** (`logging.json`): This is the file you should change if you want to have a custom logging setup. Jellyfin uses the [Serilog](https://serilog.net/) logging framework, and you can read about the configuration options available in their [documentation](https://github.com/serilog/serilog-settings-configuration).
+
+   > [!NOTE]
+   > This file can be changed at runtime, which will automatically reload the configuration and apply the changes immediately.
+
+4. **Environment variables**: The [documentation](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration/?view=aspnetcore-3.1#environment-variables) provided by Microsoft explains how to set these configuration options via environment variables. Jellyfin uses its own custom `JELLYFIN_` prefix for these variables. For example, to set a value for the `HttpListenerHost:DefaultRedirectPath` setting, you would set a value for the `JELLYFIN_HttpListenerHost__DefaultRedirectPath` environment variable.
+5. **Command line options**: Certain command line options are loaded into the configuration system and have the highest priority. The following command line options are mapped to associated configuration options.
+
+    - `--nowebcontent` sets the `hostwebclient` configuration setting to false
+    - `--plugin-manifest-url` sets a value for the `InstallationManager:PluginManifestUrl` configuration setting
+
+### Main Configuration Options
+
+This section lists all the configuration options available and explains their function.
+
+|Key|Default Value|Description|
+|---|-------------|-----------|
+|`hostwebclient`|`True`|Set to `True` if the server should host the web client.|
+|`HttpListenerHost:DefaultRedirectPath`|`"web/index.html"` if `hostwebclient` is true; `"swagger/index.html"` if `hostwebclient` is false|The default redirect path to use for requests where the URL base prefix is invalid or missing|
+|`InstallationManager:PluginManifestUrl`|`"https://repo.jellyfin.org/releases/plugin/manifest.json"`|The URL for the plugin repository JSON manifest.|
+|`FFmpeg:probesize`|`"1G"`|Value to set for the FFmpeg `probesize` format option. See the FFmpg [documentation](https://ffmpeg.org/ffmpeg-formats.html#Format-Options) for more details.|
+|`FFmpeg:analyzeduration`|`"200M"`|The value to set for the FFmpeg `analyzeduration` format option. See the FFmpg [documentation](https://ffmpeg.org/ffmpeg-formats.html#Format-Options) for more details.|
+|`playlists:allowDuplicates`|`True`|Whether playlists should allow duplicate items or automatically filter out duplicates.|