Merge pull request #662 from Splinter7914/work

minor documentation update
This commit is contained in:
Abdulmohsen
2025-05-12 16:36:57 +03:00
committed by GitHub
3 changed files with 14 additions and 3 deletions

10
FAQ.md
View File

@@ -913,7 +913,7 @@ In order to sync the watch progress between media backends, you need to enable t
$ docker exec -ti watchstate console system:env -k WS_SYNC_PROGRESS -e true
```
For best experience, you should enable the `Webhooks` feature for the media backends you want to sync the watch
For best experience, you should enable the [webhook](guides/webhooks.md) feature for the media backends you want to sync the watch
progress,
however, if you are unable to do so, the `Tasks > import` task will also generate progress watch events. However, it's
not as reliable as the `Webhooks` or as fast. using `Webhooks` is the recommended way and offers the best experience.
@@ -922,6 +922,14 @@ To check if there is any watch progress events being registered, You can go to `
`on_progress` events, if you are seeing those, this means the progress is being synced. Check the `Tasks logs` to see
the event log.
If this is setup and working you may be ok with changing the `WS_CRON_IMPORT_AT/WS_CRON_EXPORT_AT` schedule to something less frequenet as
the sync progress working will update the progress near realtime. For example you could change these tasks to run daily instead of hourly.
```
WS_CRON_IMPORT_AT=0 11 * * *
WS_CRON_EXPORT_AT=30 11 * * *
```
---
# Sub users support.

View File

@@ -17,11 +17,11 @@ Please refer to [NEWS](/NEWS.md) for the latest updates and changes.
* **Sub-users** support.
* Sync backends play state (`Many-to-Many` or `One-Way`).
* Backup your backends play state into `portable` format.
* Receive webhook events from media backends.
* Receive [webhook](guides/webhooks.md) events from media backends.
* Find `un-matched` or `mis-matched` items.
* Search your backend metadata.
* Check if your media servers reporting same data via the parity checks.
* Sync your watch progress/play state via webhooks or scheduled tasks.
* Sync your watch [progress/play](FAQ.md#sync-watch-progress) state via webhooks or scheduled tasks.
* Check if your media backends have stale references to old files.
If you like my work, you might also like my other project [YTPTube](https://github.com/arabcoders/ytptube), which is

View File

@@ -73,6 +73,8 @@ Click *Add Webhook / Save*.
Click *Save*.
Note: It is best to disable "Webhook match user" option for Jellyfin backend as some events might not have a user associated with them. See [limitations](#jellyfin) for more info.
### Plex (PlexPass Required)
1. Go to your Plex Web UI and navigate to *Settings > Your Account > Webhooks*. Click *Add Webhook*.
@@ -204,6 +206,7 @@ Here are some known limitations and issues when using webhooks with different me
- When items are marked as **unwatched**, Plex resets the date on the media object.
- If you share your Plex server with other users (e.g., home/managed users), you must enable **Webhook match user** to prevent their play state from affecting yours.
- If you use multiple Plex servers with the same PlexPass account, you must add each backend separately and enable both *Webhook Match User* and *Webhook Match Backend ID*. Plex webhooks are account-wide and not server or user specific.
- If you have multiple "Plex Home" users then you will see miss match reported for user ids. This is because Plex uses the same account to send webhooks for all users in "Plex Home". If you want to capture webhooks for these users then you would need to add them as sub users and set them up with individual webhooks.
### Plex via Tautulli