Easyflix

Easyflix is a self-hosted and reactive video-streaming server powered by The Movie Database. Use it to stream your digitized movies and TV shows (or any other videos) to your family's and friends' devices.

It is written in Typescript and Scala, and is licensed under the GNU Affero General Public License v3.

Features

• Local, FTP and Amazon S3 libraries support
• Auto-discovery of movies and TV shows
• Authentication
• Searching, sorting and filtering
• Keyboard navigable
• Shareable URLs
• Themes

Presentation

Library creation

The player

Sorting and filtering

Roadmap

• Internationalization of the user interface
• "Continue watching" functionality
• Support for subtitles

Feel free to make a suggestion by opening a ticket.

Install

Requirements

1. Create an account on The Movie Database and request an API key
2. Install Java on your computer/server (minimum JRE version 8)
3. Download the latest Easyflix release and extract the archive

Configure and run

Method 1: The configuration file

1. Create a file named easyflix.conf in your easyflix folder
2. Edit it with this minimal configuration:

tmdbApiKey: "<your-TMDb-api-key>"
auth.key: "<any-secret-key>"
auth.password: "<a-password>"

Notes:

• Check what configuration keys you can override by consulting easyflix-reference.conf
• auth.key can be anything but should preferably be a 128 bits hexadecimal key for security
• auth.password is the password you will use to log into your Easyflix instance

3. Run bin\easyflix and then type start or run bin\easyflix start directly

Method 2: Configure by command-line arguments

Run bin\easyflix start --help to see what arguments are available.

Example

Build

TODO

FAQ

• Can Easyflix play any video?

Easyflix provides an HTML5 player which means that you can only play videos in a format supported by your browser. The formats that are supported by modern browsers change over time. You can get an idea of your browser support for videos by referring to caniuse.com. The most commonly supported format at the time of writing is the MPEG-4/H.264 video format.

• Where does Easyflix find metadata for my movies and TV Shows?

Easyflix is powered by The Movie Database and uses its API to fetch presentation metadata for your videos. As such you will need an account and a valid API key from The Movie Database to run Easyflix.

Contribute

You can find contributions ideas and guidelines by consulting CONTRIBUTING.

Note that a star is the easiest way to contribute to the project by increasing its visibility on Github!

Privacy Policy

Easyflix does not collect any personal information.

However Easyflix uses The Movie Database API to retrieve metadata about your movies and TV shows. Check their privacy policy here.

License

Copyright © 2019 Thomas Gambet

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

For more information, please see LICENSE.