mirror of
https://github.com/beetbox/beets.git
synced 2025-12-15 21:14:19 +01:00
Improve formatting in the plugins/plexupdate page
This commit is contained in:
parent
6c06a18f8b
commit
ca320527c8
1 changed files with 41 additions and 18 deletions
|
|
@ -8,18 +8,22 @@ To use ``plexupdate`` plugin, enable it in your configuration
|
|||
(see :ref:`using-plugins`).
|
||||
Then, you'll probably want to configure the specifics of your Plex server.
|
||||
You can do that using an ``plex:`` section in your ``config.yaml``,
|
||||
which looks like this::
|
||||
which looks like this:
|
||||
|
||||
plex:
|
||||
host: localhost
|
||||
port: 32400
|
||||
token: token
|
||||
.. 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`_).
|
||||
|
||||
To use the ``plexupdate`` plugin you need to install the `requests`_ library with:
|
||||
|
||||
pip install requests
|
||||
.. code-block:: console
|
||||
|
||||
$ pip install beets[plexupdate]
|
||||
|
||||
With that all in place, you'll see beets send the "update" command to your Plex
|
||||
server every time you change your beets library.
|
||||
|
|
@ -33,15 +37,34 @@ 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``
|
||||
``host``
|
||||
The Plex server name.
|
||||
|
||||
Default: ``"localhost"``.
|
||||
|
||||
``port``
|
||||
|
||||
The Plex server port.
|
||||
|
||||
Default: ``32400``.
|
||||
|
||||
``token``
|
||||
The Plex Home token.
|
||||
|
||||
Default: ``""``.
|
||||
|
||||
``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``
|
||||
|
|
|
|||
Loading…
Reference in a new issue