beets/docs/plugins/mpdupdate.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

39 lines
1.3 KiB
ReStructuredText

MPDUpdate Plugin
================
``mpdupdate`` is a very simple plugin for beets that lets you automatically
update `MPD`_'s index whenever you change your beets library.
.. _MPD: https://www.musicpd.org/
To use ``mpdupdate`` plugin, enable it in your configuration
(see :ref:`using-plugins`).
Then, you'll probably want to configure the specifics of your MPD server.
You can do that using an ``mpd:`` section in your ``config.yaml``,
which looks like this::
mpd:
host: localhost
port: 6600
password: seekrit
With that all in place, you'll see beets send the "update" command to your MPD
server every time you change your beets library.
If you want to communicate with MPD over a Unix domain socket instead over
TCP, just give the path to the socket in the filesystem for the ``host``
setting. (Any ``host`` value starting with a slash or a tilde is interpreted as a domain
socket.)
Configuration
-------------
The available options under the ``mpd:`` section are:
- **host**: The MPD server name.
Default: The ``$MPD_HOST`` environment variable if set, falling back to ``localhost`` otherwise.
- **port**: The MPD server port.
Default: The ``$MPD_PORT`` environment variable if set, falling back to 6600
otherwise.
- **password**: The MPD server password.
Default: None.