aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex <alexta69@gmail.com>2019-12-08 10:16:02 +0200
committerGitHub <noreply@github.com>2019-12-08 10:16:02 +0200
commit4bf1841de3e886a7c0da7e514b045aaa8a526c71 (patch)
tree10ec289e337368dafd29500d4778cbb222f4c37e
parentfixed potential race (diff)
downloadmetube-4bf1841de3e886a7c0da7e514b045aaa8a526c71.tar.gz
metube-4bf1841de3e886a7c0da7e514b045aaa8a526c71.tar.bz2
metube-4bf1841de3e886a7c0da7e514b045aaa8a526c71.zip
update README
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index e7b1555..43474ba 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# MeTube
-Web GUI for youtube-dl with playlist support
+Web GUI for youtube-dl with playlist support. Allows you to download videos from YouTube and dozens of other sites (https://ytdl-org.github.io/youtube-dl/supportedsites.html).
![screenshot1](https://github.com/alexta69/metube/raw/master/screenshot.gif)
@@ -30,12 +30,12 @@ services:
Certain values can be set via environment variables, using the `-e` parameter on the docker command line, or the `environment:` section in docker-compose.
-* __DOWNLOAD_DIR__: path to where the downloads will be saved. Defaults to "/downloads" in the docker image, and "." otherwise.
-* __URL_PREFIX__: base path for the web server (for use when hosting behind a reverse proxy). Defaults to "/".
+* __DOWNLOAD_DIR__: path to where the downloads will be saved. Defaults to `/downloads` in the docker image, and `.` otherwise.
+* __URL_PREFIX__: base path for the web server (for use when hosting behind a reverse proxy). Defaults to `/`.
## Running behind a reverse proxy
-Use the following nginx configuration to run MeTube behind a reverse proxy. The extra `proxy_set_headers` directives are there to make WebSockets work. Don't forget to set the URL_PREFIX environment variable to the correct value as well.
+Use the following nginx configuration to run MeTube behind a reverse proxy. The extra `proxy_set_header` directives are there to make WebSocket work. Don't forget to set the URL_PREFIX environment variable to the correct value as well.
```
location /metube/ {
@@ -49,7 +49,7 @@ location /metube/ {
## Build and run locally
-Make sure you have node.js installed.
+Make sure you have node.js and Python 3.8 installed.
```bash
cd metube
bgstack15