diff --git a/mkdocs/docs/advanced.md b/mkdocs/docs/advanced.md index 24d8fbc..882e687 100644 --- a/mkdocs/docs/advanced.md +++ b/mkdocs/docs/advanced.md @@ -147,34 +147,3 @@ pip install \ https://github.com/yt-dlp/yt-dlp/archive/master.tar.gz ``` This is obviously particularly likely to create problems. Also note that the `--version` command will only show the latest regular release, not a nightly version mentioned. - -## Erase errors from download queue -Sometimes videos will fail to download. That can be because of expected errors: - -- A video is no longer available for download. - -That is not recoverable. - -Other kind of errors *are* recoverable, for example: - -- You got temporarily rate limited. -- Your internet connection dropped out. - -Failed downloads won't get retried again as they require your intervention. You can click on **Download Now** on a video in the queue to verify, if a video became available again. - -If you know that all errors are resolved you can bulk clear. Run this from within the TA container: - -???+ bug "Erase Errors" - ```bash - curl -X POST "$ES_URL/ta_download/_update_by_query?pretty" -u elastic:$ELASTIC_PASSWORD -H 'Content-Type: application/json' -d' - { - "script": { - "source": "ctx._source.message = null", - "lang": "painless" - }, - "query": { - "match_all": {} - } - } - ' - ``` diff --git a/mkdocs/docs/downloads.md b/mkdocs/docs/downloads.md index 3990880..d7cf24a 100644 --- a/mkdocs/docs/downloads.md +++ b/mkdocs/docs/downloads.md @@ -22,7 +22,13 @@ 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. The *Add to queue* will add the videos as regular items to the queue, where 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. +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. This will _not_ add videos already in the queue, previously ignored or already indexed. + +### Fast add +This will add videos in bulk to the queue, at the expense of having less metadata and no thumbnail available in the download queue. The full metadata will get index as usual after downloading. Particularly usefull to add whole channels and playlists in bulk, has no effect when just adding a single video. + +### Auto download +If you add them with *Download Now*, this will start the download automatically with priority. You have a few options: @@ -38,7 +44,22 @@ Add a [playlist](urls.md#playlist) to download all videos in the list. When addi ## The Download Queue Below the three action buttons is the download queue. New items will get added to the end of the queue, the next video to download once you click on **Start Download** will be the first in the list. -You can filter the download queue with the **filter** dropdown box, the filter will show once you have more than one channel in the download queue. Select the channel to filter by name, the number in parentheses indicates how many videos you have pending from this channel. Reset the filter by selecting *all* from the dropdown. This will generate links for the top 30 channels with pending videos. +### Advanced Filtering and Bulk Actions +Clicking on **Show Advanced** opens additional filter and bulk action options: + +- Filter by types: Shorts, Streams or regular Videos +- Filter by channel: If there are videos from more than one channel in the queue. This generates links for the top 30 channels in the queue. +- Filter by error state: Filter by videos with or without any errors +- Search by video title +- All these are filters are applied combined and you'll see the intersections + +Then the **Bulk Actions** are applied to the filters as indicated: + +- Ignore: Bulk ignore, shows when showing **Pending Videos** only. +- Add to queue: Bulk add ignored videos back to queue, shows when showing **Ignored Videos** only. +- Download now: Start downloading selected videos with priority +- Clear errors: Clear any error messages from +- Forget: This forgets the videos from the queue Every video in the download queue has two buttons: @@ -52,5 +73,3 @@ Every video in the ignored list has two buttons: - **Forget**: This will delete the item from the ignored list. - **Add to Queue**: This will add the ignored video back to the download queue. - -You can delete your download queue from the [Settings](settings/actions.md) page. diff --git a/mkdocs/docs/playlists.md b/mkdocs/docs/playlists.md index 7da16d8..b0384dc 100644 --- a/mkdocs/docs/playlists.md +++ b/mkdocs/docs/playlists.md @@ -38,4 +38,5 @@ Each playlist will get a dedicated playlist detail page accessible at `/playlist - The **Mark as Watched** and **Mark as Unwatched** buttons will mark all videos of this playlist as watched/unwatched. - The **Reindex** button will reindex the playlist metadata. - The **Reindex Videos** button will reindex all videos from this playlist. +- The **Switch sort order** toggle will change the sort order from top to bottom to bottom to top. This might be needed if you are subscribed to the playlists and the playlist owner adds new videos to the bottom. - The **Delete Playlist** button will give you the option to delete just the *metadata*, which won't delete any media files, or *delete all*, which will delete the metadata plus all videos belonging to this playlist. \ No newline at end of file diff --git a/mkdocs/docs/settings/actions.md b/mkdocs/docs/settings/actions.md index 161c268..3e370a8 100644 --- a/mkdocs/docs/settings/actions.md +++ b/mkdocs/docs/settings/actions.md @@ -5,9 +5,6 @@ description: Administration tasks for the application. # Actions Page Accessible at `/settings/actions/` of your **Tube Archivist** instance, this page allows admins to perform actions related to the database and other functions. -## Delete download queue -The button **Delete all queued** will delete all pending videos from the download queue. The button **Delete all ignored** will delete all videos you have previously ignored. - ## Manual Media Files Import !!! warning This is inherently error prone, as there are many variables, some outside of the control of this project. Read this carefully and use at your own risk. @@ -72,7 +69,7 @@ If the video you are trying to import is not available on YouTube any more, **Tu - The file `.info.json` is required to extract the required information. - Add the thumbnail as `.`, where valid file extensions are *.jpg*, *.png* or *.webp*. If there is no thumbnail file, **Tube Archivist** will try to extract the embedded cover from the media file or will fallback to a default thumbnail. - Add subtitles as `..vtt` where *lang* is the two letter ISO country code. This will archive all subtitle files you add to the import folder, independent from your configurations. Subtitles can be archived and used in the player, but they can't be indexed or made searchable due to the fact, that they have a very different structure than the subtitles as **Tube Archivist** needs them. -- For videos, where the whole channel is not available any more, you can add the `.info.json` file as generated by *youtube-dl/yt-dlp* to get the full metadata. Alternatively **Tube Archivist** will extract as much info as possible from the video info.json file. +- For videos, where the whole channel is not available any more, TA will extract as much info as possible from the info json file. ### Some notes: diff --git a/mkdocs/docs/settings/application.md b/mkdocs/docs/settings/application.md index e9314db..577622c 100644 --- a/mkdocs/docs/settings/application.md +++ b/mkdocs/docs/settings/application.md @@ -21,9 +21,21 @@ Same as above, but for a channel's live streams. *Disable by setting to 0.* ### Shorts page Size Same as above, but for a channel's shorts videos. *Disable by setting to 0.* +### Playlist page size +Page size used for playlist subscriptions. + ### Auto Start This will prioritize and automatically start downloading videos from your subscriptions over regular videos added to the download queue. +### Fast add +Activating that will add videos from channels and playlists in bulk instead of one by one. That is significantly faster but can't extract all metadata. Notably this won't extract: + +- Thumbnails: As the thumbnails returned from the channel and playlist pages are much lower resolution. +- Date published: Although the sort order will be correct, e.g. newer videos will be on top. +- Duration: In most cases duration will not be available. + +This only applies to the download queue. All metadata is extracted and indexed after downloading. + ## Downloads Settings related to the download process. diff --git a/mkdocs/docs/settings/scheduling.md b/mkdocs/docs/settings/scheduling.md index ef2106a..b958a27 100644 --- a/mkdocs/docs/settings/scheduling.md +++ b/mkdocs/docs/settings/scheduling.md @@ -62,7 +62,8 @@ docker exec -it tubearchivist apprise -b "Hello from TA" ``` !!! note "Notes:" - - This will only send notifications when a task returns anything, e.g. if a [Rescan Subscriptions](#rescan-subscriptions) task doesn't find any new videos to add, **no** notification will will be sent. + - This will only send notifications when a task returns anything, e.g. if a [Rescan Subscriptions](#rescan-subscriptions) task doesn't find any new videos to add, **no** notification will be sent. - Due to the fact that Apprise is running inside a container, [desktop notifications](https://github.com/caronc/apprise/wiki#desktop-notification-services) will not work. - - Notification services that require additional libraries that what is provided by Apprise are not supported. If you really *need* to use services that require additional libraries, you can use Apprise in a standalone server as a proxy or manually install what you need in the container. - - You can add mutiple notifications for the same task by saving and selecting the same task multiple times. + - Notification services that require additional libraries then what is provided by Apprise are not supported. If you really *need* to use services that require additional libraries, you can use Apprise in a standalone server as a proxy or manually install what you need in the container. + - You can add multiple notifications for the same task by saving and selecting the same task multiple times. + - When adding a new URL, you can click on **Test** to send a test notification to verify your URL is working. Monitor the container logs for errors. diff --git a/requirements-dev.txt b/requirements-dev.txt index 87e8b6b..e24e270 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -1,2 +1,2 @@ -r requirements.txt -requirementscheck==0.0.6 +requirementscheck==0.1.0