funkwhale/docs/users/apps.rst

Using Funkwhale from other apps
===============================

The only official client for using Funkwhale is the web client, the one you use in your browser.

As of 0.21, the web client has seen major improvements as a standalone app
with changes to player design to make it a more mobile-first experience as
well as the introduction of `PWA functionality <https://en.wikipedia.org/wiki/Progressive_web_application>`_.
Using Funkwhale as a PWA gives the following benefits:

- Allows users to install the web player as a standalone app on mobile and desktop
- Greatly improves background performance on mobile devices
- Allows you to interact with the player using media keys on desktop
- Allows users to perform updates as soon as they roll out on the server
  at the click of a button

In addition to the web player, this page lists alternative clients you can
use to connect to your Funkwhale instance and enjoy your music.


Subsonic-compatible clients
---------------------------

Since version 0.12, Funkwhale implements a subset of the `Subsonic API <http://www.subsonic.org/pages/api.jsp>`_.
This API is a de-facto standard for a lot of projects out there, and many clients
are available that works with this API.

These Subsonic features are supported in Funkwhale:

- Search (artists, albums, tracks)
- Common library browsing using ID3 tags (list artists, albums, etc.)
- Playlist management
- Stars (which is mapped to Funkwhale's favorites)

These features are missing:

- Transcoding/streaming with different bitrates
- Album covers
- Artist info (this data is not available in Funkwhale)
- Library browsing that relies music directories
- Bookmarks
- Admin
- Chat
- Shares

.. note::

    If you know or use some recent, well-maintained Subsonic clients,
    please get in touch so we can add them to this list.

    In particular we're still lacking an iOS client!


Enabling Subsonic on your Funkwhale account
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. note::

   Accessing Funkwhale from third party apps requires the instance administrator
   to enable the Subsonic API setting. If you are unable to use Subsonic, please
   contact your administrator.

To log-in on your Funkwhale account from Subsonic clients, you will need to
set a separate Subsonic API password by visiting your settings page.

Then, when using a client, you'll have to input some information about your server:

1. Your Funkwhale instance URL (e.g. https://demo.funkwhale.audio)
2. Your Funkwhale username (e.g. demo)
3. Your Subsonic API password (the one you set earlier in this section)

In your client configuration, please double check the "ID3" or "Browse with tags"
setting is enabled.

Ultrasonic (Android)
^^^^^^^^^^^^^^^^^^^^

- Price: free
- F-Droid: https://f-droid.org/en/packages/org.moire.ultrasonic/
- Google Play: https://play.google.com/store/apps/details?id=org.moire.ultrasonic
- Sources: https://github.com/ultrasonic/ultrasonic

Ultrasonic is a full-featured Subsonic client with Playlists, Stars, Search,
Offline mode, etc.

It's one of the recommended Android client to use with Funkwhale, as we are doing
our Android tests on this one.

To enable playback from Funkwhale, enter the following information in the server settings:

- Server address: the root URL of your instance
- Username: your username on the instance
- Password: this will be your subsonic password

Then in the general settings select "Browse Using ID3 Tags"

DSub (Android)
^^^^^^^^^^^^^^

- Price: free (on F-Droid)
- F-Droid: https://f-droid.org/en/packages/github.daneren2005.dsub/
- Google Play: https://play.google.com/store/apps/details?id=github.daneren2005.dsub
- Sources: https://github.com/daneren2005/Subsonic

DSub is a full-featured Subsonic client that works great, and has a lot of features:

- Playlists
- Stars
- Search
- Offline cache (with configurable size, playlist download, queue prefetching, etc.)

It's one of the recommended Android client to use with Funkwhale, as we are doing
our Android tests on this one.

To enable playback from Funkwhale, enter the following information in the server settings:

- Server address: the root URL of your instance
- Username: your username on the instance
- Password: this will be your subsonic password
- Browse By Tags: enabled

play:Sub (iOS)
^^^^^^^^^^^^^^

- Price: $4,99
- App Store: https://itunes.apple.com/us/app/play-sub-subsonic-music-streamer/id955329386
- Website: http://michaelsapps.dk/playsubapp/

Although paid, this app is known to work great with Funkwhale as the maintainer, Michael Bech Hansen, implements Funkwhale-specific logic and checks.

Substreamer (iOS)
^^^^^^^^^^^^^^^^^

- Price: free
- App Store: https://itunes.apple.com/us/app/substreamer/id1012991665


Clementine (Desktop)
^^^^^^^^^^^^^^^^^^^^
- Price: free
- Website: https://www.clementine-player.org/fr/

This desktop client works on Windows, Mac OS X and Linux and is able to stream
music from your Funkwhale instance. However, it does not implement advanced
features such as playlist management, search or stars.

This is the client we use for our desktop tests.

To enable playback from Funkwhale, enter the following information in the Internet -> subsonic settings:

- Server address: the root URL of your instance
- Username: your username on the instance
- Password: this will be your subsonic password

Mopidy (CLI)
^^^^^^^^^^^^
- Price: free
- Website: https://www.mopidy.com/

Mopidy is a Python-based music server which you can run on your machine in order
to access your music through a CLI such as `ncmpcpp <https://github.com/arybczak/ncmpcpp>`_.

In order to use Mopidy to stream from the CLI, you will need to install the following dependencies:

- Mopidy
- mopidy-subidy: a plugin for Subsonic https://github.com/Prior99/mopidy-subidy
- ncmpcpp

Once installed, add the following to your /etc/mopidy/mopidy.conf::

    [subidy]
    enabled=True
    url=https://path.to/your/funkwhale/server
    username=your_funkwhale_username
    password=your_subsonic_password
    #legacy_auth=(optional - setting to yes may solve some connection errors)
    #api_version=(optional - specify which API version to use. Subsonic 6.2 uses 1.14.0)

Then in your .config/ncmpcpp/config, change the startup_screen value so that it doesn't default to the built-in media library::

   startup_screen = browser

This will show your artists, albums, and playlists when you start ncmpcpp.

[Optional]: enable and start mopidy as a service to start the server at boot.

.. note::

   This also works with the `mopidy-funkwhale plugin <https://dev.funkwhale.audio/funkwhale/mopidy>`_

Mobydick (Desktop)
^^^^^^^^^^^^^^^^^^

- Price: free
- Website: https://github.com/AnaGelez/mobydick

Mobydick is a free and open-source desktop application for linux (based on GTK+) to easily download
tracks, albums and discography from a Funkwhale instance.