chibicitiberiu/ytsm
1
0
Fork 0
mirror of https://github.com/chibicitiberiu/ytsm.git synced 2024-02-24 05:43:31 +00:00
Code Issues Releases Wiki Activity

Clean up readme

Browse Source
This commit is contained in:
chibicitiberiu 2018-10-30 11:56:20 +02:00 committed by GitHub
parent 555707962f
commit d9dc463358
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
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. 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. 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:
This is what still needs to be done:
* get status bar to actually display something (right now it's just a hardcoded message) * 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 * 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 * Update UI when something changes
* Improve stability * Improve stability
* Bonus: Plex integration * Bonus: Plex integration
* Bonus: Support for additional services (Twitch, Vimeo)
# 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.
## Dependencies ## Dependencies
@ -40,6 +34,8 @@ You can edit the default download locations in the docker-compose.yml file.
## Installation ## Installation
### Normal installation for development/testing
1. Install all the dependencies listed above. 1. Install all the dependencies listed above.
```bash ```bash
@ -90,7 +86,15 @@ individual user.
10. Add some subscriptions, and enjoy! 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 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. is still in development, I haven't really thought about getting it ready for production.