Skip to content
Snippets Groups Projects
Verified Commit a5ebf56f authored by Eliot Berriot's avatar Eliot Berriot
Browse files

See #75: User documentation

parent 24cb1d95
No related branches found
No related tags found
No related merge requests found
......@@ -11,6 +11,7 @@ Funkwhale is a self-hosted, modern free and open-source music server, heavily in
.. toctree::
:maxdepth: 2
users/index
features
installation/index
configuration
......
Using Funkwhale from other apps
===============================
As of today, the only official client for using Funkwhale is the web client,
the one you use in your browser.
While the web client works okay, it's still not ready for some use cases, especially:
- Usage on narrow/touche screens (smartphones, tablets)
- Usage on the go, with an intermittent connexion
This pages 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.
Those 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)
Those features as 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.
Especially we're still lacking an iOS client!
Enabling Subsonic on your Funkwhale account
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
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 the recommended Android client to use with Funkwhale, as we are doing
our Android tests on this one.
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.
.. funkwhale documentation master file, created by
sphinx-quickstart on Sun Jun 25 18:49:23 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Funkwhale's users documentation
=====================================
.. note::
This documentation is meant for end-users of the platform.
.. toctree::
:maxdepth: 2
apps
......@@ -11,7 +11,7 @@
<p>
{{ $t('However, accessing Funkwhale from those clients require a separate password you can set below.') }}
</p>
<p><a href="https://docs.funkwhale.audio/users/apps.html#subsonic" target="_blank">
<p><a href="https://docs.funkwhale.audio/users/apps.html#subsonic-compatible-clients" target="_blank">
{{ $t('Discover how to use Funkwhale from other apps') }}
</a></p>
<div v-if="success" class="ui positive message">
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment