jellyfin-server/README.md

130 lines
6.1 KiB
Markdown
Raw Normal View History

Jellyfin
2013-02-16 04:55:32 +00:00
============
2013-02-21 15:13:12 +00:00
Jellyfin is a personal media server. The Jellyfin project was started as a result of Emby's decision to take their code closed-source, as well as various philosophical differences with the core developers. Jellyfin seeks to be the free software alternative to Emby and Plex to provide media management and streaming from a dedicated server to end-user devices.
2013-03-05 05:36:39 +00:00
Jellyfin is descended from Emby 3.5.2, ported to the .NET Core framework, and aims to contain build facilities for every platform.
2013-08-29 13:48:15 +00:00
2018-12-11 07:14:30 +00:00
For further details, please see [our wiki](https://github.com/jellyfin/jellyfin/wiki). To receive the latest project updates feel free to join [our public chat on Matrix/Riot](https://matrix.to/#/#jellyfin:matrix.org) and to subscribe to [our subreddit](https://www.reddit.com/r/jellyfin/).
2018-12-10 20:12:00 +00:00
## Feature Requests
While our first priority is a stable build, we will eventually add features that were missing in Emby or were not well implemented (technically or philosophically).
[Feature Requests](http://feathub.com/jellyfin/jellyfin)
2018-12-10 17:24:58 +00:00
2018-12-11 23:01:42 +00:00
## Contributing to Jellyfin
2018-12-11 23:36:23 +00:00
If you're interested in contributing, please see [CONTRIBUTING.md](https://github.com/jellyfin/jellyfin/blob/master/CONTRIBUTING.md).
2018-12-11 23:01:42 +00:00
## Prebuilt Jellyfin packages
2018-12-11 17:48:20 +00:00
Prebuild packages are available for Debian/Ubuntu and Arch, and via Docker Hub.
### Docker
The Jellyfin Docker image is available on Docker Hub at https://hub.docker.com/r/jellyfin/jellyfin/
### Arch
The Jellyfin package is in the AUR at https://aur.archlinux.org/packages/jellyfin-git/
### Unraid
An Unraid Docker template is available. See [this documentation page](https://github.com/jellyfin/jellyfin/blob/master/unRaid/docker-templates/README.md) for details on installing it.
### Debian/Ubuntu
A package repository is available at https://repo.jellyfin.org.
#### Clean install
2018-12-12 14:44:21 +00:00
0. Install the `dotnet-runtime-2.2` package via [Microsoft's repositories](https://dotnet.microsoft.com/download/dotnet-core/2.2).
0. Import the GPG signing key (signed by Joshua):
```
wget -O - https://repo.jellyfin.org/debian/jellyfin-signing-key-joshua.gpg.key | sudo apt-key add -
```
0. Add an entry to `/etc/apt/sources.list.d/jellyfin.list` (note that Ubuntu will get `buster` in the list file, but this should still work fine):
```
echo "deb https://repo.jellyfin.org/debian $( grep -Ewo -m1 --color=none 'jessie|stretch|buster' /etc/os-release || echo buster ) main" | sudo tee /etc/apt/sources.list.d/jellyfin.list
```
0. Update APT repositories:
```
sudo apt update
```
0. Install Jellyfin:
```
sudo apt install jellyfin
```
#### Upgrade from Emby
2018-12-12 02:40:34 +00:00
The following procedure should work to upgrade from Emby to Jellyfin on an existing installation:
0. Upgrade to Emby 3.5.X, preferably 3.5.2, so the database schema is fully up-to-date and consistent. This is somewhat optional but can reduce the risk of obscure bugs later on.
0. Stop the `emby-server` daemon:
```
sudo service emby-server stop
```
0. Move your existing Emby data directory out of the way:
```
sudo mv /var/lib/emby /var/lib/emby.backup
```
0. Remove the `emby-server` package:
```
sudo apt remove emby-server
```
0. Install the `jellyfin` package using the instructions above, verifying that `/var/lib/emby` is a symlink to `/var/lib/jellyfin`.
0. Stop the `jellyfin` daemon:
```
sudo service jellyfin stop
```
0. Copy over all the data files from the old backup data directory:
```
sudo cp -a /var/lib/emby.backup/* /var/lib/jellyfin/
```
0. Correct ownership on the new data directory:
```
2018-12-12 14:44:21 +00:00
sudo chown -R jellyfin:jellyfin /var/lib/jellyfin
```
0. Start the `jellyfin` daemon:
```
sudo service jellyfin start
```
This same general procedure should apply for upgrades on any other platform as well though the specific commands and/or paths may be different.
2018-12-12 02:40:34 +00:00
## Building Jellyfin packages from source
Jellyfin seeks to integrate build facilities for any desired packaging format. Instructions for the various formats can be found below.
2018-12-11 20:12:57 +00:00
NOTE: When building from source, only cloning the full Git repository is supported, rather than using a `.zip`/`.tar` archive, in order to support submodules.
### Debian/Ubuntu
Debian build facilities are integrated into the repo at `debian/`.
2018-12-12 14:44:21 +00:00
0. Install the `dotnet-sdk-2.2` package via [Microsoft's repositories](https://dotnet.microsoft.com/download/dotnet-core/2.2).
0. Run `dpkg-buildpackage -us -uc`.
0. Install the resulting `jellyfin_*.deb` file on your system.
2018-08-08 05:23:57 +00:00
2018-12-11 20:12:57 +00:00
A huge thanks to Carlos Hernandez who created the original Debian build configuration for Emby 3.1.1.
2018-12-11 22:52:40 +00:00
### Windows (64 bit)
2018-12-11 22:52:40 +00:00
A pre-built windows installer will be available soon. Until then it isn't too hard to install Jellyfin from Source.
2018-12-12 14:44:21 +00:00
0. Install the dotnet core SDK 2.2 from [Microsoft's Webpage](https://dotnet.microsoft.com/download/dotnet-core/2.2) and [install Git for Windows](https://gitforwindows.org/)
0. Clone Jellyfin into a directory of your choice.
```
git clone https://github.com/jellyfin/jellyfin.git C:\Jellyfin
```
2018-12-12 22:31:21 +00:00
0. From the Jellyfin directory you can use our Jellyfin build script. Call `Build-Jellyfin.ps1 -InstallFFMPEG` from inside the directory in a powershell window. Make sure you've set your executionpolicy to unrestricted.
Additional flags:
* If you want to optimize for your environment you can use the `-WindowsVersion` and `-Architecture` flags to do so; the default is generic Windows x64.
* The `-InstallLocation` flag lets you select where the compiled binaries go; the default is `$Env:AppData\JellyFin-Server\` .
* The `-InstallFFMPEG` flag will automatically pull the stable ffmpeg binaries appropriate to your architecture (x86/x64 only for now) from [Zeranoe](https://ffmpeg.zeranoe.com/builds/) and place them in your Jellyfin directory.
0. (Optional) Use [NSSM](https://nssm.cc/) to configure JellyFin to run as a service
0. 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, `&"$env:APPDATA\Jellyfin-Server\EmbyServer.exe"`. To start it from CMD, run, `%APPDATA%\Jellyfin-Server\EmbyServer.exe`