index.rst

Installation

Project architecture

The project relies on the following components and services to work:

• A web application server (Python/Django/Gunicorn)
• A PostgreSQL database to store application data
• A redis server to store cache and tasks data
• A celery worker to run asynchronous tasks (such as music import)
• A celery scheduler to run recurrent tasks
• A ntp-synced clock to ensure federation is working seamlessly

Note

The synced clock is needed for federation purpose, to assess the validity of incoming requests.

Hardware requirements

Funkwhale is not especially CPU hungry. On a dockerized instance with 2 CPUs and a few active users, the memory footprint is around ~500Mb:

CONTAINER                   MEM USAGE
funkwhale_api_1             202.1 MiB
funkwhale_celerybeat_1      96.52 MiB
funkwhale_celeryworker_1    168.7 MiB
funkwhale_postgres_1        22.73 MiB
funkwhale_redis_1           1.496 MiB