diff options
| author | Alex Shnitman <alexta69@gmail.com> | 2022-11-19 17:23:36 +0200 |
|---|---|---|
| committer | Alex Shnitman <alexta69@gmail.com> | 2022-11-19 17:23:36 +0200 |
| commit | a6d6942f7ba4d7916a51e879addd8427f9f98318 (patch) | |
| tree | ad60323f77b6004aafba803022e6b33672e1323a /README.md | |
| parent | upgraded yt-dlp (diff) | |
| download | metube-a6d6942f7ba4d7916a51e879addd8427f9f98318.tar.gz metube-a6d6942f7ba4d7916a51e879addd8427f9f98318.tar.bz2 metube-a6d6942f7ba4d7916a51e879addd8427f9f98318.zip | |
upgrade dependencies; add troubleshooting section to README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 15 insertions, 2 deletions
@@ -42,7 +42,7 @@ Certain values can be set via environment variables, using the `-e` parameter on * __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`.
* __OUTPUT_TEMPLATE_CHAPTER__: the template for the filenames of the downloaded videos, when split into chapters via postprocessors. Defaults to `%(title)s - %(section_number)s %(section_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.
+* __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#L183). 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.
The following example value for `YTDL_OPTIONS` embeds English subtitles and chapter markers (for videos that have them), and also changes the permissions on the downloaded video:
```
@@ -168,7 +168,20 @@ There's an automatic nightly build of MeTube which looks for a new version of yt I recommend installing and setting up [watchtower](https://github.com/containrrr/watchtower) for this purpose.
-## Build and run locally
+## Troubleshooting and submitting issues
+
+Before asking a question or submitting an issue for MeTube, please remember that MeTube is only a UI for [yt-dlp](https://github.com/yt-dlp/yt-dlp). Any issues you might be experiencing with authentication to video websites, postprocessing, permissions, other `YTDL_OPTIONS` configurations which seem not to work, or anything else that concerns the workings of the underlying yt-dlp library, need not be opened on the MeTube project. In order to debug and troubleshoot them, it's advised to try using the yt-dlp binary directly first, bypassing the UI, and once that is working, importing the options that worked for you into `YTDL_OPTIONS`.
+
+In order to test with the yt-dlp command directly, you can either download it and run it locally, or for a better simulation of its actual conditions, you can run it within the MeTube container itself. Assuming your MeTube container is called `metube`, run the following on your Docker host to get a shell inside the container:
+
+```bash
+docker exec -ti metube sh
+cd /downloads
+```
+
+Once there, you can use the yt-dlp command freely.
+
+## Building and running locally
Make sure you have node.js and Python 3.8 installed.
|