mopidy-funkwhale/README.rst

64 lines
1.5 KiB
ReStructuredText
Raw Normal View History

2018-10-03 18:34:45 +02:00
================
mopidy-funkwhale
================
2018-10-03 22:40:14 +02:00
A small `Mopidy`_ backend extension to stream music from a Funkwhale server.
2018-10-03 18:34:45 +02:00
2018-10-03 22:40:14 +02:00
Status
------
2018-10-03 18:34:45 +02:00
2018-10-03 22:40:14 +02:00
This project is still pretty young and is not feature complete. It has been
tested with the latest version of Mopidy and the `Iris`_ and `ncmpcpp`_ clients.
2018-10-03 18:34:45 +02:00
2018-10-03 22:40:14 +02:00
Features
--------
2018-10-03 18:34:45 +02:00
2018-10-03 22:40:14 +02:00
* Searching for tracks, albums and artists available in your Funkwhale instance
* Simple configuration
2018-10-03 18:34:45 +02:00
2018-10-03 22:40:14 +02:00
Installation
------------
2018-10-03 18:34:45 +02:00
2018-10-03 22:40:14 +02:00
We assume you have a Mopidy server available.
2018-10-03 18:34:45 +02:00
2018-10-03 22:40:14 +02:00
We don't have any package for this extension yet, so you may install
from the repository:
2018-10-03 18:34:45 +02:00
2018-10-03 22:40:14 +02:00
.. code-block:: shell
2018-10-03 18:34:45 +02:00
2018-10-03 22:40:14 +02:00
pip install git+https://code.eliotberriot.com/funkwhale/mopidy.git
2018-10-03 18:34:45 +02:00
2018-10-03 22:40:14 +02:00
.. note::
Depending on your setup, you may want to run this comand with ``sudo`` or ``--user``
Configuration
-------------
To enable the extension, add the following to your ``mopidy.conf`` file::
[funkwhale]
enabled = true
# URL of your funkwhale instance
url = https://demo.funkwhale.audio
# Username to use when authenticating (leave empty fo anonymous access)
username = demo
# Password to use when authenticating (leave empty fo anonymous access)
password = demo
Of course, replace the demo values with your actual info (but you can
try using the demo server).
2018-10-03 18:34:45 +02:00
2018-10-03 22:40:14 +02:00
After that, reload your mopidy daemon, and you should be good!
Todo
----
2018-10-03 18:34:45 +02:00
2018-10-03 22:40:14 +02:00
- Browse Funkwhale library and playlists
2018-10-03 18:34:45 +02:00
2018-10-03 22:40:14 +02:00
.. _Mopidy: https://www.mopidy.com/
.. _ncmpcpp: https://wiki.archlinux.org/index.php/ncmpcpp
.. _iris: https://github.com/jaedb/iris