Merge pull request #106 from Erazor2/queuePersistence

Queue persistence

1 files changed, 4 insertions, 2 deletions

diff --git a/README.md b/README.md
index 3de21af..f2cd0e2 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ Web GUI for youtube-dl (using the [yt-dlp](https://github.com/yt-dlp/yt-dlp) for
 ## Run using Docker

 

 ```bash

-docker run -d -p 8081:8081 -v /path/to/downloads:/downloads --user 1001:1001 alexta69/metube

+docker run -d -p 8081:8081 -v /path/to/downloads:/downloads -v /path/to/state:/state --user 1001:1001 alexta69/metube

 ```

 

 ## Run using docker-compose

@@ -27,6 +27,7 @@ services:
       - "8081:8081"

     volumes:

       - /path/to/downloads:/downloads

+      - /path/to/state:/state  # optional, if you want download queue persistence between re-creations of the container

 ```

 ## Configuration via environment variables

 

@@ -34,6 +35,7 @@ Certain values can be set via environment variables, using the `-e` parameter on
 

 * __DOWNLOAD_DIR__: path to where the downloads will be saved. Defaults to `/downloads` in the docker image, and `.` otherwise.

 * __AUDIO_DOWNLOAD_DIR__: path to where audio-only downloads will be saved, if you wish to separate them from the video downloads. Defaults to the value of `DOWNLOAD_DIR`.

+* __STATE_DIR__: path to where the queue persistence files will be saved. Defaults to `/state` in the docker image, and `.` otherwise.

 * __URL_PREFIX__: base path for the web server (for use when hosting behind a reverse proxy). Defaults to `/`.

 * __OUTPUT_TEMPLATE__: the template for the filenames of the downloaded videos, formatted according to [this spec](https://github.com/yt-dlp/yt-dlp/blob/master/README.md#output-template). Defaults to `%(title)s.%(ext)s`.

 * __YTDL_OPTIONS__: Additional options to pass to youtube-dl, in JSON format. [See available options here](https://github.com/yt-dlp/yt-dlp/blob/master/yt_dlp/YoutubeDL.py#L176). They roughly correspond to command-line options, though some do not have exact equivalents here, for example `--recode-video` has to be specified via `postprocessors`. Also note that dashes are replaced with underscores.

@@ -144,5 +146,5 @@ docker build -t metube .
 

 ## Development notes

 

-* The above works on Windows and MacOS as well as Linux.

+* The above works on Windows and macOS 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).