Browse Source

Merge pull request #74 from joshuaboniface/unraid-docker

Additions to the README
Andrew Rabert 6 years ago
parent
commit
1bb90e0135
1 changed files with 21 additions and 8 deletions
  1. 21 8
      README.md

+ 21 - 8
README.md

@@ -51,6 +51,10 @@ A package repository is available at https://repo.jellyfin.org. To use it:
     sudo apt install jellyfin
     ```
 
+### 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.
+
 ## 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.
@@ -61,17 +65,26 @@ NOTE: When building from source, only cloning the full Git repository is support
 
 Debian build facilities are integrated into the repo at `debian/`.
 
-1. Install the `dotnet-sdk-2.1` package via [Microsoft's repositories](https://dotnet.microsoft.com/download/dotnet-core/2.1).
-2. Run `dpkg-buildpackage -us -uc`.
-3. Install the resulting `jellyfin_*.deb` file on your system.
+0. Install the `dotnet-sdk-2.1` package via [Microsoft's repositories](https://dotnet.microsoft.com/download/dotnet-core/2.1).
+0. Run `dpkg-buildpackage -us -uc`.
+0. Install the resulting `jellyfin_*.deb` file on your system.
 
 A huge thanks to Carlos Hernandez who created the original Debian build configuration for Emby 3.1.1.
 
 ### Windows (64 bit)
+
 A pre-built windows installer will be available soon. Until then it isn't too hard to install Jellyfin from Source.
 
-1. Install the dotnet core SDK 2.1 from [Microsoft's Webpage](https://dotnet.microsoft.com/download/dotnet-core/2.1) and [install Git for Windows](https://gitforwindows.org/)
-2. Clone Jellyfin into a directory of your choice. `git clone https://github.com/jellyfin/jellyfin.git C:\Jellyfin`
-3. 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 unsrestricted. If you want to optimize for your environment you can use the -WindowsVersion and -Architecture flags to do so, default is generic windows x64. The -InstallLocation flag lets you select where the compiled binaries go, 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 then place them in your emby directory. 
-4. (Optional) Use [NSSM](https://nssm.cc/) to configure JellyFin to run as a service
-5. 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`
+0. Install the dotnet core SDK 2.1 from [Microsoft's Webpage](https://dotnet.microsoft.com/download/dotnet-core/2.1) 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
+    ```
+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 unsrestricted.
+
+    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`