PlexUpdate Plugin
=================

``plexupdate`` is a very simple plugin for beets that lets you automatically
update Plex_'s music library whenever you change your beets library.

Firstly, install ``beets`` with ``plexupdate`` extra

.. code-block:: console

    pip install "beets[plexupdate]"

Then, enable ``plexupdate`` plugin it in your configuration (see
:ref:`using-plugins`). Optionally, configure the specifics of your Plex server.
You can do this using a ``plex:`` section in your ``config.yaml``:

.. code-block:: yaml

    plex:
        host: "localhost"
        port: 32400
        token: "TOKEN"

The ``token`` key is optional: you'll need to use it when in a Plex Home (see
Plex's own `documentation about tokens`_).

With that all in place, you'll see beets send the "update" command to your Plex
server every time you change your beets library.

.. _documentation about tokens: https://support.plex.tv/hc/en-us/articles/204059436-Finding-your-account-token-X-Plex-Token

.. _plex: https://plex.tv/

Configuration
-------------

The available options under the ``plex:`` section are:

- **host**: The Plex server name. Default: ``localhost``.
- **port**: The Plex server port. Default: 32400.
- **token**: The Plex Home token. Default: Empty.
- **library_name**: The name of the Plex library to update. Default: ``Music``
- **secure**: Use secure connections to the Plex server. Default: ``False``
- **ignore_cert_errors**: Ignore TLS certificate errors when using secure
  connections. Default: ``False``
