beets/docs/plugins/kodiupdate.rst
FichteFoll aa31fea037
Update a lot of URLs to use HTTPS
*All* URLs were checked manually, but only once per domain!

I mostly concerned myself with URLs in documentation rather than source
code because the latter may or may not have impactful changes, while the
former should be straight forward.

Changes in addition to simply adding an s:

- changed pip and pypi references as their location has changed
- MPoD (iOS app) url redirects to Regelian, so I replaced those
- updated homebrew references

Notable observations:

- beets.io does have HTTPS set up properly (via gh-pages)
- beatport.py uses the old HTTP url for beatport
- as does lyrics.py for lyrics.wikia.com
- https://tomahawk-player.org/ expired long ago, but the http page
  redirects to https regardless
- none of the sourceforge subdomains have https (in 2019!)
2019-06-05 03:11:49 +02:00

44 lines
1.3 KiB
ReStructuredText

KodiUpdate Plugin
=================
The ``kodiupdate`` plugin lets you automatically update `Kodi`_'s music
library whenever you change your beets library.
To use ``kodiupdate`` plugin, enable it in your configuration
(see :ref:`using-plugins`).
Then, you'll want to configure the specifics of your Kodi host.
You can do that using a ``kodi:`` section in your ``config.yaml``,
which looks like this::
kodi:
host: localhost
port: 8080
user: kodi
pwd: kodi
To use the ``kodiupdate`` plugin you need to install the `requests`_ library with::
pip install requests
You'll also need to enable JSON-RPC in Kodi in order the use the plugin.
In Kodi's interface, navigate to System/Settings/Network/Services and choose "Allow control of Kodi via HTTP."
With that all in place, you'll see beets send the "update" command to your Kodi
host every time you change your beets library.
.. _Kodi: https://kodi.tv/
.. _requests: https://docs.python-requests.org/en/latest/
Configuration
-------------
The available options under the ``kodi:`` section are:
- **host**: The Kodi host name.
Default: ``localhost``
- **port**: The Kodi host port.
Default: 8080
- **user**: The Kodi host user.
Default: ``kodi``
- **pwd**: The Kodi host password.
Default: ``kodi``