8.0 KiB
FAQ
Q: How to update watched status for newly added server without overwriting my current watch state?
First, add the server and when asked, answer n for allow import from this server. when you finish, run the following
command:
$ docker exec -ti watchstate console state:export -vvrm --ignore-date --force-full --servers-filter [SERVER_NAME]
this command will force export your current database state back to the selected server. If the operation is successful you can then enable the import feature if you want.
Q: Is there support for Multi-user setup?
No, The database design centered on single user. However, It's possible to run container for each user.
Note: for Plex managed users run the following command to extract each managed user token.
$ docker exec -ti console servers:remote --list-users-with-tokens -- my_plex_1
For jellyfin/emby, you can use same api-token and just replace the userId.
Q: Sometimes episodes or movies don't make it to webhook server?
As stated in webhook limitation sometimes servers don't make it easy to receive those events, as such, to complement webhooks, its good idea enable the scheduled tasks of import/export and let them run once in a while to re-sync the state of map of server guids, as webhook push support rely entirely on local data of each server.
Q: Can this tool run without docker?
Yes, if you have the required PHP version and the needed extensions. to run this tool you need the following php8.1,
and the following extensions php8.1-pdo, php8.1-mbstring, php8.1-ctype, php8.1-curl, php8.1-sqlite3 and
composer. once you have the required runtime for first time run:
cd ~/watchstate
composer install --optimize-autoloader
after that you can start using the tool via this command.
$ php console
The app should save your data into ./var directory. If you want to change the directory you can export the environment
variable WS_DATA_PATH for console and browser. you can add a file called .env in main tool directory with the
environment variables. take look at the files inside docker directory to know how to run the scheduled tasks and ofc if
you want a webhook support you would need a frontend proxy for php8.1-fpm like nginx, caddy or apache.
Q: Some records keep getting updated even when the state did not change?
This most likely relates to incorrect GUID reported from servers, in our testing we noticed that at least few hundred records in thetvdb that get reported by plex have incorrect imdb, which in turns conflicts sometimes with jellyfin/emby there is nothing we can do beside have the problematic records reported to thetvdb site mods to fix their db entries.
Q: I keep on seeing "No supported GUID was given." in logs?
This most likely means, the item being reported by the media server is not matched, in jellyfin/emby edit metadata and make sure there are External IDs listed in the metadata. like tvdb/imdb etc. For plex click the (...), and click Fix match.
Q: I enabled strict user match to allow only my user to update the state, webhook requests are failing?
If this relates to jellyfin, then please make sure you have selected "Send All Properties (ignores template)", if it's plex and your account is main account then update the user id to 1 by running the following command:
$ docker exec -ti watchstate console servers:edit --key user --set 1 -- [PLEX_SERVER_NAME]
Q: Does this tool require webhooks to work?
No, You can use the task scheduler or on demand sync if you want. However, we recommend the webhook method as it's the most efficient method to gather play state.
Q: When i use jellyfin, i sometimes see double events?
This likely a bug in resulted from jf webhook. #113, Just reload the page make sure there is only one watchstate event.
Q: I keep on seeing "..., entity state is tainted." what does that means?
Tainted events are events that are not used to update the watch state, but they are interesting enough for us to keep around for other benefits like updating the GUID mapping for items. It's normal do not worry about it.
Q: How can I see the database history?
$ docker exec -ti watchstate console db:list
This command will give you access to see the database entries. by default, it will show the last 20 events, however you can run the same command with --help to see more options to extend the list or to filter the results.
Q: Can I ignore specific libraries from being processed?
Yes, First run the following command
$ docker exec -ti watchstate console servers:remote --list-libraries -- [SERVER_NAME]
it should show you list of given server libraries, you are mainly interested in the ID column. take note of the library
id, after that run the following command to ignore the libraries. The options.ignore accepts comma seperated list of
ids to ignore.
$ docker exec -ti watchstate console servers:edit --key options.ignore --set 'id1,id2,id3' -- [SERVER_NAME]
If you ignored a library by mistake you can run the same command again and omit the id, or you can just delete the key entirely by running the following command
$ docker exec -ti watchstate console servers:edit --delete --key options.ignore -- [SERVER_NAME]
Q: I get tired of writing the whole command everytime is there an easy way to do the commands?
Since there is no way to access the command interface outside docker, you can create small shell script to at least omit part of command that you have to write for example create new file named
$ echo 'docker exec -ti watchstate console "$@"' > ws
$ chmod +x ws
after that you can do ws command for example, ws db:list
Q: I am using media servers hosted behind TLS/SSL, and see errors related to http2
Sometimes there are problems related to http/2.0, so before reporting bug please try running the following command
$ docker exec -ti watchstate console servers:edit --key options.client.http_version --set 1.0 -- [SERVER_NAME]
if it does not fix your problem, please open issue about it.
We use symfony/httpClient internally, So any options available in
configuration section, can be used
under options.client. key for example if you want to increase the timeout you can do
$ docker exec -ti watchstate console servers:edit --key options.client.timeout --set 300 -- [SERVER_NAME]
Q: Can I search my server remote libraries?
Yes, Run the following command
$ docker exec -ti console server servers:remote --search '[searchTerm]' -- [SERVER_NAME]
Flags:
- (required)
--searchSearch query. For example,GUNDAM. - (optional)
--search-limitTo limit returned results. Defaults to25. - (optional)
--search-outputSet output style, it can beyamlorjson. Defaults tojson.
Q: Can Task scheduler import unwatched episodes?
Yes, Set the environment variable WS_CRON_IMPORT_UNWATCHED in your docker-compose.yaml and restart your container
for changes to take effect.
Q: Can this tool work with alternative Plex agents?
Supported Agents GUIDs:
- plex://(type)/(id)
- tvdb://(id)
- imdb://(id)
- tmdb://(id)
- com.plexapp.agents.imdb://(id)?lang=en
- com.plexapp.agents.tmdb://(id)?lang=en
- com.plexapp.agents.themoviedb://(id)?lang=en
- com.plexapp.agents.hama://(db)-(id)
- com.plexapp.agents.xbmcnfo://(id)?lang=en
Unsupported Agents:
- com.plexapp.agents.tvdb://(show-id)/(season)/(episode)?lang=en
- com.plexapp.agents.thetvdb://(show-id)/(season)/(episode)?lang=en
- com.plexapp.agents.tvmaze://(show-id)/(season)/(episode)?lang=en
- com.plexapp.agents.xbmcnfotv://(show-id)/(season)/(episode)?lang=en
Those agents do not provide Unique ID, and thus will not work with this tool.