File: plexupdate.rst

package info (click to toggle)
beets 2.5.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 8,016 kB
  • sloc: python: 46,429; javascript: 8,018; xml: 334; sh: 261; makefile: 125
file content (45 lines) | stat: -rw-r--r-- 1,526 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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``