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" } ``` 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: diff --git a/mkdocs/docs/faq.md b/mkdocs/docs/faq.md index dd72198..e635eca 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? diff --git a/mkdocs/docs/playlists.md b/mkdocs/docs/playlists.md index 8b3d9de..38c98af 100644 --- a/mkdocs/docs/playlists.md +++ b/mkdocs/docs/playlists.md @@ -12,11 +12,15 @@ Accessible at `/playlist/` of your **Tube Archivist** instance, this **Overview You can index playlists of a channel from the [channel detail page](channels.md#about). -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](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 to the corresponding channel as this will slow down the **Rescan Subscriptions** [task](downloads.md#rescan-subscriptions). diff --git a/mkdocs/docs/settings/application.md b/mkdocs/docs/settings/application.md index 5825495..9d10a2d 100644 --- a/mkdocs/docs/settings/application.md +++ b/mkdocs/docs/settings/application.md @@ -85,7 +85,7 @@ All third party integrations of **Tube Archivist** will **always** be *opt in*. !!! info 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 and outside of the regular daily schedule. - **Restore**: Restore your index to that point in time. Select one of the available snapshots to restore from. diff --git a/mkdocs/docs/video.md b/mkdocs/docs/video.md index 0206f38..50b47cb 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 entry and 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. diff --git a/requirements.txt b/requirements.txt index b2f8a79..5bdde6f 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.18 +pillow==10.3.0