Funkwhale is made up of several components. Understanding these components and what they do is important when contributing to Funkwhale’s codebase. In this article, we’ll break down each part of Funkwhale’s architecture to help you understand what each component does.
Below is a diagram of Funkwhale’s project setup.
Select a link below to see information about each component.
Users can access Funkwhale using a variety of entrypoints. They can make use of a Funkwhale application, a Subsonic-compatible application, or by calling the API directly. Each entrypoint interacts with the Funkwhale backend in the same way.
The Funkwhale web app is a SPA written in Vue.js and Typescript. This is the application most people associate with Funkwhale. Server admins usually run an instance of the web app alongside their Funkwhale pod, but you can also connect a standalone web app to another pod.
The Funkwhale web app interacts with the Funkwhale API to fetch and update data. Using a service worker, the web app caches important information for offline use.
Funkwhale for Android is the Funkwhale collective’s official Android app written in Kotlin. It interacts with the Funkwhale API to fetch and update data and stores information for offline playback.
Funkwhale supports a limited subset of the Subsonic API to support existing Subsonic apps. These apps can request data stored on a Funkwhale server by calling these endpoints.
The reverse proxy acts as a layer between a Funkwhale pod and the open internet. It enhances the pod’s security and provides additional options to help increase performance.
When a user tries to communicate with a Funkwhale pod, the reverse proxy:
Handles the HTTP/HTTPS requests and proxies them to the Funkwhale API server
Serves requested static files, such as audio files and stylesheets
The Funkwhale backend is made up of a few components which are responsible for:
Communicating with the user’s entrypoint and actioning requests
Maintaining data consistency
Communicating with other Funkwhale pods (if federation is enabled)
The Funkwhale API is responsible for:
Fetching requested data from the cache/database and returning it to the requester in a meaningful way
Processing incoming data and writing it to the database in a meaningful way
Delegating long-running tasks to workers to reduce load
Funkwhale uses a PostgreSQL database to store data. All information that is served by and sent to the Funkwhale API is stored in this database.
The Funkwhale database makes heavy use of indexes for enhanced performance.
Funkwhale uses Redis to cache information from the database and to store a queue of messages to send. We use this cache to avoid locking database resources and to speed up requests.
Funkwhale has to handle a lot of tasks that take longer than the average HTTP request/response cycle. To ensure these tasks complete and don’t impact the API’s performance, they are offloaded to a Celery task worker. The worker then works through all the tasks in its queue while the API handles real-time responses.
Some common tasks the Celery worker handles are:
In addition to handling tasks from the API, the Celery worker also needs to handle some recurring tasks. To manage these, we implement a Celery beat scheduler. The scheduler is responsible for triggering tasks on a schedule and adding messages to the queue so the worker can work through them.
Some common recurring tasks are:
Clearing the cache
Refreshing content metadata