From 4a197e5475ba848a4a13bb23ebd70bc9ad8f99d5 Mon Sep 17 00:00:00 2001 From: Eliot Berriot <contact@eliotberriot.com> Date: Tue, 29 Jan 2019 14:25:19 +0100 Subject: [PATCH] Version bump and changelog for 0.18.1 --- CHANGELOG | 115 +++++++++++++++++++++++ api/funkwhale_api/__init__.py | 2 +- changes/changelog.d/666.bugfix | 1 - changes/changelog.d/667.bugfix | 1 - changes/changelog.d/668.bugfix | 1 - changes/changelog.d/670.enhancement | 1 - changes/changelog.d/676.bugfix | 1 - changes/changelog.d/678.bugfix | 1 - changes/changelog.d/681.enhancement | 1 - changes/changelog.d/683.bugfix | 1 - changes/changelog.d/684.enhancement | 1 - changes/changelog.d/685.enhancement | 1 - changes/changelog.d/686.enhancement | 1 - changes/changelog.d/688.bugfix | 1 - changes/changelog.d/celery.bugfix | 1 - changes/changelog.d/docker-proxy.bugfix | 1 - changes/changelog.d/kombu.bugfix | 1 - changes/changelog.d/progress.enhancement | 1 - changes/changelog.d/upload.doc | 1 - changes/notes.rst | 77 --------------- 20 files changed, 116 insertions(+), 95 deletions(-) delete mode 100644 changes/changelog.d/666.bugfix delete mode 100644 changes/changelog.d/667.bugfix delete mode 100644 changes/changelog.d/668.bugfix delete mode 100644 changes/changelog.d/670.enhancement delete mode 100644 changes/changelog.d/676.bugfix delete mode 100644 changes/changelog.d/678.bugfix delete mode 100644 changes/changelog.d/681.enhancement delete mode 100644 changes/changelog.d/683.bugfix delete mode 100644 changes/changelog.d/684.enhancement delete mode 100644 changes/changelog.d/685.enhancement delete mode 100644 changes/changelog.d/686.enhancement delete mode 100644 changes/changelog.d/688.bugfix delete mode 100644 changes/changelog.d/celery.bugfix delete mode 100644 changes/changelog.d/docker-proxy.bugfix delete mode 100644 changes/changelog.d/kombu.bugfix delete mode 100644 changes/changelog.d/progress.enhancement delete mode 100644 changes/changelog.d/upload.doc diff --git a/CHANGELOG b/CHANGELOG index e5444df9..a0446517 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -10,6 +10,121 @@ This changelog is viewable on the web at https://docs.funkwhale.audio/changelog. .. towncrier +0.18.1 (2019-01-29) +------------------- + +Upgrade instructions are available at +https://docs.funkwhale.audio/index.html + + +Fix Gzip compression to avoid BREACH exploit [security] [manual action required] +-------------------------------------------------------------------------------- + +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. + +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 ``gzip_types`` settings:: + + application/atom+xml + application/json + application/ld+json + application/activity+json + application/manifest+json + application/rss+xml + application/xhtml+xml + application/xml + +For convenience, you can also replace the whole setting with the following snippet:: + + gzip_types + application/javascript + application/vnd.geo+json + application/vnd.ms-fontobject + application/x-font-ttf + application/x-web-app-manifest+json + font/opentype + image/bmp + image/svg+xml + image/x-icon + text/cache-manifest + text/css + text/plain + text/vcard + text/vnd.rim.location.xloc + text/vtt + text/x-component + text/x-cross-domain-policy; + +Many thanks to @jibec for the report! + +Fix Apache configuration file for 0.18 [manual action required] +---------------------------------------------------------- + +The way front is served has changed since 0.18. The Apache configuration can't serve 0.18 properly, leading to blank screens. + +If you are on an Apache setup, you will have to replace the `<Location "/api">` block with the following:: + + <Location "/"> + # similar to nginx 'client_max_body_size 100M;' + LimitRequestBody 104857600 + + ProxyPass ${funkwhale-api}/ + ProxyPassReverse ${funkwhale-api}/ + </Location> + +And add some more `ProxyPass` directives so that the `Alias` part of your configuration file looks this way:: + + ProxyPass "/front" "!" + Alias /front /srv/funkwhale/front/dist + + ProxyPass "/media" "!" + Alias /media /srv/funkwhale/data/media + + ProxyPass "/staticfiles" "!" + Alias /staticfiles /srv/funkwhale/data/static + +In case you are using custom css and theming, you also need to match this block:: + + ProxyPass "/settings.json" "!" + Alias /settings.json /srv/funkwhale/custom/settings.json + + ProxyPass "/custom" "!" + Alias /custom /srv/funkwhale/custom + + +Enhancements: + +- Added name attributes on all inputs to improve UX, especially with password managers (#686) +- Disable makemigrations in production and misleading message when running migrate (#685) +- Display progress during file upload +- Hide pagination when there is only one page of results (#681) +- Include shared/public playlists in Subsonic API responses (#684) +- Use proper locale for date-related/duration strings (#670) + + +Bugfixes: + +- Fix transcoding of in-place imported tracks (#688) +- Fixed celery worker defaulting to development settings instead of production +- Fixed crashing Django admin when loading track detail page (#666) +- Fixed list icon alignement on landing page (#668) +- Fixed overescaping issue in notifications and album page (#676) +- Fixed wrong number of affected elements in bulk action modal (#683) +- Fixed wrong URL in documentation for funkwhale_proxy.conf file when deploying using Docker +- Make Apache configuration file work with 0.18 changes (#667) +- Removed potential BREACH exploit because of Gzip compression (#678) +- Upgraded kombu to fix an incompatibility with redis>=3 + + +Documentation: + +- Added user upload documentation at https://docs.funkwhale.audio/users/upload.html + + 0.18 "Naomi" (2019-01-22) ------------------------- diff --git a/api/funkwhale_api/__init__.py b/api/funkwhale_api/__init__.py index b6e74547..bc497671 100644 --- a/api/funkwhale_api/__init__.py +++ b/api/funkwhale_api/__init__.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -__version__ = "0.18" +__version__ = "0.18.1" __version_info__ = tuple( [ int(num) if num.isdigit() else num diff --git a/changes/changelog.d/666.bugfix b/changes/changelog.d/666.bugfix deleted file mode 100644 index 5027dd40..00000000 --- a/changes/changelog.d/666.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fixed crashing Django admin when loading track detail page (#666) diff --git a/changes/changelog.d/667.bugfix b/changes/changelog.d/667.bugfix deleted file mode 100644 index d553867c..00000000 --- a/changes/changelog.d/667.bugfix +++ /dev/null @@ -1 +0,0 @@ -Make Apache configuration file work with 0.18 changes (#667) diff --git a/changes/changelog.d/668.bugfix b/changes/changelog.d/668.bugfix deleted file mode 100644 index 5f4f878d..00000000 --- a/changes/changelog.d/668.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fixed list icon alignement on landing page (#668) diff --git a/changes/changelog.d/670.enhancement b/changes/changelog.d/670.enhancement deleted file mode 100644 index 8da3f97f..00000000 --- a/changes/changelog.d/670.enhancement +++ /dev/null @@ -1 +0,0 @@ -Use proper locale for date-related/duration strings (#670) diff --git a/changes/changelog.d/676.bugfix b/changes/changelog.d/676.bugfix deleted file mode 100644 index 30829cd1..00000000 --- a/changes/changelog.d/676.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fixed overescaping issue in notifications and album page (#676) diff --git a/changes/changelog.d/678.bugfix b/changes/changelog.d/678.bugfix deleted file mode 100644 index ba508bb8..00000000 --- a/changes/changelog.d/678.bugfix +++ /dev/null @@ -1 +0,0 @@ -Removed potential BREACH exploit because of Gzip compression (#678) diff --git a/changes/changelog.d/681.enhancement b/changes/changelog.d/681.enhancement deleted file mode 100644 index 9f872310..00000000 --- a/changes/changelog.d/681.enhancement +++ /dev/null @@ -1 +0,0 @@ -Hide pagination when there is only one page of results (#681) \ No newline at end of file diff --git a/changes/changelog.d/683.bugfix b/changes/changelog.d/683.bugfix deleted file mode 100644 index 18cc3a7a..00000000 --- a/changes/changelog.d/683.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fixed wrong number of affected elements in bulk action modal (#683) diff --git a/changes/changelog.d/684.enhancement b/changes/changelog.d/684.enhancement deleted file mode 100644 index 1cdd0cdd..00000000 --- a/changes/changelog.d/684.enhancement +++ /dev/null @@ -1 +0,0 @@ -Include shared/public playlists in Subsonic API responses (#684) diff --git a/changes/changelog.d/685.enhancement b/changes/changelog.d/685.enhancement deleted file mode 100644 index f9cc105a..00000000 --- a/changes/changelog.d/685.enhancement +++ /dev/null @@ -1 +0,0 @@ -Disable makemigrations in production and misleading message when running migrate (#685) diff --git a/changes/changelog.d/686.enhancement b/changes/changelog.d/686.enhancement deleted file mode 100644 index c346a9ab..00000000 --- a/changes/changelog.d/686.enhancement +++ /dev/null @@ -1 +0,0 @@ -Added name attributes on all inputs to improve UX, especially with password managers (#686) diff --git a/changes/changelog.d/688.bugfix b/changes/changelog.d/688.bugfix deleted file mode 100644 index 085f205c..00000000 --- a/changes/changelog.d/688.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fix transcoding of in-place imported tracks (#688) diff --git a/changes/changelog.d/celery.bugfix b/changes/changelog.d/celery.bugfix deleted file mode 100644 index 448a536e..00000000 --- a/changes/changelog.d/celery.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fixed celery worker defaulting to development settings instead of production diff --git a/changes/changelog.d/docker-proxy.bugfix b/changes/changelog.d/docker-proxy.bugfix deleted file mode 100644 index 9dac8ffb..00000000 --- a/changes/changelog.d/docker-proxy.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fixed wrong URL in documentation for funkwhale_proxy.conf file when deploying using Docker diff --git a/changes/changelog.d/kombu.bugfix b/changes/changelog.d/kombu.bugfix deleted file mode 100644 index 01469f29..00000000 --- a/changes/changelog.d/kombu.bugfix +++ /dev/null @@ -1 +0,0 @@ -Upgraded kombu to fix an incompatibility with redis>=3 diff --git a/changes/changelog.d/progress.enhancement b/changes/changelog.d/progress.enhancement deleted file mode 100644 index cbd50903..00000000 --- a/changes/changelog.d/progress.enhancement +++ /dev/null @@ -1 +0,0 @@ -Display progress during file upload diff --git a/changes/changelog.d/upload.doc b/changes/changelog.d/upload.doc deleted file mode 100644 index 0b2506fc..00000000 --- a/changes/changelog.d/upload.doc +++ /dev/null @@ -1 +0,0 @@ -Added user upload documentation diff --git a/changes/notes.rst b/changes/notes.rst index 1276dd01..96ac3d76 100644 --- a/changes/notes.rst +++ b/changes/notes.rst @@ -5,80 +5,3 @@ Next release notes Those release notes refer to the current development branch and are reset after each release. - -Fix Gzip compression to avoid BREACH exploit [security] [manual action required] --------------------------------------------------------------------------------- - -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. - -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 ``gzip_types`` settings:: - - application/atom+xml - application/json - application/ld+json - application/activity+json - application/manifest+json - application/rss+xml - application/xhtml+xml - application/xml - -For convenience, you can also replace the whole setting with the following snippet:: - - gzip_types - application/javascript - application/vnd.geo+json - application/vnd.ms-fontobject - application/x-font-ttf - application/x-web-app-manifest+json - font/opentype - image/bmp - image/svg+xml - image/x-icon - text/cache-manifest - text/css - text/plain - text/vcard - text/vnd.rim.location.xloc - text/vtt - text/x-component - text/x-cross-domain-policy; - - -Fix Apache configuration file for 0.18 [manual action required] ----------------------------------------------------------- - -The way front is served has changed since 0.18. The Apache configuration can't serve 0.18 properly, leading to blank screens. - -If you are on an Apache setup, you will have to replace the `<Location "/api">` block with the following:: - - <Location "/"> - # similar to nginx 'client_max_body_size 100M;' - LimitRequestBody 104857600 - - ProxyPass ${funkwhale-api}/ - ProxyPassReverse ${funkwhale-api}/ - </Location> - -And add some more `ProxyPass` directives so that the `Alias` part of your configuration file looks this way:: - - ProxyPass "/front" "!" - Alias /front /srv/funkwhale/front/dist - - ProxyPass "/media" "!" - Alias /media /srv/funkwhale/data/media - - ProxyPass "/staticfiles" "!" - Alias /staticfiles /srv/funkwhale/data/static - -In case you are using custom css and theming, you also need to match this block:: - - ProxyPass "/settings.json" "!" - Alias /settings.json /srv/funkwhale/custom/settings.json - - ProxyPass "/custom" "!" - Alias /custom /srv/funkwhale/custom -- GitLab