features.rst 2.46 KB
Newer Older
1 2 3 4 5 6
Features
=========

Scope
------

7
Funkwhale is a web based music server. It is similar in terms of goals and feature set to various existing projects, such as `Sonerezh <https://www.sonerezh.bzh/>`_ or `Airsonic <https://airsonic.github.io/>`_.
8 9 10 11

A social platform
------------------

Reg's avatar
Reg committed
12
However, Funkwhale is better-suited for small to medium communities and was designed to be not only a music server and player, but also a place to socialize around music and discover new content. While some of these features are not currently implemented, our roadmap includes:
13

14
- Radios, to discover the music of a given user, artist, or genre
15 16
- Playlists
- Favorites
17
- Broadcasts, as they existed in, for example, Grooveshark
18 19 20 21 22
- Recommendations

Music acquisition
------------------

23
Funkwhale is not bundled with any music, and you'll have to import your own music into the platform.
24

25
At the moment, you can feed your existing music library to the server either by uploading it or by using :ref:`in-place-import` from a server-side directory. Assuming the files have the correct tags defined, they will be imported seamlessly.
26

27
You can also access music being made available by other Funkwhale instances using :doc:`/federation/index`.
28 29 30 31

Metadata
---------

32
In order to keep your library clean, browsable, and well-stocked with relevant data about artists, albums and tracks, we fetch a lot of metadata from the `MusicBrainz project <http://musicbrainz.org/>`_.
33 34 35 36

Structure
---------

37
The project itself is split in two parts:
38

Paul Walko's avatar
Paul Walko committed
39
1. The backend, a REST API developed using Python3 and Django
40 41
2. The frontend, that consumes the API, built as a single page application with VueJS and Semantic UI

Paul Walko's avatar
Paul Walko committed
42
While the main interface to the server and API is the bundled front-end, the project itself is agnostic in the way you connect to it. Therefore, desktop clients or apps could be developed and could implement the same (or even more) features as the bundled frontend.
43

44
This modularity also makes it possible to deploy only a single component from the system.
45 46 47 48 49

Federation
----------

Each Funkwhale instance is able to fetch music from other compatible servers,
50 51 52
and share its own library on the network, in a process known as "federation".
Federation is implemented using the ActivityPub protocol, in order to leverage
existing tools and be compatible with other services such as Mastodon.
53

54 55 56
As of today, federation only targets music acquisition, meaning user
interactions are not shared via ActivityPub. This will be implemented at a later
point.