Skip to content
Snippets Groups Projects
Select Git revision
  • fix-index.html-encoding
  • develop default protected
  • document-loglevel
  • master
  • 1.0.1
  • 1121-download
  • plugins-v3
  • 876-http-signature
  • plugins-v2
  • plugins
  • 1.0.1
  • 1.0
  • 1.0-rc1
  • 0.21.2
  • 0.21.1
  • 0.21
  • 0.21-rc2
  • 0.21-rc1
  • 0.20.1
  • 0.20.0
  • 0.20.0-rc1
  • 0.19.1
  • 0.19.0
  • 0.19.0-rc2
  • 0.19.0-rc1
  • 0.18.3
  • 0.18.2
  • 0.18.1
  • 0.18
  • 0.17
30 results
Blame History Permalink
Forked from funkwhale / funkwhale
5394 commits behind the upstream repository.
features.rst 2.46 KiB

Features

Scope

Funkwhale is a web based music server. It is similar in terms of goals and feature set to various existing projects, such as Sonerezh or Airsonic.

A social platform

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:

  • Radios, to discover the music of a given user, artist, or genre
  • Playlists
  • Favorites
  • Broadcasts, as they existed in, for example, Grooveshark
  • Recommendations

Music acquisition

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

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.

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

Metadata

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.

Structure

The project itself is split in two parts:

  1. The backend, a REST API developed using Python3 and Django
  2. The frontend, that consumes the API, built as a single page application with VueJS and Semantic UI

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.

This modularity also makes it possible to deploy only a single component from the system.

Federation

Each Funkwhale instance is able to fetch music from other compatible servers, 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.

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