You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-27
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
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!
3
3
4
4
5
-
#### Super simple setup:
5
+
#### Super Simple Setup:
6
6
- you need [JDK7](http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html)
7
7
- you need a mysql db called "streama" (username `root`, no password). To change this, see below.
8
8
- you need the following directory: `/data/streama` (for windows,that this directory should be on your C: drive)
@@ -13,94 +13,94 @@ Ever had a huge bookshelf full of shows and movies? Ever wanted to digitalize th
13
13
The application uses Grails for the REST-API, and AngularJS for the frontend. If you don't like grails, you can just use the frontend components and add your own REST-API for handling all the data :)
14
14
15
15
###### Video Codecs
16
-
For supported video-codecs, please refer to [HTML5 Video Browser Support](https://en.wikipedia.org/wiki/HTML5_video#Browser_support). I will add video-conversion soon, but right now there is no conversion, so you have to rely on what your browser can handle. A quick and easy test is to open a new empty browser-tab and drag&drop your video file in. If it shows up in a player, then its a compatible format. if it downloads, its incompatible. But again, will hopefully add conversion, soon. And btw, Chrome supports most formats afaik.
16
+
For supported video-codecs, please refer to [HTML5 Video Browser Support](https://en.wikipedia.org/wiki/HTML5_video#Browser_support). I will add video-conversion soon, but right now there is no conversion, so you have to rely on what your browser can handle. A quick and easy test is to open a new empty browser-tab and drag&drop your video file in. If it shows up in a player, then it's a compatible format. If it downloads, it's incompatible. But again, conversion will hopefully be added soon. And btw, Chrome supports most formats afaik.
17
17
18
-
###### API key
18
+
###### API Key
19
19
You need to register for an API-key over at theMovieDb.org and enter it in /grails-app/conf/Config.groovy line 157. For testing out the app you may use my key that is hardcoded in there, but if you plan on using it, please get your own key, or the guys at theMovieDb.org will get angry with me :P
20
20
21
21
#### Roadmap
22
-
This app is not nearly close to completion.
22
+
This app is still being developed.
23
23
These [enhancement-issues](https://github.com/dularion/streama/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) are the features that I will be working on in the near future.
On the dashboard a user can see his 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.
30
+
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.
31
31
32
32
If a Movie or Episode does not contain any video-files, it won't show up in the dashboard.
The Streama-Player is (heavily) inspired by netflix, so you get all the good stuff from there. For Shows, there is "next episode" button, a handy episode- and season-browser, and then there are the basics, like volume-control, play/pause, and fullscreen.
38
+
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/seasonbrowser. There are also the basics: volume-control, play/pause, and fullscreen.
39
39
Later down the road I will add a feature to add subtitles and switch between video-files (for instance for different quality uploads).
40
40
The player is html5-based and has only really been tested in chrome so far.
41
41
42
42
##### The Episode Browser
43
-
I am especially proud of the Episode-Browser, which aims to function just like on netflix. By default, the season is selected, that the current video-fileis a part of. The user gets an overview over 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).
43
+
I am especially proud of the Episode-Browser, which aims to function just like on netflix. By default, the current video-file's 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).
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, so that you, the user, will have hardly any work.
50
+
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.
51
51
52
-
For instance, creating a new Tv-Show and the episodes for the first season looks something like this:
52
+
For example, creating a new Tv-show and the episodes for the first season looks something like this:
64
-
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 a user-administration in place, I plan on expaning on this a lot! I want to add a feature, where users can add and administer something like playlists. So there is a lot of potential to make this even better!
64
+
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 potential to make this even better!
65
65
66
-
## The technical Details
67
-
This application is web-based and is programmed with [Grails 2.4.4](https://grails.org/) and Mysql. For Login & User-Handling[SpringSecurity](http://projects.spring.io/spring-security/) is used. The player is completely html5-based, meaning there are limitations as to which file-types can be played.
66
+
## The Technical Details
67
+
This application is web-based and is programmed with [Grails 2.4.4](https://grails.org/) and MySQL. For login & user-handling[SpringSecurity](http://projects.spring.io/spring-security/) is used. The player is completely html5-based, meaning there are limitations as to which file-types can be played at the moment.
68
68
69
69
As an API for all the movies and shows I used the awesome API from theMovieDatabase.
[Setup Streama on Ubuntu-14.04](https://github.com/dularion/streama/wiki/Setup-App-on-Ubuntu-14.04)
76
76
77
77
You need the following
78
-
-java
79
-
-mysql
80
-
-a mysql database called "streama" (default config uses username "root" and no password)
81
-
-if you prefer different settings, adjust `/grails-app/conf/DataSource.groovy`
82
-
-a folder called "streama" that is located in /data that is owned by tomcat7 (this is where all the files will be stored)
78
+
-Java
79
+
-MySQL
80
+
-A MySQL database called "streama" (default config uses username "root" and no password)
81
+
-If you prefer different settings, adjust `/grails-app/conf/DataSource.groovy`
82
+
-A folder called "streama" that is located in /data that is owned by tomcat7 (this is where all the files will be stored)
83
83
- if you prefer a different location, you can change that in `/grails-app/conf/Config.groovy` line `155`
84
-
-And your preferred IDE to run it all. I like IntelliJ for grails-projects.
84
+
-Your preferred IDE to run it all. I like IntelliJ for grails-projects.
85
85
86
86
87
-
Once the application is runnning the default user has "admin" both as username and password.
87
+
Once the application is running the default user's admin credentials are "admin" for both the username and password.
88
88
89
-
**Mails**
89
+
**E-mail**
90
90
By default the plugin assumes an unsecured mail server configured at localhost on port 25. In order to get emails to work with something else, look into [Grails mail plugin](http://grails.org/plugins/mail).
91
91
92
92
93
93
94
94
95
-
## Work-in-progress
96
-
Lastly, I would like to mention that this project is extremely work-in-progress. Just today I was using it and noticed that it would be nice if the browser remembered the latest volume-setting.
95
+
## Work-in-Progress
96
+
Lastly, I would like to mention that this project is still very much a work-in-progress. Just today I was using it and noticed that it would be nice if the browser remembered the latest volume-setting.
97
97
I will be adding new features and bugfixes often and quickly, but this is first and foremost a hobby project, so the time that I can spend on it is limited. If you want to contibute, feel free! I will be honored by each and every pull-request :)
98
98
99
99
Btw, if you have any issues getting started, let me know. I will gladly help out and then improve the docs accordingly.
100
100
101
-
## Known issues
102
-
- When streaming a video, an exception occurs `getOutputStream() has already been called for this response` because springSecurity applies a filter that adds more data to the outputStream, even though I already added all the data and closed it. This error is merely cosmetic, and does not influence the video streaming. But I will want to get this fixed.
103
-
- There is no video-conversion currently, meaning you are reliant upon html5 browser compatibilities. But I will implement server-side conversion soon!
101
+
## Known Issues
102
+
- When streaming a video, an exception occurs `getOutputStream() has already been called for this response` because springSecurity applies a filter that adds more data to the outputStream, even though I already added all the data and closed it. This error is merely cosmetic, and does not influence the video streaming. I still want to get this fixed.
103
+
- There is no video-conversion currently, meaning you are reliant upon html5 browser compatibilities. I will implement server-side conversion soon which will enable this functionality.
0 commit comments