From c13ffcaafdda283c727ac9dcd2103975a994711c Mon Sep 17 00:00:00 2001 From: Simon Date: Wed, 10 Apr 2024 18:22:39 +0200 Subject: [PATCH 1/7] fix version string parsing docs --- mkdocs/docs/api/additional.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/mkdocs/docs/api/additional.md b/mkdocs/docs/api/additional.md index 480fa8d..abf73d5 100644 --- a/mkdocs/docs/api/additional.md +++ b/mkdocs/docs/api/additional.md @@ -129,18 +129,14 @@ Change watched state, where the `id` can be a single video, or channel/playlist ``` ## Ping -Validate your connection with the API +Validate your connection and authentication with the API **GET** `/api/ping/` -When valid returns message with user id and parsed TubeArchivist version (Family, Major, Minor): +When valid returns message with user id and TubeArchivist version: ```json { "response": "pong", "user": 1, - "version": [ - 0, - 3, - 6 - ] + "version": "v0.4.7" } ``` From e262948291d2454731220de99280d9059d82ac3b Mon Sep 17 00:00:00 2001 From: Simon Date: Wed, 10 Apr 2024 18:23:04 +0200 Subject: [PATCH 2/7] [API] add custom playlist docs --- mkdocs/docs/api/playlist.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/mkdocs/docs/api/playlist.md b/mkdocs/docs/api/playlist.md index 9136a1f..ea4b37f 100644 --- a/mkdocs/docs/api/playlist.md +++ b/mkdocs/docs/api/playlist.md @@ -3,6 +3,10 @@ ## Playlist List **GET** `/api/playlist/` +Parameter: + +- playlist_type: filter py playlist type. + Subscribe/Unsubscribe to a list of playlists: **POST** `/api/playlist/` ```json @@ -16,6 +20,8 @@ Subscribe/Unsubscribe to a list of playlists: ## Playlist Item **GET** `/api/playlist//` +**POST**: Update Playlist item, only valid for custom playlists + Delete playlist, metadata only: **DELETE** `/api/playlist//` Delete playlist, also delete all videos in playlist: From 5f4dea216b79945cb92365caafde8d4da0e9c8a0 Mon Sep 17 00:00:00 2001 From: Simon Date: Wed, 10 Apr 2024 18:23:15 +0200 Subject: [PATCH 3/7] bump requirements --- requirements.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index b2f8a79..58dc3f0 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ cairosvg==2.7.1 mkdocs==1.5.3 -mkdocs-material==9.5.13 -pillow==10.2.0 +mkdocs-material==9.5.17 +pillow==10.3.0 From ccea275c30245b711f6eaefa5473136fec1f2c41 Mon Sep 17 00:00:00 2001 From: Simon Date: Wed, 10 Apr 2024 18:35:05 +0200 Subject: [PATCH 4/7] add custom playlist user docs --- mkdocs/docs/playlists.md | 7 +++++-- mkdocs/docs/video.md | 1 + 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/mkdocs/docs/playlists.md b/mkdocs/docs/playlists.md index 346a7aa..f8fa1e1 100644 --- a/mkdocs/docs/playlists.md +++ b/mkdocs/docs/playlists.md @@ -12,11 +12,14 @@ Accessible at `/playlist/` of your Tube Archivist, this **Overview Page** shows You can index playlists of a channel from the channel detail page as described [here](channels.md#channel-detail). -The **Subscribe to Playlist** button add icon opens a text field to subscribe to playlists. You have a few options: +To add a playlist click on the add icon button. There you can **Subscribe to Playlist**: -- Enter a playlist [playlist](urls.md#playlist) +- Enter a playlist [playlist](urls.md#playlist). - Add one per line. +*or* you can **Create Custom Playlist**. That is a local only playlist. Add videos from their [video detail page](video.md). + + !!! note It doesn't make sense to subscribe to a playlist if you are already subscribed the corresponding channel as this will slow down the **Rescan Subscriptions** [task](downloads.md#rescan-subscriptions). diff --git a/mkdocs/docs/video.md b/mkdocs/docs/video.md index bd240ea..bc3677c 100644 --- a/mkdocs/docs/video.md +++ b/mkdocs/docs/video.md @@ -10,6 +10,7 @@ Clicking on the channel name or the channel icon will bring you to the dedicated - The button **Reindex** will reindex the metadata of this video. - The button **Download File** will download the media file in the browser. - The button **Delete Video** will delete that video including the media file. +- The button **Add to Playlist** opens a list of your available [custom playlists](playlists.md/#playlist-overview). Check the box to add the video to the list. If available, a tag cloud will show, representing the tags set by the uploader. From d7dcbd00f3e864edf331f5d76b7f001ce6c5a0b4 Mon Sep 17 00:00:00 2001 From: David Date: Fri, 12 Apr 2024 13:42:06 +0200 Subject: [PATCH 5/7] Fix typo (#28) --- mkdocs/docs/settings/application.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs/docs/settings/application.md b/mkdocs/docs/settings/application.md index 829c8b4..9efb4a2 100644 --- a/mkdocs/docs/settings/application.md +++ b/mkdocs/docs/settings/application.md @@ -84,7 +84,7 @@ All third party integrations of TubeArchivist will **always** be *opt in*. !!! note This will make a snapshot of your metadata index only, no media files or additional configuration variables you have set on the settings page will be backed up. -System snapshots will automatically make daily snapshots of the Elasticsearch index. The task will start at 12pm your local time. Snapshots are deduplicated, meaning that each snapshot will only have to backup changes since the last snapshot. Old snpshots will automatically get deleted after 30 days. +System snapshots will automatically make daily snapshots of the Elasticsearch index. The task will start at 12pm your local time. Snapshots are deduplicated, meaning that each snapshot will only have to backup changes since the last snapshot. Old snapshots will automatically get deleted after 30 days. - **Create snapshot now**: Will start the snapshot process now, outside of the regular daily schedule. - **Restore**: Restore your index to that point in time. From 7dd45d71e4539085955f9b97bc3be7e8ff75c8db Mon Sep 17 00:00:00 2001 From: Simon Date: Wed, 17 Apr 2024 22:44:02 +0200 Subject: [PATCH 6/7] bump requirements --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 58dc3f0..5bdde6f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ cairosvg==2.7.1 mkdocs==1.5.3 -mkdocs-material==9.5.17 +mkdocs-material==9.5.18 pillow==10.3.0 From ab284e40f0dd79337b02ad67bc81f113e137d446 Mon Sep 17 00:00:00 2001 From: Simon Date: Wed, 17 Apr 2024 22:44:17 +0200 Subject: [PATCH 7/7] add jf plugin --- mkdocs/docs/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs/docs/faq.md b/mkdocs/docs/faq.md index 440ddc1..35934f8 100644 --- a/mkdocs/docs/faq.md +++ b/mkdocs/docs/faq.md @@ -29,7 +29,7 @@ Although there are similarities between these excellent projects and Tube Archiv Part of the scope is to be its own media server, to be able to overcome these limitations, so that's where the focus and effort of this project is. That being said, the nature of self hosted and open source software gives you all the possible freedom to use your media as you wish. -- **Jellyfin**: There is an API to API integration available to sync metadata from Tube Archivist to Jellyfin: [tubearchivist/tubearchivist-jf](https://github.com/tubearchivist/tubearchivist-jf). Follow the instructions there. Please contribute to improve this integration. +- **Jellyfin**: There is a Jellyfin Plugin available to sync metadata to JF: [tubearchivist/tubearchivist-jf-plugin](https://github.com/tubearchivist/tubearchivist-jf-plugin). Follow the instructions there. Please contribute to improve this plugin. - **Plex**: There is a Plex Scanner and Agent combination that allows integration between Tube Archivist and Plex: [tubearchivist/tubearchivist-plex](https://github.com/tubearchivist/tubearchivist-plex). Follow the instructions there. Please contribute to improve this integration. ## How do I install this natively?