diff --git a/CHANGELOG b/CHANGELOG index a9d92f50cf19fd9348e4c10774fc94f66863c71f..82c867bf890d619bd9c10177a75f906a4445c56a 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -10,6 +10,111 @@ This changelog is viewable on the web at https://docs.funkwhale.audio/changelog. .. towncrier +0.11 (unreleased) +----------------- + +Upgrade instructions are available at https://docs.funkwhale.audio/upgrading.html + +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! + +Features: + +- 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! +- Users can now request password reset by email, assuming a SMTP server was + correctly configured (#187) + +Enhancements: + +- Added a fix_track_files command to run checks and fixes against library + (#183) +- Avoid fetching Actor object on every request authentication +- Can now relaunch errored jobs and batches (#176) +- List pending requests by default, added a status filter for requests (#109) +- More structured menus in sidebar, added labels with notifications +- Sample virtual-host file for Apache2 reverse-proxy (!165) +- Store high-level settings (such as federation or auth-related ones) in + database (#186) + + +Bugfixes: + +- Ensure in place imported files get a proper mimetype (#183) +- Federation cache suppression is now simpler and also deletes orphaned files + (#189) +- Fixed small UI glitches/bugs in federation tabs (#184) +- X-sendfile not working with in place import (#182) + + +Documentation: + +- Added a documentation area for third-party projects (#180) +- Added documentation for optimizing Funkwhale and reduce its memory footprint. +- Document that the database should use an utf-8 encoding (#185) +- Foundations for API documentation with Swagger (#178) + + +Database storage for high-level settings +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Due to the work done in #186, the following environment variables have been +deprecated: + +- FEDERATION_ENABLED +- FEDERATION_COLLECTION_PAGE_SIZE +- FEDERATION_MUSIC_NEEDS_APPROVAL +- FEDERATION_ACTOR_FETCH_DELAY +- PLAYLISTS_MAX_TRACKS +- API_AUTHENTICATION_REQUIRED + +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. + +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. + +Please browse https://docs.funkwhale.audio/configuration.html#instance-settings +for more information about instance configuration using the web interface. + + +System emails +^^^^^^^^^^^^^ + +Starting from this release, Funkwhale will send two types +of emails: + +- Email confirmation emails, to ensure a user's email is valid +- Password reset emails, enabling user to reset their password without an admin's intervention + +Email sending is disabled by default, as it requires additional configuration. +In this mode, emails are simply outputed on stdout. + +If you want to actually send those emails to your users, you should edit your +.env file and tweak the EMAIL_CONFIG variable. See :ref:`setting-EMAIL_CONFIG` +for more details. + +.. note:: + + As a result of these changes, the DJANGO_EMAIL_BACKEND variable, + which was not documented, has no effect anymore. You can safely remove it from + your .env file if it is set. + + +Proxy headers for non-docker deployments +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +For non-docker deployments, add ``--proxy-headers`` at the end of the ``daphne`` +command in :file:`/etc/systemd/system/funkwhale-server.service`. + +This will ensure the application receive the correct IP address from the client +and not the proxy's one. + + 0.10 (2018-04-23) ----------------- diff --git a/api/funkwhale_api/__init__.py b/api/funkwhale_api/__init__.py index 596926919170b9efbf5914a51010f9da8f67751d..4f62dd9b5b08542e8fa55eaae0920bda4edd6296 100644 --- a/api/funkwhale_api/__init__.py +++ b/api/funkwhale_api/__init__.py @@ -1,3 +1,3 @@ # -*- coding: utf-8 -*- -__version__ = '0.10' +__version__ = '0.11' __version_info__ = tuple([int(num) if num.isdigit() else num for num in __version__.replace('-', '.', 1).split('.')]) diff --git a/changes/changelog.d/109.enhancement b/changes/changelog.d/109.enhancement deleted file mode 100644 index 60e740d738670724a9a3722107a3b30a47b4f89a..0000000000000000000000000000000000000000 --- a/changes/changelog.d/109.enhancement +++ /dev/null @@ -1 +0,0 @@ -List pending requests by default, added a status filter for requests (#109) diff --git a/changes/changelog.d/176.enhancement b/changes/changelog.d/176.enhancement deleted file mode 100644 index 874aed72755a92bd26132f8875e5a31cbbd584c5..0000000000000000000000000000000000000000 --- a/changes/changelog.d/176.enhancement +++ /dev/null @@ -1 +0,0 @@ -Can now relaunch errored jobs and batches (#176) diff --git a/changes/changelog.d/178.doc b/changes/changelog.d/178.doc deleted file mode 100644 index 419e6984b80460904ec4859d8072554c133ca264..0000000000000000000000000000000000000000 --- a/changes/changelog.d/178.doc +++ /dev/null @@ -1 +0,0 @@ -Foundations for API documentation with Swagger (#178) diff --git a/changes/changelog.d/180.doc b/changes/changelog.d/180.doc deleted file mode 100644 index ee79f3e3f96dcdf1cc9915e48895ebf1858bcee0..0000000000000000000000000000000000000000 --- a/changes/changelog.d/180.doc +++ /dev/null @@ -1 +0,0 @@ -Added a documentation area for third-party projects (#180) diff --git a/changes/changelog.d/182.bugfix b/changes/changelog.d/182.bugfix deleted file mode 100644 index 6a880c4b0275f064be8adfc11759b5aceec8aec0..0000000000000000000000000000000000000000 --- a/changes/changelog.d/182.bugfix +++ /dev/null @@ -1 +0,0 @@ -X-sendfile not working with in place import (#182) diff --git a/changes/changelog.d/183.bugfix b/changes/changelog.d/183.bugfix deleted file mode 100644 index 03a28e9c394e73fe679c47f573aa879343918dd4..0000000000000000000000000000000000000000 --- a/changes/changelog.d/183.bugfix +++ /dev/null @@ -1 +0,0 @@ -Ensure in place imported files get a proper mimetype (#183) diff --git a/changes/changelog.d/183.enhancement b/changes/changelog.d/183.enhancement deleted file mode 100644 index 2549db810c97283c1ea7ef246ea79dc5a4ced674..0000000000000000000000000000000000000000 --- a/changes/changelog.d/183.enhancement +++ /dev/null @@ -1 +0,0 @@ -Added a fix_track_files command to run checks and fixes against library (#183) diff --git a/changes/changelog.d/184.bugfix b/changes/changelog.d/184.bugfix deleted file mode 100644 index 354b691db2cf62d5191b7cafa84e779c685d347e..0000000000000000000000000000000000000000 --- a/changes/changelog.d/184.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fixed small UI glitches/bugs in federation tabs (#184) diff --git a/changes/changelog.d/185.doc b/changes/changelog.d/185.doc deleted file mode 100644 index 72144e343d0d6f271232ad37c6190c49b1596c10..0000000000000000000000000000000000000000 --- a/changes/changelog.d/185.doc +++ /dev/null @@ -1 +0,0 @@ -Document that the database should use an utf-8 encoding (#185) diff --git a/changes/changelog.d/186.enhancement b/changes/changelog.d/186.enhancement deleted file mode 100644 index 36777c78652e042e4ba3c6d05f9df9d0f56e442d..0000000000000000000000000000000000000000 --- a/changes/changelog.d/186.enhancement +++ /dev/null @@ -1,24 +0,0 @@ -Store high-level settings (such as federation or auth-related ones) in database (#186) - -Changelog -^^^^^^^^^ -Due to the work done in #186, the following environment variables have been -deprecated: - -- FEDERATION_ENABLED -- FEDERATION_COLLECTION_PAGE_SIZE -- FEDERATION_MUSIC_NEEDS_APPROVAL -- FEDERATION_ACTOR_FETCH_DELAY -- PLAYLISTS_MAX_TRACKS -- API_AUTHENTICATION_REQUIRED - -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. - -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. - -Please browse https://docs.funkwhale.audio/configuration.html#instance-settings -for more information about instance configuration using the web interface. diff --git a/changes/changelog.d/187.feature b/changes/changelog.d/187.feature deleted file mode 100644 index 501331a19327a2b177e62fefeb5e5a5f47f35c5d..0000000000000000000000000000000000000000 --- a/changes/changelog.d/187.feature +++ /dev/null @@ -1,24 +0,0 @@ -Users can now request password reset by email, assuming -a SMTP server was correctly configured (#187) - -Update -^^^^^^ - -Starting from this release, Funkwhale will send two types -of emails: - -- Email confirmation emails, to ensure a user's email is valid -- Password reset emails, enabling user to reset their password without an admin's intervention - -Email sending is disabled by default, as it requires additional configuration. -In this mode, emails are simply outputed on stdout. - -If you want to actually send those emails to your users, you should edit your -.env file and tweak the EMAIL_CONFIG variable. See :ref:`setting-EMAIL_CONFIG` -for more details. - -.. note:: - - As a result of these changes, the DJANGO_EMAIL_BACKEND variable, - which was not documented, has no effect anymore. You can safely remove it from - your .env file if it is set. diff --git a/changes/changelog.d/189.bugfix b/changes/changelog.d/189.bugfix deleted file mode 100644 index 076058e636736b4bb9344ce566a31943c2c1a0bf..0000000000000000000000000000000000000000 --- a/changes/changelog.d/189.bugfix +++ /dev/null @@ -1 +0,0 @@ -Federation cache suppression is now simpler and also deletes orphaned files (#189) diff --git a/changes/changelog.d/actor-fetch.enhancement b/changes/changelog.d/actor-fetch.enhancement deleted file mode 100644 index 17f3a88df2d961d2fbc7d60fcf9c876fd4ba96c8..0000000000000000000000000000000000000000 --- a/changes/changelog.d/actor-fetch.enhancement +++ /dev/null @@ -1 +0,0 @@ -Avoid fetching Actor object on every request authentication diff --git a/changes/changelog.d/apache.enhancement b/changes/changelog.d/apache.enhancement deleted file mode 100644 index 5aa4338051fc5b4ca7b6d4f1080b5ebcb8ba8461..0000000000000000000000000000000000000000 --- a/changes/changelog.d/apache.enhancement +++ /dev/null @@ -1 +0,0 @@ -Sample virtual-host file for Apache2 reverse-proxy (!165) diff --git a/changes/changelog.d/optimization.doc b/changes/changelog.d/optimization.doc deleted file mode 100644 index 929e148210ceff60a0085b04124bc0ce31c53e53..0000000000000000000000000000000000000000 --- a/changes/changelog.d/optimization.doc +++ /dev/null @@ -1,11 +0,0 @@ -Added documentation for optimizing Funkwhale and reduce its memory -footprint. - -Changelog -^^^^^^^^^ - -For non-docker deployments, add ``--proxy-headers`` at the end of the ``daphne`` -command in :file:`/etc/systemd/system/funkwhale-server.service`. - -This will ensure the application receive the correct IP address from the client -and not the proxy's one. diff --git a/changes/changelog.d/sidebar.enhancement b/changes/changelog.d/sidebar.enhancement deleted file mode 100644 index 1bc1a482f6b2b87e89649fb267ed51db8c913ec8..0000000000000000000000000000000000000000 --- a/changes/changelog.d/sidebar.enhancement +++ /dev/null @@ -1 +0,0 @@ -More structured menus in sidebar, added labels with notifications