diff --git a/Building-from-Source.md b/Building-from-Source.md new file mode 100644 index 0000000..f0d93e8 --- /dev/null +++ b/Building-from-Source.md @@ -0,0 +1,33 @@ +# Building from Source + +Jellyfin seeks to integrate build facilities for any desired packaging format. Instructions for the various formats can be found below. + +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/`. + +0. Install the `dotnet-sdk-2.2` package via [Microsoft's repositories](https://dotnet.microsoft.com/download/dotnet-core/2.2). +1. Run `dpkg-buildpackage -us -uc`. +2. 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. + +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/) +1. Clone Jellyfin into a directory of your choice. + git clone https://github.com/jellyfin/jellyfin.git C:\Jellyfin +2. 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. + +3. (Optional) Use [NSSM](https://nssm.cc/) to configure JellyFin to run as a service +4. 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` diff --git a/Home.md b/Home.md index 3bca2c3..f2c9da9 100644 --- a/Home.md +++ b/Home.md @@ -1,3 +1,41 @@ -Welcome to the jellyfin wiki! +# Welcome to the Jellyfin wiki! -Details still incoming. + +Jellyfin is a free software media system that puts you in control of managing and streaming your media. It is a free software alternative to Emby and Plex, to provide media from a dedicated server to end-user devices. + +Jellyfin is descended from Emby 3.5.2, ported to the .NET Core framework, and aims to contain build facilities for every platform. + +--- + +

+Want to get started? Choose from [Prebuilt packages](Prebuilt-Packages), or [build from source](Building-from-Source). +

+

+Want to contribute? Check out our [Contributing Guidelines](Contributing-to-Jellyfin). +

+ +--- + +## Issues and 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). During this time, we will continue to fix issues wherever possible. + +

+New idea or improvement? +
+Open a Feature Request. +

+

+Something not working right? +
+Open an Issue. +

+ + +--- + +## Follow Us! + +To receive the latest project updates feel free to join [our public chat on Matrix/Riot](https://matrix.to/#/#jellyfin:matrix.org) and follow us on [Social Media](https://github.com/jellyfin/jellyfin/wiki/Social-Media). + +Have documentation suggestions or other technical questions? [Open an issue](https://github.com/mike-grant/haaska/issues/new)! diff --git a/Prebuilt-Packages.md b/Prebuilt-Packages.md new file mode 100644 index 0000000..7e4ff5f --- /dev/null +++ b/Prebuilt-Packages.md @@ -0,0 +1,17 @@ +# Prebuilt Packages +Prebuilt packages are available for Debian/Ubuntu and Arch, and via Docker Hub. + +### Debian +Please see the [Jellyfin Debian Repository](Jellyfin-Debian-Repository) page. + +### Docker Docker Pull Count + +The Jellyfin Docker image is available on [Docker Hub](https://hub.docker.com/r/jellyfin/jellyfin/). + +### Arch + +The Jellyfin package is in the AUR at . + +### 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. diff --git a/Web-archive-of-Emby-documentation.md b/Web-archive-of-Emby-documentation.md index c5427e7..aad7b14 100644 --- a/Web-archive-of-Emby-documentation.md +++ b/Web-archive-of-Emby-documentation.md @@ -1 +1 @@ -Web archive of Emby documentation at around time of fork (most snapshotted at 16 December 2018) is available here: https://web.archive.org/web/20181216120305/https://github.com/MediaBrowser/Wiki/wiki \ No newline at end of file +Web archive of Emby documentation at around time of fork (most snapshotted at 16 December 2018) is available here: https://web.archive.org/web/20181216120305/https://github.com/MediaBrowser/Wiki/wiki