Something wrong with the translation?

Help us to improve it on our translation platform

Changelog

You can subscribe to release announcements by:

  • Following @funkwhale@fosstodon.org on Mastodon

  • Subscribing to the following Atom feed: https://dev.funkwhale.audio/funkwhale/funkwhale/commits/develop?format=atom&search=Merge+tag

This changelog is viewable on the web at https://docs.funkwhale.audio/changelog.html.

1.3.3 (2023-09-07)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Bugfixes:

  • Revert changed logging to fix crashes

Contributors to our Issues:

  • Alexandra Parker

  • Aurelien Vaillant

  • ChengChung

  • Ciarán Ainsworth

  • Georg Krause

  • Johann Queuniet

  • Kasper Seweryn

  • Mathieu Jourdan

  • Nicolas Derive

  • Puniko Nyan

  • Thomas

  • petitminion

  • philip ballinger

Contributors to our Merge Requests:

  • Ciarán Ainsworth

  • Georg Krause

  • JuniorJPDJ

  • Kasper Seweryn

  • Marcos Peña

  • jooola

  • petitminion

1.3.2 (2023-09-01)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Enhancements:

  • Enable sourcemaps for production builds

  • Use logger composable instead of window.console

Bugfixes:

  • Clear shuffled id list on queue clear (#2192)

  • Fetch the nodeinfo endpoint from .well-known/nodeinfo when checking instance availability

  • Fix instance checking its own availability (#2199)

  • Fix multiarch docker builds #2211

  • Fix ordering when querystring contains + prefix Resolve multiple updates to ordering fields

  • Fix password reset via email

  • Make podcast episode pagination reactive (#2205)

  • Render HTML in podcast short description (#2206)

  • Resolve race condition regarding axios when initializing the frontend Prevent sending same language setting to backend multiple times

Documentation:

  • Fixed incorrect upgrade instructions link in docs.

Contributors to our Issues:

  • Ciarán Ainsworth

  • Georg Krause

  • Kasper Seweryn

  • Kay Borowski

  • Marcos Peña

  • Mathieu Jourdan

  • Virgile Robles

  • codl

  • jooola

  • petitminion

  • tinglycraniumplacidly

  • unkn0wwn52

Contributors to our Merge Requests:

  • Ciarán Ainsworth

  • Georg Krause

  • JuniorJPDJ

  • Kasper Seweryn

  • Marcos Peña

  • Virgile Robles

  • codl

  • jooola

  • petitminion

Committers:

  • Ciarán Ainsworth

  • codl

  • Georg Krause

  • jo

  • Kasper Seweryn

  • petitminion

1.3.1 (2023-06-27)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Bugfixes:

  • Dynamically add report targets to the map to avoid missing keys (#2121)

  • Fix location of the nginx config template for docker deployments (#2146)

  • Fix pagination on search page (#2134)

  • Fix Prune skipped uploads is OOM killed (#2136)

  • Fixed Fomantic UI dropdown messing with Vue internals in radio builder (#2142)

  • Fixed premature login redirect on podcast detail page (#2155)

  • Fixed stale data in indexedDB after logout (#2133)

  • Make sure dependency pins are working with pip install (Restores python3.7 support)

  • Make sure embed codes generated before 1.3.0 are still working

  • Make sure the SPA Manifest is fetched using the right protocol (#2151)

  • Moved modals above all content (#2154)

  • Raise SystemExit exception in API manage.py script

  • Remove track from cache when it gets disposed outside of the cache handler (#2157)

  • Standardize instanceUrl value in instance store (#2113)

  • Fix for banner images not being served on pods.

  • Fixed PWA Window theme color.

Documentation:

  • Fix instructions for using custom nginx configurations in our documentation

Other:

  • Don’t run CI on branch containing stable or develop

Contributors to our Issues:

  • AMoonRabbit

  • Asier Iturralde Sarasola

  • Bertille D.

  • Casuallynoted

  • Ciarán Ainsworth

  • Daniel Jeller

  • Georg Krause

  • JuniorJPDJ

  • Kasper Seweryn

  • Mathieu Jourdan

  • NaiveTub

  • Ricardo

  • Virgile Robles

  • nouts

  • petitminion

Contributors to our Merge Requests:

  • AMoonRabbit

  • Ciarán Ainsworth

  • Georg Krause

  • JuniorJPDJ

  • Kasper Seweryn

  • jooola

  • petitminion

Committers:

  • AMoonRabbit

  • Georg Krause

  • jo

  • JuniorJPDJ

  • Kasper Seweryn

  • Moon Rabbit

  • Petitminion

1.3.0 (2023-06-01)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Update instructions:

  • If you are running the docker deployment, make sure to update our compose file. In this small example we show you how to save the old config and update it correctly:

    export FUNKWHALE_VERSION="1.3.0"
    cd /srv/funkwhale
    docker-compose down
    mv docker-compose.yml docker-compose.bak
    curl -L -o /srv/funkwhale/docker-compose.yml "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/${FUNKWHALE_VERSION}/deploy/docker-compose.yml"
    

    Note

    If you need to customize your nginx template, e.g. to work around problems with Docker’s resolver, you can mount your custom nginx configuration into the container. Uncomment the commented volumes in the nginx section of your docker-compose.yml. Additionally you need to update the paths in nginx/funkwhale.template. Replace all occurrences of /funkwhale by /usr/share/nginx/html. This loads the templates from your nginx folder and overrides the template files in the Docker container.

    docker-compose up -d
    
  • The Docker instructions now use the updated Docker compose plugin. If you previously used the docker-compose standalone installation, do the following while upgrading:

    1. Download the Docker compose plugin

    2. Stop your containers using the docker-compose syntax.

    sudo docker-compose down
    
    1. Bring the containers back up using the docker compose syntax.

    sudo docker compose up -d
    

    After this you can continue to use the docker compose syntax for all Docker management tasks.

  • Upgrade Postgres to version 15. Make sure to migrate!

  • With this update Funkwhale starts using poetry to maintain its dependencies. We therefore recommend removing the old virtualenv by running rm -rf /srv/funkwhale/virtualenv.

Features:

  • Add a management command to create a new library for a user

  • Add Gitpod configuration and guide

  • Add Sentry SDK to collect #1479

  • Prepare API for the upcoming version 2

  • Rewrite player to be based on Web Audio API

Enhancements:

  • Add a celery task to scan remote library (#1712)

  • Add coverage report for Frontend Tests

  • Add hint which serializer is used for OembedView (#1901)

  • Add music visualizer (#1135)

  • Add playable tracks to gitpod instance

  • Add playlists radio to search page (#1968)

  • Add proper serialization for TextPreviewView (#1903)

  • Add python debug and test support for gitpod

  • Add Serializer for SpaManifest endpoint

  • Add support for python 3.11

  • Added proper serializers for the rate-limit endpoint.

  • Added type hints to the API.

  • Adding support for play all radio in search result page (#1563)

  • All administrator documentation has been rewritten to improve clarity and update outdated information.

  • Allow arbitrary length names for artists, albums and tracks

  • Allow installing the funkwhale_api package

  • Allow using default browser dark mode and update UI dynamically on change

  • Apply migrations on API container start (!1879)

  • Automatically fetch next page of tracks (#1526)

  • Build frontend natively for cross-arch docker images

  • Change unmaintained PyMemoize library to django-cache-memoize to enable Python 3.10 support

  • Cleaned up frontend docker container

  • Cleanup Gitlab CI and Dockerfiles (!1796)

  • Create the funkwhale-manage entrypoint in the api package

  • Created migration guide for the deprecated all-in-one docker container.

  • Don’t buffer python stdout/err in docker

  • Don’t compile python byte code in docker

  • Don’t use poetry in production deployments

  • Drop direct dependency on pyopenssl (#1975)

  • Exclude /api/v1/oauth/authorize from the specs since its not supported yet (#1899)

  • Fix openapi specs for user endpoints (#1892, #1894)

  • Fix Serializer for inline channel artists (#1833)

  • Fix specs for ListenViewSet (#1898)

  • Handle PWA correctly and provide better cache strategy for album covers (#1721)

  • Improve docker caching

  • Improve specification of LibraryFollowViewSet (#1896)

  • Install API python package in docker image

  • Make CI always run all tests on protected branches.

  • Make mutations endpoint appear in openapi specs

  • Make Python 3.10 tests in CI mandatory

  • Make sure ChannelViewSet always has a serializer (#1895)

  • Migrate to new queue system from old localStorage keys

  • Migrate to Vue 3

  • Migrate to vue-i18n (#1831) Fix locale changing (#1862)

  • Migrated to sphinx-design.

  • New task checking if remote instance is reachable to avoid playback latence (#1711)

  • OAuth Application client secrets are now hashed before storing them to the DB. Those are only displayed once from now on!

  • Parameterize the default S3 ACL when uploading objects. (#1319)

  • Pin Alpine package versions in API Dockerfile (fixes part of CI build issues).

  • Prefer using the funkwhale-manage entrypoint

  • Prevent running two pipelines for MRs

  • Random and less listened radio filter out un-owned content on library section (#2007)

  • Refactor node info endpoint to use proper serializers

  • Refactor SettingsView to use a proper serializer

  • Remove unnecessary or wrong is keyword usage from backend

  • Rename OpenAPI schema’s operation ids for nicer API client method names.

  • Replace django-channels package with web socket implementation from @vueuse/core (#1715)

  • Retry fetching new radio track 5 times if error occurred before resetting radio session (#2022)

  • Rewrite embedded player to petite-vue

  • Split DATABASE_URL into multiple configuration variables

  • The ListenBrainz plugin submits the track duration

  • Update Django OAuth Toolkit to version 2, ref #1944

  • Update migration after django update (#1815)

  • Update upload status when import fails (#1999)

  • Updated the installation guides to make installation steps clearer.

  • Upgrade docker base image to alpine 3.17

  • Use proper serializer for Search endpoint (#1902)

Refactoring:

  • Instead of requesting the right spa content from the API using a middleware we now serve the Frontend directly with nginx and only proxy-forward for API endpoints

  • Replace django-rest-auth with dj-rest-auth (#1877)

Bugfixes:

  • Allow enabling systemd funkwhale.target

  • Allow playback of media from external frontend (#1937).

  • Allow summary field of actors to be blank. This leaves actors valid that have a blank ("") summary field and allows follows from those.

  • Catch ValueError on radio end (#1596)

  • Channel overview was displaying foreign tracks (#1773) (1773)

  • Docker setup: do not export the API port 5000 publicly

  • Fix adding same track multiple times (#1933)

  • Fix artist name submission in Maloja plugin

  • Fix changing visualizer CORS error (#1934).

  • Fix content form autofocus despite autofocus prop being set to false (#1924)

  • Fix CSP header issues

  • Fix CSP issue caused by django-channels package (#1752)

  • Fix docker API image building with removing autobahn workaround version pin

  • Fix docker builds on armv7

  • Fix docker nginx entrypoint

  • Fix editing playlist tracks (#1362)

  • Fix embedded player not working on social posts (1946)

  • Fix favorite button in queue

  • Fix fetching pages of albums in album detail view (#1927)

  • Fix front album tracks count translation

  • Fix global keyboard shortcuts firing when input is focused (#1876)

  • Fix lots of problems in debian installation guide

  • Fix media directory nginx routing error in front docker container introduced in !1897

  • Fix OAuth login (#1890)

  • Fix play button in albums with multi-page volumes (#1928)

  • Fix player closing when queue ends (#1931)

  • Fix postgres connection details in docker setup

  • Fix purging of dangling files #1929

  • Fix remote search (#1857)

  • Fix search by text in affected views (#1858)

  • Fix timeout on spa manifest requests

  • Fix track table showing all tracks and double pagination in some cases (#1923)

  • Fix user requests and reports filtering (#1924)

  • Fix validity issues in openapi/swagger spec files (#1171)

  • Fixed an issue which caused links in Markdown forms to not render correctly. (#2023)

  • Fixed login redirect (1736)

  • Fixed mobile player element widths (#2054)

  • Fixed remote subscription form in Podcast and search views (#1708)

  • Fixed upload form VUE errors (#1738) (1738)

  • Fixes an issue which made it possible to download all media files without access control (#2101)

  • Fixes channel page (#1729) (1729)

  • Fixes development environment set-up with docker (1726)

  • Fixes embed player (#1783) (1783)

  • Fixes service worker (#1634)

  • Fixes track listenings not being sent when tab is not focused

  • Hide create custom radio to un-authenticated users (#1720)

  • Improve signal handling for service and containers

  • Move api docker hardcoded env vars in the settings module

  • Prefer str over dict for the CACHE_URL api setting

    This fix the ability to reuse the CACHE_URL with other settings such as CELERY_BROKER_URL.

  • Remove trailing slash from reverse proxy configuration

  • Remove unused Footer component (#1660)

  • Remove usage of deprecated Model and Serializer fields (#1663)

  • Resolved an issue where queue text with mouse over has dark text on dark background (#2058) (2058)

  • Skip refreshing local actors in celery federation.refresh_actor_data task - fixes disappearing avatars (!1873)

Documentation:

  • Add ability to translate documentation into multiple languages

  • Add generic upgrade instructions to Docker postgres documentation (#2049)

  • Add restore instructions to backup docs (#1627).

  • Add systemd update instructions to Debian upgrade instructions (#1966)

  • Added Nginx regeneration instructions to Debian update guide (#2050)

  • Added virtualenv upgrade instructions for Debian (#1562).

  • Cleaned up documentation

  • Document the new login flow of the CLI-tool (#1800)

  • Documented LOGLEVEL command (#1541).

  • Documented the NGINX_MAX_BODY_SIZE .env variable (#1624).

  • Fix broken links in CHANGELOG (#1976)

  • Harden security for debian install docs

  • Remove unnecessary postgres variable in Docker migration guide (#2124).

  • Rewrote documentation contributor guide.

  • Rewrote the architecture file (#1908)

  • Rewrote the federation developer documentation (#1911)

  • Rewrote the plugins documentation (#1910)

  • Rewrote translators file

  • Updated API developer documentation (#1912, #1909)

  • Updated CONTRIBUTING guide with up-to-date documentation. Created layout in documentation hub.

Other:

  • Add a CI job to check if changelog snippet is available

  • Add CI broken links checker

  • Add pre-commit hooks

    • flake8

    • black

    • isort

    • pyupgrade

    • prettier

    • codespell

  • Add pre-commit to development tools

  • Align the openapi spec to the actual API wherever possible

  • Cache lychee checked urls for 1 day in CI

  • Fix api tests warnings by renaming fixtures

  • Fix permissions for build artifacts

  • Fix shell scripts lint errors

  • Format api pyproject.toml

  • Format or fix files using pre-commit

    • Upgrade code to >=python3.7

    • Fix flake8 warnings

    • Fix spelling errors

    • Format files using black

    • Format files using isort

    • Format files using prettier

  • Move api tools config to pyproject.toml

  • Move database url composition from custom script to django settings

  • Remove docker_all_in_one_release ci job

  • Rename api composer/django/ dir to docker/

  • Unpin asgiref in API dependencies

  • Use vite for building the frontend, #1644

Deprecation:

  • Deprecate the api manage.py script in favor of the funkwhale-manage entrypoint

  • That’s the last minor version series that supports python3.7. Funkwhale 1.4 will remove support for it. #1693

  • The automatically generated DATABASE_URL configuration in the docker setup is deprecated, please configure either the DATABASE_URL environment variable or the DATABASE_HOST, DATABASE_USER and DATABASE_PASSWORD environment variables instead.

Removal:

  • This release removes support for Python 3.6. Please make sure you update your python version before Updating Funkwhale!

Committers:

  • Agate

  • Aina Hernàndez Campaña

  • AMoonRabbit

  • Anton

  • bruce diao

  • Bruno Talanski

  • ButterflyOfFire

  • Çağla Pickaxe

  • Ciarán Ainsworth

  • Dignified Silence

  • dignny

  • Éilias McTalún

  • EorlBruder

  • Fedi Funkers

  • Georg Krause

  • ghose

  • Henri Dickson

  • Jacek Pruciak

  • Jasper Bogers

  • Jhoan Sebastian Espinosa Borrero

  • jo

  • jooola

  • Julian Rademacher

  • JuniorJPDJ

  • Kasper Seweryn

  • Keunes

  • Kisel1337

  • Laurin W

  • Marcos Peña

  • Matyáš Caras

  • Michael Long

  • nztvar

  • oki

  • Petitminion

  • Philipp Wolfer

  • poeppe

  • Porrumentzio

  • ppom

  • Reinhard Prechtl

  • Sky

  • Sporiff

  • Stuart Begley-Miller

  • @ta

  • Thomas

  • Till Robin Zickel

  • tobifroe

  • wvffle

Contributors to our Issues:

  • AMoonRabbit

  • Agate

  • Artem Anufrij

  • ChengChung

  • Ciarán Ainsworth

  • Creak

  • Eric Mesa

  • Georg Krause

  • Hans Bauer

  • HurricaneDancer

  • Jakob Schürz

  • Jucgshu

  • Julian-Samuel Gebühr

  • JuniorJPDJ

  • Kasper Seweryn

  • Keunes

  • Laser Lesbian

  • Laurin W

  • Marco

  • Marcos Peña

  • Martin Giger

  • Mathieu Jourdan

  • MattDHarding

  • Meliurwen

  • Micha Gläß-Stöcker

  • MichaelBechHansen

  • Nathan Mih

  • Nicolas Derive

  • Nolan Darilek

  • Philipp Wolfer

  • Porrumentzio

  • Rodion Borisov

  • Sam Birch

  • Sky Leite

  • TheSunCat

  • Thomas

  • Tobias Frölich

  • Tony Wasserka

  • Vincent Riquer

  • Virgile Robles

  • dddddd-mmmmmm

  • gerry_the_hat

  • getzze

  • heyarne

  • jake

  • jooola

  • jovuit

  • nouts

  • petitminion

  • ppom

  • pullopen

  • resister

  • silksow

  • troll

Contributors to our Merge Requests:

  • AMoonRabbit

  • Ciarán Ainsworth

  • Georg Krause

  • JuniorJPDJ

  • Kasper Seweryn

  • Laurin W

  • Marcos Peña

  • Mathieu Jourdan

  • Nicolas Derive

  • Philipp Wolfer

  • Rodion Borisov

  • Thomas

  • Tobias Frölich

  • getzze

  • jooola

  • mqus

  • petitminion

  • poeppe

1.2.10 (2023-03-17)

Bugfixes:

  • Fixes a security vulnerability that allows to download all media files without access control #2101

Contributors to our Issues:

  • Georg Krause

  • JuniorJPDJ

Special thanks to Conradowatz for reporting the vulnerability

Committers:

  • JuniorJPDJ

1.2.9 (2022-11-25)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Bugfixes:

  • Ensure index.html files get loaded with UTF-8 encoding

  • Fixed invitation reuse after the invited user has been deleted (#1952)

  • Fixed unplayable skipped upload (#1349)

Committers:

  • Georg Krause

  • Marcos Peña

  • Philipp Wolfer

  • Travis Briggs

Contributors to our Issues:

  • Ciarán Ainsworth

  • Georg Krause

  • JuniorJPDJ

  • Kasper Seweryn

  • Marcos Peña

  • Mathieu Jourdan

  • Micha Gläß-Stöcker

  • fuomag9

  • gammelalf

  • myOmikron

  • petitminion

Contributors to our Merge Requests:

  • Georg Krause

  • JuniorJPDJ

  • Marcos Peña

  • Philipp Wolfer

  • fuomag9

1.2.8 (2022-09-12)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Features:

  • Add Sentry SDK to collect errors at the backend

Bugfixes:

  • Fix exponentially growing database when using in-place-imports on a regular base #1676

  • Fix navigating to registration request not showing anything (#1836)

  • Fix player cover image overlapping queue list

  • Fixed metadata handling for Various Artists albums (#1201)

  • Fixed search behaviour in radio builder’s filters (#733)

  • Fixed unpredictable subsonic search3 results (#1782)

Committers:

  • Ciarán Ainsworth

  • Georg Krause

  • Marcos Peña

  • Mathias Koehler

  • wvffle

Contributors to our Issues:

  • AMoonRabbit

  • Agate

  • Ciarán Ainsworth

  • Georg Krause

  • JuniorJPDJ

  • Kasper Seweryn

  • Kelvin Hammond

  • Marcos Peña

  • Meliurwen

  • Micha Gläß-Stöcker

  • Miv2nir

  • Sam Birch

  • Tolriq

  • Tony Wasserka

  • f1reflyyyylmao

  • heyarne

  • petitminion

  • troll

Contributors to our Merge Requests:

  • Ciarán Ainsworth

  • Georg Krause

  • JuniorJPDJ

  • Kasper Seweryn

  • Marcos Peña

  • interru

1.2.7 (2022-07-14)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Bugfixes:

  • Fixed libre.fm plugin not submitting scrobbles (#1817)

Committers:

  • Georg Krause

  • Marcos Peña

Contributors to our Issues:

  • Ciarán Ainsworth

  • Marcos Peña

Contributors to our Merge Requests:

  • Georg Krause

  • Marcos Peña

1.2.6 (2022-07-04)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Bugfixes:

  • Channel overview was displaying foreign tracks (#1773)

  • Fixed login form focusing reset password link instead of next input (#1373)

  • Fixed missing album contextual menu (#1791)

  • Fixed single listening submission when repeating a song (#1312)

  • Fixed subsonic createPlaylist’s endpoint doesn’t update playlist (#1263)

  • Resolve timeouts if nodeinfo and service actor is not known (#1714)

Other:

  • Replaced references to #funkwhale-troubleshooting with #funkwhale-support

Committers:

  • Georg Krause

  • Marcos Peña

  • Petitminion

  • wvffle

Contributors to our Issues:

  • jeweet

  • wvffle

  • Georg Krause

  • Marcos Peña

  • AMoonRabbit

  • Micha Gläß-Stöcker

  • Ciarán Ainsworth

  • heyarne

  • Agate

  • JuniorJPDJ

  • MichaelBechHansen

  • ooZberg

  • Esras .

  • PhieF

  • Petitminion

Contributors to our Merge Requests:

  • wvffle

  • Georg Krause

  • Marcos Peña

  • Petitminion

1.2.5 (2022-05-07)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Enhancements:

  • Parameterize the default S3 ACL when uploading objects. (#1319)

Bugfixes:

  • Fix stopped player to not show 00:00 when loading a track (#1432)

  • Fixes channel page (#1729) (1729)

Committers:

  • Georg Krause

  • Marcos

  • MattDHarding

  • Stuart Begley-Miller

Contributors to our Issues:

  • Agate

  • Beto Dealmeida

  • Cam Sweeney

  • Ciarán Ainsworth

  • Georg Krause

  • JuniorJPDJ

  • Marcos Peña

  • Mathieu Jourdan

  • MattDHarding

  • Micha Gläß-Stöcker

  • Stuart Begley-Miller

  • Tony Wasserka

  • jovuit

  • petitminion

  • pullopen

Contributors to our Merge Requests:

  • Ciarán Ainsworth

  • Georg Krause

  • JuniorJPDJ

  • Marcos Peña

  • MattDHarding

  • PhieF

  • Stuart Begley-Miller

  • petitminion

1.2.4 (2022-04-23)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Enhancements:

  • Hand cursor now displayed over artist and album cards

Bugfixes:

  • Fixes docs’ SMTP URI configuration (#1749) (1749)

Documentation:

  • The documentation is now available in two versions: Develop and Stable

Contributors to our Issues:

  • Beto Dealmeida

  • Cam Sweeney

  • Ciarán Ainsworth

  • Georg Krause

  • JuniorJPDJ

  • Marcos Peña

  • Mathieu Jourdan

  • Micha Gläß-Stöcker

  • petitminion

Contributors to our Merge Requests:

  • Georg Krause

  • JuniorJPDJ

  • Marcos Peña

  • petitminion

Committers:

  • Georg Krause

  • Marcos Peña

  • MattDHarding

1.2.3 (2022-03-18)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Enhancements:

  • Added support for all cover sources in the embedded player (#1697).

  • Change unmaintained PyMemoize library to django-cache-memoize to enable Python 3.10 support

Bugfixes:

  • Catch ValueError on radio end (#1596)

  • Fix bug that prevents users from creating a new oauth application (#1706)

  • Fix failed track adding to playlist being silent (#1020)

  • Fix recently added radio not working has expected (#1674)

  • Fixed an issue where you couldn’t load the details page for tracks with no associated album (#1703)

  • Fixed library visibility dropdown (#1384)

  • In playlist editor can now click outside the trashcan but inside the button to delete entry (#1348)

Contributors to our Issues:

  • Agate

  • Baudouin Feildel

  • Christoph Pomaska

  • Ciarán Ainsworth

  • Georg Krause

  • JuniorJPDJ

  • Kasper Seweryn

  • Marcos Peña

  • Mathieu Jourdan

  • MattDHarding

  • Micha Gläß-Stöcker

  • dnikolov

  • jovuit

  • petitminion

Contributors to our Merge Requests:

  • Ciarán Ainsworth

  • Georg Krause

  • JuniorJPDJ

  • Kasper Seweryn

  • Marcos Peña

  • MattDHarding

  • petitminion

Committers

  • Ciaran Ainsworth

  • Georg Krause

  • JuniorJPDJ

  • MattDHarding

  • Petitminion

  • Reinhard Prechtl

1.2.2 (2022-02-04)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Bugfixes:

  • Fix an issue where the tracks tab in a library doesn’t show any tracks (#1683)

  • Fix an issue with the embedded player not showing any content (#1675)

  • Fix broken instance description if it contains a line break #1673

Dependency Updates:

  • Update dependency vue-template-compiler to 2.6.14

  • Update dependency vue to ^2.6.14

  • Update dependency vuex-persistedstate to ^2.7.1

  • Update dependency vuedraggable to ^2.24.3

  • Update dependency vue-lazyload to ^1.3.3

  • Update dependency vue-plyr to ^5.1.3

  • Update dependency vue-upload-component to ^2.8.22

  • Update dependency vue-gettext to ^2.1.12

  • Update dependency showdown to ^1.9.1

  • Update dependency js-logger to ^1.6.1

  • Update dependency register-service-worker to ^1.7.2

  • Update dependency howler to ^2.2.3

  • Update dependency fomantic-ui-css to ^2.8.8

  • Update dependency diff to ^4.0.2

  • Update dependency axios-auth-refresh to ^2.2.8

Contributors to our Issues:

  • Ciarán Ainsworth

  • Georg Krause

  • JuniorJPDJ

  • Marcos Peña

  • Mathieu Jourdan

  • Micha Gläß-Stöcker

  • Ricardo

  • petitminion

Contributors to our Merge Requests:

  • Ciarán Ainsworth

  • Georg Krause

  • JuniorJPDJ

  • Marcos Peña

Committers

  • Ciarán Ainsworth

  • Georg Krause

  • JuniorJPDJ

  • Keunes

  • Marcos Peña

1.2.1 (2022-01-06)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Bugfixes:

  • Fix Pipeline for stable release builds (#1652)

  • Fix remote content page (#1655)

Contributors to our Issues:

  • Ciarán Ainsworth

  • Georg Krause

  • Jakob Schürz

  • Mathieu Jourdan

  • Micha Gläß-Stöcker

  • petitminion

Contributors to our Merge Requests:

  • Georg Krause

Committers:

  • Dignified Silence

  • Georg Krause

  • JuniorJPDJ

  • nztvar

1.2.0 (2021-12-27)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Due to a bug in our CI Pipeline, you need to download the frontend artifact here: https://dev.funkwhale.audio/funkwhale/funkwhale/-/jobs/81069/artifacts/download

If you are running the All-in-One-Container since a longer time, you probably need to manually migrate your database information. If that’s the case, you will get a message like this:

DETAIL: The data directory was initialized by PostgreSQL version 11, which is not compatible with this version 13.5.

Make sure the Funkwhale version is set to 1.1.4 in docker-compose.yml. Now you can run this command to dump the database into a file:

docker-compose exec -T funkwhale pg_dump -c -U funkwhale > "db.dump"

Now you can update the Funkwhale version in docker-compose.yml to 1.2.0. Additionally you should save your data directory, eg by running mv data data.bak && mkdir data. Stop Funkwhale and start it again with the new version, by using docker-compose down && docker-compose up -d. This will initialize a fresh DB and applies all migrations. Now you can restore your database with the following command: cat db.dump | docker-compose exec -T funkwhale psql -U funkwhale. That’s it, enjoy!

Features:

  • Implemented awesome recently added radio (part of #1390)

  • Rework the instance about page (#1376)

  • Made changes to the track table to make it more visibly pleasing

Enhancements:

  • Add linting for Frontend code (#1602)

  • Add xmlns:content to feed schemas fixes #1535

  • Add a Maloja plugin to submit listenings

  • Add artist cover art in subsonic API response (#1528)

  • Allow listen activities privacy level to be set public

  • Allow running multi-container setup on non-root user inside docker (!1375) (fixes #1334)

  • Change volume dynamic range from 60dB to 40dB (fixes #1544)

  • Change Start Radio to Play Radio (#1400)

  • Display toast when subsonic password is copied (#1496)

  • Expose more metadata in Subsonic’s getAlbumList endpoint (#623)

  • ListenBrainz: Submit media player and submission client information

  • Make “play in list” the default when interacting with individual tracks (#1274)

  • Prevent an uncontrolled exception when uploading a file without tags, and prints user friendly message (1275)

  • Remove deprecated JWT Authentication (#1108) (1108)

  • Remove Raven SDK to report errors to Sentry (#1425) (1425)

  • Replace psycopg2-binary with psycopg2 (#1513)

Bugfixes:

  • Add worker-src to nginx header to prevent issues (#1489)

  • Enable stepless adjustment of the volume slider (!1294)

  • Fix an error in a Subsonic methods that return lists of numbers/strings like getUser

  • Fix showing too long radio descriptions (#1556)

  • Fix X-Frame-Options HTTP header for embed and force it to SAMEORIGIN value for other pages (fix #1022)

  • Fix before last track starts playing when last track removed (#1485)

  • Fix delete account button is not disabled when missing password (#1591)

  • Fix omputed properties already defined in components data (#1649)

  • Fix the all in one docker image building process, related to #1503

  • Fix crash in album moderation interface when missing cover (#1474)

  • Fix subsonic scrobble not triggering plugin hook (#1416)

  • Improve formatting of RSS episode descriptions (#1405)

  • Only suggest typed tag once if it already exists

  • Partially fixed playing two tracks at same time (#1213)

  • Revert changes that break mobile browser playback (#1509)

  • Sanitize remote tracks’ saving locations with slashes on their names (#1435)

  • Show embed option for channel tracks (#1278)

  • Store volume in logarithmic scale and convert when setting it to audio (fixes #1543)

  • Use global Howler volume instead of setting it separately for each track (fixes #1542)

Documentation:

  • Add email configuration to the documentation (#1481)

  • Add server uninstallation documentation (!1314)

  • Document location of cli env file on macOS (!1354)

  • Fix broken backup documentation (#1345)

  • Refactore installation documentation and other small documentation adjustments (!1314)

  • Add User documentation for built-in plugins

Other:

  • Create stable branch, master is now deprecated and will be removed in 1.3 (#1476)

Committers:

  • Alexandra Parker

  • Alyssa Ross

  • appzer0

  • Arthur Brugière

  • Asier Iturralde Sarasola

  • bittin

  • Blopware

  • Brian McMillen

  • Christoph Pomaska

  • Ciaran Ainsworth

  • Ciarán Ainsworth

  • Classified

  • Connor Hay

  • Damian Szetela

  • David Marzal

  • Deleted User

  • Dignified Silence

  • Dominik Danelski

  • egon0

  • Erik Präntare

  • Georg Abenthung

  • Georgios B

  • Georgios Brellas

  • Georg Krause

  • ghose

  • greengekota

  • heyarne

  • ian Vatega

  • Janek

  • jovuit

  • JuniorJPDJ

  • Konstantinos G

  • manuelviens

  • Manuel Viens

  • Marcos

  • Marcos Peña

  • Martin Giger

  • Matthew J

  • Micha Gläß-Stöcker

  • petitminion

  • Petitminion

  • Philipp Wolfer

  • Porrumentzio

  • Quentin PAGÈS

  • Raphael Lullis

  • Riccardo Sacchetto

  • Romain Failliot

  • Rubén Cabrera

  • Ryan Harg

  • Sergio Varela

  • SpcCw

  • Stefano Pigozzi

  • Thomas

  • Tony Simoes

  • Tony Wasserka

  • vachan-maker

  • Virgile Robles

Contributors to our Issues:

  • AMoonRabbit

  • Agate

  • Antoine POPINEAU

  • Arthur Brugière

  • Ciarán Ainsworth

  • Connor Hay

  • Creak

  • David Marzal

  • Georg Krause

  • Gerhard Beck

  • Greg Poole

  • JuniorJPDJ

  • Kuba Orlik

  • Lunar Control

  • Marcos Peña

  • Mateusz Korzeniewski

  • Mathieu Jourdan

  • Micha Gläß-Stöcker

  • Philipp Wolfer

  • Porrumentzio

  • Thomas

  • Tony Wasserka

  • Ville Ranki

  • arkhi

  • heyarne

  • interfect

  • jovuit

  • mal

  • petitminion

  • vachan-maker

Contributors to our Merge Requests:

  • Agate

  • Arthur Brugière

  • Ciarán Ainsworth

  • Connor Hay

  • David Marzal

  • Distopico

  • Fanyx

  • Georg Abenthung

  • Georg Krause

  • Janek

  • JuniorJPDJ

  • Kasper Seweryn

  • Marcos Peña

  • Mathieu Jourdan

  • Matthew J.

  • Micha Gläß-Stöcker

  • Philipp Wolfer

  • Thomas

  • Tony Wasserka

  • heyarne

  • jovuit

  • petitminion

  • thanksd

1.1.4 (2021-08-02)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

  • Pinned version of asgiref to avoid trouble with latest release. For further information, see #1516

1.1.3 (2021-08-02)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Enhancements:

  • Test better tagging of Docker Images (#1505)

Bugfixes:

  • Fix the scrobbler plugin submitting literal “None” as MusicBrainz ID (#1498)

  • Add worker-src to nginx header to prevent issues (#1489)

  • Only suggest typed tag once if it already exists

  • Implement access control on the moderation views (#1494)

  • Prevent open redirect on login (#1492)

1.1.2 (2021-05-19)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Enhancements:

  • Added modal to prompt users to log in when subscribing to channels (#1296)

Bugfixes:

  • Added missing is_playable serializer for the tracks endpoint.

  • Fixed minor graphical bug where loaders would appear white in dark theme (#1442)

  • Fixed systemd unit for funkwhale-worker (#1160)

  • Several minor fixes for the Frontend

1.1.1 (2021-04-13)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Enhancements:

  • Improve UI consistency in artist tracks (#1286)

  • Adds year to album’s card and album’s base UI

Bugfixes:

  • Fix playback issues when pausing close the the end of a track (#1324)

  • Fix tracks playing in the background without the ability to control them (#1213) (#1387)

  • Fixed track playback indicator to reset on queue end (#1380)

  • Frontend build tooling is less dependent on npm or yarn being used (!1285)

  • Fixed a small discrepancy to the subsonic api 1374

1.1 (2021-03-10)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Enhancements:

  • Add number of tracks and discs of an album to API (#1238)

  • Add spacing after “Play all” button in playlist view (!1271)

  • Added a ListenBrainz plugin to submit listenings

  • Added ability to choose fediverse addresses from channel subscription page/podcast screen (#1294)

  • Added new search functions to allow users to more easily search for podcasts in the UI.

  • Added padding to volume slider to ease mouse control (#1241)

  • Logarithmic scale for volume slider (#1222)

  • More user-friendly subsonic tokens (#1269)

  • Remove manual entry of Import Reference on front-end import (#1284)

  • Support AIFF file format (#1243)

Bugfixes:

  • “Add check for empty/null covers (#1281)”

  • Added an album filter to fix problem where channel entries would show up in the wrong series (#1282)

  • Avoid broken Faker version (#1323)

  • Changed audio format detection to happen via sniffing and not file extensions (#1274)

  • Changed default behaviour of channel entries to use channel artwork if no entry artwork available (#1289)

  • Fix delete library modal closing immediately (#1272)

  • Fix public shared remote library radio button being disabled (#1292)

  • Fixed an issue that prevented disabling plugins

  • Fixed an issue where channel albums don’t show up in the album search (#1300)

  • Fixed an issue where modals would prevent users being able to interact with channels (#1295)

  • Update MediaSession metadata for initially loaded track (#1252)

  • Update playback position slider also when track is paused (#1266)

  • Fixed follows from Pleroma with custom Emoji as Tag by ignoring not supported tag types #1342

  • Update pleroma JSON-LD Schema (#1341)

  • Pin twisted version to 20.3.0

Contributors to this release (development, documentation, reviews):

  • Adam Novak

  • Agate

  • alemairebe

  • Alicia Blasco Leon

  • anonymous

  • Amaranthe

  • appzer0

  • Arne

  • Asier Iturralde Sarasola

  • Christian Paul

  • Ciarán Ainsworth

  • Daniel

  • David

  • Dominik Danelski

  • Eorn le goéland

  • Eleos

  • Erik Duxstad

  • Esteban

  • Fred Uggla

  • Freyja Wildes

  • Georg Krause

  • ghose

  • hellekin

  • heyarne

  • interfect

  • Jess Jing

  • Johannes H.

  • jovuit

  • marzzzello

  • Meliurwen

  • Mehdi

  • Nitai Bezerra da Silva

  • Philipp Wolfer

  • Pierre Couy

  • Porrumentzio

  • Reg

  • Robert Kaye

  • Rubén Cabrera

  • Silver Fox

  • Snack Capt

  • SpcCw

  • Strom Lin

  • vicdorke

  • x

1.1-rc2 (2021-03-01)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Bugfixes:

  • Fixed follows from Pleroma with custom Emoji as Tag by ignoring not supported tag types #1342

  • Update pleroma JSON-LD Schema (#1341)

  • Revert fork replacement of http-signature since official package breaks federation

  • Pin twisted version to 20.3.0

1.1-rc1 (2021-02-24)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Enhancements:

  • Add number of tracks and discs of an album to API (#1238)

  • Add spacing after “Play all” button in playlist view (!1271)

  • Added a ListenBrainz plugin to submit listenings

  • Added ability to choose fediverse addresses from channel subscription page/podcast screen (#1294)

  • Added new search functions to allow users to more easily search for podcasts in the UI.

  • Added padding to volume slider to ease mouse control (#1241)

  • Logarithmic scale for volume slider (#1222)

  • More user-friendly subsonic tokens (#1269)

  • Remove manual entry of Import Reference on front-end import (#1284)

  • Replaced forked http-signature dependency with official package (#876)

  • Support AIFF file format (#1243)

Bugfixes:

  • “Add check for empty/null covers (#1281)”

  • Added an album filter to fix problem where channel entries would show up in the wrong series (#1282)

  • Avoid broken Faker version (#1323)

  • Changed audio format detection to happen via sniffing and not file extensions (#1274)

  • Changed default behaviour of channel entries to use channel artwork if no entry artwork available (#1289)

  • Fix delete library modal closing immediately (#1272)

  • Fix public shared remote library radio button being disabled (#1292)

  • Fixed an issue that prevented disabling plugins

  • Fixed an issue where channel albums don’t show up in the album search (#1300)

  • Fixed an issue where modals would prevent users being able to interact with channels (#1295)

  • Update MediaSession metadata for initially loaded track (#1252)

  • Update playback position slider also when track is paused (#1266)

Contributors to this release (development, documentation, reviews):

  • Reg

  • hellekin

  • Esteban

  • Freyja Wildes

  • Amaranthe

  • Eleos

  • Johannes H.

  • Mehdi

  • Adam Novak

  • Agate

  • Christian Paul

  • Ciarán Ainsworth

  • Erik Duxstad

  • Fred Uggla

  • Georg Krause

  • heyarne

  • interfect

  • jovuit

  • Nitai Bezerra da Silva

  • Philipp Wolfer

  • Pierre Couy

  • Robert Kaye

  • Strom Lin

1.0.1 (2020-10-31)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Enhancements:

  • Added controls to play volume of an album (#1226)

  • Allow genre tags to be updated when rescanning files in-place (#1246)

Bugfixes:

  • Fixed broken install because of upgraded dependencies

  • Fixed duplication of discs for multi-disc albums in album views (#1228)

  • Make the generated RSS feed more conformant with w3c specification (#1250)

Contributors to this release (development, documentation, reviews):

  • Agate

  • Cédric Schieli

  • Ciarán Ainsworth

  • Kuba Orlik

1.0 (2020-09-09)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Dropped python 3.5 support [manual action required, non-docker only]

With Funkwhale 1.0, we’re dropping support for Python 3.5. Before upgrading, ensure python3 --version returns 3.6 or higher.

If it returns 3.6 or higher, you have nothing to do.

If it returns 3.5, you will need to upgrade your Python version/Host, then recreate your virtual environment:

rm -rf /srv/funkwhale/virtualenv
python3 -m venv /srv/funkwhale/virtualenv

Increased quality of JPEG thumbnails [manual action required]

Default quality for JPEG thumbnails was increased from 70 to 95, as 70 was producing visible artifacts in resized images.

Because of this change, existing thumbnails will not load, and you will need to:

  1. delete the __sized__ directory in your MEDIA_ROOT directory

  2. run python manage.py fw media generate-thumbnails to regenerate thumbnails with the enhanced quality

If you don’t want to regenerate thumbnails, you can keep the old ones by adding THUMBNAIL_JPEG_RESIZE_QUALITY=70 to your .env file.

Small API breaking change in /api/v1/libraries

To allow easier crawling of public libraries on a pod,we had to make a slight breaking change to the behaviour of GET /api/v1/libraries.

Before, it returned only libraries owned by the current user.

Now, it returns all the accessible libraries (including ones from other users and pods).

If you are consuming the API via a third-party client and need to retrieve your libraries, use the scope parameter, like this: GET /api/v1/libraries?scope=me

API breaking change in /api/v1/albums

To increase performance, querying /api/v1/albums doesn’t return album tracks anymore. This caused some performance issues, especially as some albums and series have dozens or even hundreds of tracks.

If you want to retrieve tracks for an album, you can query /api/v1/tracks/?album=<albumid>.

JWT deprecation

API Authentication using JWT is deprecated and will be removed in Funkwhale 1.0. Please use OAuth or application tokens and refer to our API documentation at https://docs.funkwhale.audio/swagger/ for guidance.

Full list of changes

Features:

  • Allow users to hide compilation artists on the artist search page (#1053)

  • Can now launch server import from the UI (#1105)

  • Dedicated, advanced search page (#370)

  • Persist theme and language settings across sessions (#996)

Enhancements:

  • Add support for unauthenticated users hitting the logout page

  • Added support for Licence Art Libre (#1088)

  • Broadcast/handle rejected follows (#858)

  • Confirm email without requiring the user to validate the form manually (#407)

  • Display channel and track downloads count (#1178)

  • Do not include tracks in album API representation (#1102)

  • Dropped python 3.5 support. Python 3.6 is the minimum required version (#1099)

  • Improved keyboard accessibility (#1125)

  • Improved naming of pages for accessibility (#1127)

  • Improved shuffle behaviour (#1190)

  • Increased quality of JPEG thumbnails

  • Lock focus in modals to improve accessibility (#1128)

  • More consistent search UX on /albums, /artists, /radios and /playlists (#1131)

  • Play button now replace current queue instead of appending to it (#1083)

  • Set proper lang attribute on HTML document (#1130)

  • Use semantic headers for accessibility (#1121)

  • Users can now update their email address (#292)

  • [plugin, scrobbler] Use last.fm API v2 for scrobbling if API key and secret are provided

  • Added a new, large thumbnail size for cover images (#1205

  • Enforce authentication when viewing remote channels, profiles and libraries (#1210)

Bugfixes:

  • Fix broken media support detection (#1180)

  • Fix layout issue with playbar on landscape tablets (#1144)

  • Fix random radio so that podcast content is not picked up (#1140)

  • Fixed an issue with search pages where results would not appear after navigating to another page

  • Fixed crash with negative track position in file tags (#1193)

  • Handle access errors scanning directories when importing files

  • Make channel card updated times more humanly readable, add internationalization (#1089)

  • Ensure search page reloads if another search is submitted in the sidebar (#1197)

  • Fixed “scope=subscribed” on albums, artists, uploads and libraries API (#1217)

  • Fixed broken federation with pods using allow-listing (#1999)

  • Fixed broken search when using (, ” or & chars (#1196)

  • Fixed domains table hidden controls when no domains are found (#1198)

Documentation:

  • Simplify Docker mono-container installation and upgrade documentation

Contributors to this release (translation, development, documentation, reviews, design, testing, third-party projects):

  • Agate

  • Andy Craze

  • anonymous

  • appzer0

  • Arne

  • Ciarán Ainsworth

  • Daniele Lira Mereb

  • dulz

  • Francesc Galí

  • ghose

  • Kalle Anka

  • mekind

  • Meliurwen

  • Puri

  • Quentin PAGÈS

  • Raphaël Ventura

  • Slimane Selyan Amiri

  • SpcCw

  • Stefano Pigozzi

  • Sébastien de Melo

  • Ventura Pérez García

  • vicdorke

  • Xosé M

0.21.2 (2020-07-27)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Enhancements:

  • Added a new ?related=obj_id filter for artists, albums and tracks, based on tags

  • Can now filter subscribed content through API (#1116)

  • Support ordering=random for artists, albums, tracks and channels endpoints (#1145)

  • Use role=alert on forms/toast message to improve accessibility (#1134)

Bugfixes:

  • Fix embedded player not working on channel series/album (#1175)

  • Fixed broken mimetype detection during import (#1165)

  • Fixed crash when loading recent albums via Subsonic (#1158)

  • Fixed crash with null help text in admin (#1161)

  • Fixed invalid metadata when importing multi-artists tracks/albums (#1104)

  • Fixed player crash when using Funkwhale as a PWA (#1157)

  • Fixed wrong convert art displaying in some situations (#1138)

  • Make channel card updated times more humanly readable, add internationalization (#1089)

Contributors to this release (development, documentation, reviews):

  • Agate

  • Bheesham Persaud

  • Ciarán Ainsworth

0.21.1 (2020-06-11)

Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html

Features:

  • Support a –watch mode with import_files to automatically add, update and remove files when filesystem is updated (#721)

Enhancements:

  • Added new channels widget on pod landing page (#1113)

  • Fix HTML not including instance name in some situations (#1107)</p></li> <li><p>Make URL-building logic more resilient against reverse proxy misconfiguration (#1085)</p></li> <li><p>Removed unused masonry dependency (#1112)</p></li> <li><p>Support for specifying itunes:email and itunes:name in channels for compatibility with third-party platforms (#1154)</p></li> <li><p>Updated the /api/v1/libraries endpoint to support listing public libraries from other users/pods (#1151)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Added safeguard to ensure local uploads are never purged from cache (#1086)</p></li> <li><p>Ensure firefox password manager dont autofill username in search bar (#1090)</p></li> <li><p>Ensure player doesn’t disappear when last queue track is removed manually (#1092)</p></li> <li><p>Ensure tracks linked to skipped upload can be pruned (#1011)</p></li> <li><p>Fix playlist modal only listing 50 first playlists (#1087)</p></li> <li><p>Fixed a wording issue on artist channel page (#1117)</p></li> <li><p>Fixed crash on python 3.5 with cli importer (#1155)</p></li> <li><p>Fixed issue when displaying starred tracks on subsonic (#1082)</p></li> <li><p>Fixed mimetype detection issue that broke transcoding on some tracks (#1093). Run <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">manage.py</span> <span class="pre">fix_uploads</span> <span class="pre">--mimetype</span></code> to set proper mimetypes on existing uploads.</p></li> <li><p>Fixed page not refreshing when switching between My Library and Explore sections (#1091)</p></li> <li><p>Fixed recursive CLI importing crashing under Python 3.5 (#1148, #1147)</p></li> <li><p>Fixed wrong album and track count in admin artist API (#1096)</p></li> <li><p>Include tracks by album artist when filtering by artist on /api/v1/tracks (#1078)</p></li> </ul> <section id="id25"> <h3>Small API breaking change in <code class="docutils literal notranslate"><span class="pre">/api/v1/libraries</span></code><a class="headerlink" href="#id25" title="Permalink to this heading"></a></h3> <p>To allow easier crawling of public libraries on a pod,we had to make a slight breaking change to the behaviour of <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/api/v1/libraries</span></code>.</p> <p>Before, it returned only libraries owned by the current user.</p> <p>Now, it returns all the accessible libraries (including ones from other users and pods).</p> <p>If you are consuming the API via a third-party client and need to retrieve your libraries, use the <code class="docutils literal notranslate"><span class="pre">scope</span></code> parameter, like this: <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/api/v1/libraries?scope=me</span></code></p> <p>Contributors to this release (development, documentation, reviews, testing):</p> <ul class="simple"> <li><p>Agate</p></li> <li><p>Ciarán Ainsworth</p></li> <li><p>Creak</p></li> <li><p>gisforgabriel</p></li> <li><p>Siren</p></li> <li><p>Tony Wasserka</p></li> </ul> </section> </section> <section id="agate-2020-04-24"> <h2>0.21 “Agate” (2020-04-24)<a class="headerlink" href="#agate-2020-04-24" title="Permalink to this heading"></a></h2> <p>This 0.21 release is dedicated to Agate, to thank her, for both having created the Funkwhale project, being the current lead developer, and for her courage of coming out. Thank you Agate from all the members of the Funkwhale community <3</p> <p>We are truly grateful as well to the dozens of people who contributed to this release with translations, development, documentation, reviews, design, testing, feedback, financial support, third-party projects and integrations… You made it possible!</p> <p>Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html, there are also additional operations you need to execute, listed in the changelog below (search “Manual action”).</p> <section id="channels-and-podcasts"> <h3>Channels and podcasts<a class="headerlink" href="#channels-and-podcasts" title="Permalink to this heading"></a></h3> <p>Funkwhale 0.21 includes a brand new feature: Channels!</p> <p>Channels can be used as a replacement to public libraries, to publish audio content, both musical and non-musical. They federate with other Funkwhale pods, but also other fediverse software, in particular Mastodon, Pleroma, Friendica and Reel2Bits, meaning people can subscribe to your channel from any of these software. To get started with publication, simply visit your profile and create a channel from there.</p> <p>Each Funkwhale channel also comes with RSS feed that is compatible with existing podcasting applications, like AntennaPod on Android and, within Funkwhale, you can also subscribe to any podcast from its RSS feed!</p> <p>Many, many thanks to the numerous people who helped with the feature design, development and testing, and in particular to the members of the working group who met every week for months in order to get this done, and the members of other third-party projects who took the time to work with us to ensure compatibility.</p> </section> <section id="redesigned-navigation-player-and-queue"> <h3>Redesigned navigation, player and queue<a class="headerlink" href="#redesigned-navigation-player-and-queue" title="Permalink to this heading"></a></h3> <p>This release includes a full redesign of our navigation, player and queue. Overall, it should provide a better, less confusing experience, especially on mobile devices. This redesign was suggested 14 months ago, and took a while, but thanks to the involvement and feedback of many people, we got it done!</p> </section> <section id="improved-search-bar-for-searching-remote-objects"> <h3>Improved search bar for searching remote objects<a class="headerlink" href="#improved-search-bar-for-searching-remote-objects" title="Permalink to this heading"></a></h3> <p>The search bar now support fetching arbitrary objects using a URL. In particular, you can use this to quickly:</p> <ul class="simple"> <li><p>Subscribe to a remote library via its URL</p></li> <li><p>Listen a public track from another pod</p></li> <li><p>Subscribe to a channel</p></li> </ul> </section> <section id="screening-for-sign-ups-and-custom-sign-up-form"> <h3>Screening for sign-ups and custom sign-up form<a class="headerlink" href="#screening-for-sign-ups-and-custom-sign-up-form" title="Permalink to this heading"></a></h3> <p>Instance admins can now configure their pod so that registrations required manual approval from a moderator. This is especially useful on private or semi-private pods where you don’t want to close registrations completely, but don’t want spam or unwanted users to join your pod.</p> <p>When this is enabled and a new user register, their request is put in a moderation queue, and moderators are notified by email. When the request is approved or refused, the user is also notified by email.</p> <p>In addition, it’s also possible to customize the sign-up form by:</p> <ul class="simple"> <li><p>Providing a custom help text, in markdown format</p></li> <li><p>Including additional fields in the form, for instance to ask the user why they want to join. Data collected through these fields is included in the sign-up request and viewable by the mods</p></li> </ul> </section> <section id="federated-reports"> <h3>Federated reports<a class="headerlink" href="#federated-reports" title="Permalink to this heading"></a></h3> <p>It’s now possible to send a copy of a report to the server hosting the reported object, in order to make moderation easier and more distributed.</p> <p>This feature is inspired by Mastodon’s current design, and should work with at least Funkwhale and Mastodon servers.</p> </section> <section id="improved-search-performance"> <h3>Improved search performance<a class="headerlink" href="#improved-search-performance" title="Permalink to this heading"></a></h3> <p>Our search engine went through a full rewrite to make it faster. This new engine is enabled by default when using the search bar, or when searching for artists, albums and tracks. It leverages PostgreSQL full-text search capabilities.</p> <p>During our tests, we observed huge performance improvements after the switch, by an order of magnitude. This should be especially perceptible on pods with large databases, more modest hardware or hard drives.</p> <p>We plan to remove the old engine in an upcoming release. In the meantime, if anything goes wrong, you can switch back by setting <code class="docutils literal notranslate"><span class="pre">USE_FULL_TEXT_SEARCH=false</span></code> in your <code class="docutils literal notranslate"><span class="pre">.env</span></code> file.</p> </section> <section id="enforced-email-verification"> <h3>Enforced email verification<a class="headerlink" href="#enforced-email-verification" title="Permalink to this heading"></a></h3> <p>The brand new <code class="docutils literal notranslate"><span class="pre">ACCOUNT_EMAIL_VERIFICATION_ENFORCE</span></code> setting can be used to make email verification mandatory for your users. It defaults to <code class="docutils literal notranslate"><span class="pre">false</span></code>, and doesn’t apply to superuser accounts created through the CLI.</p> <p>If you enable this, ensure you have a SMTP server configured too.</p> </section> <section id="more-reliable-cli-importer-manual-action-required"> <h3>More reliable CLI importer [manual action required]<a class="headerlink" href="#more-reliable-cli-importer-manual-action-required" title="Permalink to this heading"></a></h3> <p>Our CLI importer is now more reliable and less prone to Out-of-Memory issues, especially when scanning large libraries. (hundreds of GB or bigger)</p> <p>We’ve also improved the directory crawling logic, so that you don’t have to use glob patterns or specify extensions when importing. As a result, the syntax for providing directories to the command as changed slightly.</p> <p>If you use the <code class="docutils literal notranslate"><span class="pre">import_files</span></code> command, this means you should replace scripts that look like this:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>api/manage.py<span class="w"> </span>import_files<span class="w"> </span><span class="nv">$LIBRARY_ID</span><span class="w"> </span><span class="s2">"/srv/funkwhale/data/music/**/*.ogg"</span><span class="w"> </span><span class="s2">"/srv/funkwhale/data/music/**/*.mp3"</span><span class="w"> </span>--recursive<span class="w"> </span>--noinput </pre></div> </div> <p>By this:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>api/manage.py<span class="w"> </span>import_files<span class="w"> </span><span class="nv">$LIBRARY_ID</span><span class="w"> </span><span class="s2">"/srv/funkwhale/data/music/"</span><span class="w"> </span>--recursive<span class="w"> </span>--noinput </pre></div> </div> <p>And Funkwhale will happily import any supported audio file from the specified directory.</p> </section> <section id="user-management-through-the-server-cli"> <h3>User management through the server CLI<a class="headerlink" href="#user-management-through-the-server-cli" title="Permalink to this heading"></a></h3> <p>We now support user creation (incl. non-admin accounts), update and removal directly from the server CLI. Typical use cases include:</p> <ul class="simple"> <li><p>Changing a user password from the command line</p></li> <li><p>Creating or updating users from deployments scripts or playbooks</p></li> <li><p>Removing or granting permissions or upload quota to multiple users at once</p></li> <li><p>Marking multiple users as inactive</p></li> </ul> <p>All user-related commands are available under the <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">manage.py</span> <span class="pre">fw</span> <span class="pre">users</span></code> namespace. Please refer to the <a class="reference external" href="https://docs.funkwhale.audio/admin/commands.html#user-management">Admin documentation</a> for more information and instructions.</p> </section> <section id="progressive-web-app-manual-action-suggested-non-docker-only"> <h3>Progressive web app [Manual action suggested, non-docker only]<a class="headerlink" href="#progressive-web-app-manual-action-suggested-non-docker-only" title="Permalink to this heading"></a></h3> <p>We’ve made Funkwhale’s Web UI a Progressive Web Application (PWA), in order to improve the user experience during offline use, and on mobile devices.</p> <p>In order to fully benefit from this change, if your pod isn’t deployed using Docker, ensure the following instruction is present in your nginx configuration:</p> <div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="k">location</span><span class="w"> </span><span class="s">/front/</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="c1"># Add the following line in the /front/ location</span> <span class="w"> </span><span class="kn">add_header</span><span class="w"> </span><span class="s">Service-Worker-Allowed</span><span class="w"> </span><span class="s">"/"</span><span class="p">;</span> <span class="p">}</span> </pre></div> </div> </section> <section id="postgres-docker-changed-environment-variable-manual-action-required-docker-multi-container-only"> <h3>Postgres docker changed environment variable [manual action required, docker multi-container only]<a class="headerlink" href="#postgres-docker-changed-environment-variable-manual-action-required-docker-multi-container-only" title="Permalink to this heading"></a></h3> <p>If you’re running with docker and our multi-container setup, there was a breaking change starting in the 11.7 postgres image (https://github.com/docker-library/postgres/pull/658)</p> <p>You need to add this to your .env file: <code class="docutils literal notranslate"><span class="pre">POSTGRES_HOST_AUTH_METHOD=trust</span></code></p> <p>Newer deployments aren’t affected.</p> </section> <section id="upgrade-from-postgres-10-to-11-manual-action-required-docker-all-in-one-only"> <h3>Upgrade from Postgres 10 to 11 [manual action required, docker all-in-one only]<a class="headerlink" href="#upgrade-from-postgres-10-to-11-manual-action-required-docker-all-in-one-only" title="Permalink to this heading"></a></h3> <p>With our upgrade to Alpine 3.10, the <code class="docutils literal notranslate"><span class="pre">funkwhale/all-in-one</span></code> image now includes PostgreSQL 11.</p> <p>In order to update to Funkwhale 0.21, you will first need to upgrade Funkwhale’s PostgreSQL database, following the steps below:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># open a shell as the Funkwhale user</span> sudo<span class="w"> </span>-u<span class="w"> </span>funkwhale<span class="w"> </span>-H<span class="w"> </span>bash <span class="c1"># move to the funkwhale data directory</span> <span class="c1"># (replace this with your own if you used a different path)</span> <span class="nb">cd</span><span class="w"> </span>/srv/funkwhale/data <span class="c1"># stop the funkwhale container</span> docker<span class="w"> </span>stop<span class="w"> </span>funkwhale <span class="c1"># backup the database files</span> cp<span class="w"> </span>-r<span class="w"> </span>data/<span class="w"> </span>../postgres.bak <span class="c1"># Upgrade the database</span> docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span><span class="se">\</span> <span class="w"> </span>-v<span class="w"> </span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span>/data:/var/lib/postgresql/10/data<span class="w"> </span><span class="se">\</span> <span class="w"> </span>-v<span class="w"> </span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span>/upgraded-postgresql:/var/lib/postgresql/11/data<span class="w"> </span><span class="se">\</span> <span class="w"> </span>-e<span class="w"> </span><span class="nv">PGUSER</span><span class="o">=</span>funkwhale<span class="w"> </span><span class="se">\</span> <span class="w"> </span>-e<span class="w"> </span><span class="nv">POSTGRES_INITDB_ARGS</span><span class="o">=</span><span class="s2">"-U funkwhale --locale C --encoding UTF8"</span><span class="w"> </span><span class="se">\</span> <span class="w"> </span>tianon/postgres-upgrade:10-to-11 <span class="c1"># replace the Postgres 10 files with Postgres 11 files</span> mv<span class="w"> </span>data/<span class="w"> </span>postgres-10 mv<span class="w"> </span>upgraded-postgresql/<span class="w"> </span>data </pre></div> </div> <p>Once you have completed the Funkwhale upgrade with our regular instructions and everything works properly, you can remove the backups/old files:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>-u<span class="w"> </span>funkwhale<span class="w"> </span>-H<span class="w"> </span>bash <span class="nb">cd</span><span class="w"> </span>/srv/funkwhale/data rm<span class="w"> </span>-rf<span class="w"> </span>../postgres.bak rm<span class="w"> </span>-rf<span class="w"> </span>postgres-10 </pre></div> </div> </section> <section id="id26"> <h3>Full list of changes<a class="headerlink" href="#id26" title="Permalink to this heading"></a></h3> <p>Features:</p> <ul class="simple"> <li><p>Support for publishing and subscribing to podcasts (#170)</p></li> <li><p>Brand new navigation, queue and player redesign (#594)</p></li> <li><p>Can now browse a library content through the UI (#926)</p></li> <li><p>Federated reports (#1038)</p></li> <li><p>Screening for sign-ups (#1040)</p></li> <li><p>Make it possible to enforce email verification (#1039)</p></li> <li><p>Added a new radio based on another user listenings (#1060)</p></li> <li><p>User management through the server CLI</p></li> </ul> <p>Enhancements:</p> <ul class="simple"> <li><p>Added ability to reject library follows from notifications screen (#859)</p></li> <li><p>Added periodic background task and CLI command to associate genre tags to artists and albums based on identical tags found on corresponding tracks (#988)</p></li> <li><p>Added support for CELERYD_CONCURRENCY env var to control the number of worker processes (#997)</p></li> <li><p>Added the ability to sort albums by release date (#1013)</p></li> <li><p>Added two new radios to play your own content or a given library tracks</p></li> <li><p>Advertise list of known nodes on /api/v1/federation/domains and in nodeinfo if stats sharing is enabled</p></li> <li><p>Changed footer to use instance name if available, and append ellipses if instance URL/Name is too long (#1012)</p></li> <li><p>Favor local uploads when playing a track with multiple uploads (#1036)</p></li> <li><p>Include only local content in nodeinfo stats, added downloads count</p></li> <li><p>Make media and static files serving more reliable when reverse proxy <code class="docutils literal notranslate"><span class="pre">X_FORWARDED_*</span></code> headers are incorrect (#947)</p></li> <li><p>Order the playlist columns by modification date in the Browse tab (#775)</p></li> <li><p>Reduced size of funkwhale/funkwhale docker images thanks to multi-stage builds (!1042)</p></li> <li><p>Remember display settings in Album, Artist, Radio and Playlist views (#391)</p></li> <li><p>Removed unnecessary “Federation music needs approval” setting (#959)</p></li> <li><p>Replaced our slow research logic by PostgreSQL full-text search (#994)</p></li> <li><p>Support autoplay when loading embed frame from Mastodon and third-party websites (#1041)</p></li> <li><p>Support filtering playlist by name and several additional UX improvements in playlists modal (#974)</p></li> <li><p>Support modifying album cover art through the web UI (#588)</p></li> <li><p>Use a dedicated scope for throttling subsonic to avoid intrusive rate-limiting</p></li> <li><p>Use same markdown widget for all content fields (rules, description, reports, notes, etc.)</p></li> <li><p>CLI Importer is now more reliable and less resource-hungry on large libraries</p></li> <li><p>Add support custom domain for S3 storage</p></li> <li><p>Better placeholders for channels when there are no episodes or series</p></li> <li><p>Updated documentation for 0.21 release</p></li> <li><p>Improved performance and error handling when fetching remote attachments</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Added missing manuallyApprovesFollowers entry in JSON-LD contexts (#961)</p></li> <li><p>Fix issue with browser shortcuts such as search and focus URL not being recognised (#340, #985)</p></li> <li><p>Fixed admin dropdown not showing after login (#1042)</p></li> <li><p>Fixed an issue with celerybeat container failing to restart (#1004)</p></li> <li><p>Fixed invalid displayed number of tracks in playlist (#986)</p></li> <li><p>Fixed issue with recent results not being loaded from the API (#948)</p></li> <li><p>Fixed issue with sorting by album name not working (#960)</p></li> <li><p>Fixed short audio glitch when switching switching to another track with player paused (#970)</p></li> <li><p>Improved deduplication logic to prevent skipped files during import (#348, #474, #557, #740, #928)</p></li> <li><p>More resilient tag parsing with empty release date or album artist (#1037)</p></li> <li><p>More robust importer against malformed dates (#966)</p></li> <li><p>Removed “nodeinfo disabled” setting, as nodeinfo is required for the UI to work (#982)</p></li> <li><p>Replaced PDF icon by List icon in playlist placeholder (#943)</p></li> <li><p>Resolve an issue where disc numbers were not taken into consideration when playing an album from the album card (#1006)</p></li> <li><p>Set correct size for album covers in playlist cards (#680)</p></li> <li><p>Remove double spaces in ChannelForm</p></li> <li><p>Deduplicate tags in Audio ActivityPub representation</p></li> <li><p>Add support custom domain for S3 storage</p></li> <li><p>Fix #1079: fixed z-index issues with dropdowns (#1079 and #1075)</p></li> <li><p>Exclude external podcasts from library home</p></li> <li><p>Fixed broken channel save when description is too long</p></li> <li><p>Fixed 500 error when federation is disabled and application+json is requested</p></li> <li><p>Fixed minor subsonic API crash</p></li> <li><p>Fixed broken local profile page when allow-list is enabled</p></li> <li><p>Fixed issue with confirmation email not sending when signup-approval was enabled</p></li> <li><p>Ensure 0 quota on user is honored</p></li> <li><p>Fixed attachments URL not honoring media URL</p></li> <li><p>Fix grammar in msg string in TrackBase.vue</p></li> <li><p>Fix typo in SubscribeButton.vue</p></li> </ul> <p>Translations:</p> <ul class="simple"> <li><p>Arabic</p></li> <li><p>Catalan</p></li> <li><p>English (United Kingdom)</p></li> <li><p>German</p></li> <li><p>Hungarian</p></li> <li><p>Japanese</p></li> <li><p>Occitan</p></li> <li><p>Portuguese (Brazil)</p></li> <li><p>Russian</p></li> </ul> <p>Contributors to this release (translation, development, documentation, reviews, design, testing, third-party projects):</p> <ul class="simple"> <li><p>Agate</p></li> <li><p>annando</p></li> <li><p>Anton Strömkvist</p></li> <li><p>Audrey</p></li> <li><p>ButterflyOfFire</p></li> <li><p>Ciarán Ainsworth</p></li> <li><p>Creak</p></li> <li><p>Daniele Lira Mereb</p></li> <li><p>dashie</p></li> <li><p>Eloisa</p></li> <li><p>eorn</p></li> <li><p>Francesc Galí</p></li> <li><p>gerhardbeck</p></li> <li><p>GinnyMcQueen</p></li> <li><p>guillermau</p></li> <li><p>Haelwenn</p></li> <li><p>jinxx</p></li> <li><p>Jonathan Aylard</p></li> <li><p>Keunes</p></li> <li><p>M.G</p></li> <li><p>marzzzello</p></li> <li><p>Mathé Grievink</p></li> <li><p>Mélanie Chauvel</p></li> <li><p>Mjourdan</p></li> <li><p>Morgan Kesler</p></li> <li><p>Noe Gaumont</p></li> <li><p>Noureddine HADDAG</p></li> <li><p>Ollie</p></li> <li><p>Peter Wickenberg</p></li> <li><p>Quentin PAGÈS</p></li> <li><p>Renon</p></li> <li><p>Satsuki Yanagi</p></li> <li><p>Shlee</p></li> <li><p>SpcCw</p></li> <li><p>techknowlogick</p></li> <li><p>ThibG</p></li> <li><p>Tony Wasserka</p></li> <li><p>unklebonehead</p></li> <li><p>wakest</p></li> <li><p>wxcafé</p></li> <li><p>Xaloc</p></li> <li><p>Xosé M</p></li> </ul> </section> </section> <section id="id27"> <h2>0.20.1 (2019-10-28)<a class="headerlink" href="#id27" title="Permalink to this heading"></a></h2> <p>Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html</p> <section id="denormalized-audio-permission-logic-in-a-separate-table-to-enhance-performance"> <h3>Denormalized audio permission logic in a separate table to enhance performance<a class="headerlink" href="#denormalized-audio-permission-logic-in-a-separate-table-to-enhance-performance" title="Permalink to this heading"></a></h3> <p>With this release, we’re introducing a performance enhancement that should reduce the load on the database and API servers (cf https://dev.funkwhale.audio/funkwhale/funkwhale/merge_requests/939).</p> <p>Under the hood, we now maintain a separate table to link users to the tracks they are allowed to see. This change is <strong>disabled</strong> by default, but should be enabled by default starting in Funkwhale 0.21.</p> <p>If you want to try it now, add <code class="docutils literal notranslate"><span class="pre">MUSIC_USE_DENORMALIZATION=True</span></code> to your <code class="docutils literal notranslate"><span class="pre">.env</span></code> file, restart Funkwhale, and run the following command:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>manage.py<span class="w"> </span>rebuild_music_permissions </pre></div> </div> <p>This shouldn’t cause any regression, but we’d appreciate if you could test this before the 0.21 release and report any unusual behaviour regarding tracks, albums and artists visibility.</p> <p>Enhancements:</p> <ul class="simple"> <li><p>Added a retry option for failed uploads (#942)</p></li> <li><p>Added feedback via loading spinner when searching a remote library</p></li> <li><p>Denormalized audio permission logic in a separate table to enhance performance</p></li> <li><p>Placeholders will now be shown if no content is available across the application (#750)</p></li> <li><p>Reduce the number of simultaneous DB connections under some deployment scenario</p></li> <li><p>Support byYear filtering in Subsonic API (#936)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Ensure password input doesn’t overflow outside of container (#933)</p></li> <li><p>Fix audio serving issues under S3/nginx when signatures are enabled</p></li> <li><p>Fix import crash when importing M4A file with no embedded cover (#946)</p></li> <li><p>Fix tag exclusion in custom radios (#950)</p></li> <li><p>Fixed an issue with embed player CSS being purged during build (#935)</p></li> <li><p>Fixed escaped pod name displayed on home/about page (#945)</p></li> <li><p>Fixed pagination in subsonic getSongsByGenre endpoint (#954)</p></li> <li><p>Fixed style glitches in dropdowns</p></li> </ul> <p>Documentation:</p> <ul class="simple"> <li><p>Documented how to create DB extension by hand in case of permission error during migrations (#934)</p></li> </ul> <p>Contributors to this release (translation, development, documentation, reviews, design):</p> <ul class="simple"> <li><p>Ciarán Ainsworth</p></li> <li><p>Dag Stenstad</p></li> <li><p>Daniele Lira Mereb</p></li> <li><p>Agate</p></li> <li><p>Esteban</p></li> <li><p>Johannes H.</p></li> <li><p>knuxify</p></li> <li><p>Mateus Mattei Garcia</p></li> <li><p>Quentin PAGÈS</p></li> </ul> </section> </section> <section id="id28"> <h2>0.20 (2019-10-04)<a class="headerlink" href="#id28" title="Permalink to this heading"></a></h2> <p>Upgrade instructions are available at https://docs.funkwhale.audio/admin/upgrading.html</p> <section id="support-for-genres-via-tags"> <h3>Support for genres via tags<a class="headerlink" href="#support-for-genres-via-tags" title="Permalink to this heading"></a></h3> <p>Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html</p> <p>One of our most requested missing features is now available!</p> <p>Starting with Funkwhale 0.20, Funkwhale will automatically extract genre information from uploaded files and associate it with the corresponding tracks in the form of tags (similar to Mastodon or Twitter hashtags). Please refer to <a class="reference external" href="https://docs.funkwhale.audio/users/upload.html#tagging-files">our tagging documentation</a> for more information regarding the tagging process.</p> <p>Tags can also be associated with artists and albums, and updated after upload through the UI using the edit system released in Funkwhale 0.19. Tags are also fetched when retrieving content via federation.</p> <p>Tags are used in various places to enhance user experience:</p> <ul class="simple"> <li><p>Tags are listed on tracks, albums and artist profiles</p></li> <li><p>Each tag has a dedicated page were you can browse corresponding content and quickly start a radio</p></li> <li><p>The custom radio builder now supports using tags</p></li> <li><p>Subsonic apps that support genres - such as DSub or Ultrasonic - should display this information as well</p></li> </ul> <p>If you are a pod admin and want to extract tags from already uploaded content, you run <a class="reference external" href="https://dev.funkwhale.audio/funkwhale/funkwhale/snippets/43">this snippet</a> and <a class="reference external" href="https://dev.funkwhale.audio/funkwhale/funkwhale/snippets/44">this snippet</a> in a <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">manage.py</span> <span class="pre">shell</span></code>.</p> </section> <section id="content-and-account-reports"> <h3>Content and account reports<a class="headerlink" href="#content-and-account-reports" title="Permalink to this heading"></a></h3> <p>It is now possible to report content, such as artists, tracks or libraries, as well as user accounts. Such reports are forwarded to the pod moderators, who can review it and delete reported content, block accounts or take any other action they deem necessary.</p> <p>By default, both anonymous and authenticated users can submit these reports. This makes sure moderators can receive and handle takedown requests and other reports for illegal content that may be sent by third-parties without an account on the pod. However, you can disable anonymous reports completely via your pod settings.</p> <p>Federation of the reports will be supported in a future release.</p> <p>For more information about this feature, please check out our documentation:</p> <ul class="simple"> <li><p><a class="reference external" href="https://docs.funkwhale.audio/moderator/reports.html">User documentation</a></p></li> <li><p><a class="reference external" href="https://docs.funkwhale.audio/users/reports.html">Moderator documentation</a></p></li> </ul> </section> <section id="account-deletion"> <h3>Account deletion<a class="headerlink" href="#account-deletion" title="Permalink to this heading"></a></h3> <p>Users can now delete their account themselves, without involving an administrator.</p> <p>The deletion process will remove any local data and objects associated with the account, but the username won’t be able to new users to avoid impersonation. Deletion is also broadcasted to other known servers on the federation.</p> <p>For more information about this feature, please check out our documentation:</p> <ul class="simple"> <li><p><a class="reference external" href="https://docs.funkwhale.audio/users/account.html">User documentation</a></p></li> </ul> </section> <section id="landing-and-about-page-redesign-manual-action-suggested"> <h3>Landing and about page redesign [Manual action suggested]<a class="headerlink" href="#landing-and-about-page-redesign-manual-action-suggested" title="Permalink to this heading"></a></h3> <p>In this release, we’ve completely redesigned the landing and about page, by making it more useful and adapted to your pod configuration. Among other things, the landing page will now include:</p> <ul class="simple"> <li><p>your pod and an excerpt from your pod’s description</p></li> <li><p>your pod banner image, if any</p></li> <li><p>your contact email, if any</p></li> <li><p>the login form</p></li> <li><p>the signup form (if registrations are open on your pod)</p></li> <li><p>some basic statistics about your pod</p></li> <li><p>a widget including recently uploaded albums, if anonymous access is enabled</p></li> </ul> <p>The landing page will still include some information about Funkwhale, but in a less intrusive and proeminent way than before.</p> <p>Additionally, the about page now includes:</p> <ul class="simple"> <li><p>your pod name, description, rules and terms</p></li> <li><p>your pod banner image, if any</p></li> <li><p>your contact email, if any</p></li> <li><p>comprehensive statistics about your pod</p></li> <li><p>some info about your pod configuration, such as registration and federation status or the default upload quota for new users</p></li> </ul> <p>With this redesign, we’ve added a handful of additional pod settings:</p> <ul class="simple"> <li><p>Pod banner image</p></li> <li><p>Contact email</p></li> <li><p>Rules</p></li> <li><p>Terms of service</p></li> </ul> <p>We recommend taking a few moments to fill these accordingly to your needs, by visiting <code class="docutils literal notranslate"><span class="pre">/manage/settings</span></code>.</p> </section> <section id="allow-list-to-restrict-federation-to-trusted-domains"> <h3>Allow-list to restrict federation to trusted domains<a class="headerlink" href="#allow-list-to-restrict-federation-to-trusted-domains" title="Permalink to this heading"></a></h3> <p>The Allow-Listing feature grants pod moderators and administrators greater control over federation by allowing you to create a pod-wide allow-list.</p> <p>When allow-listing is enabled, your pod’s users will only be able to interact with pods included in the allow-list. Any messages, activity, uploads, or modifications to libraries and playlists will only be shared with pods on the allow-list. Pods which are not included in the allow-list will not have access to your pod’s content or messages and will not be able to send anything to your pod.</p> <p>If you want to enable this feature on your pod, or learn more, please refer to <a class="reference external" href="https://docs.funkwhale.audio/moderator/listing.html">our documentation</a>!</p> </section> <section id="periodic-message-to-incite-people-to-support-their-pod-and-funkwhale"> <h3>Periodic message to incite people to support their pod and Funkwhale<a class="headerlink" href="#periodic-message-to-incite-people-to-support-their-pod-and-funkwhale" title="Permalink to this heading"></a></h3> <p>Users will now be reminded on a regular basis that they can help Funkwhale by donating or contributing.</p> <p>If specified by the pod admin, a separate and custom message will also be displayed in a similar way to provide instructions and links to support the pod.</p> <p>Both messages will appear for the first time 15 days after signup, in the notifications tab. For each message, users can schedule a reminder for a later time, or disable the messages entirely.</p> </section> <section id="replaced-daphne-by-gunicorn-uvicorn-manual-action-required-non-docker-only"> <h3>Replaced Daphne by Gunicorn/Uvicorn [manual action required, non-docker only]<a class="headerlink" href="#replaced-daphne-by-gunicorn-uvicorn-manual-action-required-non-docker-only" title="Permalink to this heading"></a></h3> <p>To improve the performance, stability and reliability of Funkwhale’s web processes, we now recommend using Gunicorn and Uvicorn instead of Daphne. This combination unlock new use cases such as:</p> <ul class="simple"> <li><p>zero-downtime upgrades</p></li> <li><p>configurable number of web worker processes</p></li> </ul> <p>Based on our benchmarks, Gunicorn/Unicorn is also faster and more stable under higher workloads compared to Daphne.</p> <p>To benefit from this enhancement on existing instances, you need to add <code class="docutils literal notranslate"><span class="pre">FUNKWHALE_WEB_WORKERS=1</span></code> in your <code class="docutils literal notranslate"><span class="pre">.env</span></code> file (use a higher number if you want to have more web worker processes).</p> <p>Then, edit your <code class="docutils literal notranslate"><span class="pre">/etc/systemd/system/funkwhale-server.service</span></code> and replace the <code class="docutils literal notranslate"><span class="pre">ExecStart=</span></code> line with <code class="docutils literal notranslate"><span class="pre">ExecStart=/srv/funkwhale/virtualenv/bin/gunicorn</span> <span class="pre">config.asgi:application</span> <span class="pre">-w</span> <span class="pre">${FUNKWHALE_WEB_WORKERS}</span> <span class="pre">-k</span> <span class="pre">uvicorn.workers.UvicornWorker</span> <span class="pre">-b</span> <span class="pre">${FUNKWHALE_API_IP}:${FUNKWHALE_API_PORT}</span></code></p> <p>Then reload the configuration change with <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">systemctl</span> <span class="pre">daemon-reload</span></code> and <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">systemctl</span> <span class="pre">restart</span> <span class="pre">funkwhale-server</span></code>.</p> </section> <section id="content-security-policy-and-additional-security-headers-manual-action-suggested"> <h3>Content-Security-Policy and additional security headers [manual action suggested]<a class="headerlink" href="#content-security-policy-and-additional-security-headers-manual-action-suggested" title="Permalink to this heading"></a></h3> <p>To improve the security and reduce the attack surface in case of a successful exploit, we suggest you add the following Content-Security-Policy to your nginx configuration.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>If you are using an S3-compatible store to serve music, you will need to specify the URL of your S3 store in the <code class="docutils literal notranslate"><span class="pre">media-src</span></code> and <code class="docutils literal notranslate"><span class="pre">img-src</span></code> headers</p> <div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="k">add_header</span><span class="w"> </span><span class="s">Content-Security-Policy</span><span class="w"> </span><span class="s">"...img-src</span><span class="w"> </span><span class="s">'self'</span><span class="w"> </span><span class="s">https://<your-s3-URL></span><span class="w"> </span><span class="s">data:</span><span class="p">;</span><span class="k">...media-src</span><span class="w"> </span><span class="s">https://<your-s3-URL></span><span class="w"> </span><span class="s">'self'</span><span class="w"> </span><span class="s">data:"</span><span class="p">;</span> </pre></div> </div> </div> <p><strong>On non-docker setups</strong>, in <code class="docutils literal notranslate"><span class="pre">/etc/nginx/sites-available/funkwhale.conf</span></code>:</p> <div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="k">server</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">add_header</span><span class="w"> </span><span class="s">Content-Security-Policy</span><span class="w"> </span><span class="s">"default-src</span><span class="w"> </span><span class="s">'self'</span><span class="p">;</span><span class="w"> </span><span class="kn">script-src</span><span class="w"> </span><span class="s">'self'</span><span class="p">;</span><span class="w"> </span><span class="kn">style-src</span><span class="w"> </span><span class="s">'self'</span><span class="w"> </span><span class="s">'unsafe-inline'</span><span class="p">;</span><span class="w"> </span><span class="kn">img-src</span><span class="w"> </span><span class="s">'self'</span><span class="w"> </span><span class="s">data:</span><span class="p">;</span><span class="w"> </span><span class="kn">font-src</span><span class="w"> </span><span class="s">'self'</span><span class="w"> </span><span class="s">data:</span><span class="p">;</span><span class="w"> </span><span class="kn">object-src</span><span class="w"> </span><span class="s">'none'</span><span class="p">;</span><span class="w"> </span><span class="kn">media-src</span><span class="w"> </span><span class="s">'self'</span><span class="w"> </span><span class="s">data:"</span><span class="p">;</span> <span class="w"> </span><span class="kn">add_header</span><span class="w"> </span><span class="s">Referrer-Policy</span><span class="w"> </span><span class="s">"strict-origin-when-cross-origin"</span><span class="p">;</span> <span class="w"> </span><span class="kn">location</span><span class="w"> </span><span class="s">/front/</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">add_header</span><span class="w"> </span><span class="s">Content-Security-Policy</span><span class="w"> </span><span class="s">"default-src</span><span class="w"> </span><span class="s">'self'</span><span class="p">;</span><span class="w"> </span><span class="kn">script-src</span><span class="w"> </span><span class="s">'self'</span><span class="p">;</span><span class="w"> </span><span class="kn">style-src</span><span class="w"> </span><span class="s">'self'</span><span class="w"> </span><span class="s">'unsafe-inline'</span><span class="p">;</span><span class="w"> </span><span class="kn">img-src</span><span class="w"> </span><span class="s">'self'</span><span class="w"> </span><span class="s">data:</span><span class="p">;</span><span class="w"> </span><span class="kn">font-src</span><span class="w"> </span><span class="s">'self'</span><span class="w"> </span><span class="s">data:</span><span class="p">;</span><span class="w"> </span><span class="kn">object-src</span><span class="w"> </span><span class="s">'none'</span><span class="p">;</span><span class="w"> </span><span class="kn">media-src</span><span class="w"> </span><span class="s">'self'</span><span class="w"> </span><span class="s">data:"</span><span class="p">;</span> <span class="w"> </span><span class="kn">add_header</span><span class="w"> </span><span class="s">Referrer-Policy</span><span class="w"> </span><span class="s">"strict-origin-when-cross-origin"</span><span class="p">;</span> <span class="w"> </span><span class="kn">add_header</span><span class="w"> </span><span class="s">X-Frame-Options</span><span class="w"> </span><span class="s">"SAMEORIGIN"</span><span class="p">;</span> <span class="w"> </span><span class="c1"># … existing content here</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="c1"># Also create a new location for the embeds to ensure external iframes work</span> <span class="w"> </span><span class="c1"># Simply copy-paste the /front/ location, but replace the following lines:</span> <span class="w"> </span><span class="kn">location</span><span class="w"> </span><span class="s">/front/embed.html</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">add_header</span><span class="w"> </span><span class="s">X-Frame-Options</span><span class="w"> </span><span class="s">"ALLOW"</span><span class="p">;</span> <span class="w"> </span><span class="kn">alias</span><span class="w"> </span><span class="nv">${FUNKWHALE_FRONTEND_PATH}/embed.html</span><span class="p">;</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </pre></div> </div> <p>Then reload nginx with <code class="docutils literal notranslate"><span class="pre">systemctl</span> <span class="pre">reload</span> <span class="pre">nginx</span></code>.</p> <p><strong>On docker setups</strong>, in <code class="docutils literal notranslate"><span class="pre">/srv/funkwhalenginx/funkwhale.template</span></code>:</p> <div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="k">server</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">add_header</span><span class="w"> </span><span class="s">Content-Security-Policy</span><span class="w"> </span><span class="s">"default-src</span><span class="w"> </span><span class="s">'self'</span><span class="p">;</span><span class="w"> </span><span class="kn">script-src</span><span class="w"> </span><span class="s">'self'</span><span class="p">;</span><span class="w"> </span><span class="kn">style-src</span><span class="w"> </span><span class="s">'self'</span><span class="w"> </span><span class="s">'unsafe-inline'</span><span class="p">;</span><span class="w"> </span><span class="kn">img-src</span><span class="w"> </span><span class="s">'self'</span><span class="w"> </span><span class="s">data:</span><span class="p">;</span><span class="w"> </span><span class="kn">font-src</span><span class="w"> </span><span class="s">'self'</span><span class="w"> </span><span class="s">data:</span><span class="p">;</span><span class="w"> </span><span class="kn">object-src</span><span class="w"> </span><span class="s">'none'</span><span class="p">;</span><span class="w"> </span><span class="kn">media-src</span><span class="w"> </span><span class="s">'self'</span><span class="w"> </span><span class="s">data:"</span><span class="p">;</span> <span class="w"> </span><span class="kn">add_header</span><span class="w"> </span><span class="s">Referrer-Policy</span><span class="w"> </span><span class="s">"strict-origin-when-cross-origin"</span><span class="p">;</span> <span class="w"> </span><span class="kn">location</span><span class="w"> </span><span class="s">/front/</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">add_header</span><span class="w"> </span><span class="s">Content-Security-Policy</span><span class="w"> </span><span class="s">"default-src</span><span class="w"> </span><span class="s">'self'</span><span class="p">;</span><span class="w"> </span><span class="kn">script-src</span><span class="w"> </span><span class="s">'self'</span><span class="p">;</span><span class="w"> </span><span class="kn">style-src</span><span class="w"> </span><span class="s">'self'</span><span class="w"> </span><span class="s">'unsafe-inline'</span><span class="p">;</span><span class="w"> </span><span class="kn">img-src</span><span class="w"> </span><span class="s">'self'</span><span class="w"> </span><span class="s">data:</span><span class="p">;</span><span class="w"> </span><span class="kn">font-src</span><span class="w"> </span><span class="s">'self'</span><span class="w"> </span><span class="s">data:</span><span class="p">;</span><span class="w"> </span><span class="kn">object-src</span><span class="w"> </span><span class="s">'none'</span><span class="p">;</span><span class="w"> </span><span class="kn">media-src</span><span class="w"> </span><span class="s">'self'</span><span class="w"> </span><span class="s">data:"</span><span class="p">;</span> <span class="w"> </span><span class="kn">add_header</span><span class="w"> </span><span class="s">Referrer-Policy</span><span class="w"> </span><span class="s">"strict-origin-when-cross-origin"</span><span class="p">;</span> <span class="w"> </span><span class="kn">add_header</span><span class="w"> </span><span class="s">X-Frame-Options</span><span class="w"> </span><span class="s">"SAMEORIGIN"</span><span class="p">;</span> <span class="w"> </span><span class="c1"># … existing content here</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="c1"># Also create a new location for the embeds to ensure external iframes work</span> <span class="w"> </span><span class="c1"># Simply copy-paste the /front/ location, but replace the following lines:</span> <span class="w"> </span><span class="kn">location</span><span class="w"> </span><span class="s">/front/embed.html</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">add_header</span><span class="w"> </span><span class="s">X-Frame-Options</span><span class="w"> </span><span class="s">"ALLOW"</span><span class="p">;</span> <span class="w"> </span><span class="kn">alias</span><span class="w"> </span><span class="s">/frontend/embed.html</span><span class="p">;</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </pre></div> </div> <p>Then reload nginx with <code class="docutils literal notranslate"><span class="pre">docker-compose</span> <span class="pre">restart</span> <span class="pre">nginx</span></code>.</p> </section> <section id="rate-limiting"> <h3>Rate limiting<a class="headerlink" href="#rate-limiting" title="Permalink to this heading"></a></h3> <p>With this release, rate-limiting on the API is enabled by default, with high enough limits to ensure regular users of the app aren’t affected. Requests beyond allowed limits are answered with a 429 HTTP error.</p> <p>For anonymous requests, the limit is applied to the IP address of the client, and for authenticated requests, the limit is applied to the corresponding user account. By default, anonymous requests get a lower limit than authenticated requests.</p> <p>You can disable the rate-limiting feature by adding <code class="docutils literal notranslate"><span class="pre">THROTTLING_ENABLED=false</span></code> to your <code class="docutils literal notranslate"><span class="pre">.env</span></code> file and restarting the services. If you are using the Funkwhale API in your project or app and want to know more about the limits, please consult https://docs.funkwhale.audio/swagger/.</p> </section> <section id="broken-audio-streaming-when-using-s3-minio-and-dsub-manual-action-required"> <h3>Broken audio streaming when using S3/Minio and DSub [manual action required]<a class="headerlink" href="#broken-audio-streaming-when-using-s3-minio-and-dsub-manual-action-required" title="Permalink to this heading"></a></h3> <p>Some Subsonic clients, such as DSub, are sending an Authorization headers which was forwarded to the S3 storage when streaming, causing some issues. If you are using S3 or a compatible storage such as Minio, please add the following in your nginx <code class="docutils literal notranslate"><span class="pre">~</span> <span class="pre">/_protected/media/(.+)</span></code> location:</p> <div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="c1"># Needed to ensure DSub auth isn't forwarded to S3/Minio, see #932</span> <span class="k">proxy_set_header</span><span class="w"> </span><span class="s">Authorization</span><span class="w"> </span><span class="s">""</span><span class="p">;</span> </pre></div> </div> <p>And reload your nginx process.</p> </section> <section id="detail"> <h3>Detail<a class="headerlink" href="#detail" title="Permalink to this heading"></a></h3> <p>Features:</p> <ul class="simple"> <li><p>Added periodical message to incite people to support their pod and Funkwhale (#839)</p></li> <li><p>Admins can now add custom CSS from their pod settings (#879)</p></li> <li><p>Allow-list to restrict federation to trusted domains (#853)</p></li> <li><p>Content and account reports (#890)</p></li> <li><p>Dark theme (#756)</p></li> <li><p>Enforce a configurable rate limit on the API to mitigate abuse (#261)</p></li> <li><p>Redesign of the landing and about pages (#872)</p></li> <li><p>Support for genres, via tags (#432)</p></li> <li><p>Users can now delete their account without admin intervention (#852)</p></li> </ul> <p>Enhancements:</p> <ul class="simple"> <li><p>Added a info message on embed wizard when anonymous access to content is disabled (#878)</p></li> <li><p>Added Catalan translation files</p></li> <li><p>Added Czech translation (#844)</p></li> <li><p>Added field to manage user upload quota in Django backend (#903)</p></li> <li><p>Added the option to replace the queue’s current contents with a selected album or track (#761)</p></li> <li><p>Artists with no albums will now show track count on artist card (#895)</p></li> <li><p>Ensure API urls answer with and without a trailing slash (#877)</p></li> <li><p>Hardcoded list of supported browsers to avoid unexpected regressions (#854)</p></li> <li><p>Hardened security thanks to CSP and additional HTTP headers (#880)</p></li> <li><p>Improve display of search results by including artist and album data</p></li> <li><p>Increase the security of JWT token generation by using DJANGO_SECRET_KEY as well as user-specific salt for the signature</p></li> <li><p>Mods can now change a library visibility through the admin UI (#548)</p></li> <li><p>New keyboard shortcuts added for enhanced control over audio player (#866)</p></li> <li><p>Now refetch remote ActivityPub artists, albums and tracks to avoid local stale data</p></li> <li><p>Numbers on the stats page will now be formatted in a human readable way and will update with the locale (#873)</p></li> <li><p>Pickup folder.png and folder.jpg files for cover art when importing from CLI (#898)</p></li> <li><p>Prevent usage of too weak passwords (#883)</p></li> <li><p>Reduced CSS size by 30% using purgecss</p></li> <li><p>Replaced Daphne by Gunicorn/Uvicorn to improve stability, flexibility and performance (#862)</p></li> <li><p>Simplified embedded docker reverse proxy IP configuration (#834)</p></li> <li><p>Support embeds on public playlists</p></li> <li><p>Support for M4A/AAC files (#661)</p></li> <li><p>Switched from Semantic-UI to Fomentic-UI</p></li> <li><p>Add dropdown menu to track table (#531)</p></li> <li><p>Display placeholder on homepage when there are no playlists (#892)</p></li> <li><p>Make album cards height independent (#710)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Added context strings to en_GB translations so that picking the language changes the interface as expected</p></li> <li><p>Ensure selected locale is not reset to browser default when refreshing app</p></li> <li><p>Fix missing license information on track details page (#913)</p></li> <li><p>Fix regression to quota bar color (#897)</p></li> <li><p>Fixed a responsive display issues on 1024px wide screens (#904)</p></li> <li><p>Fixed album art not being retrieved from Ogg/Opus files</p></li> <li><p>Fixed broken embedded player layout after dependency update (#875)</p></li> <li><p>Fixed broken external HTTPS request under some scenarios, because of missing PyOpenSSL</p></li> <li><p>Fixed broken less listened radio (#912)</p></li> <li><p>Fixed broken URL to artist and album on album and track pages (#871)</p></li> <li><p>Fixed empty contentType causing client crash in some Subsonic payloads (#893)</p></li> <li><p>Fixed import crashing with empty cover file or too long values on some fields</p></li> <li><p>Fixed in-place imported files not playing under nginx when filename contains ? or % (#924)</p></li> <li><p>Fixed remaining transcoding issue with Subsonic API (#867)</p></li> <li><p>Fixed search usability issue when browsing artists, albums, radios and playlists (#902)</p></li> <li><p>Improved performance of /artists, /albums and /tracks API endpoints by a factor 2 (#865)</p></li> <li><p>Updated docs to ensure streaming works when using Minio/S3 and DSub (#932)</p></li> </ul> <p>Contributors to this release (translation, development, documentation, reviews, design):</p> <ul class="simple"> <li><p>Amaranthe</p></li> <li><p>ButterflyOfFire</p></li> <li><p>Ciarán Ainsworth</p></li> <li><p>Agate</p></li> <li><p>Esteban</p></li> <li><p>Francesc Galí</p></li> <li><p>Freyja Wildes</p></li> <li><p>hellekin</p></li> <li><p>IISergII</p></li> <li><p>jiri-novacek</p></li> <li><p>Johannes H.</p></li> <li><p>Keunes</p></li> <li><p>Koen</p></li> <li><p>Manuel Cortez</p></li> <li><p>Mehdi</p></li> <li><p>Mélanie Chauvel</p></li> <li><p>nouts</p></li> <li><p>Quentí</p></li> <li><p>Reg</p></li> <li><p>Rodrigo Leite</p></li> <li><p>Romain Failliot</p></li> <li><p>SpcCw</p></li> <li><p>Sylke Vicious</p></li> <li><p>Tobias Reisinger</p></li> <li><p>Xaloc</p></li> <li><p>Xosé M</p></li> </ul> </section> </section> <section id="id29"> <h2>0.19.1 (2019-06-28)<a class="headerlink" href="#id29" title="Permalink to this heading"></a></h2> <p>Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html</p> <p>Enhancements:</p> <ul class="simple"> <li><p>The currently playing track is now highlighted with an orange play icon (#832)</p></li> <li><p>Support for importing files with no album tag (#122)</p></li> <li><p>Redirect from / to /library when user is logged in (#864)</p></li> <li><p>Added a SUBSONIC_DEFAULT_TRANSCODING_FORMAT env var to support clients that don’t provide the format parameter (#867)</p></li> <li><p>Added button to search for objects on Discogs (#368)</p></li> <li><p>Added copy-to-clipboard button with Subsonic password input (#814)</p></li> <li><p>Added opus to the list of supported mimetypes and extensions (#868)</p></li> <li><p>Aligned search headers with search results in the sidebar (#708)</p></li> <li><p>Clicking on the currently selected playlist in the Playlist popup will now close the popup (#807)</p></li> <li><p>Favorites radio will not be visible if the user does not have any favorites (#419)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Ensure empty but optional fields in file metadata don’t error during import (#850)</p></li> <li><p>Fix broken upload for specific files when using S3 storage (#857)</p></li> <li><p>Fixed broken translation on home and track detail page (#833)</p></li> <li><p>Fixed broken user admin for users with non-digit or letters in their username (#869)</p></li> <li><p>Fixed invalid file extension for transcoded tracks (#848)</p></li> <li><p>Fixed issue with French translation for “Start radio” (#849)</p></li> <li><p>Fixed issue with player changing height when hovering over the volume slider (#838)</p></li> <li><p>Fixed secondary menus truncated on narrow screens (#855)</p></li> <li><p>Fixed wrong og:image url when using S3 storage (#851)</p></li> <li><p>Hide pod statistics on about page if those are disabled (#835)</p></li> <li><p>Use ASCII filename before upload to S3 to avoid playback issues (#847)</p></li> </ul> <p>Contributors to this release (committers and reviewers):</p> <ul class="simple"> <li><p>Ciarán Ainsworth</p></li> <li><p>Creak</p></li> <li><p>ealgase</p></li> <li><p>Agate</p></li> <li><p>Esteban</p></li> <li><p>Freyja Wildes</p></li> <li><p>hellekin</p></li> <li><p>Johannes H.</p></li> <li><p>Mehdi</p></li> <li><p>Reg</p></li> </ul> </section> <section id="id30"> <h2>0.19.0 (2019-05-16)<a class="headerlink" href="#id30" title="Permalink to this heading"></a></h2> <p>Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html</p> <section id="edits-on-tracks-albums-and-artists"> <h3>Edits on tracks, albums and artists<a class="headerlink" href="#edits-on-tracks-albums-and-artists" title="Permalink to this heading"></a></h3> <p>Funkwhale was a bit annoying when it camed to metadata. Tracks, albums and artists profiles were created from audio file tags, but basically immutable after that (unless you had admin access to Django’s UI, which wasn’t ideal to do this kind of changes).</p> <p>With this release, everyone can suggest changes on track, album and artist pages. Users with the “library” permission can review suggested edits in a dedicated interface and apply/reject them.</p> <p>Approved edits are broadcasted via federation, to ensure other instances get the information too.</p> <p>Not all fields are currently modifiable using this feature. Especially, it’s not possible to suggest a new album cover, or reassign a track to a different album or artist. Those will be implemented in a future release.</p> </section> <section id="admin-ui-for-tracks-albums-artists-libraries-and-uploads"> <h3>Admin UI for tracks, albums, artists, libraries and uploads<a class="headerlink" href="#admin-ui-for-tracks-albums-artists-libraries-and-uploads" title="Permalink to this heading"></a></h3> <p>As part of our ongoing effort to make Funkwhale easier to manage for instance owners, this release includes a brand new administration interface to deal with:</p> <ul class="simple"> <li><p>tracks</p></li> <li><p>albums</p></li> <li><p>artists</p></li> <li><p>libraries</p></li> <li><p>uploads</p></li> </ul> <p>You can use this UI to quickly search for any object, delete objects in batch, understand where they are coming from etc. This new UI should remove the need to go through Django’s admin in the vast majority of cases (but also includes a link to Django’s admin when needed).</p> </section> <section id="artist-hiding-in-the-interface"> <h3>Artist hiding in the interface<a class="headerlink" href="#artist-hiding-in-the-interface" title="Permalink to this heading"></a></h3> <p>It’s now possible for users to hide artists they don’t want to see.</p> <p>Content linked to hidden artists will not show up in the interface anymore. Especially:</p> <ul class="simple"> <li><p>Hidden artists tracks are removed from the current queue</p></li> <li><p>Starting a playlist will skip tracks from hidden artists</p></li> <li><p>Recently favorited, recently listened and recently added widgets on the homepage won’t include content from hidden artists</p></li> <li><p>Radio suggestions will exclude tracks from hidden artists</p></li> <li><p>Hidden artists won’t appear in Subsonic apps</p></li> </ul> <p>Results linked to hidden artists will continue to show up in search results and their profile page remains accessible.</p> </section> <section id="oauth2-authorization-for-better-integration-with-third-party-apps"> <h3>OAuth2 authorization for better integration with third-party apps<a class="headerlink" href="#oauth2-authorization-for-better-integration-with-third-party-apps" title="Permalink to this heading"></a></h3> <p>Funkwhale now support the OAuth2 authorization and authentication protocol which will allow third-party apps to interact with Funkwhale on behalf of users.</p> <p>This feature makes it possible to build third-party apps that have the same capabilities as Funkwhale’s Web UI. The only exception at the moment is for actions that requires special permissions, such as modifying instance settings or moderation (but this will be enabled in a future release).</p> <p>If you want to start building an app on top of Funkwhale’s API, please check-out https://docs.funkwhale.audio/api.html and https://docs.funkwhale.audio/developers/authentication.html.</p> </section> <section id="better-error-handling-and-display-during-import"> <h3>Better error handling and display during import<a class="headerlink" href="#better-error-handling-and-display-during-import" title="Permalink to this heading"></a></h3> <p>Funkwhale should now be more resilient to missing tags in imported files, and give you more insights when something goes wrong, including the specific tags that were missing or invalid, and additional debug information to share in your support requests.</p> <p>This information is available in all pages that list uploads, when clicking on the button next to the upload status.</p> </section> <section id="support-for-s3-compatible-storages-to-store-media-files"> <h3>Support for S3-compatible storages to store media files<a class="headerlink" href="#support-for-s3-compatible-storages-to-store-media-files" title="Permalink to this heading"></a></h3> <p>Storing all media files on the Funkwhale server itself may not be possible or desirable in all scenarios. You can now configure Funkwhale to store those files in a S3 bucket instead.</p> <p>Check-out https://docs.funkwhale.audio/admin/external-storages.html if you want to use this feature.</p> </section> <section id="prune-library-command"> <h3>Prune library command<a class="headerlink" href="#prune-library-command" title="Permalink to this heading"></a></h3> <p>Users are often surprised by Funkwhale’s tendency to keep track, album and artist metadata even if no associated files exist.</p> <p>To help with that, we now offer a <code class="docutils literal notranslate"><span class="pre">prune_library</span></code> management command you can run to purge your database from obsolete entries. <a class="reference external" href="https://docs.funkwhale.audio/admin/commands.html#pruning-library">Please refer to our documentation for usage instructions</a>.</p> </section> <section id="check-in-place-files-command"> <h3>Check in-place files command<a class="headerlink" href="#check-in-place-files-command" title="Permalink to this heading"></a></h3> <p>When using in-place import with a living audio library, you’ll quite often rename or remove files from the file system. Unfortunately, Funkwhale keeps a reference to those files in the database, which results in unplayable tracks.</p> <p>To help with that, we now offer a <code class="docutils literal notranslate"><span class="pre">check_inplace_files</span></code> management command you can run to purge your database from obsolete files. <a class="reference external" href="https://docs.funkwhale.audio/admin/commands.html#remove-obsolete-files-from-database">Please refer to our documentation for usage instructions</a>.</p> <p>Features:</p> <ul class="simple"> <li><p>Added albums view. Similar to artists view, it’s viewable by clicking on the “Albums” link on the top bar. (#356)</p></li> <li><p>Allow artists hiding (#701)</p></li> <li><p>Change the document title to display current track information. (#359)</p></li> <li><p>Display a confirmation dialog when adding duplicate songs to a playlist (#784)</p></li> <li><p>Improved error handling and display during import (#252, #718, #583, #501, #544)</p></li> <li><p>Support embedding full artist discographies (#747)</p></li> <li><p>Support metadata update on tracks, albums and artists and broadcast those on the federation (#689)</p></li> <li><p>Support OAuth2 authorization for better integration with third-party apps (#752)</p></li> <li><p>Support S3-compatible storages for media files (#565)</p></li> </ul> <p>Enhancements:</p> <ul> <li><p>[Experimental] Added a new “Similar” radio based on users history (suggested by @gordon)</p></li> <li><p>Added a “load more” button on artist pages to load more tracks/albums (#719)</p></li> <li><p>Added a <code class="docutils literal notranslate"><span class="pre">check_inplace_files</span></code> management command to remove purge the database from references to in-place imported files that don’t exist on disk anymore (#781)</p></li> <li><p>Added a prune_library management command to remove obsolete metadata from the database (#777)</p></li> <li><p>Added admin options to disable login for users, ensure related content is deleted when deleting a user account (#809)</p></li> <li><p>Added standardized translation context for all strings in the frontend to give accurate hints to translators.</p></li> <li><p>Added twitter:* meta tags to detect tracks and albums players automatically on more sites (#578) Improved responsiveness of embedded player</p></li> <li><p>Advertise the list of supported upload extensions in the Nodeinfo endpoint (#808)</p></li> <li><p>Better handling of follow/accept messages to avoid and recover from desync between instances (#830)</p></li> <li><p>Better workflow for connecting to another instance (#715)</p> <p>Changing the instance used is now better integrated in the App, and it is checked that the chosen instance and the suggested instances are valid and running Funkwhale servers.</p> </li> <li><p>Bumped dependencies to latest versions (#815)</p></li> <li><p>Descriptions will now be shown underneath user libraries (#768)</p></li> <li><p>Don’t store unhandled ActivityPub messages in database (#776)</p></li> <li><p>Enhanced the design of the embed wizard. (!619)</p></li> <li><p>Ensure the footer always stays at the bottom of the page</p></li> <li><p>Expose an instance-level actor (service@domain) in nodeinfo endpoint (#689)</p></li> <li><p>Improved readability of logo (#385)</p></li> <li><p>Keep persistent connections to the database instead of recreating a new one for each request</p></li> <li><p>Labels for privacy levels are now consistently grabbed from a common source instead of being hardcoded every time they are needed.</p></li> <li><p>Merged artist/album buttons with title text on artist and album pages (#725)</p></li> <li><p>Now honor maxBitrate parameter in Subsonic API (#802)</p></li> <li><p>Preload next track in queue (#572)</p></li> <li><p>Reduced app size for regular users by moving admin-related code in a dedicated chunk (#805)</p></li> <li><p>Removed broken/instable lyrics feature (#799)</p></li> <li><p>Show remaining storage space during import and prevent file upload if not enough space is remaining (#550)</p></li> <li><p>The buttons displaying an icon now always show a little divider between the icon and the text. (!620)</p></li> <li><p>Use attributedTo instead of actor in library ActivityPub payload (#619)</p></li> <li><p>Use network/depends_on instead of links in docker-compose.yml (!716)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Add missing command from contributing file (#754)</p></li> <li><p>Add required envvar for dev environment (!668)</p></li> <li><p>Added env variable to set AWS region and signature version to serve media without proxy (#826)</p></li> <li><p>Allow users with dots in their usernames to request a subsonic password (#798)</p></li> <li><p>Better handling of featuring/multi-artist tracks tagged with MusicBrainz (#782)</p></li> <li><p>Do not consider tracks as duplicates during import if they have different positions (#740)</p></li> <li><p>Ensure all our ActivityPub fetches are authenticated (#758)</p></li> <li><p>Ensure correct track duration and playable status when browsing radios (#812)</p></li> <li><p>Fixed alignment/size issue with some buttons (#702)</p></li> <li><p>Fixed an encoding issue with instance name on about page (#828)</p></li> <li><p>Fixed cover not showing in queue/player when playing tracks from “albums” tab (#795)</p></li> <li><p>Fixed crashing upload processing on invalid date format (#718)</p></li> <li><p>Fixed dev command for fake data creation (!664)</p></li> <li><p>Fixed invalid OEmbed URL when using a local FUNKWHALE_SPA_HTML_ROOT (#824)</p></li> <li><p>Fixed invalid required fields in Upload django’s admin (#819)</p></li> <li><p>Fixed issue with querying the albums api endpoint (#356)</p></li> <li><p>Fixed non-transparent background for volume range on Firefox (#722)</p></li> <li><p>Fixed overflowing input on account detail page (#791)</p></li> <li><p>Fixed unplayable radios for anonymous users (#563)</p></li> <li><p>Prevent skipping on file import if album_mbid is different (#772)</p></li> <li><p>Use proper site name/domain in emails (#806)</p></li> <li><p>Width of filter menus for radios has been set to stop text from overlapping the borders</p></li> </ul> <p>Documentation:</p> <ul class="simple"> <li><p>Document how to use Redis over unix sockets (#770)</p></li> </ul> <p>Contributors to this release (committers and translators):</p> <ul class="simple"> <li><p>Ale London</p></li> <li><p>Alexander</p></li> <li><p>Ben Finney</p></li> <li><p>ButterflyOfFire</p></li> <li><p>Ciarán Ainsworth</p></li> <li><p>Damien Nicolas</p></li> <li><p>Daniele Lira Mereb</p></li> <li><p>Agate</p></li> <li><p>Elza Gelez</p></li> <li><p>gerry_the_hat</p></li> <li><p>gordon</p></li> <li><p>interfect</p></li> <li><p>jake</p></li> <li><p>Jee</p></li> <li><p>jovuit</p></li> <li><p>Mélanie Chauvel</p></li> <li><p>nouts</p></li> <li><p>Pierrick</p></li> <li><p>Qasim Ali</p></li> <li><p>Quentí</p></li> <li><p>Renon</p></li> <li><p>Rodrigo Leite</p></li> <li><p>Sylke Vicious</p></li> <li><p>Thomas Brockmöller</p></li> <li><p>Tixie</p></li> <li><p>Vierkantor</p></li> <li><p>Von</p></li> <li><p>Zach Halasz</p></li> </ul> </section> </section> <section id="id31"> <h2>0.18.3 (2019-03-21)<a class="headerlink" href="#id31" title="Permalink to this heading"></a></h2> <p>Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html</p> <section id="avoid-mixed-content-when-deploying-mono-container-behind-proxy-manual-action-required"> <h3>Avoid mixed content when deploying mono-container behind proxy [Manual action required]<a class="headerlink" href="#avoid-mixed-content-when-deploying-mono-container-behind-proxy-manual-action-required" title="Permalink to this heading"></a></h3> <p><em>You are only concerned if you use the mono-container docker deployment behind a reverse proxy</em></p> <p>Because of <a class="reference external" href="https://github.com/thetarkus/docker-funkwhale/issues/19">an issue in our mono-container configuration</a>, users deploying Funkwhale via docker using our <code class="docutils literal notranslate"><span class="pre">funkwhale/all-in-one</span></code> image could face some mixed content warnings (and possibly other troubles) when browsing the Web UI.</p> <p>This is fixed in this release, but on existing deployments, you’ll need to add <code class="docutils literal notranslate"><span class="pre">NESTED_PROXY=1</span></code> in your container environment (either in your <code class="docutils literal notranslate"><span class="pre">.env</span></code> file, or via your container management tool), then recreate your funkwhale container.</p> <p>Enhancements:</p> <ul class="simple"> <li><p>Added title on hover for truncated content (#766)</p></li> <li><p>Ask for confirmation before leaving upload page if there is a an upload in process (#630)</p></li> <li><p>Exclude in-place imported files from quota computation (#570)</p></li> <li><p>Truncate filename in library file table to ensure correct display of the table. (#735)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Avoid mixed content when deploying mono-container behind HTTPS proxy (thetarkus/docker-funkwhale#19)</p></li> <li><p>Display new notifications immediately on notifications page (#729)</p></li> <li><p>Ensure cover art from uploaded files is picked up properly on existing albums (#757)</p></li> <li><p>Fixed a crash when federating a track with unspecified position</p></li> <li><p>Fixed broken Activity and Actor modules in django admin (#767)</p></li> <li><p>Fixed broken sample apache configuration (#764)</p></li> <li><p>Fixed constant and unpredictable reordering during file upload (#716)</p></li> <li><p>Fixed delivering of local activities causing unintended side effects, such as rollbacking changes (#737)</p></li> <li><p>Fixed escaping issues in translated strings (#652)</p></li> <li><p>Fixed saving moderation policy when clicking on “Cancel” (#751)</p></li> <li><p>i18n: Update page title when changing the App’s language. (#511)</p></li> <li><p>Include disc number in Subsonic responses (#765)</p></li> <li><p>Do not send notification when rejecting a follow on a local library (#743)</p></li> </ul> <p>Documentation:</p> <ul class="simple"> <li><p>Added documentation on mono-container docker upgrade (#713)</p></li> <li><p>Added documentation to set up let’s encrypt certificate (#745)</p></li> </ul> </section> </section> <section id="id32"> <h2>0.18.2 (2019-02-13)<a class="headerlink" href="#id32" title="Permalink to this heading"></a></h2> <p>Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html</p> <p>Enhancements:</p> <ul class="simple"> <li><p>Added a ‘fix_federation_ids’ management command to deal with protocol/domain issues in federation IDs after deployments (#706)</p></li> <li><p>Can now use a local file with FUNKWHALE_SPA_HTML_ROOT to avoid sending an HTTP request (#705)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Downgraded channels dependency to 2.1.6 to fix denied uploads (#697)</p></li> <li><p>Fixed cards display issues on medium/small screens (#707)</p></li> <li><p>Fixed Embed component name that could lead to issue when developping on OSX (#696)</p></li> <li><p>Fixed resizing issues for album cards on artist pages (#694)</p></li> </ul> </section> <section id="id33"> <h2>0.18.1 (2019-01-29)<a class="headerlink" href="#id33" title="Permalink to this heading"></a></h2> <p>Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html</p> <section id="fix-gzip-compression-to-avoid-breach-exploit-security-manual-action-required"> <h3>Fix Gzip compression to avoid BREACH exploit [security] [manual action required]<a class="headerlink" href="#fix-gzip-compression-to-avoid-breach-exploit-security-manual-action-required" title="Permalink to this heading"></a></h3> <p>In the 0.18 release, we’ve enabled Gzip compression by default for various content types, including HTML and JSON. Unfortunately, enabling Gzip compression on such content types could make BREACH-type exploits possible.</p> <p>We’ve removed the risky content-types from our nginx template files, to ensure new instances are safe, however, if you already have an instance, you need to double check that your host nginx virtualhost do not include the following values for the <code class="docutils literal notranslate"><span class="pre">gzip_types</span></code> settings:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">application</span><span class="o">/</span><span class="n">atom</span><span class="o">+</span><span class="n">xml</span> <span class="n">application</span><span class="o">/</span><span class="n">json</span> <span class="n">application</span><span class="o">/</span><span class="n">ld</span><span class="o">+</span><span class="n">json</span> <span class="n">application</span><span class="o">/</span><span class="n">activity</span><span class="o">+</span><span class="n">json</span> <span class="n">application</span><span class="o">/</span><span class="n">manifest</span><span class="o">+</span><span class="n">json</span> <span class="n">application</span><span class="o">/</span><span class="n">rss</span><span class="o">+</span><span class="n">xml</span> <span class="n">application</span><span class="o">/</span><span class="n">xhtml</span><span class="o">+</span><span class="n">xml</span> <span class="n">application</span><span class="o">/</span><span class="n">xml</span> </pre></div> </div> <p>For convenience, you can also replace the whole setting with the following snippet:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">gzip_types</span> <span class="n">application</span><span class="o">/</span><span class="n">javascript</span> <span class="n">application</span><span class="o">/</span><span class="n">vnd</span><span class="o">.</span><span class="n">geo</span><span class="o">+</span><span class="n">json</span> <span class="n">application</span><span class="o">/</span><span class="n">vnd</span><span class="o">.</span><span class="n">ms</span><span class="o">-</span><span class="n">fontobject</span> <span class="n">application</span><span class="o">/</span><span class="n">x</span><span class="o">-</span><span class="n">font</span><span class="o">-</span><span class="n">ttf</span> <span class="n">application</span><span class="o">/</span><span class="n">x</span><span class="o">-</span><span class="n">web</span><span class="o">-</span><span class="n">app</span><span class="o">-</span><span class="n">manifest</span><span class="o">+</span><span class="n">json</span> <span class="n">font</span><span class="o">/</span><span class="n">opentype</span> <span class="n">image</span><span class="o">/</span><span class="n">bmp</span> <span class="n">image</span><span class="o">/</span><span class="n">svg</span><span class="o">+</span><span class="n">xml</span> <span class="n">image</span><span class="o">/</span><span class="n">x</span><span class="o">-</span><span class="n">icon</span> <span class="n">text</span><span class="o">/</span><span class="n">cache</span><span class="o">-</span><span class="n">manifest</span> <span class="n">text</span><span class="o">/</span><span class="n">css</span> <span class="n">text</span><span class="o">/</span><span class="n">plain</span> <span class="n">text</span><span class="o">/</span><span class="n">vcard</span> <span class="n">text</span><span class="o">/</span><span class="n">vnd</span><span class="o">.</span><span class="n">rim</span><span class="o">.</span><span class="n">location</span><span class="o">.</span><span class="n">xloc</span> <span class="n">text</span><span class="o">/</span><span class="n">vtt</span> <span class="n">text</span><span class="o">/</span><span class="n">x</span><span class="o">-</span><span class="n">component</span> <span class="n">text</span><span class="o">/</span><span class="n">x</span><span class="o">-</span><span class="n">cross</span><span class="o">-</span><span class="n">domain</span><span class="o">-</span><span class="n">policy</span><span class="p">;</span> </pre></div> </div> <p>Many thanks to @jibec for the report!</p> </section> <section id="fix-apache-configuration-file-for-0-18-manual-action-required"> <h3>Fix Apache configuration file for 0.18 [manual action required]<a class="headerlink" href="#fix-apache-configuration-file-for-0-18-manual-action-required" title="Permalink to this heading"></a></h3> <p>The way front is served has changed since 0.18. The Apache configuration can’t serve 0.18 properly, leading to blank screens.</p> <p>If you are on an Apache setup, you will have to replace the <code class="docutils literal notranslate"><span class="pre"><Location</span> <span class="pre">"/api"></span></code> block with the following:</p> <div class="highlight-apache notranslate"><div class="highlight"><pre><span></span><span class="nt"><Location</span><span class="w"> </span><span class="s">"/"</span><span class="nt">></span> <span class="w"> </span><span class="c"># similar to nginx 'client_max_body_size 100M;'</span> <span class="w"> </span><span class="nb">LimitRequestBody</span><span class="w"> </span><span class="m">104857600</span> <span class="w"> </span><span class="nb">ProxyPass</span><span class="w"> </span>${funkwhale-api}/ <span class="w"> </span><span class="nb">ProxyPassReverse</span><span class="w"> </span>${funkwhale-api}/ <span class="nt"></Location></span> </pre></div> </div> <p>And add some more <code class="docutils literal notranslate"><span class="pre">ProxyPass</span></code> directives so that the <code class="docutils literal notranslate"><span class="pre">Alias</span></code> part of your configuration file looks this way:</p> <div class="highlight-apache notranslate"><div class="highlight"><pre><span></span><span class="w"> </span><span class="nb">ProxyPass</span><span class="w"> </span><span class="s2">"/front"</span><span class="w"> </span><span class="s2">"!"</span> <span class="w"> </span><span class="nb">Alias</span><span class="w"> </span><span class="sx">/front</span><span class="w"> </span><span class="sx">/srv/funkwhale/front/dist</span> <span class="w"> </span><span class="nb">ProxyPass</span><span class="w"> </span><span class="s2">"/media"</span><span class="w"> </span><span class="s2">"!"</span> <span class="w"> </span><span class="nb">Alias</span><span class="w"> </span><span class="sx">/media</span><span class="w"> </span><span class="sx">/srv/funkwhale/data/media</span> <span class="w"> </span><span class="nb">ProxyPass</span><span class="w"> </span><span class="s2">"/staticfiles"</span><span class="w"> </span><span class="s2">"!"</span> <span class="w"> </span><span class="nb">Alias</span><span class="w"> </span><span class="sx">/staticfiles</span><span class="w"> </span><span class="sx">/srv/funkwhale/data/static</span> </pre></div> </div> <p>In case you are using custom css and theming, you also need to match this block:</p> <div class="highlight-apache2 notranslate"><div class="highlight"><pre><span></span> ProxyPass "/settings.json" "!" Alias /settings.json /srv/funkwhale/custom/settings.json ProxyPass "/custom" "!" Alias /custom /srv/funkwhale/custom </pre></div> </div> <p>Enhancements:</p> <ul class="simple"> <li><p>Added name attributes on all inputs to improve UX, especially with password managers (#686)</p></li> <li><p>Disable makemigrations in production and misleading message when running migrate (#685)</p></li> <li><p>Display progress during file upload</p></li> <li><p>Hide pagination when there is only one page of results (#681)</p></li> <li><p>Include shared/public playlists in Subsonic API responses (#684)</p></li> <li><p>Use proper locale for date-related/duration strings (#670)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Fix transcoding of in-place imported tracks (#688)</p></li> <li><p>Fixed celery worker defaulting to development settings instead of production</p></li> <li><p>Fixed crashing Django admin when loading track detail page (#666)</p></li> <li><p>Fixed list icon alignment on landing page (#668)</p></li> <li><p>Fixed overescaping issue in notifications and album page (#676)</p></li> <li><p>Fixed wrong number of affected elements in bulk action modal (#683)</p></li> <li><p>Fixed wrong URL in documentation for funkwhale_proxy.conf file when deploying using Docker</p></li> <li><p>Make Apache configuration file work with 0.18 changes (#667)</p></li> <li><p>Removed potential BREACH exploit because of Gzip compression (#678)</p></li> <li><p>Upgraded kombu to fix an incompatibility with redis>=3</p></li> </ul> <p>Documentation:</p> <ul class="simple"> <li><p>Added user upload documentation at https://docs.funkwhale.audio/users/upload.html</p></li> </ul> </section> </section> <section id="naomi-2019-01-22"> <h2>0.18 “Naomi” (2019-01-22)<a class="headerlink" href="#naomi-2019-01-22" title="Permalink to this heading"></a></h2> <p>This release is dedicated to Naomi, an early contributor and beta tester of Funkwhale. Her positivity, love and support have been incredibly helpful and helped shape the project as you can enjoy it today. Thank you so much Naomi <3</p> <p>Many thanks to the dozens of people that contributed to this release: translators, developers, bug hunters, admins and backers. You made it possible!</p> <p>Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html, ensure you also execute the instructions marked with <code class="docutils literal notranslate"><span class="pre">[manual</span> <span class="pre">action</span> <span class="pre">required]</span></code> and <code class="docutils literal notranslate"><span class="pre">[manual</span> <span class="pre">action</span> <span class="pre">suggested]</span></code>.</p> <p>See <code class="docutils literal notranslate"><span class="pre">Full</span> <span class="pre">changelog</span></code> below for an exhaustive list of changes!</p> <section id="audio-transcoding-is-back"> <h3>Audio transcoding is back!<a class="headerlink" href="#audio-transcoding-is-back" title="Permalink to this heading"></a></h3> <p>After removal of our first, buggy transcoding implementation, we’re proud to announce that this feature is back. It is enabled by default, and can be configured/disabled in your instance settings!</p> <p>This feature works in the browser, with federated/non-federated tracks and using Subsonic clients. Transcoded tracks are generated on the fly, and cached for a configurable amount of time, to reduce the load on the server.</p> </section> <section id="licensing-and-copyright-information"> <h3>Licensing and copyright information<a class="headerlink" href="#licensing-and-copyright-information" title="Permalink to this heading"></a></h3> <p>Funkwhale is now able to parse copyright and license data from file and store this information. Apart from displaying it on each track detail page, no additional behaviour is currently implemented to use this new data, but this will change in future releases.</p> <p>License and copyright data is also broadcasted over federation.</p> <p>License matching is done on the content of the <code class="docutils literal notranslate"><span class="pre">License</span></code> tag in the files, with a fallback on the <code class="docutils literal notranslate"><span class="pre">Copyright</span></code> tag.</p> <p>Funkwhale will successfully extract licensing data for the following licenses:</p> <ul class="simple"> <li><p>Creative Commons 0 (Public Domain)</p></li> <li><p>Creative Commons 1.0 (All declinations)</p></li> <li><p>Creative Commons 2.0 (All declinations)</p></li> <li><p>Creative Commons 2.5 (All declinations and countries)</p></li> <li><p>Creative Commons 3.0 (All declinations and countries)</p></li> <li><p>Creative Commons 4.0 (All declinations)</p></li> </ul> <p>Support for other licenses such as Art Libre or WTFPL will be added in future releases.</p> </section> <section id="instance-level-moderation-tools"> <h3>Instance-level moderation tools<a class="headerlink" href="#instance-level-moderation-tools" title="Permalink to this heading"></a></h3> <p>This release includes a first set of moderation tools that will give more control to admins about the way their instance federates with other instance and accounts on the network. Using these tools, it’s now possible to:</p> <ul class="simple"> <li><p>Browse known accounts and domains, and associated data (storage size, software version, etc.)</p></li> <li><p>Purge data belonging to given accounts and domains</p></li> <li><p>Block or partially restrict interactions with any account or domain</p></li> </ul> <p>All those features are usable using a brand new “moderation” permission, meaning you can appoint one or multiple moderators to help with this task.</p> <p>I’d like to thank all Mastodon contributors, because some of the these tools are heavily inspired from what’s being done in Mastodon. Thank you so much!</p> </section> <section id="iframe-widget-to-embed-public-tracks-and-albums-manual-action-required"> <h3>Iframe widget to embed public tracks and albums [manual action required]<a class="headerlink" href="#iframe-widget-to-embed-public-tracks-and-albums-manual-action-required" title="Permalink to this heading"></a></h3> <p>Funkwhale now supports embedding a lightweight audio player on external websites for album and tracks that are available in public libraries. Important pages, such as artist, album and track pages also include OpenGraph tags that will enable previews on compatible apps (like sharing a Funkwhale track link on Mastodon or Twitter).</p> <p>To achieve that, we had to tweak the way Funkwhale front-end is served. You’ll have to modify your nginx configuration when upgrading to keep your instance working.</p> <p><strong>On docker setups</strong>, edit your <code class="docutils literal notranslate"><span class="pre">/srv/funkwhale/nginx/funkwhale.template</span></code> and replace the <code class="docutils literal notranslate"><span class="pre">location</span> <span class="pre">/api/</span></code> and <code class="docutils literal notranslate"><span class="pre">location</span> <span class="pre">/</span></code> blocks by the following snippets:</p> <div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="k">location</span><span class="w"> </span><span class="s">/</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">include</span><span class="w"> </span><span class="s">/etc/nginx/funkwhale_proxy.conf</span><span class="p">;</span> <span class="w"> </span><span class="c1"># this is needed if you have file import via upload enabled</span> <span class="w"> </span><span class="kn">client_max_body_size</span><span class="w"> </span><span class="nv">${NGINX_MAX_BODY_SIZE}</span><span class="p">;</span> <span class="w"> </span><span class="kn">proxy_pass</span><span class="w"> </span><span class="s">http://funkwhale-api/</span><span class="p">;</span> <span class="p">}</span> <span class="k">location</span><span class="w"> </span><span class="s">/front/</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">alias</span><span class="w"> </span><span class="s">/frontend/</span><span class="p">;</span> <span class="p">}</span> </pre></div> </div> <p>The change of configuration will be picked when restarting your nginx container.</p> <p><strong>On non-docker setups</strong>, edit your <code class="docutils literal notranslate"><span class="pre">/etc/nginx/sites-available/funkwhale.conf</span></code> file, and replace the <code class="docutils literal notranslate"><span class="pre">location</span> <span class="pre">/api/</span></code> and <code class="docutils literal notranslate"><span class="pre">location</span> <span class="pre">/</span></code> blocks by the following snippets:</p> <div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="k">location</span><span class="w"> </span><span class="s">/</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">include</span><span class="w"> </span><span class="s">/etc/nginx/funkwhale_proxy.conf</span><span class="p">;</span> <span class="w"> </span><span class="c1"># this is needed if you have file import via upload enabled</span> <span class="w"> </span><span class="kn">client_max_body_size</span><span class="w"> </span><span class="nv">${NGINX_MAX_BODY_SIZE}</span><span class="p">;</span> <span class="w"> </span><span class="kn">proxy_pass</span><span class="w"> </span><span class="s">http://funkwhale-api/</span><span class="p">;</span> <span class="p">}</span> <span class="k">location</span><span class="w"> </span><span class="s">/front/</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">alias</span><span class="w"> </span><span class="nv">${FUNKWHALE_FRONTEND_PATH}/</span><span class="p">;</span> <span class="p">}</span> </pre></div> </div> <p>Replace <code class="docutils literal notranslate"><span class="pre">${FUNKWHALE_FRONTEND_PATH}</span></code> by the corresponding variable from your .env file, which should be <code class="docutils literal notranslate"><span class="pre">/srv/funkwhale/front/dist</span></code> by default, then reload your nginx process with <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">systemctl</span> <span class="pre">reload</span> <span class="pre">nginx</span></code>.</p> </section> <section id="alternative-docker-deployment-method"> <h3>Alternative docker deployment method<a class="headerlink" href="#alternative-docker-deployment-method" title="Permalink to this heading"></a></h3> <p>Thanks to the awesome work done by @thetarkus at https://github.com/thetarkus/docker-funkwhale, we’re now able to provide an alternative and easier Docker deployment method!</p> <p>In contrast with our current, multi-container offer, this method integrates all Funkwhale processes and services (database, redis, etc.) into a single, easier to deploy container.</p> <p>Both methods will coexist in parallel, as each one has pros and cons. You can learn more about this exciting new deployment option by visiting https://docs.funkwhale.audio/installation/docker.html!</p> </section> <section id="automatically-load-env-file"> <h3>Automatically load .env file<a class="headerlink" href="#automatically-load-env-file" title="Permalink to this heading"></a></h3> <p>On non-docker deployments, earlier versions required you to source the config/.env file before launching any Funkwhale command, with <code class="docutils literal notranslate"><span class="pre">export</span> <span class="pre">$(cat</span> <span class="pre">config/.env</span> <span class="pre">|</span> <span class="pre">grep</span> <span class="pre">-v</span> <span class="pre">^#</span> <span class="pre">|</span> <span class="pre">xargs)</span></code> This led to more complex and error prone deployment / setup.</p> <p>This is not the case anymore, and Funkwhale will automatically load this file if it’s available.</p> </section> <section id="delete-pre-0-17-federated-tracks-manual-action-suggested"> <h3>Delete pre 0.17 federated tracks [manual action suggested]<a class="headerlink" href="#delete-pre-0-17-federated-tracks-manual-action-suggested" title="Permalink to this heading"></a></h3> <p>If you were using Funkwhale before the 0.17 release and federated with other instances, it’s possible that you still have some unplayable federated files in the database.</p> <p>To purge the database of those entries, you can run the following command:</p> <p>On docker setups:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>docker-compose<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span>api<span class="w"> </span>python<span class="w"> </span>manage.py<span class="w"> </span>script<span class="w"> </span>delete_pre_017_federated_uploads<span class="w"> </span>--no-input </pre></div> </div> <p>On non-docker setups:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>manage.py<span class="w"> </span>script<span class="w"> </span>delete_pre_017_federated_uploads<span class="w"> </span>--no-input </pre></div> </div> </section> <section id="enable-gzip-compression-manual-action-suggested"> <h3>Enable gzip compression [manual action suggested]<a class="headerlink" href="#enable-gzip-compression-manual-action-suggested" title="Permalink to this heading"></a></h3> <p>Gzip compression will be enabled on new instances by default and will reduce the amount of bandwidth consumed by your instance.</p> <p>If you want to benefit from gzip compression on your instance, edit your reverse proxy virtualhost file (located at <code class="docutils literal notranslate"><span class="pre">/etc/nginx/sites-available/funkwhale.conf</span></code>) and add the following snippet in the server block, then reload your nginx server:</p> <div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="k">server</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="c1"># ...</span> <span class="w"> </span><span class="c1"># compression settings</span> <span class="w"> </span><span class="kn">gzip</span><span class="w"> </span><span class="no">on</span><span class="p">;</span> <span class="w"> </span><span class="kn">gzip_comp_level</span><span class="w"> </span><span class="mi">5</span><span class="p">;</span> <span class="w"> </span><span class="kn">gzip_min_length</span><span class="w"> </span><span class="mi">256</span><span class="p">;</span> <span class="w"> </span><span class="kn">gzip_proxied</span><span class="w"> </span><span class="s">any</span><span class="p">;</span> <span class="w"> </span><span class="kn">gzip_vary</span><span class="w"> </span><span class="no">on</span><span class="p">;</span> <span class="w"> </span><span class="kn">gzip_types</span> <span class="w"> </span><span class="s">application/javascript</span> <span class="w"> </span><span class="s">application/vnd.geo+json</span> <span class="w"> </span><span class="s">application/vnd.ms-fontobject</span> <span class="w"> </span><span class="s">application/x-font-ttf</span> <span class="w"> </span><span class="s">application/x-web-app-manifest+json</span> <span class="w"> </span><span class="s">font/opentype</span> <span class="w"> </span><span class="s">image/bmp</span> <span class="w"> </span><span class="s">image/svg+xml</span> <span class="w"> </span><span class="s">image/x-icon</span> <span class="w"> </span><span class="s">text/cache-manifest</span> <span class="w"> </span><span class="s">text/css</span> <span class="w"> </span><span class="s">text/plain</span> <span class="w"> </span><span class="s">text/vcard</span> <span class="w"> </span><span class="s">text/vnd.rim.location.xloc</span> <span class="w"> </span><span class="s">text/vtt</span> <span class="w"> </span><span class="s">text/x-component</span> <span class="w"> </span><span class="s">text/x-cross-domain-policy</span><span class="p">;</span> <span class="w"> </span><span class="c1"># end of compression settings</span> <span class="p">}</span> </pre></div> </div> </section> <section id="full-changelog"> <h3>Full changelog<a class="headerlink" href="#full-changelog" title="Permalink to this heading"></a></h3> <p>Features:</p> <ul class="simple"> <li><p>Allow embedding of albums and tracks available in public libraries via an <iframe> (#578)</p></li> <li><p>Audio transcoding is back! (#272)</p></li> <li><p>First set of instance level moderation tools (#580, !521)</p></li> <li><p>Store licensing and copyright information from file metadata, if available (#308)</p></li> </ul> <p>Enhancements:</p> <ul class="simple"> <li><p>Add UI elements for multi-disc albums (#631)</p></li> <li><p>Added alternative funkwhale/all-in-one docker image (#614)</p></li> <li><p>Broadcast library updates (name, description, visibility) over federation</p></li> <li><p>Based Docker image on alpine to have a smaller (and faster to build) image</p></li> <li><p>Improved front-end performance by stripping unused dependencies, reducing bundle size and enabling gzip compression</p></li> <li><p>Improved accessibility by using main/section/nav tags and aria-labels in most critical places (#612)</p></li> <li><p>The progress bar in the player now display loading state / buffer loading (#586)</p></li> <li><p>Added “type: funkwhale” and “funkwhale-version” in Subsonic responses (#573)</p></li> <li><p>Documented keyboard shortcuts, list is now available by pressing “h” or in the footer (#611)</p></li> <li><p>Documented which Subsonic endpoints are implemented (#575)</p></li> <li><p>Hide invitation code field during signup when it’s not required (#410)</p></li> <li><p>Importer will now pick embedded images in files with OTHER type if no COVER_FRONT is present</p></li> <li><p>Improved keyboard accessibility on player, queue and various controls (#576)</p></li> <li><p>Improved performance when listing playable tracks, albums and artists</p></li> <li><p>Increased default upload limit from 30 to 100MB (#654)</p></li> <li><p>Load env file in config/.env automatically to avoid sourcing it by hand (#626)</p></li> <li><p>More resilient date parsing during audio import, will not crash anymore on invalid dates (#622)</p></li> <li><p>Now start radios immediately, skipping any existing tracks in queue (#585)</p></li> <li><p>Officially support connecting to a password protected redis server, with the redis://:password@localhost:6379/0 scheme (#640)</p></li> <li><p>Performance improvement when fetching favorites, down to a single, small http request</p></li> <li><p>Removed “Activity” page, since all the data is available on the “Browse” page (#600)</p></li> <li><p>Removed the need to specify the DJANGO_ALLOWED_HOSTS variable</p></li> <li><p>Restructured the footer, added useful links and removed unused content</p></li> <li><p>Show short entries first in search results to improve UX</p></li> <li><p>Store disc number and order tracks by disc number / position) (#507)</p></li> <li><p>Strip EXIF metadata from uploaded avatars to avoid leaking private data (#374)</p></li> <li><p>Support blind key rotation in HTTP Signatures (#658)</p></li> <li><p>Support setting a server URL in settings.json (#650)</p></li> <li><p>Updated default docker postgres version from 9.4 to 11 (#656)</p></li> <li><p>Updated lots of dependencies (especially django 2.0->2.1), and removed unused dependencies (#657)</p></li> <li><p>Improved test suite speed by reducing / disabling expensive operations (#648)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Fixed parsing of embedded file cover for ogg files tagged with MusicBrainz (#469)</p></li> <li><p>Upgraded core dependencies to fix websocket/messaging issues and possible memory leaks (#643)</p></li> <li><p>Fix “.None” extension when downloading Flac file (#473)</p></li> <li><p>Fixed None extension when downloading an in-place imported file (#621)</p></li> <li><p>Added a script to prune pre 0.17 federated tracks (#564)</p></li> <li><p>Advertise public libraries properly in ActivityPub representations (#553)</p></li> <li><p>Allow opus file upload (#598)</p></li> <li><p>Do not display “view on MusicBrainz” button if we miss the mbid (#422)</p></li> <li><p>Do not try to create unaccent extension if it’s already present (#663)</p></li> <li><p>Ensure admin links in sidebar are displayed for users with relevant permissions, and only them (#597)</p></li> <li><p>Fix broken websocket connection under Chrome browser (#589)</p></li> <li><p>Fix play button not starting playback with empty queue (#632)</p></li> <li><p>Fixed a styling inconsistency on about page when instance description was missing (#659)</p></li> <li><p>Fixed a UI discrepancy in playlist tracks count (#647)</p></li> <li><p>Fixed greyed tracks in radio builder and detail page (#637)</p></li> <li><p>Fixed inconsistencies in subsonic error responses (#616)</p></li> <li><p>Fixed incorrect icon for “next track” in player control (#613)</p></li> <li><p>Fixed malformed search string when redirecting to LyricsWiki (#608)</p></li> <li><p>Fixed missing track count on various library cards (#581)</p></li> <li><p>Fixed skipped track when appending multiple tracks to the queue under certain conditions (#209)</p></li> <li><p>Fixed wrong album/track count on artist page (#599)</p></li> <li><p>Hide unplayable/empty playlists in “Browse playlist” pages (#424)</p></li> <li><p>Initial UI render using correct language from browser (#644)</p></li> <li><p>Invalid URI for reverse proxy websocket with apache (#617)</p></li> <li><p>Properly encode Wikipedia and lyrics search urls (#470)</p></li> <li><p>Refresh profile after user settings update to avoid cache issues (#606)</p></li> <li><p>Use role=button instead of empty links for player controls (#610)</p></li> </ul> <p>Documentation:</p> <ul class="simple"> <li><p>Deploy documentation from the master branch instead of the develop branch to avoid inconsistencies (#642)</p></li> <li><p>Document how to find and use library id when importing files in CLI (#562)</p></li> <li><p>Fix documentation typos (#645)</p></li> </ul> </section> </section> <section id="id34"> <h2>0.17 (2018-10-07)<a class="headerlink" href="#id34" title="Permalink to this heading"></a></h2> <section id="per-user-libraries"> <h3>Per user libraries<a class="headerlink" href="#per-user-libraries" title="Permalink to this heading"></a></h3> <p>This release contains a big change in music management. This has a lot of impact on how Funkwhale behaves, and you should have a look at https://docs.funkwhale.audio/upgrading/0.17.html for information about what changed and how to migrate.</p> <p>Features:</p> <ul class="simple"> <li><p>Per user libraries (#463, also fixes #160 and #147)</p></li> <li><p>Authentication using a LDAP directory (#194)</p></li> </ul> <p>Enhancements:</p> <ul class="simple"> <li><p>Add configuration option to set Musicbrainz hostname</p></li> <li><p>Add sign up link in the sidebar (#408)</p></li> <li><p>Added a library widget to display libraries associated with a track, album and artist (#551)</p></li> <li><p>Ensure from_activity field is not required in django’s admin (#546)</p></li> <li><p>Move setting link from profile page to the sidebar (#406)</p></li> <li><p>Simplified and less error-prone nginx setup (#358)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Do not restart current song when rordering queue, deleting tracks from queue or adding tracks to queue (#464)</p></li> <li><p>Fix broken icons in playlist editor (#515)</p></li> <li><p>Fixed a few untranslated strings (#559)</p></li> <li><p>Fixed split album when importing from federation (#346)</p></li> <li><p>Fixed toggle mute in volume bar does not restore previous volume level (#514)</p></li> <li><p>Fixed wrong env file URL and display bugs in deployment documentation (#520)</p></li> <li><p>Fixed wrong title in PlayButton (#435)</p></li> <li><p>Remove transparency on artist page button (#517)</p></li> <li><p>Set sane width default for ui cards and center play button (#530)</p></li> <li><p>Updated wrong icon and copy in play button dropdown (#436)</p></li> </ul> <p>Documentation:</p> <ul class="simple"> <li><p>Fixed wrong URLs for docker / nginx files in documentation (#537)</p></li> </ul> <p>Other:</p> <ul class="simple"> <li><p>Added a merge request template and more documentation about the changelog</p></li> </ul> </section> <section id="using-a-ldap-directory-to-authenticate-to-your-funkwhale-instance"> <h3>Using a LDAP directory to authenticate to your Funkwhale instance<a class="headerlink" href="#using-a-ldap-directory-to-authenticate-to-your-funkwhale-instance" title="Permalink to this heading"></a></h3> <p>Funkwhale now support LDAP as an authentication source: you can configure your instance to delegate login to a LDAP directory, which is especially useful when you have an existing directory and don’t want to manage users manually.</p> <p>You can use this authentication backend side by side with the classic one.</p> <p>Have a look at https://docs.funkwhale.audio/installation/ldap.html for detailed instructions on how to set this up.</p> </section> <section id="simplified-nginx-setup-docker-manual-action-required"> <h3>Simplified nginx setup [Docker: Manual action required]<a class="headerlink" href="#simplified-nginx-setup-docker-manual-action-required" title="Permalink to this heading"></a></h3> <p>We’ve received a lot of user feedback regarding our installation process, and it seems the proxy part is the one which is the most confusing and difficult. Unfortunately, this is also the one where errors and mistakes can completely break the application.</p> <p>To make things easier for everyone, we now offer a simplified deployment process for the reverse proxy part. This will make upgrade of the proxy configuration significantly easier on docker deployments.</p> <p>On non-docker instances, you have nothing to do.</p> <p>If you have a dockerized instance, here is the upgrade path.</p> <p>First, tweak your .env file:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># remove the FUNKWHALE_URL variable</span> <span class="c1"># and add the next variables</span> <span class="nv">FUNKWHALE_HOSTNAME</span><span class="o">=</span>yourdomain.funkwhale <span class="nv">FUNKWHALE_PROTOCOL</span><span class="o">=</span>https <span class="c1"># add the following variable, matching the path your app is deployed</span> <span class="c1"># leaving the default should work fine if you deployed using the same</span> <span class="c1"># paths as the documentation</span> <span class="nv">FUNKWHALE_FRONTEND_PATH</span><span class="o">=</span>/srv/funkwhale/front/dist </pre></div> </div> <p>Then, add the following block at the end of your docker-compose.yml file:</p> <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">services</span><span class="p">:</span> <span class="w"> </span><span class="c1"># existing services</span> <span class="w"> </span><span class="nt">api</span><span class="p">:</span> <span class="w"> </span><span class="c1"># ...</span> <span class="w"> </span><span class="nt">celeryworker</span><span class="p">:</span> <span class="w"> </span><span class="c1"># ...</span> <span class="w"> </span><span class="c1"># new service</span> <span class="w"> </span><span class="nt">nginx</span><span class="p">:</span> <span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</span> <span class="w"> </span><span class="nt">env_file</span><span class="p">:</span> <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">.env</span> <span class="w"> </span><span class="nt">environment</span><span class="p">:</span> <span class="w"> </span><span class="c1"># Override those variables in your .env file if needed</span> <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"NGINX_MAX_BODY_SIZE=${NGINX_MAX_BODY_SIZE-100M}"</span> <span class="w"> </span><span class="nt">volumes</span><span class="p">:</span> <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"./nginx/funkwhale.template:/etc/nginx/conf.d/funkwhale.template:ro"</span> <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"./nginx/funkwhale_proxy.conf:/etc/nginx/funkwhale_proxy.conf:ro"</span> <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"${MUSIC_DIRECTORY_SERVE_PATH-/srv/funkwhale/data/music}:${MUSIC_DIRECTORY_SERVE_PATH-/srv/funkwhale/data/music}:ro"</span> <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"${MEDIA_ROOT}:${MEDIA_ROOT}:ro"</span> <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"${STATIC_ROOT}:${STATIC_ROOT}:ro"</span> <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"${FUNKWHALE_FRONTEND_PATH}:/frontend:ro"</span> <span class="w"> </span><span class="nt">ports</span><span class="p">:</span> <span class="w"> </span><span class="c1"># override those variables in your .env file if needed</span> <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"${FUNKWHALE_API_IP}:${FUNKWHALE_API_PORT}:80"</span> <span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">></span> <span class="w"> </span><span class="no">sh -c "envsubst \"`env | awk -F = '{printf \" $$%s\", $$1}'`\"</span> <span class="w"> </span><span class="no">< /etc/nginx/conf.d/funkwhale.template</span> <span class="w"> </span><span class="no">> /etc/nginx/conf.d/default.conf</span> <span class="w"> </span><span class="no">&& cat /etc/nginx/conf.d/default.conf</span> <span class="w"> </span><span class="no">&& nginx -g 'daemon off;'"</span> <span class="w"> </span><span class="nt">links</span><span class="p">:</span> <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">api</span> </pre></div> </div> <p>By doing that, you’ll enable a dockerized nginx that will automatically be configured to serve your Funkwhale instance.</p> <p>Download the required configuration files for the nginx container:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">srv</span><span class="o">/</span><span class="n">funkwhale</span> <span class="n">mkdir</span> <span class="n">nginx</span> <span class="n">curl</span> <span class="o">-</span><span class="n">L</span> <span class="o">-</span><span class="n">o</span> <span class="n">nginx</span><span class="o">/</span><span class="n">funkwhale</span><span class="o">.</span><span class="n">template</span> <span class="s2">"https://dev.funkwhale.audio/funkwhale/funkwhale/raw/|version|/deploy/docker.nginx.template"</span> <span class="n">curl</span> <span class="o">-</span><span class="n">L</span> <span class="o">-</span><span class="n">o</span> <span class="n">nginx</span><span class="o">/</span><span class="n">funkwhale_proxy</span><span class="o">.</span><span class="n">conf</span> <span class="s2">"https://dev.funkwhale.audio/funkwhale/funkwhale/raw/|version|/deploy/funkwhale_proxy.conf"</span> </pre></div> </div> <p>Update the funkwhale.conf configuration of your server’s reverse-proxy:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># the file should match something like that, upgrade all variables</span> <span class="c1"># between ${} to match the ones in your .env file,</span> <span class="c1"># and your SSL configuration if you're not using let's encrypt</span> <span class="c1"># The important thing is that you only have a single location block</span> <span class="c1"># that proxies everything to your dockerized nginx.</span> sudo<span class="w"> </span>nano<span class="w"> </span>/etc/nginx/sites-enabled/funkwhale.conf </pre></div> </div> <div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="k">upstream</span><span class="w"> </span><span class="s">fw</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="c1"># depending on your setup, you may want to update this</span> <span class="w"> </span><span class="kn">server</span><span class="w"> </span><span class="nv">${FUNKWHALE_API_IP}:${FUNKWHALE_API_PORT}</span><span class="p">;</span> <span class="p">}</span> <span class="k">map</span><span class="w"> </span><span class="nv">$http_upgrade</span><span class="w"> </span><span class="nv">$connection_upgrade</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">default</span><span class="w"> </span><span class="s">upgrade</span><span class="p">;</span> <span class="w"> </span><span class="kn">''</span><span class="w"> </span><span class="s">close</span><span class="p">;</span> <span class="p">}</span> <span class="k">server</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">listen</span><span class="w"> </span><span class="mi">80</span><span class="p">;</span> <span class="w"> </span><span class="kn">listen</span><span class="w"> </span><span class="s">[::]:80</span><span class="p">;</span> <span class="w"> </span><span class="kn">server_name</span><span class="w"> </span><span class="nv">${FUNKWHALE_HOSTNAME}</span><span class="p">;</span> <span class="w"> </span><span class="kn">location</span><span class="w"> </span><span class="s">/</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="kn">return</span><span class="w"> </span><span class="mi">301</span><span class="w"> </span><span class="s">https://</span><span class="nv">$host$request_uri</span><span class="p">;</span><span class="w"> </span><span class="p">}</span> <span class="p">}</span> <span class="k">server</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">listen</span><span class="w"> </span><span class="mi">443</span><span class="w"> </span><span class="s">ssl</span><span class="p">;</span> <span class="w"> </span><span class="kn">listen</span><span class="w"> </span><span class="s">[::]:443</span><span class="w"> </span><span class="s">ssl</span><span class="p">;</span> <span class="w"> </span><span class="kn">server_name</span><span class="w"> </span><span class="nv">${FUNKWHALE_HOSTNAME}</span><span class="p">;</span> <span class="w"> </span><span class="c1"># TLS</span> <span class="w"> </span><span class="kn">ssl_protocols</span><span class="w"> </span><span class="s">TLSv1.2</span><span class="p">;</span> <span class="w"> </span><span class="kn">ssl_ciphers</span><span class="w"> </span><span class="s">HIGH:!MEDIUM:!LOW:!aNULL:!NULL:!SHA</span><span class="p">;</span> <span class="w"> </span><span class="kn">ssl_prefer_server_ciphers</span><span class="w"> </span><span class="no">on</span><span class="p">;</span> <span class="w"> </span><span class="kn">ssl_session_cache</span><span class="w"> </span><span class="s">shared:SSL:10m</span><span class="p">;</span> <span class="w"> </span><span class="kn">ssl_certificate</span><span class="w"> </span><span class="s">/etc/letsencrypt/live/</span><span class="nv">${FUNKWHALE_HOSTNAME}/fullchain.pem</span><span class="p">;</span> <span class="w"> </span><span class="kn">ssl_certificate_key</span><span class="w"> </span><span class="s">/etc/letsencrypt/live/</span><span class="nv">${FUNKWHALE_HOSTNAME}/privkey.pem</span><span class="p">;</span> <span class="w"> </span><span class="c1"># HSTS</span> <span class="w"> </span><span class="kn">add_header</span><span class="w"> </span><span class="s">Strict-Transport-Security</span><span class="w"> </span><span class="s">"max-age=31536000"</span><span class="p">;</span> <span class="w"> </span><span class="kn">location</span><span class="w"> </span><span class="s">/</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">include</span><span class="w"> </span><span class="s">/etc/nginx/funkwhale_proxy.conf</span><span class="p">;</span> <span class="w"> </span><span class="kn">proxy_pass</span><span class="w"> </span><span class="s">http://fw/</span><span class="p">;</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </pre></div> </div> <p>Check that your configuration is valid then reload:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>nginx<span class="w"> </span>-t sudo<span class="w"> </span>systemctl<span class="w"> </span>reload<span class="w"> </span>nginx </pre></div> </div> </section> </section> <section id="id35"> <h2>0.16.3 (2018-08-21)<a class="headerlink" href="#id35" title="Permalink to this heading"></a></h2> <p>Upgrade instructions are available at https://docs.funkwhale.audio/upgrading.html</p> <p>Bugfixes:</p> <ul class="simple"> <li><p>Fixed front-end not contacting the proper path on the API (!385)</p></li> </ul> </section> <section id="id36"> <h2>0.16.2 (2018-08-21)<a class="headerlink" href="#id36" title="Permalink to this heading"></a></h2> <div class="admonition warning"> <p class="admonition-title">Warning</p> <p><strong>This release is broken, do not use it. Upgrade to 0.16.3 or higher instead.</strong></p> </div> <p>Upgrade instructions are available at https://docs.funkwhale.audio/upgrading.html</p> <p>Bugfixes:</p> <ul class="simple"> <li><p>Ensure we always have a default api url set on first load to avoid displaying the instance picker (#490)</p></li> <li><p>Fixed CLI importer syntax error because of async reserved keyword usage (#494)</p></li> </ul> </section> <section id="id37"> <h2>0.16.1 (2018-08-19)<a class="headerlink" href="#id37" title="Permalink to this heading"></a></h2> <p>Upgrade instructions are available at https://docs.funkwhale.audio/upgrading.html</p> <p>Features:</p> <ul class="simple"> <li><p>Make funkwhale themable by loading external stylesheets (#456)</p></li> </ul> <p>Enhancements:</p> <ul class="simple"> <li><p>Add link to admin on “Staff member” button (#202)</p></li> <li><p>Can now add a description to radios and better radio cards (#331)</p></li> <li><p>Display track duration in track tables (#461)</p></li> <li><p>More permissive default permissions for front-end files (#388)</p></li> <li><p>Simpler configuration and toolchain for the front-end using vue-cli (!375)</p></li> <li><p>Use Howler to manage audio instead of our own dirty/untested code (#392)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Fix alignment issue on top bar in Admin tabs (#395)</p></li> <li><p>Fix Apache2 permission issue preventing <code class="docutils literal notranslate"><span class="pre">/media</span></code> folder from being served correctly (#389)</p></li> <li><p>Fix loading on browse page lists causing them to go down, and dimming over the top bar (#468)</p></li> <li><p>Fixed (again): administration section not showing up in sidebar after login (#245)</p></li> <li><p>Fixed audio mimetype not showing up on track detail and list (#459)</p></li> <li><p>Fixed broken audio playback on Chrome and invisible volume control (#390)</p></li> <li><p>Fixed broken federation import on big imports due to missing transaction logic (#397)</p></li> <li><p>Fixed crash on artist pages when no cover is available (#457)</p></li> <li><p>Fixed favorited status of tracks not appearing in interface (#398)</p></li> <li><p>Fixed invitation code not prefilled in form when accessing invitation link (#476)</p></li> <li><p>Fixed typos in scheduled tasks configuration (#487)</p></li> <li><p>Removed release date error in case of empty date (#478)</p></li> <li><p>Removed white on white artist button on hover, on Album page (#393)</p></li> <li><p>Smarter date parsing during import by replacing arrow with pendulum (#376)</p></li> <li><p>Display public playlists properly for anonymous users (#488)</p></li> </ul> <p>i18n:</p> <ul class="simple"> <li><p>Added portuguese, spanish and german translations</p></li> </ul> <section id="custom-themes-for-funkwhale"> <h3>Custom themes for Funkwhale<a class="headerlink" href="#custom-themes-for-funkwhale" title="Permalink to this heading"></a></h3> <p>If you ever wanted to give a custom look and feel to your instance, this is now possible.</p> <p>Check https://docs.funkwhale.audio/configuration.html#theming if you want to know more!</p> </section> <section id="fix-apache2-configuration-file-for-media-block-manual-action-required"> <h3>Fix Apache2 configuration file for media block [Manual action required]<a class="headerlink" href="#fix-apache2-configuration-file-for-media-block-manual-action-required" title="Permalink to this heading"></a></h3> <p>The permission scope on the current Apache2 configuration file is too narrow, preventing thumbnails from being served.</p> <p>On Apache2 setups, you have to replace the following line:</p> <div class="highlight-apache notranslate"><div class="highlight"><pre><span></span><span class="nt"><Directory</span><span class="w"> </span><span class="s">/srv/funkwhale/data/media/albums</span><span class="nt">></span> </pre></div> </div> <p>with:</p> <div class="highlight-apache notranslate"><div class="highlight"><pre><span></span><span class="nt"><Directory</span><span class="w"> </span><span class="s">/srv/funkwhale/data/media</span><span class="nt">></span> </pre></div> </div> <p>You can now restart your server:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>systemctl<span class="w"> </span>restart<span class="w"> </span>apache2 </pre></div> </div> </section> </section> <section id="id38"> <h2>0.16 (2018-07-22)<a class="headerlink" href="#id38" title="Permalink to this heading"></a></h2> <p>Upgrade instructions are available at https://docs.funkwhale.audio/upgrading.html</p> <p>Features:</p> <ul class="simple"> <li><p>Complete redesign of the library home and playlist pages (#284)</p></li> <li><p>Expose ActivityPub actors for users (#317)</p></li> <li><p>Implemented a basic but functional Github-like search on federated tracks list (#344)</p></li> <li><p>Internationalized interface as well as translations for Arabic, French, Esperanto, Italian, Occitan, Polish, Portuguese and Swedish (#161, #167)</p></li> <li><p>Users can now upload an avatar in their settings page (#257)</p></li> </ul> <p>Enhancements:</p> <ul class="simple"> <li><p>Added feedback when creating/updating radio (#302)</p></li> <li><p>Apply restrictions to username characters during signup</p></li> <li><p>Autoselect best language based on browser configuration (#386)</p></li> <li><p>Can now order tracks on federated track list (#326)</p></li> <li><p>Can now relaunch pending import jobs from the web interface (#323)</p></li> <li><p>Ensure we do not display pagination on single pages (#334)</p></li> <li><p>Ensure we have sane defaults for MEDIA_ROOT, STATIC_ROOT and MUSIC_DIRECTORY_PATH in the deployment .env file (#350)</p></li> <li><p>Make some space for the volume slider to allow precise control (#318)</p></li> <li><p>Removed django-cacheops dependency</p></li> <li><p>Store track artist and album artist separately (#237) Better handling of tracks with a different artist than the album artist</p></li> <li><p>The navigation bar of Library is now fixed (#375)</p></li> <li><p>Use thumbnails for avatars and covers to reduce bandwidth</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Ensure 750 permissions on CI artifacts (#332)</p></li> <li><p>Ensure images are not cropped in queue (#337)</p></li> <li><p>Ensure we do not import artists with empty names (#351)</p></li> <li><p>Fix notifications not closing when clicking on the cross (#366)</p></li> <li><p>Fix the most annoying offset in the whole fediverse (#369)</p></li> <li><p>Fixed persistent message in playlist modal (#304)</p></li> <li><p>Fixed unfiltered results in favorites API (#384)</p></li> <li><p>Raise a warning instead of crashing when getting a broken path in file import (#138)</p></li> <li><p>Remove parallelization of uploads during import to avoid crashing small servers (#382)</p></li> <li><p>Subsonic API login is now case insensitive (#339)</p></li> <li><p>Validate Date header in HTTP Signatures (#328)</p></li> </ul> <p>Documentation:</p> <ul class="simple"> <li><p>Added troubleshotting and technical overview documentation (#256)</p></li> <li><p>Arch Linux installation steps</p></li> <li><p>Document that users can use Ultrasonic on Android (#316)</p></li> <li><p>Fixed a couple of typos</p></li> <li><p>Some cosmetic improvements to the doc</p></li> </ul> <p>i18n:</p> <ul class="simple"> <li><p>Arabic translation (!302)</p></li> <li><p>Polish translation (!304)</p></li> </ul> <section id="library-home-and-playlist-page-overhaul"> <h3>Library home and playlist page overhaul<a class="headerlink" href="#library-home-and-playlist-page-overhaul" title="Permalink to this heading"></a></h3> <p>The library home page have been completely redesigned to include:</p> <ul class="simple"> <li><p>other users activity (listenings, playlists and favorites)</p></li> <li><p>recently imported albums</p></li> </ul> <p>We think this new version showcases more music in a more useful way, let us know what you think about it!</p> <p>The playlist page have been updated as well.</p> </section> <section id="internationalized-interface"> <h3>Internationalized interface<a class="headerlink" href="#internationalized-interface" title="Permalink to this heading"></a></h3> <p>After months of work, we’re proud to announce our interface is now ready for internationalization.</p> <p>Translators have already started the work of translating Funkwhale in 8 different languages, and we’re ready to add more as needed.</p> <p>You can easily get involved at https://translate.funkwhale.audio/engage/funkwhale/</p> </section> <section id="better-handling-of-tracks-with-a-different-artist-than-the-album-artist"> <h3>Better handling of tracks with a different artist than the album artist<a class="headerlink" href="#better-handling-of-tracks-with-a-different-artist-than-the-album-artist" title="Permalink to this heading"></a></h3> <p>Some tracks involve a different artist than the album artist (e.g. a featuring) and Funkwhale has been known to do weird things when importing such tracks, resulting in albums that contained a single track, for instance.</p> <p>The situation should be improved with this release, as Funkwhale is now able to store separately the track and album artist, and display it properly in the interface.</p> </section> <section id="users-now-have-an-activitypub-actor-manual-action-required"> <h3>Users now have an ActivityPub Actor [Manual action required]<a class="headerlink" href="#users-now-have-an-activitypub-actor-manual-action-required" title="Permalink to this heading"></a></h3> <p>In the process of implementing federation for user activity such as listening history, we are now making user profiles (a.k.a. ActivityPub actors) available through federation.</p> <p>This does not means the federation is working, but this is a needed step to implement it.</p> <p>Those profiles will be created automatically for new users, but you have to run a command to create them for existing users.</p> <p>On docker setups:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>docker-compose<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span>api<span class="w"> </span>python<span class="w"> </span>manage.py<span class="w"> </span>script<span class="w"> </span>create_actors<span class="w"> </span>--no-input </pre></div> </div> <p>On non-docker setups:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>manage.py<span class="w"> </span>script<span class="w"> </span>create_actors<span class="w"> </span>--no-input </pre></div> </div> <p>This should only take a few seconds to run. It is safe to interrupt the process or rerun it multiple times.</p> </section> <section id="image-thumbnails-manual-action-required"> <h3>Image thumbnails [Manual action required]<a class="headerlink" href="#image-thumbnails-manual-action-required" title="Permalink to this heading"></a></h3> <p>To reduce bandwidth usage on slow or limited connexions and improve performance in general, we now use smaller images in the front-end. For instance, if you have an album cover with a 1000x1000 pixel size, we will create smaller versions of this image (50x50, 200x200, 400x400) and reference those resized version when we don’t actually need the original image.</p> <p>Thumbnail will be created automatically for new objects, however, you have to launch a manual command to deal with existing ones.</p> <p>On docker setups:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>docker-compose<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span>api<span class="w"> </span>python<span class="w"> </span>manage.py<span class="w"> </span>script<span class="w"> </span>create_image_variations<span class="w"> </span>--no-input </pre></div> </div> <p>On non-docker setups:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>manage.py<span class="w"> </span>script<span class="w"> </span>create_image_variations<span class="w"> </span>--no-input </pre></div> </div> <p>This should be quite fast but may take up to a few minutes depending on the number of albums you have in database. It is safe to interrupt the process or rerun it multiple times.</p> </section> <section id="improved-search-on-federated-tracks-list"> <h3>Improved search on federated tracks list<a class="headerlink" href="#improved-search-on-federated-tracks-list" title="Permalink to this heading"></a></h3> <p>Having a powerful but easy-to-use search is important but difficult to achieve, especially if you do not want to have a real complex search interface.</p> <p>Github does a pretty good job with that, using a structured but simple query system (See https://help.github.com/articles/searching-issues-and-pull-requests/#search-only-issues-or-pull-requests).</p> <p>This release implements a limited but working subset of this query system. You can use it only on the federated tracks list (/manage/federation/tracks) at the moment, but depending on feedback it will be rolled-out on other pages as well.</p> <p>This is the type of query you can run:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">hello</span> <span class="pre">world</span></code>: search for “hello” and “world” in all the available fields</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">hello</span> <span class="pre">in:artist</span></code> search for results where artist name is “hello”</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">spring</span> <span class="pre">in:artist,album</span></code> search for results where artist name or album title contain “spring”</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">artist:hello</span></code> search for results where artist name equals “hello”</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">artist:"System</span> <span class="pre">of</span> <span class="pre">a</span> <span class="pre">Down"</span> <span class="pre">domain:instance.funkwhale</span></code> search for results where artist name equals “System of a Down” and inside “instance.funkwhale” library</p></li> </ul> </section> <section id="ensure-media-root-static-root-and-music-directory-are-set-explicitly-manual-action-required"> <h3>Ensure <code class="docutils literal notranslate"><span class="pre">MEDIA_ROOT</span></code>, <code class="docutils literal notranslate"><span class="pre">STATIC_ROOT</span></code> and <code class="docutils literal notranslate"><span class="pre">MUSIC_DIRECTORY_*</span></code> are set explicitly [Manual action required]<a class="headerlink" href="#ensure-media-root-static-root-and-music-directory-are-set-explicitly-manual-action-required" title="Permalink to this heading"></a></h3> <p>In our default .env file, MEDIA_ROOT and STATIC_ROOT were commented by default, causing some deployment issues on non-docker setups when people forgot to uncomment them.</p> <p>From now on, those variables are uncommented, and will also be used on docker setups to mount the volumes automatically in the docker-compose.yml file. This has been a source of headache as well in some deployments, where you had to update both the .env file and the compose file.</p> <p>This also applies to in-place paths (MUSIC_DIRECTORY_PATH and MUSIC_DIRECTORY_SERVE_PATH), whose values are now used directly to set up the proper Docker volumes.</p> <p>This will only affect new deployments though. If you want to benefit from this on an existing instance, do a backup of your <code class="docutils literal notranslate"><span class="pre">.env</span></code> and <code class="docutils literal notranslate"><span class="pre">docker-compose.yml</span></code> files and apply the following changes:</p> <ul class="simple"> <li><p>Ensure <code class="docutils literal notranslate"><span class="pre">MEDIA_ROOT</span></code> is uncommented in your .env file and match the absolute path where media files are stored on your host (<code class="docutils literal notranslate"><span class="pre">/srv/funkwhale/data/media</span></code> by default)</p></li> <li><p>Ensure <code class="docutils literal notranslate"><span class="pre">STATIC_ROOT</span></code> is uncommented in your .env file and match the absolute path where static files are stored on your host (<code class="docutils literal notranslate"><span class="pre">/srv/funkwhale/data/static</span></code> by default)</p></li> <li><p>If you use in-place import:</p> <ul> <li><p>Ensure MUSIC_DIRECTORY_PATH is uncommented and set to <code class="docutils literal notranslate"><span class="pre">/music</span></code></p></li> <li><p>Ensure MUSIC_DIRECTORY_SERVE_PATH is uncommented and set to the absolute path on your host were your music files are stored (<code class="docutils literal notranslate"><span class="pre">/srv/funkwhale/data/music</span></code> by default)</p></li> </ul> </li> <li><p>Edit your docker-compose.yml file to reflect the changes:</p> <ul> <li><p>Search for volumes (there should be two occurrences) that contains <code class="docutils literal notranslate"><span class="pre">/app/funkwhale_api/media</span></code> on the right side, and replace the whole line with <code class="docutils literal notranslate"><span class="pre">-</span> <span class="pre">"${MEDIA_ROOT}:${MEDIA_ROOT}"</span></code></p></li> <li><p>Search for a volume that contains <code class="docutils literal notranslate"><span class="pre">/app/staticfiles</span></code> on the right side, and replace the whole line with <code class="docutils literal notranslate"><span class="pre">-</span> <span class="pre">"${STATIC_ROOT}:${STATIC_ROOT}"</span></code></p></li> <li><p>If you use in-place import, search for volumes (there should be two occurrences) that contains <code class="docutils literal notranslate"><span class="pre">/music:ro</span></code> on the right side, and replace the whole line with <code class="docutils literal notranslate"><span class="pre">-</span> <span class="pre">"${MUSIC_DIRECTORY_SERVE_PATH}:${MUSIC_DIRECTORY_PATH}:ro"</span></code></p></li> </ul> </li> </ul> <p>In the end, the <code class="docutils literal notranslate"><span class="pre">volumes</span></code> directives of your containers should look like that:</p> <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">services</span><span class="p">:</span> <span class="w"> </span><span class="c1"># ...</span> <span class="w"> </span><span class="nt">celeryworker</span><span class="p">:</span> <span class="w"> </span><span class="nt">volumes</span><span class="p">:</span> <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"${MUSIC_DIRECTORY_SERVE_PATH}:${MUSIC_DIRECTORY_PATH}:ro"</span> <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"${MEDIA_ROOT}:${MEDIA_ROOT}"</span> <span class="w"> </span><span class="c1"># ...</span> <span class="w"> </span><span class="nt">api</span><span class="p">:</span> <span class="w"> </span><span class="nt">volumes</span><span class="p">:</span> <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"${MUSIC_DIRECTORY_SERVE_PATH}:${MUSIC_DIRECTORY_PATH}:ro"</span> <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"${MEDIA_ROOT}:${MEDIA_ROOT}"</span> <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"${STATIC_ROOT}:${STATIC_ROOT}"</span> <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./front/dist:/frontend</span> <span class="w"> </span><span class="c1"># ...</span> </pre></div> </div> </section> <section id="removed-cacheops-dependency"> <h3>Removed Cacheops dependency<a class="headerlink" href="#removed-cacheops-dependency" title="Permalink to this heading"></a></h3> <p>We removed one of our dependency named django-cacheops. It was unly used in a few places, and not playing nice with other dependencies.</p> <p>You can safely remove this dependency in your environment with <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">uninstall</span> <span class="pre">django-cacheops</span></code> if you’re not using docker.</p> <p>You can also safely remove any <code class="docutils literal notranslate"><span class="pre">CACHEOPS_ENABLED</span></code> setting from your environment file.</p> </section> </section> <section id="id39"> <h2>0.15 (2018-06-24)<a class="headerlink" href="#id39" title="Permalink to this heading"></a></h2> <p>Upgrade instructions are available at https://docs.funkwhale.audio/upgrading.html</p> <p>Features:</p> <ul class="simple"> <li><p>Added admin interface to manage import requests (#190)</p></li> <li><p>Added replace flag during import to replace already present tracks with a new version of their track file (#222)</p></li> <li><p>Funkwhale’s front-end can now point to any instance (#327) Removed front-end and back-end coupling</p></li> <li><p>Management interface for users (#212)</p></li> <li><p>New invite system (#248) New invite system</p></li> </ul> <p>Enhancements:</p> <ul class="simple"> <li><p>Added “TV” to the list of highlighted words during YouTube import (#154)</p></li> <li><p>Command line import now accepts unlimited args (#242)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Expose track files date in manage API (#307)</p></li> <li><p>Fixed current track restart/hiccup when shuffling queue, deleting track from queue or reordering (#310)</p></li> <li><p>Include user’s current private playlists on playlist list (#302)</p></li> <li><p>Remove link to generic radios, since they don’t have detail pages (#324)</p></li> </ul> <p>Documentation:</p> <ul class="simple"> <li><p>Document that Funkwhale may be installed with YunoHost (#325)</p></li> <li><p>Documented a saner layout with symlinks for in-place imports (#254)</p></li> <li><p>Upgrade documentation now use the correct user on non-docker setups (#265)</p></li> </ul> <section id="invite-system"> <h3>Invite system<a class="headerlink" href="#invite-system" title="Permalink to this heading"></a></h3> <p>On closed instances, it has always been a little bit painful to create accounts by hand for new users. This release solve that by adding invitations.</p> <p>You can generate invitation codes via the “users” admin interface (you’ll find a link in the sidebar). Those codes are valid for 14 days, and can be used once to create a new account on the instance, even if registrations are closed.</p> <p>By default, we generate a random code for invitations, but you can also use custom codes if you need to print them or make them fancier ;)</p> <p>Invitations generation and management requires the “settings” permission.</p> </section> <section id="removed-front-end-and-back-end-coupling"> <h3>Removed front-end and back-end coupling<a class="headerlink" href="#removed-front-end-and-back-end-coupling" title="Permalink to this heading"></a></h3> <p>Even though Funkwhale’s front-end has always been a Single Page Application, talking to an API, it was only able to talk to an API on the same domain.</p> <p>There was no real technical justification behind this (only laziness), and it was also blocking interesting use cases:</p> <ul class="simple"> <li><p>Use multiple customized versions of the front-end with the same instance</p></li> <li><p>Use a customized version of the front-end with multiple instances</p></li> <li><p>Use a locally hosted front-end with a remote API, which is especially useful in development</p></li> </ul> <p>From now on, Funkwhale’s front-end can connect to any Funkwhale server. You can change the server you are connecting to in the footer.</p> <p>Fixing this also unlocked a really interesting feature in our development/review workflow: by leveraging Gitlab CI and review apps, we are now able to deploy automatically live versions of a merge request, making it possible for anyone to review front-end changes easily, without the need to install a local environment.</p> </section> </section> <section id="id40"> <h2>0.14.2 (2018-06-16)<a class="headerlink" href="#id40" title="Permalink to this heading"></a></h2> <div class="admonition warning"> <p class="admonition-title">Warning</p> <p>This release contains a fix for a permission issue. You should upgrade as soon as possible. Read the changelog below for more details.</p> </div> <p>Upgrade instructions are available at https://docs.funkwhale.audio/upgrading.html</p> <p>Enhancements:</p> <ul class="simple"> <li><p>Added feedback on shuffle button (#262)</p></li> <li><p>Added multiple warnings in the documentation that you should never run makemigrations yourself (#291)</p></li> <li><p>Album cover served in http (#264)</p></li> <li><p>Apache2 reverse proxy now supports websockets (tested with Apache 2.4.25) (!252)</p></li> <li><p>Display file size in human format during file upload (#289)</p></li> <li><p>Switch from BSD-3 licence to AGPL-3 licence (#280)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Ensure radios can only be edited and deleted by their owners (#311)</p></li> <li><p>Fixed admin menu not showing after login (#245)</p></li> <li><p>Fixed broken pagination in Subsonic API (#295)</p></li> <li><p>Fixed duplicated websocket connection on timeline (#287)</p></li> </ul> <p>Documentation:</p> <ul class="simple"> <li><p>Improved documentation about in-place imports setup (#298)</p></li> </ul> <p>Other:</p> <ul class="simple"> <li><p>Added Black and flake8 checks in CI to ensure consistent code styling and formatting (#297)</p></li> <li><p>Added bug and feature issue templates (#299)</p></li> </ul> <section id="permission-issues-on-radios"> <h3>Permission issues on radios<a class="headerlink" href="#permission-issues-on-radios" title="Permalink to this heading"></a></h3> <p>Because of an error in the way we checked user permissions on radios, public radios could be deleted by any logged-in user, even if they were not the owner of the radio.</p> <p>We recommend instances owners to upgrade as fast as possible to avoid any abuse and data loss.</p> </section> <section id="funkwhale-is-now-licenced-under-agpl-3"> <h3>Funkwhale is now licenced under AGPL-3<a class="headerlink" href="#funkwhale-is-now-licenced-under-agpl-3" title="Permalink to this heading"></a></h3> <p>Following the recent switch made by PixelFed (https://github.com/dansup/pixelfed/issues/143), we decided along with the community to relicence Funkwhale under the AGPL-3 licence. We did this switch for various reasons:</p> <ul class="simple"> <li><p>This is better aligned with other fediverse software</p></li> <li><p>It prohibits anyone to distribute closed-source and proprietary forks of Funkwhale</p></li> </ul> <p>As end users and instance owners, this does not change anything. You can continue to use Funkwhale exactly as you did before :)</p> </section> <section id="apache-support-for-websocket"> <h3>Apache support for websocket<a class="headerlink" href="#apache-support-for-websocket" title="Permalink to this heading"></a></h3> <p>Up until now, our Apache2 configuration was not working with websockets. This is now solved by adding this at the beginning of your Apache2 configuration file:</p> <div class="highlight-apache notranslate"><div class="highlight"><pre><span></span><span class="nb">Define</span><span class="w"> </span>funkwhale-api-ws<span class="w"> </span>ws://localhost:5000 </pre></div> </div> <p>And this, before the “/api” block:</p> <div class="highlight-apache notranslate"><div class="highlight"><pre><span></span><span class="c"># Activating WebSockets</span> <span class="nb">ProxyPass</span><span class="w"> </span><span class="s2">"/api/v1/instance/activity"</span><span class="w"> </span>${funkwhale-api-ws}/api/v1/instance/activity </pre></div> </div> <p>Websockets may not be supported in older versions of Apache2. Be sure to upgrade to the latest version available.</p> </section> <section id="serving-album-covers-in-https-apache2-proxy"> <h3>Serving album covers in https (Apache2 proxy)<a class="headerlink" href="#serving-album-covers-in-https-apache2-proxy" title="Permalink to this heading"></a></h3> <p>Two issues are addressed here. The first one was about Django replying with mixed content (http) when queried for covers. Setting up the <code class="docutils literal notranslate"><span class="pre">X-Forwarded-Proto</span></code> allows Django to know that the client is using https, and that the reply must be https as well.</p> <p>Second issue was a problem of permission causing Apache a denied access to album cover folder. It is solved by adding another block for this path in the Apache configuration file for funkwhale.</p> <p>Here is how to modify your <code class="docutils literal notranslate"><span class="pre">funkwhale.conf</span></code> apache2 configuration:</p> <div class="highlight-apache notranslate"><div class="highlight"><pre><span></span><span class="nt"><VirtualHost</span><span class="w"> </span><span class="s">*:443</span><span class="nt">></span> <span class="w"> </span><span class="c"># ...</span> <span class="w"> </span><span class="c">#Add this new line</span> <span class="w"> </span><span class="nb">RequestHeader</span><span class="w"> </span>set<span class="w"> </span>X-Forwarded-Proto<span class="w"> </span><span class="s2">"https"</span> <span class="w"> </span><span class="c"># ...</span> <span class="w"> </span><span class="c"># Add this new block below the other <Directory/> blocks</span> <span class="w"> </span><span class="c"># replace /srv/funkwhale/data/media with the path to your media directory</span> <span class="w"> </span><span class="c"># if you're not using the standard layout.</span> <span class="w"> </span><span class="nt"><Directory</span><span class="w"> </span><span class="s">/srv/funkwhale/data/media/albums</span><span class="nt">></span> <span class="w"> </span><span class="nb">Options</span><span class="w"> </span>FollowSymLinks <span class="w"> </span><span class="nb">AllowOverride</span><span class="w"> </span><span class="k">None</span> <span class="w"> </span><span class="nb">Require</span><span class="w"> </span><span class="k">all</span><span class="w"> </span>granted <span class="w"> </span><span class="nt"></Directory></span> <span class="w"> </span><span class="c"># ...</span> <span class="nt"></VirtualHost></span> </pre></div> </div> </section> <section id="about-the-makemigrations-warning"> <h3>About the makemigrations warning<a class="headerlink" href="#about-the-makemigrations-warning" title="Permalink to this heading"></a></h3> <p>You may sometimes get the following warning while applying migrations:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s2">"Your models have changes that are not yet reflected in a migration, and so won't be applied."</span> </pre></div> </div> <p>This is a warning, not an error, and it can be safely ignored. Never run the <code class="docutils literal notranslate"><span class="pre">makemigrations</span></code> command yourself.</p> </section> </section> <section id="id41"> <h2>0.14.1 (2018-06-06)<a class="headerlink" href="#id41" title="Permalink to this heading"></a></h2> <p>Upgrade instructions are available at https://docs.funkwhale.audio/upgrading.html</p> <p>Enhancements:</p> <ul class="simple"> <li><p>Display server version in the footer (#270)</p></li> <li><p>fix_track_files will now update files with bad mimetype (and not only the one with no mimetype) (#273)</p></li> <li><p>Huge performance boost (~x5 to x7) during CLI import that queries MusicBrainz (#288)</p></li> <li><p>Removed alpha-state transcoding support (#271)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Broken logging statement during import error (#274)</p></li> <li><p>Broken search bar on library home (#278)</p></li> <li><p>Do not crash when importing track with an artist that do not match the release artist (#237)</p></li> <li><p>Do not crash when tag contains multiple uuids with a / separator (#267)</p></li> <li><p>Ensure we do not store bad mimetypes (such as application/x-empty) (#266)</p></li> <li><p>Fix broken “play all” button that played only 25 tracks (#281)</p></li> <li><p>Fixed broken track download modal (overflow and wrong URL) (#239)</p></li> <li><p>Removed hardcoded size limit in file upload widget (#275)</p></li> </ul> <p>Documentation:</p> <ul class="simple"> <li><p>Added warning about _protected/music location in nginx configuration (#247)</p></li> </ul> <section id="removed-alpha-state-transcoding-271"> <h3>Removed alpha-state transcoding (#271)<a class="headerlink" href="#removed-alpha-state-transcoding-271" title="Permalink to this heading"></a></h3> <p>A few months ago, a basic transcoding feature was implemented. Due to the way this feature was designed, it was slow, CPU intensive on the server side, and very tightly coupled to the reverse-proxy configuration, preventing it to work Apache2, for instance. It was also not compatible with Subsonic clients.</p> <p>Based on that, we’re currently removing support for transcoding <strong>in its current state</strong>. The work on a better designed transcoding feature can be tracked in https://dev.funkwhale.audio/funkwhale/funkwhale/issues/272.</p> <p>You don’t have to do anything on your side, but you may want to remove the now obsolete configuration from your reverse proxy file (nginx only):</p> <div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="c1"># Remove those blocks:</span> <span class="c1"># transcode cache</span> <span class="k">proxy_cache_path</span><span class="w"> </span><span class="s">/tmp/funkwhale-transcode</span><span class="w"> </span><span class="s">levels=1:2</span><span class="w"> </span><span class="s">keys_zone=transcode:10m</span><span class="w"> </span><span class="s">max_size=1g</span><span class="w"> </span><span class="s">inactive=7d</span><span class="p">;</span> <span class="c1"># Transcoding logic and caching</span> <span class="k">location</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">/transcode-auth</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">include</span><span class="w"> </span><span class="s">/etc/nginx/funkwhale_proxy.conf</span><span class="p">;</span> <span class="w"> </span><span class="c1"># needed so we can authenticate transcode requests, but still</span> <span class="w"> </span><span class="c1"># cache the result</span> <span class="w"> </span><span class="kn">internal</span><span class="p">;</span> <span class="w"> </span><span class="kn">set</span><span class="w"> </span><span class="nv">$query</span><span class="w"> </span><span class="s">''</span><span class="p">;</span> <span class="w"> </span><span class="c1"># ensure we actually pass the jwt to the underlytin auth url</span> <span class="w"> </span><span class="kn">if</span><span class="w"> </span><span class="s">(</span><span class="nv">$request_uri</span><span class="w"> </span><span class="p">~</span><span class="sr">*</span><span class="w"> </span><span class="s">"[^\?]+\?(.*)</span><span class="nv">$"</span><span class="s">)</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">set</span><span class="w"> </span><span class="nv">$query</span><span class="w"> </span><span class="nv">$1</span><span class="p">;</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="kn">proxy_pass</span><span class="w"> </span><span class="s">http://funkwhale-api/api/v1/trackfiles/viewable/?</span><span class="nv">$query</span><span class="p">;</span> <span class="w"> </span><span class="kn">proxy_pass_request_body</span><span class="w"> </span><span class="no">off</span><span class="p">;</span> <span class="w"> </span><span class="kn">proxy_set_header</span><span class="w"> </span><span class="s">Content-Length</span><span class="w"> </span><span class="s">""</span><span class="p">;</span> <span class="p">}</span> <span class="k">location</span><span class="w"> </span><span class="s">/api/v1/trackfiles/transcode/</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">include</span><span class="w"> </span><span class="s">/etc/nginx/funkwhale_proxy.conf</span><span class="p">;</span> <span class="w"> </span><span class="c1"># this block deals with authenticating and caching transcoding</span> <span class="w"> </span><span class="c1"># requests. Caching is heavily recommended as transcoding</span> <span class="w"> </span><span class="c1"># is a CPU intensive process.</span> <span class="w"> </span><span class="kn">auth_request</span><span class="w"> </span><span class="s">/transcode-auth</span><span class="p">;</span> <span class="w"> </span><span class="kn">if</span><span class="w"> </span><span class="s">(</span><span class="nv">$args</span><span class="w"> </span><span class="p">~</span><span class="w"> </span><span class="sr">(.*)jwt=[^&]*(.*))</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">set</span><span class="w"> </span><span class="nv">$cleaned_args</span><span class="w"> </span><span class="nv">$1$2</span><span class="p">;</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="kn">proxy_cache_key</span><span class="w"> </span><span class="s">"</span><span class="nv">$scheme$request_method$host$uri$is_args$cleaned_args"</span><span class="p">;</span> <span class="w"> </span><span class="kn">proxy_cache</span><span class="w"> </span><span class="s">transcode</span><span class="p">;</span> <span class="w"> </span><span class="kn">proxy_cache_valid</span><span class="w"> </span><span class="mi">200</span><span class="w"> </span><span class="s">7d</span><span class="p">;</span> <span class="w"> </span><span class="kn">proxy_ignore_headers</span><span class="w"> </span><span class="s">"Set-Cookie"</span><span class="p">;</span> <span class="w"> </span><span class="kn">proxy_hide_header</span><span class="w"> </span><span class="s">"Set-Cookie"</span><span class="p">;</span> <span class="w"> </span><span class="kn">add_header</span><span class="w"> </span><span class="s">X-Cache-Status</span><span class="w"> </span><span class="nv">$upstream_cache_status</span><span class="p">;</span> <span class="w"> </span><span class="kn">proxy_pass</span><span class="w"> </span><span class="s">http://funkwhale-api</span><span class="p">;</span> <span class="p">}</span> <span class="c1"># end of transcoding logic</span> </pre></div> </div> </section> </section> <section id="id42"> <h2>0.14 (2018-06-02)<a class="headerlink" href="#id42" title="Permalink to this heading"></a></h2> <p>Upgrade instructions are available at https://docs.funkwhale.audio/upgrading.html</p> <p>Features:</p> <ul class="simple"> <li><p>Admins can now configure default permissions that will be granted to all registered users (#236)</p></li> <li><p>Files management interface for users with “library” permission (#223)</p></li> <li><p>New action table component for quick and efficient batch actions (#228) This is implemented on the federated tracks pages, but will be included in other pages as well depending on the feedback.</p></li> </ul> <p>Enhancements:</p> <ul class="simple"> <li><p>Added a new “upload” permission that allows user to launch import and view their own imports (#230)</p></li> <li><p>Added Support for OggTheora in import.</p></li> <li><p>Autoremove media files on model instance deletion (#241)</p></li> <li><p>Can now import a whole remote library at once thanks to new Action Table component (#164)</p></li> <li><p>Can now use album covers from flac/mp3 metadata and separate file in track directory (#219)</p></li> <li><p>Implemented getCovertArt in Subsonic API to serve album covers (#258)</p></li> <li><p>Implemented scrobble endpoint of subsonic API, listenings are now tracked correctly from third party apps that use this endpoint (#260)</p></li> <li><p>Retructured music API to increase performance and remove useless endpoints (#224)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Consistent constraints/checks for URL size (#207)</p></li> <li><p>Display proper total number of tracks on radio detail (#225)</p></li> <li><p>Do not crash on flac import if musicbrainz tags are missing (#214)</p></li> <li><p>Empty save button in radio builder (#226)</p></li> <li><p>Ensure anonymous users can use the app if the instance is configured accordingly (#229)</p></li> <li><p>Ensure inactive users cannot get auth tokens (#218) This was already the case bug we missed some checks</p></li> <li><p>File-upload import now supports Flac files (#213)</p></li> <li><p>File-upload importer should now work properly, assuming files are tagged (#106)</p></li> <li><p>Fixed a few broken translations strings (#227)</p></li> <li><p>Fixed broken ordering in front-end lists (#179)</p></li> <li><p>Fixed ignored page_size parameter on artist and favorites list (#240)</p></li> <li><p>Read ID3Tag Tracknumber from TRCK (#220)</p></li> <li><p>We now fetch album covers regardless of the import methods (#231)</p></li> </ul> <p>Documentation:</p> <ul class="simple"> <li><p>Added missing subsonic configuration block in deployment vhost files (#249)</p></li> <li><p>Moved upgrade doc under install doc in TOC (#251)</p></li> </ul> <p>Other:</p> <ul class="simple"> <li><p>Removed acoustid support, as the integration was buggy and error-prone (#106)</p></li> </ul> <section id="files-management-interface"> <h3>Files management interface<a class="headerlink" href="#files-management-interface" title="Permalink to this heading"></a></h3> <p>This is the first bit of an ongoing work that will span several releases, to bring more powerful library management features to Funkwhale. This iteration includes a basic file management interface where users with the “library” permission can list and search available files, order them using various criteria (size, bitrate, duration…) and delete them.</p> </section> <section id="new-upload-permission"> <h3>New “upload” permission<a class="headerlink" href="#new-upload-permission" title="Permalink to this heading"></a></h3> <p>This new permission is helpful if you want to give upload/import rights to some users, but don’t want them to be able to manage the library as a whole: although there are no controls yet for managing library in the fron-end, subsequent release will introduce management interfaces for artists, files, etc.</p> <p>Because of that, users with the “library” permission will have much more power, and will also be able to remove content from the platform. On the other hand, users with the “upload” permission will only have the ability to add new content.</p> <p>Also, this release also includes a new feature called “default permissions”: those are permissions that are granted to every users on the platform. On public/open instances, this will play well with the “upload” permission since everyone will be able to contribute to the instance library without an admin giving the permission to every single user.</p> </section> <section id="smarter-album-cover-importer"> <h3>Smarter album cover importer<a class="headerlink" href="#smarter-album-cover-importer" title="Permalink to this heading"></a></h3> <p>In earlier versions, covers where only imported when launching a YouTube import. Starting from this release, covers will be imported regardless of the import mode (file upload, youtube-dl, CLI, in-place…). Funkwhale will look for covers in the following order:</p> <ol class="arabic simple"> <li><p>In the imported file itself (FLAC/MP3 only)</p></li> <li><p>In a cover.jpg or cover.png in the file directory</p></li> <li><p>By fetching cover art from Musibrainz, assuming the file is tagged correctly</p></li> </ol> <p>This will only work for newly imported tracks and albums though. In the future, we may offer an option to refetch album covers from the interface, but in the meantime, you can use the following snippet:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Store this in /tmp/update_albums.py</span> <span class="kn">from</span> <span class="nn">funkwhale_api.music.models</span> <span class="kn">import</span> <span class="n">Album</span><span class="p">,</span> <span class="n">TrackFile</span> <span class="kn">from</span> <span class="nn">funkwhale_api.music.tasks</span> <span class="kn">import</span> <span class="n">update_album_cover</span> <span class="n">albums_without_covers</span> <span class="o">=</span> <span class="n">Album</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">cover</span><span class="o">=</span><span class="s1">''</span><span class="p">)</span> <span class="n">total</span> <span class="o">=</span> <span class="n">albums_without_covers</span><span class="o">.</span><span class="n">count</span><span class="p">()</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'Found </span><span class="si">{}</span><span class="s1"> albums without cover'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">total</span><span class="p">))</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">album</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">albums_without_covers</span><span class="o">.</span><span class="n">iterator</span><span class="p">()):</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'[</span><span class="si">{}</span><span class="s1">/</span><span class="si">{}</span><span class="s1">] Fetching cover for </span><span class="si">{}</span><span class="s1">...'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">i</span><span class="o">+</span><span class="mi">1</span><span class="p">,</span> <span class="n">total</span><span class="p">,</span> <span class="n">album</span><span class="o">.</span><span class="n">title</span><span class="p">))</span> <span class="n">f</span> <span class="o">=</span> <span class="n">TrackFile</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">track__album</span><span class="o">=</span><span class="n">album</span><span class="p">)</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">source__startswith</span><span class="o">=</span><span class="s1">'file://'</span><span class="p">)</span><span class="o">.</span><span class="n">first</span><span class="p">()</span> <span class="n">update_album_cover</span><span class="p">(</span><span class="n">album</span><span class="p">,</span> <span class="n">track_file</span><span class="o">=</span><span class="n">f</span><span class="p">)</span> </pre></div> </div> <p>Then launch it:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># docker setups</span> cat<span class="w"> </span>/tmp/update_albums.py<span class="w"> </span><span class="p">|</span><span class="w"> </span>docker-compose<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span>api<span class="w"> </span>python<span class="w"> </span>manage.py<span class="w"> </span>shell<span class="w"> </span>-i<span class="w"> </span>python <span class="c1"># non-docker setups</span> <span class="nb">source</span><span class="w"> </span>/srv/funkwhale/load_env <span class="nb">source</span><span class="w"> </span>/srv/funkwhale/virtualenv/bin/activate cat<span class="w"> </span>/tmp/update_albums.py<span class="w"> </span><span class="p">|</span><span class="w"> </span>python<span class="w"> </span>manage.py<span class="w"> </span>shell<span class="w"> </span>-i<span class="w"> </span>python <span class="c1"># cleanup</span> rm<span class="w"> </span>/tmp/update_albums.py </pre></div> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Depending on your number of albums, the previous snippet may take some time to execute. You can interrupt it at any time using ctrl-c and relaunch it later, as it’s idempotent.</p> </div> </section> <section id="music-api-changes"> <h3>Music API changes<a class="headerlink" href="#music-api-changes" title="Permalink to this heading"></a></h3> <p>This release includes an API break. Even though the API is advertised as unstable, and not documented, here is a brief explanation of the change in case you are using the API in a client or in a script. Summary of the changes:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">/api/v1/artists</span></code> does not includes a list of tracks anymore. It was to heavy to return all of this data all the time. You can get all tracks for an artist using <code class="docutils literal notranslate"><span class="pre">/api/v1/tracks?artist=artist_id</span></code></p></li> <li><p>Additionally, <code class="docutils literal notranslate"><span class="pre">/api/v1/tracks</span></code> now support an <code class="docutils literal notranslate"><span class="pre">album</span></code> filter to filter tracks matching an album</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">/api/v1/artists/search</span></code>, <code class="docutils literal notranslate"><span class="pre">/api/v1/albums/search</span></code> and <code class="docutils literal notranslate"><span class="pre">/api/v1/tracks/search</span></code> endpoints are removed. Use <code class="docutils literal notranslate"><span class="pre">/api/v1/{artists|albums|tracks}/?q=yourquery</span></code> instead. It’s also more powerful, since you can combine search with other filters and ordering options.</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">/api/v1/requests/import-requests/search</span></code> endpoint is removed as well. Use <code class="docutils literal notranslate"><span class="pre">/api/v1/requests/import-requests/?q=yourquery</span></code> instead. It’s also more powerful, since you can combine search with other filters and ordering options.</p></li> </ul> <p>Of course, the front-end was updated to work with the new API, so this should not impact end-users in any way, apart from slight performance gains.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>The API is still not stable and may evolve again in the future. API freeze will come at a later point.</p> </div> </section> <section id="flac-files-imports-via-upload"> <h3>Flac files imports via upload<a class="headerlink" href="#flac-files-imports-via-upload" title="Permalink to this heading"></a></h3> <p>You have nothing to do to benefit from this, however, since Flac files tend to be a lot bigger than other files, you may want to increase the <code class="docutils literal notranslate"><span class="pre">client_max_body_size</span></code> value in your Nginx configuration if you plan to upload flac files.</p> </section> <section id="missing-subsonic-configuration-block-in-vhost-files"> <h3>Missing subsonic configuration block in vhost files<a class="headerlink" href="#missing-subsonic-configuration-block-in-vhost-files" title="Permalink to this heading"></a></h3> <p>Because of a missing block in the sample Nginx and Apache configurations, instances that were deployed after the 0.13 release are likely to be unable to answer to Subsonic clients (the missing bits were properly documented in the changelog).</p> <p>Ensure you have the following snippets in your Nginx or Apache configuration if you plan to use the Subsonic API.</p> <p>Nginx:</p> <div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="k">location</span><span class="w"> </span><span class="s">/rest/</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">include</span><span class="w"> </span><span class="s">/etc/nginx/funkwhale_proxy.conf</span><span class="p">;</span> <span class="w"> </span><span class="kn">proxy_pass</span><span class="w"> </span><span class="s">http://funkwhale-api/api/subsonic/rest/</span><span class="p">;</span> <span class="p">}</span> </pre></div> </div> <p>Apache2:</p> <div class="highlight-apache notranslate"><div class="highlight"><pre><span></span><span class="nt"><Location</span><span class="w"> </span><span class="s">"/rest"</span><span class="nt">></span> <span class="w"> </span><span class="nb">ProxyPass</span><span class="w"> </span>${funkwhale-api}/api/subsonic/rest <span class="w"> </span><span class="nb">ProxyPassReverse</span><span class="w"> </span>${funkwhale-api}/api/subsonic/rest <span class="w"> </span><span class="nt"></Location></span> </pre></div> </div> </section> </section> <section id="id43"> <h2>0.13 (2018-05-19)<a class="headerlink" href="#id43" title="Permalink to this heading"></a></h2> <p>Upgrade instructions are available at https://docs.funkwhale.audio/upgrading.html</p> <p>Features:</p> <ul class="simple"> <li><p>Can now import and play flac files (#157)</p></li> <li><p>Simpler permission system (#152)</p></li> <li><p>Store file length, size and bitrate (#195)</p></li> <li><p>We now have a brand new instance settings interface in the front-end (#206)</p></li> </ul> <p>Enhancements:</p> <ul class="simple"> <li><p>Disabled browsable HTML API in production (#205)</p></li> <li><p>Instances can now indicate on the nodeinfo endpoint if they want to remain private (#200)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>.well-known/nodeinfo endpoint can now answer to request with Accept: application/json (#197)</p></li> <li><p>Fixed escaping issue of track name in playlist modal (#201)</p></li> <li><p>Fixed missing dot when downloading file (#204)</p></li> <li><p>In-place imported tracks with non-ascii characters don’t break reverse-proxy serving (#196)</p></li> <li><p>Removed Python 3.6 dependency (secrets module) (#198)</p></li> <li><p>Uplayable tracks are now properly disabled in the interface (#199)</p></li> </ul> <section id="instance-settings-interface"> <h3>Instance settings interface<a class="headerlink" href="#instance-settings-interface" title="Permalink to this heading"></a></h3> <p>Prior to this release, the only way to update instance settings (such as instance description, signup policy, federation configuration, etc.) was using the admin interface provided by Django (the back-end framework which power the API).</p> <p>This interface worked, but was not really-user friendly and intuitive.</p> <p>Starting from this release, we now offer a dedicated interface directly in the front-end. You can view and edit all your instance settings from here, assuming you have the required permissions.</p> <p>This interface is available at <code class="docutils literal notranslate"><span class="pre">/manage/settings</span></code> and via link in the sidebar.</p> </section> <section id="storage-of-bitrate-size-and-length-in-database"> <h3>Storage of bitrate, size and length in database<a class="headerlink" href="#storage-of-bitrate-size-and-length-in-database" title="Permalink to this heading"></a></h3> <p>Starting with this release, when importing files, Funkwhale will store additional information about audio files:</p> <ul class="simple"> <li><p>Bitrate</p></li> <li><p>Size (in bytes)</p></li> <li><p>Duration</p></li> </ul> <p>This change is not retroactive, meaning already imported files will lack those information. The interface and API should work as before in such case, however, we offer a command to deal with legacy files and populate the missing values.</p> <p>On docker setups:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>docker-compose<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span>api<span class="w"> </span>python<span class="w"> </span>manage.py<span class="w"> </span>fix_track_files </pre></div> </div> <p>On non-docker setups:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># from your activated virtualenv</span> python<span class="w"> </span>manage.py<span class="w"> </span>fix_track_files </pre></div> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>The execution time for this command is proportional to the number of audio files stored on your instance. This is because we need to read the files from disk to fetch the data. You can run it in the background while Funkwhale is up.</p> <p>It’s also safe to interrupt this command and rerun it at a later point, or run it multiple times.</p> <p>Use the –dry-run flag to check how many files would be impacted.</p> </div> </section> <section id="simpler-permission-system"> <h3>Simpler permission system<a class="headerlink" href="#simpler-permission-system" title="Permalink to this heading"></a></h3> <p>Starting from this release, the permission system is much simpler. Up until now, we were using Django’s built-in permission system, which was working, but also quite complex to deal with.</p> <p>The new implementation relies on simpler logic, which will make integration on the front-end in upcoming releases faster and easier.</p> <p>If you have manually given permissions to users on your instance, you can migrate those to the new system.</p> <p>On docker setups:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>docker-compose<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span>api<span class="w"> </span>python<span class="w"> </span>manage.py<span class="w"> </span>script<span class="w"> </span>django_permissions_to_user_permissions<span class="w"> </span>--no-input </pre></div> </div> <p>On non-docker setups:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># in your virtualenv</span> python<span class="w"> </span>api/manage.py<span class="w"> </span>script<span class="w"> </span>django_permissions_to_user_permissions<span class="w"> </span>--no-input </pre></div> </div> <p>There is still no dedicated interface to manage user permissions, but you can use the admin interface at <code class="docutils literal notranslate"><span class="pre">/api/admin/users/user/</span></code> for that purpose in the meantime.</p> </section> </section> <section id="id44"> <h2>0.12 (2018-05-09)<a class="headerlink" href="#id44" title="Permalink to this heading"></a></h2> <p>Upgrade instructions are available at https://docs.funkwhale.audio/upgrading.html</p> <p>Features:</p> <ul class="simple"> <li><p>Subsonic API implementation to offer compatibility with existing clients such as DSub (#75)</p></li> <li><p>Use nodeinfo standard for publishing instance information (#192)</p></li> </ul> <p>Enhancements:</p> <ul class="simple"> <li><p>Play button now play tracks immediately instead of appending them to the queue (#99, #156)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Fix broken federated import (#193)</p></li> </ul> <p>Documentation:</p> <ul class="simple"> <li><p>Up-to-date documentation for upgrading front-end files on docker setup (#132)</p></li> </ul> <section id="subsonic-api"> <h3>Subsonic API<a class="headerlink" href="#subsonic-api" title="Permalink to this heading"></a></h3> <p>This release implements some core parts of the Subsonic API, which is widely deployed in various projects and supported by numerous clients.</p> <p>By offering this API in Funkwhale, we make it possible to access the instance library and listen to the music without from existing Subsonic clients, and without developping our own alternative clients for each and every platform.</p> <p>Most advanced Subsonic clients support offline caching of music files, playlist management and search, which makes them well-suited for nomadic use.</p> <p>Please see <a class="reference external" href="https://funkwhale.audio/en_US/apps">our list of supported apps</a> for more information about supported clients and user instructions.</p> <p>At the instance-level, the Subsonic API is enabled by default, but require and additional endpoint to be added in you reverse-proxy configuration.</p> <p>On nginx, add the following block:</p> <div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="k">location</span><span class="w"> </span><span class="s">/rest/</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">include</span><span class="w"> </span><span class="s">/etc/nginx/funkwhale_proxy.conf</span><span class="p">;</span> <span class="w"> </span><span class="kn">proxy_pass</span><span class="w"> </span><span class="s">http://funkwhale-api/api/subsonic/rest/</span><span class="p">;</span> <span class="p">}</span> </pre></div> </div> <p>On Apache, add the following block:</p> <div class="highlight-apache notranslate"><div class="highlight"><pre><span></span><span class="nt"><Location</span><span class="w"> </span><span class="s">"/rest"</span><span class="nt">></span> <span class="w"> </span><span class="nb">ProxyPass</span><span class="w"> </span>${funkwhale-api}/api/subsonic/rest <span class="w"> </span><span class="nb">ProxyPassReverse</span><span class="w"> </span>${funkwhale-api}/api/subsonic/rest <span class="nt"></Location></span> </pre></div> </div> <p>The Subsonic can be disabled at the instance level from the django admin.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Because of Subsonic’s API design which assumes cleartext storing of user passwords, we chose to have a dedicated, separate password for that purpose. Users can generate this password from their settings page in the web client.</p> </div> </section> <section id="nodeinfo-standard-for-instance-information-and-stats"> <h3>Nodeinfo standard for instance information and stats<a class="headerlink" href="#nodeinfo-standard-for-instance-information-and-stats" title="Permalink to this heading"></a></h3> <div class="admonition warning"> <p class="admonition-title">Warning</p> <p>The <code class="docutils literal notranslate"><span class="pre">/api/v1/instance/stats/</span></code> endpoint which was used to display instance data in the about page is removed in favor of the new <code class="docutils literal notranslate"><span class="pre">/api/v1/instance/nodeinfo/2.0/</span></code> endpoint.</p> </div> <p>In earlier version, we where using a custom endpoint and format for our instance information and statistics. While this was working, this was not compatible with anything else on the fediverse.</p> <p>We now offer a nodeinfo 2.0 endpoint which provides, in a single place, all the instance information such as library and user activity statistics, public instance settings (description, registration and federation status, etc.).</p> <p>We offer two settings to manage nodeinfo in your Funkwhale instance:</p> <ol class="arabic simple"> <li><p>One setting to completely disable nodeinfo, but this is not recommended as the exposed data may be needed to make some parts of the front-end work (especially the about page).</p></li> <li><p>One setting to disable only usage and library statistics in the nodeinfo endpoint. This is useful if you want the nodeinfo endpoint to work, but don’t feel comfortable sharing aggregated statistics about your library and user activity.</p></li> </ol> <p>To make your instance fully compatible with the nodeinfo protocol, you need to to edit your nginx configuration file:</p> <div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="c1"># before</span> <span class="c1"># ...</span> <span class="k">location</span><span class="w"> </span><span class="s">/.well-known/webfinger</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">include</span><span class="w"> </span><span class="s">/etc/nginx/funkwhale_proxy.conf</span><span class="p">;</span> <span class="w"> </span><span class="kn">proxy_pass</span><span class="w"> </span><span class="s">http://funkwhale-api/.well-known/webfinger</span><span class="p">;</span> <span class="p">}</span> <span class="c1"># ...</span> <span class="c1"># after</span> <span class="c1"># ...</span> <span class="k">location</span><span class="w"> </span><span class="s">/.well-known/</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">include</span><span class="w"> </span><span class="s">/etc/nginx/funkwhale_proxy.conf</span><span class="p">;</span> <span class="w"> </span><span class="kn">proxy_pass</span><span class="w"> </span><span class="s">http://funkwhale-api/.well-known/</span><span class="p">;</span> <span class="p">}</span> <span class="c1"># ...</span> </pre></div> </div> <p>You can do the same if you use apache:</p> <div class="highlight-apache notranslate"><div class="highlight"><pre><span></span><span class="c"># before</span> <span class="c"># ...</span> <span class="nt"><Location</span><span class="w"> </span><span class="s">"/.well-known/webfinger"</span><span class="nt">></span> <span class="w"> </span><span class="nb">ProxyPass</span><span class="w"> </span>${funkwhale-api}/.well-known/webfinger <span class="w"> </span><span class="nb">ProxyPassReverse</span><span class="w"> </span>${funkwhale-api}/.well-known/webfinger <span class="nt"></Location></span> <span class="c"># ...</span> <span class="c"># after</span> <span class="c"># ...</span> <span class="nt"><Location</span><span class="w"> </span><span class="s">"/.well-known/"</span><span class="nt">></span> <span class="w"> </span><span class="nb">ProxyPass</span><span class="w"> </span>${funkwhale-api}/.well-known/ <span class="w"> </span><span class="nb">ProxyPassReverse</span><span class="w"> </span>${funkwhale-api}/.well-known/ <span class="nt"></Location></span> <span class="c"># ...</span> </pre></div> </div> <p>This will ensure all well-known endpoints are proxied to funkwhale, and not just webfinger one.</p> <p>Links:</p> <ul class="simple"> <li><p>About nodeinfo: https://github.com/jhass/nodeinfo</p></li> </ul> </section> </section> <section id="id45"> <h2>0.11 (2018-05-06)<a class="headerlink" href="#id45" title="Permalink to this heading"></a></h2> <p>Upgrade instructions are available at https://docs.funkwhale.audio/upgrading.html</p> <p>Special thanks for this release go to @renon:matrix.org (@Hazmo on Gitlab) for bringing Apache2 support to Funkwhale and contributing on other issues. Thank you!</p> <p>Features:</p> <ul class="simple"> <li><p>Funkwhale now works behind an Apache2 reverse proxy (!165) check out the brand new documentation at https://docs.funkwhale.audio/installation/index.html#apache2 if you want to try it!</p></li> <li><p>Users can now request password reset by email, assuming a SMTP server was correctly configured (#187)</p></li> </ul> <p>Enhancements:</p> <ul class="simple"> <li><p>Added a fix_track_files command to run checks and fixes against library (#183)</p></li> <li><p>Avoid fetching Actor object on every request authentication</p></li> <li><p>Can now relaunch errored jobs and batches (#176)</p></li> <li><p>List pending requests by default, added a status filter for requests (#109)</p></li> <li><p>More structured menus in sidebar, added labels with notifications</p></li> <li><p>Sample virtual-host file for Apache2 reverse-proxy (!165)</p></li> <li><p>Store high-level settings (such as federation or auth-related ones) in database (#186)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Ensure in place imported files get a proper mimetype (#183)</p></li> <li><p>Federation cache suppression is now simpler and also deletes orphaned files (#189)</p></li> <li><p>Fixed small UI glitches/bugs in federation tabs (#184)</p></li> <li><p>X-sendfile not working with in place import (#182)</p></li> </ul> <p>Documentation:</p> <ul class="simple"> <li><p>Added a documentation area for third-party projects (#180)</p></li> <li><p>Added documentation for optimizing Funkwhale and reduce its memory footprint.</p></li> <li><p>Document that the database should use an utf-8 encoding (#185)</p></li> <li><p>Foundations for API documentation with Swagger (#178)</p></li> </ul> <section id="database-storage-for-high-level-settings"> <h3>Database storage for high-level settings<a class="headerlink" href="#database-storage-for-high-level-settings" title="Permalink to this heading"></a></h3> <p>Due to the work done in #186, the following environment variables have been deprecated:</p> <ul class="simple"> <li><p>FEDERATION_ENABLED</p></li> <li><p>FEDERATION_COLLECTION_PAGE_SIZE</p></li> <li><p>FEDERATION_MUSIC_NEEDS_APPROVAL</p></li> <li><p>FEDERATION_ACTOR_FETCH_DELAY</p></li> <li><p>PLAYLISTS_MAX_TRACKS</p></li> <li><p>API_AUTHENTICATION_REQUIRED</p></li> </ul> <p>Configuration for this settings has been moved to database, as it will provide a better user-experience, by allowing you to edit these values on-the-fly, without restarting Funkwhale processes.</p> <p>You can leave those environment variables in your .env file for now, as the values will be used to populate the database entries. We’ll make a proper announcement when the variables won’t be used anymore.</p> <p>Please browse https://docs.funkwhale.audio/configuration.html#instance-settings for more information about instance configuration using the web interface.</p> </section> <section id="system-emails"> <h3>System emails<a class="headerlink" href="#system-emails" title="Permalink to this heading"></a></h3> <p>Starting from this release, Funkwhale will send two types of emails:</p> <ul class="simple"> <li><p>Email confirmation emails, to ensure a user’s email is valid</p></li> <li><p>Password reset emails, enabling user to reset their password without an admin’s intervention</p></li> </ul> <p>Email sending is disabled by default, as it requires additional configuration. In this mode, emails are simply outputted on stdout.</p> <p>If you want to actually send those emails to your users, you should edit your .env file and tweak the <code class="docutils literal notranslate"><span class="pre">EMAIL_CONFIG</span></code> variable. See :data:<code class="docutils literal notranslate"><span class="pre">EMAIL_CONFIG</span> <span class="pre"><config.settings.common.EMAIL_CONFIG></span></code> for more details.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>As a result of these changes, the <code class="docutils literal notranslate"><span class="pre">DJANGO_EMAIL_BACKEND</span></code> variable, which was not documented, has no effect anymore. You can safely remove it from your .env file if it is set.</p> </div> </section> <section id="proxy-headers-for-non-docker-deployments"> <h3>Proxy headers for non-docker deployments<a class="headerlink" href="#proxy-headers-for-non-docker-deployments" title="Permalink to this heading"></a></h3> <p>For non-docker deployments, add <code class="docutils literal notranslate"><span class="pre">--proxy-headers</span></code> at the end of the <code class="docutils literal notranslate"><span class="pre">daphne</span></code> command in :file:<code class="docutils literal notranslate"><span class="pre">/etc/systemd/system/funkwhale-server.service</span></code>.</p> <p>This will ensure the application receive the correct IP address from the client and not the proxy’s one.</p> </section> </section> <section id="id46"> <h2>0.10 (2018-04-23)<a class="headerlink" href="#id46" title="Permalink to this heading"></a></h2> <p>Features:</p> <ul class="simple"> <li><p>Can now import files in-place from the CLI importer (#155)</p></li> </ul> <p>Enhancements:</p> <ul class="simple"> <li><p>Avoid downloading audio files multiple times from remote libraries (#163)</p></li> <li><p>Better file import performance and error handling (#144)</p></li> <li><p>Import job and batch API and front-end have been improved with better performance, pagination and additional filters (#171)</p></li> <li><p>Increased max_length on TrackFile.source, this will help when importing files with a really long path (#142)</p></li> <li><p>Player is back in Queue tab (#150)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Fail graciously when AP representation includes a null_value for mediaType</p></li> <li><p>Fix sidebar tabs not showing under small resolution under Chrome (#173)</p></li> <li><p>Fixed broken login due to badly configured Axios (#172)</p></li> <li><p>Fixed broken playlist modal after login (#155)</p></li> <li><p>Fixed queue reorder or track deletion restarting currently playing track (#151)</p></li> <li><p>Radio will now append new track if you delete the last track in queue (#145)</p></li> <li><p>Reset all sensitive front-end data on logout (#124)</p></li> <li><p>Typos/not showing text due to i18n work (#175)</p></li> </ul> <p>Documentation:</p> <ul class="simple"> <li><p>Better documentation for hardware requirements and memory usage (#165)</p></li> </ul> <section id="in-place-import"> <h3>In-place import<a class="headerlink" href="#in-place-import" title="Permalink to this heading"></a></h3> <p>This release includes in-place imports for the CLI import. This means you can load gigabytes of music into funkwhale without worrying about about Funkwhale copying those music files in its internal storage and eating your disk space.</p> <p><a class="reference external" href="https://docs.funkwhale.audio/importing-music.html#in-place-import">This new feature is documented here</a> and require additional configuration to ensure funkwhale and your webserver can serve those files properly.</p> <p><strong>Non-docker users:</strong></p> <p>Assuming your music is stored in <code class="docutils literal notranslate"><span class="pre">/srv/funkwhale/data/music</span></code>, add the following block to your nginx configuration:</p> <div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="k">location</span><span class="w"> </span><span class="s">/_protected/music</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">internal</span><span class="p">;</span> <span class="w"> </span><span class="kn">alias</span><span class="w"> </span><span class="s">/srv/funkwhale/data/music</span><span class="p">;</span> <span class="p">}</span> </pre></div> </div> <p>And the following to your .env file:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">MUSIC_DIRECTORY_PATH</span><span class="o">=</span>/srv/funkwhale/data/music </pre></div> </div> <p><strong>Docker users:</strong></p> <p>Assuming your music is stored in <code class="docutils literal notranslate"><span class="pre">/srv/funkwhale/data/music</span></code>, add the following block to your nginx configuration:</p> <div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="k">location</span><span class="w"> </span><span class="s">/_protected/music</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">internal</span><span class="p">;</span> <span class="w"> </span><span class="kn">alias</span><span class="w"> </span><span class="s">/srv/funkwhale/data/music</span><span class="p">;</span> <span class="p">}</span> </pre></div> </div> <p>Assuming you have the following volume directive in your <code class="docutils literal notranslate"><span class="pre">docker-compose.yml</span></code> (it’s the default): <code class="docutils literal notranslate"><span class="pre">/srv/funkwhale/data/music:/music:ro</span></code>, then add the following to your .env file:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># this is the path in the container</span> <span class="nv">MUSIC_DIRECTORY_PATH</span><span class="o">=</span>/music <span class="c1"># this is the path on the host</span> <span class="nv">MUSIC_DIRECTORY_SERVE_PATH</span><span class="o">=</span>/srv/funkwhale/data/music </pre></div> </div> </section> </section> <section id="id47"> <h2>0.9.1 (2018-04-17)<a class="headerlink" href="#id47" title="Permalink to this heading"></a></h2> <p>Bugfixes:</p> <ul class="simple"> <li><p>Allow null values for musicbrainz_id in Audio ActivityPub representation</p></li> <li><p>Fixed broken permission check on library scanning and too aggressive page validation</p></li> </ul> </section> <section id="id48"> <h2>0.9 (2018-04-17)<a class="headerlink" href="#id48" title="Permalink to this heading"></a></h2> <p>Features:</p> <ul class="simple"> <li><p>Add internationalization support (#5)</p></li> <li><p>Can now follow and import music from remote libraries (#136, #137)</p></li> </ul> <p>Enhancements:</p> <ul class="simple"> <li><p>Added a i18n-extract yarn script to extract strings to PO files (#162)</p></li> <li><p>User admin now includes signup and last login dates (#148)</p></li> <li><p>We now use a proper user agent including instance version and url during outgoing requests</p></li> </ul> <section id="federation-is-here"> <h3>Federation is here!<a class="headerlink" href="#federation-is-here" title="Permalink to this heading"></a></h3> <p>This is for real this time, and includes:</p> <ul class="simple"> <li><p>Following other Funkwhale libraries</p></li> <li><p>Importing tracks from remote libraries (tracks are hotlinked, and only cached for a short amount of time)</p></li> <li><p>Searching across federated catalogs</p></li> </ul> <p>Note that by default, federation is opt-in, on a per-instance basis: instances will request access to your catalog, and you can accept or refuse those requests. You can also revoke the access at any time.</p> <p>Documentation was updated with relevant instructions to use and benefit from this new feature: https://docs.funkwhale.audio/federation.html</p> </section> <section id="preparing-internationalization"> <h3>Preparing internationalization<a class="headerlink" href="#preparing-internationalization" title="Permalink to this heading"></a></h3> <p>Funkwhale’s front-end as always been english-only, and this is a barrier to new users. The work make Funkwhale’s interface translatable was started in this release by Baptiste. Although nothing is translated yet, this release includes behind the stage changes that will make it possible in the near future.</p> <p>Many thank to Baptiste for the hard work and for figuring out a proper solution to this difficult problem.</p> </section> <section id="upgrade-path"> <h3>Upgrade path<a class="headerlink" href="#upgrade-path" title="Permalink to this heading"></a></h3> <p>In addition to the usual instructions from https://docs.funkwhale.audio/upgrading.html, non-docker users will have to setup an additional systemd unit file for recurrent tasks.</p> <p>This was forgotten in the deployment documentation, but recurrent tasks, managed by the celery beat process, will be needed more and more in subsequent releases. Right now, we’ll be using to clear the cache for federated music files and keep disk usage to a minimum.</p> <p>In the future, they will also be needed to refetch music metadata or federated information periodically.</p> <p>Celery beat can be enabled easily:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>curl<span class="w"> </span>-L<span class="w"> </span>-o<span class="w"> </span><span class="s2">"/etc/systemd/system/funkwhale-beat.service"</span><span class="w"> </span><span class="s2">"https://dev.funkwhale.audio/funkwhale/funkwhale/raw/develop/deploy/funkwhale-beat.service"</span> <span class="c1"># Also edit /etc/systemd/system/funkwhale.target</span> <span class="c1"># and ensure the Wants= line contains the following:</span> <span class="c1"># Wants=funkwhale-server.service funkwhale-worker.service funkwhale-beat.service</span> nano<span class="w"> </span>/etc/systemd/system/funkwhale.target <span class="c1"># reload configuration</span> systemctl<span class="w"> </span>daemon-reload </pre></div> </div> <p>Docker users already have celerybeat enabled.</p> </section> </section> <section id="id49"> <h2>0.8 (2018-04-02)<a class="headerlink" href="#id49" title="Permalink to this heading"></a></h2> <p>Features:</p> <ul class="simple"> <li><p>Add a detail page for radios (#64)</p></li> <li><p>Implemented page title binding (#1)</p></li> <li><p>Previous Track button restart playback after 3 seconds (#146)</p></li> </ul> <p>Enhancements:</p> <ul class="simple"> <li><p>Added credits to Francis Gading for the logotype (#101)</p></li> <li><p>API endpoint for fetching instance activity and updated timeline to use this new endpoint (#141)</p></li> <li><p>Better error messages in case of missing environment variables (#140)</p></li> <li><p>Implemented a @test@yourfunkwhaledomain bot to ensure federation works properly. Send it “/ping” and it will answer back :)</p></li> <li><p>Queue shuffle now apply only to tracks after the current one (#97)</p></li> <li><p>Removed player from queue tab and consistently show current track in queue (#131)</p></li> <li><p>We now restrict some usernames from being used during signup (#139)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Better error handling during file import (#120)</p></li> <li><p>Better handling of utf-8 filenames during file import (#138)</p></li> <li><p>Converted favicon from .ico to .png (#130)</p></li> <li><p>Upgraded to Python 3.6 to fix weird but harmless weakref error on django task (#121)</p></li> </ul> <p>Documentation:</p> <ul class="simple"> <li><p>Documented the upgrade process (#127)</p></li> </ul> <section id="preparing-for-federation"> <h3>Preparing for federation<a class="headerlink" href="#preparing-for-federation" title="Permalink to this heading"></a></h3> <p>Federation of music libraries is one of the most asked feature. While there is still a lot of work to do, this version includes the foundation that will enable funkwhale servers to communicate between each others, and with other federated software, such as Mastodon.</p> <p>Funkwhale will use ActivityPub as it’s federation protocol.</p> <p>In order to prepare for federation (see #136 and #137), new API endpoints have been added under /federation and /.well-known/webfinger.</p> <p>For these endpoints to work, you will need to update your nginx configuration, and add the following snippets:</p> <div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="k">location</span><span class="w"> </span><span class="s">/federation/</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">include</span><span class="w"> </span><span class="s">/etc/nginx/funkwhale_proxy.conf</span><span class="p">;</span> <span class="w"> </span><span class="kn">proxy_pass</span><span class="w"> </span><span class="s">http://funkwhale-api/federation/</span><span class="p">;</span> <span class="p">}</span> <span class="k">location</span><span class="w"> </span><span class="s">/.well-known/webfinger</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">include</span><span class="w"> </span><span class="s">/etc/nginx/funkwhale_proxy.conf</span><span class="p">;</span> <span class="w"> </span><span class="kn">proxy_pass</span><span class="w"> </span><span class="s">http://funkwhale-api/.well-known/webfinger</span><span class="p">;</span> <span class="p">}</span> </pre></div> </div> <p>This will ensure federation endpoints will be reachable in the future. You can of course skip this part if you know you will not federate your instance.</p> <p>A new <code class="docutils literal notranslate"><span class="pre">FEDERATION_ENABLED</span></code> env var have also been added to control whether federation is enabled or not on the application side. This settings defaults to True, which should have no consequences at the moment, since actual federation is not implemented and the only available endpoints are for testing purposes.</p> <p>Add <code class="docutils literal notranslate"><span class="pre">FEDERATION_ENABLED=false</span></code> to your .env file to disable federation on the application side.</p> <p>To test and troubleshoot federation, we’ve added a bot account. This bot is available at @test@yourinstancedomain, and sending it “/ping”, for example, via Mastodon, should trigger a response.</p> </section> </section> <section id="id50"> <h2>0.7 (2018-03-21)<a class="headerlink" href="#id50" title="Permalink to this heading"></a></h2> <p>Features:</p> <ul class="simple"> <li><p>Can now filter artists and albums with no listenable tracks (#114)</p></li> <li><p>Improve the style of the sidebar to make it easier to understand which tab is selected (#118)</p></li> <li><p>On artist page, albums are not sorted by release date, if any (#116)</p></li> <li><p>Playlists are here \o/ :tada: (#3, #93, #94)</p></li> <li><p>Use django-cacheops to cache common ORM requests (#117)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Fixed broken import request admin (#115)</p></li> <li><p>Fixed forced redirection to login event with API_AUTHENTICATION_REQUIRED=False (#119)</p></li> <li><p>Fixed position not being reset properly when playing the same track multiple times in a row</p></li> <li><p>Fixed synchronized start/stop radio buttons for all custom radios (#103)</p></li> <li><p>Fixed typo and missing icon on homepage (#96)</p></li> </ul> <p>Documentation:</p> <ul class="simple"> <li><p>Up-to-date and complete development and contribution instructions in README.rst (#123)</p></li> </ul> </section> <section id="id51"> <h2>0.6.1 (2018-03-06)<a class="headerlink" href="#id51" title="Permalink to this heading"></a></h2> <p>Features:</p> <ul class="simple"> <li><p>Can now skip acoustid on file import with the –no-acoustid flag (#111)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Added missing batch id in output during import (#112)</p></li> <li><p>Added some feedback on the play button (#100)</p></li> <li><p>Smarter pagination which takes a fixed size (#84)</p></li> </ul> <p>Other:</p> <ul class="simple"> <li><p>Completely removed django-cachalot from the codebase (#110). You can safely remove the CACHALOT_ENABLED setting from your .env file</p></li> </ul> </section> <section id="id52"> <h2>0.6 (2018-03-04)<a class="headerlink" href="#id52" title="Permalink to this heading"></a></h2> <p>Features:</p> <ul class="simple"> <li><p>Basic activity stream for listening and favorites (#23)</p></li> <li><p>Switched to django-channels and daphne for serving HTTP and websocket (#34)</p></li> </ul> <section id="upgrades-notes"> <h3>Upgrades notes<a class="headerlink" href="#upgrades-notes" title="Permalink to this heading"></a></h3> <p>This version contains breaking changes in the way funkwhale is deployed, please read the notes carefully.</p> </section> <section id="instance-timeline"> <h3>Instance timeline<a class="headerlink" href="#instance-timeline" title="Permalink to this heading"></a></h3> <p>A new “Activity” page is now available from the sidebar, where you can browse your instance activity. At the moment, this includes other users favorites and listening, but more activity types will be implemented in the future.</p> <p>Internally, we implemented those events by following the Activity Stream specification, which will help us to be compatible with other networks in the long-term.</p> <p>A new settings page has been added to control the visibility of your activity. By default, your activity will be browsable by anyone on your instance, but you can switch to a full private mode where nothing is shared.</p> <p>The setting form is available in your profile.</p> </section> <section id="switch-from-gunicorn-to-daphne"> <h3>Switch from gunicorn to daphne<a class="headerlink" href="#switch-from-gunicorn-to-daphne" title="Permalink to this heading"></a></h3> <p>This release include an important change in the way we serve the HTTP API. To prepare for new realtime features and enable websocket support in Funkwhale, we are now using django-channels and daphne to serve HTTP and websocket traffic.</p> <p>This replaces gunicorn and the switch should be easy assuming you follow the upgrade process described below.</p> <p>If you are using docker, please remove the command instruction inside the api service, as the up-to-date command is now included directly in the image as the default entry point:</p> <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">services</span><span class="p">:</span> <span class="w"> </span><span class="nt">api</span><span class="p">:</span> <span class="w"> </span><span class="nt">restart</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">unless-stopped</span> <span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">funkwhale/funkwhale:${FUNKWHALE_VERSION:-latest}</span> <span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./compose/django/gunicorn.sh</span><span class="w"> </span><span class="c1"># You can remove this line</span> </pre></div> </div> <p>On non docker setups, you’ll have to update the <code class="docutils literal notranslate"><span class="pre">[Service]</span></code> block of your funkwhale-server systemd unit file to launch the application server using daphne instead of gunicorn.</p> <p>The new configuration should be similar to this:</p> <div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[Service]</span> <span class="na">User</span><span class="o">=</span><span class="s">funkwhale</span> <span class="c1"># adapt this depending on the path of your funkwhale installation</span> <span class="na">WorkingDirectory</span><span class="o">=</span><span class="s">/srv/funkwhale/api</span> <span class="na">EnvironmentFile</span><span class="o">=</span><span class="s">/srv/funkwhale/config/.env</span> <span class="na">ExecStart</span><span class="o">=</span><span class="s">/usr/local/bin/daphne -b ${FUNKWHALE_API_IP} -p ${FUNKWHALE_API_PORT} config.asgi:application</span> </pre></div> </div> <p>Ensure you update funkwhale’s dependencies as usual to install the required packages.</p> <p>On both docker and non-docker setup, you’ll also have to update your nginx configuration for websocket support. Ensure you have the following blocks included in your virtualhost file:</p> <div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="k">map</span><span class="w"> </span><span class="nv">$http_upgrade</span><span class="w"> </span><span class="nv">$connection_upgrade</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kn">default</span><span class="w"> </span><span class="s">upgrade</span><span class="p">;</span> <span class="w"> </span><span class="kn">''</span><span class="w"> </span><span class="s">close</span><span class="p">;</span> <span class="p">}</span> <span class="k">server</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="c1"># ...</span> <span class="w"> </span><span class="kn">proxy_http_version</span><span class="w"> </span><span class="mi">1</span><span class="s">.1</span><span class="p">;</span> <span class="w"> </span><span class="kn">proxy_set_header</span><span class="w"> </span><span class="s">Upgrade</span><span class="w"> </span><span class="nv">$http_upgrade</span><span class="p">;</span> <span class="w"> </span><span class="kn">proxy_set_header</span><span class="w"> </span><span class="s">Connection</span><span class="w"> </span><span class="nv">$connection_upgrade</span><span class="p">;</span> <span class="p">}</span> </pre></div> </div> <p>Remember to reload your nginx server after the edit.</p> </section> </section> <section id="id53"> <h2>0.5.4 (2018-02-28)<a class="headerlink" href="#id53" title="Permalink to this heading"></a></h2> <p>Features:</p> <ul class="simple"> <li><p>Now stop running radio when clearing queue (#98)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Fixed queue skipping tracks (#91)</p></li> <li><p>Now loop properly on queue when we only have one track (#95)</p></li> </ul> </section> <section id="id54"> <h2>0.5.3 (2018-02-27)<a class="headerlink" href="#id54" title="Permalink to this heading"></a></h2> <p>Features:</p> <ul class="simple"> <li><p>Added admin interface for radios, track files, favorites and import requests (#80)</p></li> <li><p>Added basic instance stats on /about (#82)</p></li> <li><p>Search now unaccent letters for queries like “The Dø” or “Björk” yielding more results (#81)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Always use username in sidebar (#89)</p></li> <li><p>Click event outside of player icons (#83)</p></li> <li><p>Fixed broken import because of missing transaction</p></li> <li><p>Now always load next radio track on last queue track ended (#87)</p></li> <li><p>Now exclude tracks without file from radio candidates (#88)</p></li> <li><p>skip to next track properly on 40X errors (#86)</p></li> </ul> <p>Other:</p> <ul class="simple"> <li><p>Switched to towncrier for changelog management and compilation</p></li> </ul> </section> <section id="id55"> <h2>0.5.2 (2018-02-26)<a class="headerlink" href="#id55" title="Permalink to this heading"></a></h2> <ul class="simple"> <li><p>Fixed broken file import due to wrong url (#73)</p></li> <li><p>More accurate mimetype detection</p></li> <li><p>Fixed really small size on small screens</p></li> <li><p>Added masonry layout for artists, requests and radios (#68)</p></li> <li><p>We now have a favicon!</p></li> <li><p>Fixed truncated play icon (#65)</p></li> </ul> </section> <section id="id56"> <h2>0.5.1 (2018-02-24)<a class="headerlink" href="#id56" title="Permalink to this heading"></a></h2> <ul class="simple"> <li><p>Front: Fixed broken ajax call on radio builder (#69)</p></li> <li><p>Front: Shuffle now restart next track from beginning (#70)</p></li> <li><p>Front: volume slider should now have the same style everywhere (#72)</p></li> </ul> </section> <section id="id57"> <h2>0.5 (2018-02-24)<a class="headerlink" href="#id57" title="Permalink to this heading"></a></h2> <ul class="simple"> <li><p>Front: Now reset player colors when track has no cover (#46)</p></li> <li><p>Front: play button now disabled for unplayable tracks</p></li> <li><p>API: You can now enable or disable registration on the fly, via a preference (#58)</p></li> <li><p>Front: can now signup via the web interface (#35)</p></li> <li><p>Front: Fixed broken redirection on login</p></li> <li><p>Front: Fixed broken error handling on settings and login form</p></li> </ul> <p>About page:</p> <p>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/).</p> <p>Transcoding:</p> <p>Basic transcoding is now available to/from the following formats : ogg and mp3.</p> <p><em>This is still an alpha feature at the moment, please report any bug.</em></p> <p>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 example nginx file at deploy/nginx.conf for an implementation.</p> <p>On the frontend, usage of transcoding should be transparent in the player.</p> <p>Music Requests:</p> <p>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.</p> </section> <section id="id58"> <h2>0.4 (2018-02-18)<a class="headerlink" href="#id58" title="Permalink to this heading"></a></h2> <ul class="simple"> <li><p>Front: ambiant colors in player based on current track cover (#59)</p></li> <li><p>Front: simplified front dev setup thanks to webpack proxy (#59)</p></li> <li><p>Front: added some unittests for the store (#55)</p></li> <li><p>Front: fixed broken login redirection when 401</p></li> <li><p>Front: Removed autoplay on page reload</p></li> <li><p>API: Added a /instance/settings endpoint</p></li> <li><p>Front: load /instance/settings on page load</p></li> <li><p>Added settings to report JS and Python error to a Sentry instance This is disabled by default, but feel free to enable it if you want to help us by sending your error reports :) (#8)</p></li> </ul> </section> <section id="id59"> <h2>0.3.5 (2018-01-07)<a class="headerlink" href="#id59" title="Permalink to this heading"></a></h2> <ul class="simple"> <li><p>Smarter BACKEND_URL in frontend</p></li> </ul> </section> <section id="id60"> <h2>0.3.4 (2018-01-07)<a class="headerlink" href="#id60" title="Permalink to this heading"></a></h2> <ul class="simple"> <li><p>Fixed wrong URL construction in ajax call</p></li> </ul> </section> <section id="id61"> <h2>0.3.3 (2018-01-07)<a class="headerlink" href="#id61" title="Permalink to this heading"></a></h2> <ul class="simple"> <li><p>Users can now create their own dynamic radios (#51)</p></li> </ul> </section> <section id="id62"> <h2>0.3.2<a class="headerlink" href="#id62" title="Permalink to this heading"></a></h2> <ul class="simple"> <li><p>Fixed an issue in the main dockerfile</p></li> </ul> </section> <section id="id63"> <h2>0.3.1<a class="headerlink" href="#id63" title="Permalink to this heading"></a></h2> <ul class="simple"> <li><p>Revamped all import logic, everything is more tested and consistent</p></li> <li><p>Can now use Acoustid in file imports to automatically grab metadata from musicbrainz</p></li> <li><p>Brand new file import wizard</p></li> </ul> </section> <section id="id64"> <h2>0.2.7<a class="headerlink" href="#id64" title="Permalink to this heading"></a></h2> <ul class="simple"> <li><p>Shortcuts: can now use the <code class="docutils literal notranslate"><span class="pre">f</span></code> shortcut to toggle the currently playing track as a favorite (#53)</p></li> <li><p>Shortcuts: avoid collisions between shortcuts by using the exact modifier (#53)</p></li> <li><p>Player: Added looping controls and shortcuts (#52)</p></li> <li><p>Player: Added shuffling controls and shortcuts (#52)</p></li> <li><p>Favorites: can now modify the ordering of track list (#50)</p></li> <li><p>Library: can now search/reorder results on artist browsing view (#50)</p></li> <li><p>Upgraded celery to 4.1, added endpoint logic for fingerprinting audio files</p></li> <li><p>Fixed #56: invalidate tokens on password change, also added change password form</p></li> <li><p>Fixed #57: now refresh jwt token on page refresh</p></li> <li><p>removed ugly dividers in batch import list</p></li> <li><p>Fixed a few padding issues</p></li> <li><p>Now persist/restore queue/radio/player state automatically</p></li> <li><p>Removed old broken imports</p></li> <li><p>Now force tests paths</p></li> <li><p>Fixed #54: Now use pytest everywhere \o/</p></li> <li><p>Now use vuex to manage state for favorites</p></li> <li><p>Now use vuex to manage state for authentication</p></li> <li><p>Now use vuex to manage state for player/queue/radios</p></li> </ul> </section> <section id="id65"> <h2>0.2.6 (2017-12-15)<a class="headerlink" href="#id65" title="Permalink to this heading"></a></h2> <ul class="simple"> <li><p>Fixed broken Dockerfile</p></li> </ul> </section> <section id="id66"> <h2>0.2.5 (2017-12-15)<a class="headerlink" href="#id66" title="Permalink to this heading"></a></h2> <p>Features:</p> <ul class="simple"> <li><p>Import: can now specify search template when querying import sources (#45)</p></li> <li><p>Login form: now redirect to previous page after login (#2)</p></li> <li><p>404: a decent 404 template, at least (#48)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Player: better handling of errors when fetching the audio file (#46)</p></li> <li><p>Csrf: default CSRF_TRUSTED_ORIGINS to ALLOWED_HOSTS to avoid Csrf issues on admin (#49)</p></li> </ul> <p>Tech:</p> <ul class="simple"> <li><p>Django 2 compatibility, lot of packages upgrades (#47)</p></li> </ul> </section> <section id="id67"> <h2>0.2.4 (2017-12-14)<a class="headerlink" href="#id67" title="Permalink to this heading"></a></h2> <p>Features:</p> <ul class="simple"> <li><p>Models: now store release group mbid on Album model (#7)</p></li> <li><p>Models: now bind import job to track files (#44)</p></li> </ul> <p>Bugfixes:</p> <ul class="simple"> <li><p>Library: fixen broken “play all albums” button on artist cards in Artist browsing view (#43)</p></li> </ul> </section> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="glossary.html" class="btn btn-neutral float-left" title="Glossary of terms" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p>© Copyright 2023, The Funkwhale Collective.</p> </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> <span class="rst-current-version" data-toggle="rst-current-version"> <span class="fa fa-book"> Other Versions</span> <span class="fa fa-caret-down"></span> </span> <div class="rst-other-versions"> <dl> <dt>Versions</dt> <dd><a href="/">stable</a></dd> <dd><a href="/develop">develop</a></dd> </dl> </div> </div><script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>