add LICENSE and README.md

This commit is contained in:
Alex
2019-11-30 10:27:50 +02:00
parent 2efdbcb3ea
commit 6f5c56595f
3 changed files with 713 additions and 27 deletions

52
README.md Normal file
View File

@@ -0,0 +1,52 @@
# MeTube
Web GUI for youtube-dl with playlist support
## Run using Docker
```bash
docker run -d -p 8081:8081 -v /path/to/downloads:/downloads --user 1001:1001 alexta69/metube
```
## Run using docker-compose
```yaml
version: "3"
services:
metube:
image: alexta69/metube
container_name: metube
restart: unless-stopped
user: "1001:1001"
ports:
- "8081:8081"
volumes:
- /path/to/downloads:/downloads
```
## Build and run locally
Make sure you have node.js installed.
```bash
cd metube
# install Angular and build the UI
npm install
node_modules/.bin/ng build
# install python dependencies
pip3 install pipenv
pipenv install
# run
python3 app/main.py
```
A Docker image can be built locally (it will build the UI too):
```bash
docker build -t metube .
```
## Development notes
* The above works on Windows as well as Linux.
* If you're running the server in VSCode, your downloads will go to your user's Downloads folder (this is configured via the environment in .vscode/launch.json).