Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documenation updates #698

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions docs/general/administration/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,15 @@
4. `$XDG_DATA_HOME/jellyfin`, if `$XDG_DATA_HOME` exists
5. `$HOME/.local/share/jellyfin`

Specific system locations include:

- Arch/EndeavourOS/Manjaro: `/var/lib/jellyfin/data`
- Debian/Mint/Ubuntu: `/var/lib/jellyfin/data`
- Fedora/RHEL/Rocky/Alma/Oracle: `/var/lib/jellyfin/data`
- Flatpak: `~/.var/app/org.jellyfin.JellyfinServer/data/jellyfin/data`
- Gentoo: `/var/lib/jellyfin/data`
- Windows: `C:\ProgramData\Jellyfin\Server\data`

### Configuration Directory

This is the directory containing the server configuration files. It is set from the following sources in order of decreasing precedence.
Expand All @@ -41,6 +50,15 @@
4. `$XDG_CONFIG_HOME/jellyfin` if `$XDG_CONFIG_HOME` exists
5. `$HOME/.config/jellyfin`

Specific system locations include:

- Arch/EndeavourOS/Manjaro: `/var/lib/jellyfin/config`
- Debian/Mint/Ubuntu: `/etc/jellyfin`
- Fedora/RHEL/Rocky/Alma/Oracle: `/etc/jellyfin`
- Flatpak: `~/.var/app/org.jellyfin.JellyfinServer/config/jellyfin/`
- Gentoo: `/etc/jellyfin`
- Windows: `C:\ProgramData\Jellyfin\Server\config`

### Cache Directory

This is the directory containing the server cache. It is set from the following sources in order of decreasing precedence.
Expand All @@ -51,6 +69,15 @@
4. `$XDG_CACHE_HOME/jellyfin` if `$XDG_CACHE_HOME` exists
5. `$HOME/.cache/jellyfin`

Specific system locations include:

- Arch/EndeavourOS/Manjaro: `/var/cache/jellyfin`
- Debian/Mint/Ubuntu: `/var/cache/jellyfin`
- Fedora/RHEL/Rocky/Alma/Oracle: `/var/cache/jellyfin`
- Flatpak: `~/.var/app/org.jellyfin.JellyfinServer/cache`
- Gentoo: `/var/cache/jellyfin`
- Windows `C:\ProgramData\Jellyfin\Server\cache`

### 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.
Expand All @@ -59,12 +86,21 @@
2. Environment variable `$JELLYFIN_WEB_DIR`, if specified
3. `<Binary Directory>/jellyfin-web`, where `<Binary Directory>` is the directory containing the Jellyfin executable


Check failure on line 89 in docs/general/administration/configuration.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Multiple consecutive blank lines [Expected: 1; Actual: 2]
:::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.

:::

Specific system locations include:

- Arch/EndeavourOS/Manjaro: `/usr/share/jellyfin/web`
- Debian/Mint/Ubuntu: `/usr/share/jellyfin/web`
- Fedora/RHEL/Rocky/Alma/Oracle: `/usr/share/jellyfin-web`
- Gentoo: `/opt/jellyfin/jellyfin-web`
- Windows `C:\Program Files\Jellyfin\Server\jellyfin-web`

### 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.
Expand All @@ -73,6 +109,15 @@
2. Environment variable `$JELLYFIN_LOG_DIR`, if specified
3. `<Data Directory>/log`

Specific system locations include:

- Arch/EndeavourOS/Manjaro: `/var/lib/jellyfin/log`
- Debian/Mint/Ubuntu: `/var/log/jellyfin`
- Fedora/RHEL/Rocky/Alma/Oracle: `/var/log/jellyfin`
- Flatpak: `~/.var/app/org.jellyfin.JellyfinServer/data/jellyfin/log`
- Gentoo: `/var/log/jellyfin/`
- Windows: `C:\ProgramData\Jellyfin\Server\log`

Check failure on line 119 in docs/general/administration/configuration.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Trailing spaces [Expected: 0 or 2; Actual: 1]

## 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.
Expand Down
10 changes: 10 additions & 0 deletions docs/general/server/transcoding.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,13 @@
- Remux: Changes the container but leaves both audio and video streams untouched.
- Direct Stream: Transcodes audio but leaves original video untouched.
- Transcode: Transcodes the video stream.

## Transcoding Directories

Check failure on line 30 in docs/general/server/transcoding.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Transcoding Directories"]
The location of the transcoded files will depend on the system being used for the server. This is a non-exhaustive list of locations:

- Arch/EndeavourOS/Manjaro: `/var/lib/jellyfin/transcodes`
- Debian/Mint/Ubuntu: `/var/lib/jellyfin/transcodes`
- Fedora/RHEL/Rocky/Alma/Oracle: `/var/lib/jellyfin/transcodes`
- Flatpak: `~/.var/app/org.jellyfin.JellyfinServer/data/jellyfin/transcodes`
- Gentoo: `/var/lib/jellyfin/transcodes`
- Windows: `C:\ProgramData\Jellyfin\Server\transcodes`
Loading