Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/streamaserver/streama

Self hosted streaming media server. https://docs.streama-project.com/
https://github.com/streamaserver/streama

media media-player media-server streaming video-player video-streaming

Last synced: about 2 months ago
JSON representation

Self hosted streaming media server. https://docs.streama-project.com/

Lists

README 

        
![Streama Banner](design/banner2.png)

# STREAMA



[![Build Status](https://img.shields.io/travis/streamaserver/streama/master.svg?style=for-the-badge)](https://travis-ci.org/streamaserver/streama) 

[![Downloads](https://img.shields.io/github/downloads/streamaserver/streama/total.svg?style=for-the-badge)](https://github.com/streamaserver/streama/releases)

[![GitHub license](https://img.shields.io/github/license/mashape/apistatus.svg?style=for-the-badge)](https://github.com/streamaserver/streama/blob/master/LICENSE.md) 

[![Discord](https://img.shields.io/discord/432358302496849931.svg?style=for-the-badge)](https://discord.gg/CJEHWX9)



  

Docs: https://docs.streama-project.com/  



Ever had a huge bookshelf full of shows and movies? Ever wanted to digitalize them, but didn't have a good way of organizing the files? Worry no more! Streama is your own personal Netflix for just such a purpose!



[![Visit the Docs](design/promo-page.png)](https://github.com/streamaserver/streama/wiki) 

[![Live Demo](design/live-demo-button.png)](https://streama.demo-version.net/) 

[![Streama on Google Play store](design/google-play-badge.jpg)](https://play.google.com/store/apps/details?id=dularion.streama) 



## Live-Demo

https://streama.demo-version.net/   

**credentials: username: demoUser | password: demoUser**  

Feel free to play around there as much as you like (everything is reset at night)  

We will keep this demo updated with our newest releases as they come, so that you can check out new features there first before deciding to deploy them in your own environments. 



## Donate

Patreon donate button

PayPal donate button



If you want to donate to the developer via bitcoin use 17rCUEX6KYQ8ZM4w39ttEUL7SUDnGCpcWq  



## Table of contents:

- [Getting Started](#getting-started)

- [Downloads](#downloads)

- [The Application](#the-application)

  - [Settings](#settings)

  - [The Dashboard](#the-dashboard)

  - [The Player](#the-player)

  - [The Admin-Panel](#the-admin-panel)

  - [Accessing existing files](#accessing-existing-files)

  - [The Users](#the-users) 

- [Technical Details](#technical-details)

- [Changelog](#changelog)

- [Roadmap](#roadmap)

- [Known Issues](#known-issues)

- [Contributing](#contributing)

- [License](#license)



# Getting Started

- [Installation and first-time setup](https://docs.streama-project.com/getting-started/installing/)



If you have any issues getting started, feel free to [chat with us on Discord](https://discord.gg/CJEHWX9). We are more than happy to assist and then improve the docs accordingly. 



# Downloads

- **Stable and beta** versions see the GitHub [releases](https://github.com/streamaserver/streama/releases)



# The Application



### Settings

![Streama Settings Validation](http://i.imgur.com/oEMXLPk.gif)



When you first run the application, you will be redirected to the settings page. Here you enter your desired upload directory for the video files, your [theMovieDb.org API key](https://www.themoviedb.org/documentation/api) and a different base URL if so desired (useful for remote hosting).



Once you made adjustments to any of the settings, make sure to validate the value before saving.

- For the API-Key, the validation checks against theMovieDb.org to see if you've entered a valid API-key.

- For the upload directory, the application checks if it has read/write permissions for it.



### The Dashboard

![Streama Dashboard](http://new.tinygrab.com/d9072ef564654c6e245c442e9c7d95facd4b738538.png)



On the dashboard, a user can see their recently watched TV-shows and Movies and their progress (they can continue where they left off) as well start new shows and movies that they haven't yet seen. The "Continue Watching" Feature works by periodically updating the database (only while watching, of course!) with info about the currently watched Video and how far it has been seen.



If a Movie or Episode does not contain any video-files, it won't show up in the dashboard.



### The Player

![Streama Player](http://new.tinygrab.com/d9072ef56407e5d1ac40fab040aedc398a9abb3609.png)



The Streama-Player is (heavily) inspired by Netflix, so you get all the good stuff from there. For Shows, there is a "next episode" button and a handy episode/season browser. There are also the basics: volume-control, play/pause, and fullscreen. 

Later down the road I will add a feature to add subtitles and switch between video-files (for instance for different quality uploads). 

The player is HTML5-based and has only really been tested in Chrome so far.



##### The Episode Browser

I am especially proud of the Episode-Browser, which aims to function just like on Netflix. By default, the current video files season is selected. The user gets an overview of which other episodes there are in the season, how many seasons there are, and, as an added feature, the user sees all the added episodes, even if no video-files are added to them (thus greyed out).



![Streama Episode Browser](http://i.imgur.com/MLE6TpH.gif)



### The Admin-Panel

![Streama Admin](http://new.tinygrab.com/d9072ef56484ebb444cc2fc7bc11f18e9f1706f68f.png)



One of the most important things to me was to make managing shows, movies, and episodes as easy and fun as possible. For this, I made heavy use of the API from [theMovieDatabase.org](https://www.themoviedb.org/), which auto-fills the episodes, shows and movies with useful information and great images. This eases the user's role in adding content.



For example, creating a new TV-show and the episodes for the first season looks something like this:



![Streama Creating Show](http://i.imgur.com/TLptKdp.gif)



Uploading video-files for each episode is as easy as drag-and-drop!



![Streama Uploading Episode](http://i.imgur.com/StgES0S.gif)  



### Accessing existing files

If you want to avoid uploading every file, use our new and improved "Local File" Feature instead. You can define a local directory (I use one directly in which I created symlinks to all my mounted drives) and then you can either use the local file browser for individual movies / tv-Shows or you can use the bulk-create feature. 



#### The local file browser

You can access the local file browser from any movie or TV-show (anywhere where you would otherwise upload a file). Note: You need to first define the local directory in the settings.

![Movie Detail](https://files.gitter.im/dularion/streama/2Al4/image.png)

![Local File directory](https://files.gitter.im/dularion/streama/wY2h/image.png)



#### Bulk-Create from File

This MR addresses the issue "Batch Add Files #241".

Note: the TV-Show does not have to be present in order for this to work. Everything will be created by the backend. 



##### Running matcher & previewing the result

![sep-02-2017 01-24-34](https://user-images.githubusercontent.com/936076/29990709-8f34e8f8-8f7d-11e7-9d9b-955236bf2251.gif)



##### adding single matched file 

![sep-02-2017 01-24-12](https://user-images.githubusercontent.com/936076/29990718-a28e2af4-8f7d-11e7-9821-eba309b04011.gif)



##### adding files in bulk

![sep-02-2017 01-24-26](https://user-images.githubusercontent.com/936076/29990720-aa6dcb08-8f7d-11e7-8f1c-59cdadee10d6.gif)



##### Customizing the Matcher

Just like in Emby or Kodi, the matcher-regex can be altered. The two defaults are 

**Movie**: `/^(?.*)[_.]\(\d{4}\).*/`  

**TvShow/Episode**: `/^(?.+)[._]S(?\d{2})E(?\d{2,3}).*/`   



In order to customize the regex, just add the regex in the bottom of the application.yml like so:

```yml

streama:

  regex:

    movies: ^(?.*)[_.]\(\d{4}\).*

    shows: ^(?.+)[._]S(?\d{2})E(?\d{2,3}).*



```



### The Users

![Streama User Management](http://new.tinygrab.com/d9072ef564717c22dde948c726144b1b707a607adc.png)

Users can be invited and managed in the admin panel. By default, they are non-admins, meaning they can only view videos, not create them. You can make them admins with the press of a button. Since there is user-administration in place, I plan on expanding on this a lot! Another feature I want to add is the ability for users to add and administer some form of playlists. There is a lot of potentials to make this even better!



# Technical Details

This application is web-based, the server-side is written on [Grails 3](https://grails.org/) with [SpringSecurity](http://projects.spring.io/spring-security/) for login & user-handling. For all the front-end components, [AngularJS](https://angularjs.org/) is used and the player is completely HTML5-based. The application is essentially split into Grails for a REST-API, and AngularJS for the frontend.



Streama uses the [awesome API](https://www.themoviedb.org/documentation/api) from [theMovieDatabase](https://www.themoviedb.org) for all media-metadata.



# Changelog

Please refer to the description of each [release](https://github.com/streamaserver/streama/releases) or the git log.



# Roadmap

Streama is still very much a work-in-progress. We will be adding new features and bug-fixes often, but this is a hobby project for the core-contributors, so the time that we can spend on it is limited.



For all our feature and bug tracking, we use the [Issues Section](https://github.com/streamaserver/streama/issues). Streama's 'roadmap' is currently to work through the feature requests and improvements that are in the issue tracker.  Take a look at the milestones for what we intend to add for upcoming releases.



# Contributing

### Features, Improvements, and Bugfixes

Streama currently only has ~2-3 core-contributors so we are grateful for any extra contributions. Send through a Pull Request and we will review it ASAP.



If you're not sure what to work on, take a look at the [issues](https://github.com/streamaserver/streama/issues). There are lots to do!



### Translations

If you want to contribute a translation, please follow [the guide here](https://github.com/streamaserver/streama/wiki/Translating-the-app). 



# Known Issues

- There is no video-conversion currently, meaning you are reliant upon HTML5 browser compatibilities. Server-side conversion is on our roadmap. See Issue [#440](https://github.com/streamaserver/streama/issues/440)



# License

Streama is distributed under the terms of the MIT license.

See [LICENSE.md](https://github.com/streamaserver/streama/blob/master/LICENSE.md) for details.