Commit 9f264e38 authored by Eliot Berriot's avatar Eliot Berriot
Browse files

Docker setup is officialy documented!

parent 5d7b1cb8
Pipeline #60 passed with stages
in 1 minute and 55 seconds
Funkwhale is a web based music server. It is similar in term of goals and feature set to various existing projects, such as `Sonerezh <>`_ or `Libresonic <>`_.
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, genre...
- Playlists
- Favorites
- Broadcasts, as they existed in Grooveshark, for exemple
- Recommendations
Music acquisition
Funkwhale is not bundled with any music, and you'll have to import your own music in the platform using the bundled plugins.
At the moment, you can feed your existing music library to the server and, assuming it has the correct tags defined on the files, it will be imported seamlessly.
You can also import music directly from YouTube (other sources coming, thanks to `Youtube-dl <>`_). Downloading and publishing copyrighted content may be forbidden in your country, though.
In order to keep your library clean, browsable and aggregate relevant data about artists, albums and tracks, we fetch a lot of metadata from the `MusicBrainz project <>`_.
The project itself is splitted in two parts:
1. The backend, a REST API developped 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 developped and implement the same (or even more) features as the bundled frontend.
This modularity also makes it possible do deploy only a single component from the system.
......@@ -3,12 +3,16 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to funkwhale's documentation!
Funkwhale's documentation
Funkwhale is a self-hosted, modern free and open-source music server, heavily inspired by Grooveshark.
.. toctree::
:maxdepth: 2
:caption: Contents:
Docker installation
Docker is the easiest way to get a funkwhale instance up and running.
First, ensure you have `Docker <>`_ and `docker-compose <>`_ installed.
Download the sample docker-compose file:
.. code-block:: bash
mkdir -p /srv/funkwhale
cd /srv/funkwhale
curl -L -o docker-compose.yml ""
Create your env file:
.. code-block:: bash
curl -L -o .env ""
Ensure to edit it to match your needs (this file is heavily commented)
Then, you should be able to pull the required images:
.. code-block:: bash
docker-compose pull
Run the database container and the initial migrations:
.. code-block:: bash
docker-compose up -d postgres
docker-compose run --rm api python migrate
Create your admin user:
.. code-block:: bash
docker-compose run --rm api python createsuperuser
Then launch the whole thing:
.. code-block:: bash
docker-compose up -d
Now, you just need to setup the :ref:`frontend files <frontend-setup>`, and configure your :ref:`reverse-proxy <reverse-proxy-setup>`. Don't worry, it's quite easy.
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 asynchronouse tasks (such as music import)
- A celery scheduler to run recurrent tasks
Available installation methods
.. toctree::
:maxdepth: 1
.. _frontend-setup:
Frontend setup
Files for the web frontend are purely static and can simply be downloaded, unzipped and served from any webserver:
.. code-block:: bash
cd /srv/funkwhale
curl -L -o ""
.. _reverse-proxy-setup:
Reverse proxy
In order to make funkwhale accessible from outside your server and to play nicely with other applications on your machine, you should configure a reverse proxy. At the moment, we only have documentation for nginx, if you know how to implement the same thing for apache, you're welcome.
Ensure you have a recent version of nginx on your server. On debian-like system, you would have to run the following:
.. code-block:: bash
apt-get update
apt-get install nginx
Then, download our sample virtualhost file:
.. code-block:: bash
curl -L -o /etc/nginx/sites-enabled/funkwhale.conf ""
Ensure static assets and proxy pass match your configuration, and check the configuration is valid with ``nginx -t``. If everything is fine, you can restart your nginx server with ``service nginx restart``.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment