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.

Sign up for GitHub

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

Jump to bottom

reorganize linux installation into categories #1145

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

reorganize linux installation into categories #1145

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
154 changes: 81 additions & 73 deletions docs/general/installation/linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,58 @@ description: Install on Linux.
sidebar_position: 2
---

## Alpine Linux
## Official Methods
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer "Officially Supported Distributions" as the sections are listed in distributions

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm using this phrase because I plan to add a link to docker instructions to this section in a future PR


### Debuntu (Debian, Ubuntu, and derivatives using `apt`) with official repository

The Jellyfin team provides 3rd-party Debian and Ubuntu repositories, to help ensure your Jellyfin install is always kept up-to-date.

#### Repository (Automatic)

To simplify deployment and help automate this for as many users as possible, we provide a BASH script to handle repo installation as well as installing Jellyfin.
All you need to do is run this command on your system (requires `curl`, or subsitute `curl` with `wget -O-`):

```sh
curl https://repo.jellyfin.org/install-debuntu.sh | sudo bash
```

:::note

You can verify the script download integrity with (requires `sha256sum`):

```sh
diff <( curl -s https://repo.jellyfin.org/install-debuntu.sh -o install-debuntu.sh; sha256sum install-debuntu.sh ) <( curl -s https://repo.jellyfin.org/install-debuntu.sh.sha256sum )
```

An empty output means everything is correct. Then you can inspect the script to see what it does (optional but recommended) and execute it with:

```sh
less install-debuntu.sh
sudo bash install-debuntu.sh
```

:::

:::note

The script tries to handle as many common derivatives as possible, including, at least, Linux Mint (Ubuntu and Debian editions), Raspbian/Raspberry Pi OS, and KDE Neon. We welcome PRs [to the script](https://github.com/jellyfin/jellyfin-repo-helper-scripts/blob/master/install-debuntu.sh) for any other common derivatives, or you can use the steps below instead.

:::

#### Repository (Using extrepo)

extrepo is only supported on Debian currently. The advantage of extrepo is that it is packaged in Debian. So you don’t have to execute the `curl | sudo bash` combo from the previous Automatic section. The risk with that command is that it relies on the security of the webserver. extrepo avoids this by having the Jellyfin repo information including the GPG key in its [extrepo-data](https://salsa.debian.org/extrepo-team/extrepo-data/-/blob/master/repos/debian/jellyfin.yaml?ref_type=heads). extrepo-data is verified with GPG by the extrepo tool. So there is a chain of trust from Debian all the way to the Jellyfin repo information.

```sh
sudo apt install extrepo
sudo extrepo enable jellyfin
```

Now you can continue at step 5. of the [Repository (Manual) section](#repository-manual).

## Unofficial Methods

### Alpine Linux

Jellyfin can be found in the `community` repository as
[`jellyfin`](https://pkgs.alpinelinux.org/package/edge/community/x86_64/jellyfin) and
Expand All @@ -14,20 +65,20 @@ Jellyfin can be found in the `community` repository as
To enable the web UI after installing `jellyfin-web`, make sure to remove the `--nowebclient` option from
`/etc/conf.d/jellyfin`.

## Arch Linux
### Arch Linux

The `Extra` repository contains builds for both [`jellyfin-server`](https://archlinux.org/packages/?name=jellyfin-server) and [`jellyfin-web`](https://archlinux.org/packages/?name=jellyfin-web).
`jellyfin-server` includes a hard dependency on [`jellyfin-ffmpeg`](https://archlinux.org/packages/?name=jellyfin-ffmpeg).

Both packages, server and web, can also be built from source at the tip of the master branch using [`jellyfin-git`](https://aur.archlinux.org/packages/jellyfin-git/).
The AUR also offers each separately at [`jellyfin-server-git`](https://aur.archlinux.org/packages/jellyfin-server-git/) and [`jellyfin-web-git`](https://aur.archlinux.org/packages/jellyfin-web-git/).

## Fedora
### Fedora

Fedora builds in RPM package format are available [in the main download repository](https://repo.jellyfin.org/?path=/server/). We do not yet have an official Fedora repository, but one is planned for the future.
However [`rpmfusion`](https://rpmfusion.org/) provides both `jellyfin-server` and `jellyfin-web` for Fedora version `38` and above.

### RPM Fusion
#### RPM Fusion

1. `rpmfusion` must be enabled first

Expand All @@ -47,7 +98,7 @@ However [`rpmfusion`](https://rpmfusion.org/) provides both `jellyfin-server` an
sudo systemctl enable --now jellyfin
```

### Manual installation via the .rpm packages
#### Manual installation via the .rpm packages

1. You will need to enable `rpmfusion`, as `ffmpeg` is a dependency of the `jellyfin` server package

Expand Down Expand Up @@ -104,7 +155,7 @@ However [`rpmfusion`](https://rpmfusion.org/) provides both `jellyfin-server` an

7. Go to `localhost:8096` or `ip-address-of-jellyfin-server:8096` to finish setup in the web UI

## CentOS
### CentOS

CentOS/RHEL 7 builds in RPM package format are available [in the main download repository](https://repo.jellyfin.org/?path=/server/). We do not yet have an official CentOS/RHEL repository, but one is planned for the future.

Expand All @@ -117,54 +168,32 @@ Instructions can be found at [the FFmpeg wiki](https://trac.ffmpeg.org/wiki/Comp

The general process should follow the above Fedora instructions.

## Debuntu (Debian, Ubuntu, and derivatives using `apt`)

The Jellyfin team provides 3rd-party Debian and Ubuntu repositories, to help ensure your Jellyfin install is always kept up-to-date.

### Repository (Automatic)

To simplify deployment and help automate this for as many users as possible, we provide a BASH script to handle repo installation as well as installing Jellyfin.
All you need to do is run this command on your system (requires `curl`, or subsitute `curl` with `wget -O-`):

```sh
curl https://repo.jellyfin.org/install-debuntu.sh | sudo bash
```

:::note

You can verify the script download integrity with (requires `sha256sum`):

```sh
diff <( curl -s https://repo.jellyfin.org/install-debuntu.sh -o install-debuntu.sh; sha256sum install-debuntu.sh ) <( curl -s https://repo.jellyfin.org/install-debuntu.sh.sha256sum )
```

An empty output means everything is correct. Then you can inspect the script to see what it does (optional but recommended) and execute it with:

```sh
less install-debuntu.sh
sudo bash install-debuntu.sh
```
### Gentoo

:::
The Gentoo ebuild repository includes the Jellyfin package which can be installed like other software:

:::note
```sh
emerge www-apps/jellyfin
```

The script tries to handle as many common derivatives as possible, including, at least, Linux Mint (Ubuntu and Debian editions), Raspbian/Raspberry Pi OS, and KDE Neon. We welcome PRs [to the script](https://github.com/jellyfin/jellyfin-repo-helper-scripts/blob/master/install-debuntu.sh) for any other common derivatives, or you can use the steps below instead.
### NixOS

:::
NixOS has a [module for Jellyfin](https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/misc/jellyfin.nix),
it can be enabled as follows:

### Repository (Using extrepo)
```nix
{
services.jellyfin.enable = true;
}
```

extrepo is only supported on Debian currently. The advantage of extrepo is that it is packaged in Debian. So you don’t have to execute the `curl | sudo bash` combo from the previous Automatic section. The risk with that command is that it relies on the security of the webserver. extrepo avoids this by having the Jellyfin repo information including the GPG key in its [extrepo-data](https://salsa.debian.org/extrepo-team/extrepo-data/-/blob/master/repos/debian/jellyfin.yaml?ref_type=heads). extrepo-data is verified with GPG by the extrepo tool. So there is a chain of trust from Debian all the way to the Jellyfin repo information.
For more information, refer to the [NixOS wiki](https://wiki.nixos.org/wiki/Jellyfin).

```sh
sudo apt install extrepo
sudo extrepo enable jellyfin
```
## Advanced

Now you can continue at step 5. of the following Repository (Manual) section.
### Manual installation on Debian, Ubuntu and derivatives

### Repository (Manual)
#### Repository (Manual)

If you would prefer to install everything manually, the full steps are as follows:

Expand Down Expand Up @@ -253,7 +282,7 @@ If you would prefer to install everything manually, the full steps are as follow
sudo service jellyfin {action}
```

### `.deb` Packages (Very Manual)
#### `.deb` Packages (Very Manual)

Raw `.deb` packages, including old versions, source packages, and `dpkg` meta files, are available [in the main download repository](https://repo.jellyfin.org/?path=/server/).

Expand Down Expand Up @@ -305,32 +334,11 @@ The repository is the preferred way to obtain Jellyfin on Debian and Ubuntu syst
sudo service jellyfin {action}
```

## Gentoo

The Gentoo ebuild repository includes the Jellyfin package which can be installed like other software:

```sh
emerge www-apps/jellyfin
```

## NixOS

NixOS has a [module for Jellyfin](https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/misc/jellyfin.nix),
it can be enabled as follows:

```nix
{
services.jellyfin.enable = true;
}
```

For more information, refer to the [NixOS wiki](https://wiki.nixos.org/wiki/Jellyfin).

## Linux (generic amd64)
### Linux (generic amd64)

Generic `amd64`, `arm64`, and `armhf` Linux builds in TAR archive format are available [in the main download repository](https://repo.jellyfin.org/?path=/server/).

### Base Installation Process
#### Base Installation Process

Create a directory in `/opt` for jellyfin and its files, and enter that directory.

Expand Down Expand Up @@ -361,7 +369,7 @@ Create four sub-directories for Jellyfin data.
sudo mkdir data cache config log
```

### `FFmpeg` Installation
#### `FFmpeg` Installation

If you are not running a Debian derivative, install `ffmpeg` through your OS's package manager, and skip this section.

Expand All @@ -379,7 +387,7 @@ If you run into any dependency errors, run this and it will install them and `je
sudo apt install -f
```

### Running Jellyfin
#### Running Jellyfin

Due to the number of command line options that must be passed on to the Jellyfin binary, it is easiest to create a small script to run Jellyfin.

Expand Down Expand Up @@ -418,7 +426,7 @@ Setup is as usual in the web browser.
./jellyfin.sh
```

#### Starting Jellyfin on boot (optional)
##### Starting Jellyfin on boot (optional)

Create a `systemd` unit file.

Expand Down Expand Up @@ -453,7 +461,7 @@ sudo systemctl enable jellyfin.service
sudo systemctl start jellyfin.service
```

## Portable DLL
### Portable DLL

Platform-agnostic .NET Core DLL builds in TAR archive format are available [here](/downloads#portable).
These builds use the binary `jellyfin.dll` and must be loaded with `dotnet`.