diff --git a/mkdocs/docs/api/download.md b/mkdocs/docs/api/download.md index 887db08..c753aa9 100644 --- a/mkdocs/docs/api/download.md +++ b/mkdocs/docs/api/download.md @@ -17,6 +17,8 @@ Add list of videos to download queue: ] } ``` +Parameter: +- autostart: true Delete download queue items by filter: **DELETE** `/api/download/?filter=ignore` diff --git a/mkdocs/docs/channels.md b/mkdocs/docs/channels.md index cfa76dd..a55aa01 100644 --- a/mkdocs/docs/channels.md +++ b/mkdocs/docs/channels.md @@ -1,3 +1,7 @@ +--- +description: Subscribe to channels, browse your channels and access additional metadata. +--- + # Channels Pages The channels are organized on two different levels, similar to the [playlists](playlists.md): @@ -21,7 +25,9 @@ To search your channels, click on the search icon download icon will start the download process starting from the top of the queue. Take a look at the relevant settings on the [Settings Page](settings.md#downloads). Once the process started, a progress message will show with additional details and controls: +The **Start Download** icon download icon will start the download process. This will prioritize videos added as *auto start* or as *download now*, starting from the top of the queue. Once the process started, a progress message will show with additional details and controls: - The stop icon stop icon will gracefully stop the download process, once the current video has been finished successfully. - [Currenlty broken] The cancel icon close icon is equivalent to killing the process and will stop the download immediately. Any leftover files will get deleted, the canceled video will still be available in the download queue. @@ -18,7 +22,9 @@ The **Start Download** icon d After downloading, Tube Archivist tries to add new videos to already indexed playlists and if activated on the settings page, get comments for the new videos. ## Add to Download Queue -The **Add to Download Queue** icon <img src= opens a text field to manually add videos to the download queue. Add one item per line. You have a few options: +The **Add to Download Queue** icon add icon opens a text field to manually add videos to the download queue. Add one item per line. The *Add to queue* will add the videos as regular items to the queue, you'll be able to ignore undesired videos before starting the queue. If you add them with *Download Now*, this will start the download automatically with priority. + +You have a few options: ### Videos - Add a YouTube video ID, for example `2tdiKTSdE9Y` diff --git a/mkdocs/docs/faq.md b/mkdocs/docs/faq.md index 6e2ff92..ceab0f2 100644 --- a/mkdocs/docs/faq.md +++ b/mkdocs/docs/faq.md @@ -1,3 +1,7 @@ +--- +description: Frequently asked questions about what this project is, what it tries and what it doesn't try to do. +--- + # Frequently Asked Questions ## What is the scope of this project? diff --git a/mkdocs/docs/index.md b/mkdocs/docs/index.md index 42f8851..5655f9d 100644 --- a/mkdocs/docs/index.md +++ b/mkdocs/docs/index.md @@ -1,3 +1,7 @@ +--- +description: Home of the documentation, additional installation instructions and user guide. Recommended reading for all interested in the project. +--- + # Tube Archivist Welcome to the official Tube Archivist Docs. This is an up-to-date documentation of user functionality. diff --git a/mkdocs/docs/playlists.md b/mkdocs/docs/playlists.md index 328cadd..255ee28 100644 --- a/mkdocs/docs/playlists.md +++ b/mkdocs/docs/playlists.md @@ -1,3 +1,7 @@ +--- +description: Subscribe to playlists, browse your playlists and access additional metadata. +--- + # Playlist Pages The playlists are organized in two different levels, similar as the [channels](channels.md): diff --git a/mkdocs/docs/search.md b/mkdocs/docs/search.md index 8c70232..91c3032 100644 --- a/mkdocs/docs/search.md +++ b/mkdocs/docs/search.md @@ -1,3 +1,7 @@ +--- +description: Unified search pagage to query your index. +--- + # Search Page Accessible at `/search/` of your **Tube Archivist**, search your archive for Videos, Channels and Playlists - or even full text search throughout your indexed subtitles. @@ -32,7 +36,7 @@ Start your query with the **primary keyword** `video:` to search for videos only - Note the omitted term after the primary key, this will show all videos from the channel *Tom Scott* that are no longer active on YouTube. ## Channel -Start with the `channel:` **primary keyword** to search for channels matching your query. This will search through the *channel name* and *channel description* fields. Narrow your search down with secondary keywords: +Start with the `channel:` **primary keyword** to search for channels matching your query. This will search through the *channel name*, *channel description* and *channel tags* fields. Narrow your search down with secondary keywords: - `subscribed:` is a boolean value, search for channels that you are subscribed to or not. - `active:` is a boolean value, to search for channels that are still active on YouTube or that are no longer active. diff --git a/mkdocs/docs/settings.md b/mkdocs/docs/settings.md index fa9dd80..104bf50 100644 --- a/mkdocs/docs/settings.md +++ b/mkdocs/docs/settings.md @@ -1,3 +1,7 @@ +--- +description: Configure this project, yt-dlp behavior, the scheduler and more. +--- + # Settings Page Accessible at `/settings/` of your **Tube Archivist**, this page holds all the configurations and additional functionality related to the database. @@ -15,11 +19,11 @@ Settings related to the channel management. Disable shorts or streams by setting - **Channel Page Size**: Defines how many pages will get analyzed by **Tube Archivist** each time you click on *Rescan Subscriptions*. The default page size used by yt-dlp is **50**, that's also the recommended value to set here. Any value higher will slow down the rescan process, for example if you set the value to 51, that means yt-dlp will have to go through 2 pages of results instead of 1 and by that doubling the time that process takes. - **Live Page Size**: Same as above, but for channel live streams. - **Shorts page Size**: Same as above, but for shorts videos. +- **Auto Start**: This will prioritize and automatically start downloading videos from your subscriptions over regular video added to the download queue. ## Downloads Settings related to the download process. -- **Download Limit**: Stop the download process after downloading the set quantity of videos. - **Download Speed Limit**: Set your download speed limit in KB/s. This will pass the option `--limit-rate` to yt-dlp. - **Throttled Rate Limit**: Restart download if the download speed drops below this value in KB/s. This will pass the option `--throttled-rate` to yt-dlp. Using this option might have a negative effect if you have an unstable or slow internet connection. - **Sleep Interval**: Time in seconds to sleep between requests to YouTube. It's a good idea to set this to **3** seconds. Might be necessary to avoid throttling. @@ -29,6 +33,8 @@ Settings related to the download process. Additional settings passed to yt-dlp. - **Format**: This controls which streams get downloaded and is equivalent to passing `--format` to yt-dlp. Use one of the recommended one or look at the documentation of [yt-dlp](https://github.com/yt-dlp/yt-dlp#format-selection). Please note: The option `--merge-output-format mp4` is automatically passed to yt-dlp to guarantee browser compatibility. Similar to that, `--check-formats` is passed as well to check that the selected formats are actually downloadable. +- **Format Sort**: This allows you to change how yt-dlp sorts formats by passing `--format-sort` to yt-dlp. Refere to the [documentation](https://github.com/yt-dlp/yt-dlp#sorting-formats), what you can pass here. Be aware, that some codecs might not be compatible with your browser of choice. +- **Extractor Language**: Some channels provide tranlated video titles and descriptions. Add the two letter ISO language code, to set your prefered default language. This will only have an effect, if the uploader adds translations. Not all language codes are supported, see the [documentation](https://github.com/yt-dlp/yt-dlp#youtube) (the `lang` section) for more details. - **Embed Metadata**: This saves the available tags directly into the media file by passing `--embed-metadata` to yt-dlp. - **Embed Thumbnail**: This will save the thumbnail into the media file by passing `--embed-thumbnail` to yt-dlp. diff --git a/mkdocs/docs/users.md b/mkdocs/docs/users.md index 29c089b..06a65b7 100644 --- a/mkdocs/docs/users.md +++ b/mkdocs/docs/users.md @@ -1,3 +1,7 @@ +--- +description: Create users, reset passwords, acces the admin interface. +--- + # User Management For now, **Tube Archivist** is a single user application. You can create multiple users with different names and passwords, they will share the same videos and permissions but some interface configurations are on a per user basis. *More is on the roadmap*. diff --git a/mkdocs/docs/video.md b/mkdocs/docs/video.md index 8b42adb..bd240ea 100644 --- a/mkdocs/docs/video.md +++ b/mkdocs/docs/video.md @@ -1,3 +1,7 @@ +--- +description: Complete Video metadata with playlist navigation and comments. +--- + # Video Page Every video downloaded gets a dedicated page accessible at `/video//` of your Tube Archivist. Throughout the interface, click on a video title to access the video page. @@ -9,6 +13,8 @@ Clicking on the channel name or the channel icon will bring you to the dedicated If available, a tag cloud will show, representing the tags set by the uploader. +There you can also find stream metadata like file size, video codecs, video bitrate and resolution, audio codecs and bitrate. + The video description is truncated to the first few lines, click on *show more* to expand the whole description. ## Playlist diff --git a/mkdocs/mkdocs.yml b/mkdocs/mkdocs.yml index b21fca3..b1877a4 100644 --- a/mkdocs/mkdocs.yml +++ b/mkdocs/mkdocs.yml @@ -59,9 +59,9 @@ extra: provider: custom plugins: - social: - cards_color: - fill: "#00202f" - text: "#eeeeee" - cards_font: Sen-Bold + cards_layout_options: + background_color: "#00202f" + color: "#eeeeee" + font_family: Sen-Bold - search: lang: en diff --git a/requirements.txt b/requirements.txt index d47e637..00b9140 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ cairosvg==2.7.0 mkdocs==1.4.3 -mkdocs-material==9.1.9 +mkdocs-material==9.1.12 pillow==9.5.0