Merge branch 'master' into master

This commit is contained in:
Jett Jackson 2018-10-30 18:05:39 +08:00 committed by GitHub
commit 192c63362a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 35 additions and 11 deletions

View File

@ -10,4 +10,3 @@ RUN pip install --no-cache-dir -r requirements.txt
COPY ./app/ .
COPY ./config/ ./config/

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2018 Tiberiu Chibici
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@ -6,8 +6,7 @@ A self-hosted tool which manages your YouTube subscriptions, and downloads files
Currently, the program will do what it's main job is to do: download videos, and keep track of the subscriptions.
Of course, there are a lot of things that still need to be done. The web interface is still pretty limited.
This is what still needs to be done:
Of course, there are a lot of things that still need to be done. The web interface is still pretty limited, and there might still be uncaught bugs. These are some of the things that need to be done:
* get status bar to actually display something (right now it's just a hardcoded message)
* add an indication of what the synchronization jobs are doing to the UI
@ -19,12 +18,7 @@ This is what still needs to be done:
* Update UI when something changes
* Improve stability
* Bonus: Plex integration
# Docker
To run with docker, edit the config file (config/config.ini) and then run `docker-compose up -d`, it will bind to port 80.
You can edit the default download locations in the docker-compose.yml file.
* Bonus: Support for additional services (Twitch, Vimeo)
## Dependencies
@ -40,6 +34,8 @@ You can edit the default download locations in the docker-compose.yml file.
## Installation
### Normal installation for development/testing
1. Install all the dependencies listed above.
```bash
@ -90,7 +86,15 @@ individual user.
10. Add some subscriptions, and enjoy!
### Correct deploying procedure
### Docker
A much easier way to install is to use Docker.
To run with docker, edit the config file (config/config.ini) and then run `docker-compose up -d`, it will bind to port 80.
You can edit the default download locations in the docker-compose.yml file.
### Deploying for production
This is a *django* project, so the correct way to deploy it to a server would be by using *mod_wsgi*. Since this project
is still in development, I haven't really thought about getting it ready for production.