Go to file
Eliot Berriot 0955df1194
Merge tag '0.5' into develop
0.5 (2018-02-24)
----------------

- Front: Now reset player colors when track has no cover (#46)
- Front: play button now disabled for unplayable tracks
- API: You can now enable or disable registration on the fly, via a preference (#58)
- Front: can now signup via the web interface (#35)
- Front: Fixed broken redirection on login
- Front: Fixed broken error handling on settings and login form

About page:

There is a brand new about page on instances (/about), and instance
owner can now provide a name, a short and a long description for their instance via the admin (/api/admin/dynamic_preferences/globalpreferencemodel/).

Transcoding:

Basic transcoding is now available to/from the following formats : ogg and mp3.

*This is still an alpha feature at the moment, please report any bug.*

This relies internally on FFMPEG and can put some load on your server.
It's definitely recommended you setup some caching for the transcoded files
at your webserver level. Check the the exemple nginx file at deploy/nginx.conf
for an implementation.

On the frontend, usage of transcoding should be transparent in the player.

Music Requests:

This release includes a new feature, music requests, which allows users
to request music they'd like to see imported.
Admins can browse those requests and mark them as completed when
an import is made.
2018-02-24 15:37:56 +01:00
api Version bump and changelog 2018-02-24 15:37:22 +01:00
demo
deploy Removed now useless REGISTRATION_MODE setting 2018-02-24 12:21:02 +01:00
docker/nginx Nginx configuration to cache transcoded media 2018-02-19 21:21:05 +01:00
docs WIP: Debian installation instructions 2017-07-20 23:30:25 +02:00
front About page for instance based on instance descriptions 2018-02-24 15:28:09 +01:00
.dockerignore
.editorconfig
.env.dev Removed now useless BACKEND_URL setting 2018-02-18 14:42:17 +01:00
.gitattributes
.gitignore Ignore useless files 2018-02-18 22:05:35 +01:00
.gitlab-ci.yml Can now configure allowed host in all settings 2018-02-18 14:42:17 +01:00
CHANGELOG Version bump and changelog 2018-02-24 15:37:22 +01:00
CONTRIBUTORS.txt
LICENSE
README.rst
dev.yml Use webpack dev proxy to serve api/media 2018-02-18 14:42:17 +01:00

README.rst

Funkwhale
=============

A self-hosted tribute to Grooveshark.com.

LICENSE: BSD

Setting up a development environment (docker)
----------------------------------------------

First of all, pull the repository.

Then, pull and build all the containers::

    docker-compose -f dev.yml build
    docker-compose -f dev.yml pull


API setup
^^^^^^^^^^

You'll have apply database migrations::

    docker-compose -f dev.yml run celeryworker python manage.py migrate

And to create an admin user::

    docker-compose -f dev.yml run celeryworker python manage.py createsuperuser


Launch all services
^^^^^^^^^^^^^^^^^^^

Then you can run everything with::

    docker-compose up

The API server will be accessible at http://localhost:6001, and the front-end at http://localhost:8080.

Running API tests
------------------

Everything is managed using docker and docker-compose, just run::

    ./api/runtests

This bash script invoke `python manage.py test` in a docker container under the hood, so you can use
traditional django test arguments and options, such as::

    ./api/runtests funkwhale_api.music   # run a specific app test