Tags give the ability to mark specific points in history as being important
  • 1.0   1.0 (2020-09-09) ---------------- Upgrade instructions are available at https://docs.funkwhale.audio/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 accross 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 - Bheesham Persaud - Ciarán Ainsworth - Creak - Daniele Lira Mereb - dulz - Francesc Galí - ghose - mekind - Puri - Quentin PAGÈS - Raphaël Ventura - Simon Arlott - Slimane Selyan Amiri - Stefano Pigozzi - Sébastien de Melo - vicdorke - Xosé M
  • 1.0-rc1
  • 0.21.2   0.21.2 (2020-07-27) ------------------- Upgrade instructions are available at https://docs.funkwhale.audio/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 serie/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 covert 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
  • 0.21   0.21 "Agate" (2020-04-24) ------------------------- 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 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! Upgrade instructions are available at https://docs.funkwhale.audio/admin/upgrading.html, there are also additional operations you need to execute, listed in the changelog below (search "Manual action"). Channels and podcasts ^^^^^^^^^^^^^^^^^^^^^ Funkwhale 0.21 includes a brand new feature: Channels! 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. 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! 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. Redesigned navigation, player and queue ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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! Improved search bar for searching remote objects ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The search bar now support fetching arbitrary objects using a URL. In particular, you can use this to quickly: - Subscribe to a remote library via its URL - Listen a public track from another pod - Subscribe to a channel Screening for sign-ups and custom sign-up form ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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. 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. In addition, it's also possible to customize the sign-up form by: - Providing a custom help text, in markdown format - 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 Federated reports ^^^^^^^^^^^^^^^^^ 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. This feature is inspired by Mastodon's current design, and should work with at least Funkwhale and Mastodon servers. Improved search performance ^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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. 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. We plan to remove the old engine in an upcoming release. In the meantime, if anything goes wrong, you can switch back by setting ``USE_FULL_TEXT_SEARCH=false`` in your ``.env`` file. Enforced email verification ^^^^^^^^^^^^^^^^^^^^^^^^^^^ The brand new ``ACCOUNT_EMAIL_VERIFICATION_ENFORCE`` setting can be used to make email verification mandatory for your users. It defaults to ``false``, and doesn't apply to superuser accounts created through the CLI. If you enable this, ensure you have a SMTP server configured too. More reliable CLI importer [manual action required] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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) 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. If you use the ``import_files`` command, this means you should replace scripts that look like this:: python api/manage.py import_files $LIBRARY_ID "/srv/funkwhale/data/music/**/*.ogg" "/srv/funkwhale/data/music/**/*.mp3" --recursive --noinput By this:: python api/manage.py import_files $LIBRARY_ID "/srv/funkwhale/data/music/" --recursive --noinput And Funkwhale will happily import any supported audio file from the specified directory. User management through the server CLI ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ We now support user creation (incl. non-admin accounts), update and removal directly from the server CLI. Typical use cases include: - Changing a user password from the command line - Creating or updating users from deployments scripts or playbooks - Removing or granting permissions or upload quota to multiple users at once - Marking multiple users as inactive All user-related commands are available under the ``python manage.py fw users`` namespace. Please refer to the `Admin documentation <https://docs.funkwhale.audio/admin/commands.html#user-management>`_ for more information and instructions. Progressive web app [Manual action suggested, non-docker only] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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. 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:: location /front/ { # Add the following line in the /front/ location add_header Service-Worker-Allowed "/"; } Postgres docker changed environment variable [manual action required, docker multi-container only] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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) You need to add this to your .env file: ``POSTGRES_HOST_AUTH_METHOD=trust`` Newer deployments aren't affected. Upgrade from Postgres 10 to 11 [manual action required, docker all-in-one only] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ With our upgrade to Alpine 3.10, the ``funkwhale/all-in-one`` image now includes PostgreSQL 11. In order to update to Funkwhale 0.21, you will first need to uprade Funkwhale's PostgreSQL database, following the steps below:: # open a shell as the Funkwhale user sudo -u funkwhale -H bash # move to the funkwhale data directory # (replace this with your own if you used a different path) cd /srv/funkwhale/data # stop the funkwhale container docker stop funkwhale # backup the database files cp -r data/ ../postgres.bak # Upgrade the database docker run --rm \ -v $(pwd)/data:/var/lib/postgresql/10/data \ -v $(pwd)/upgraded-postgresql:/var/lib/postgresql/11/data \ -e PGUSER=funkwhale \ -e POSTGRES_INITDB_ARGS="-U funkwhale --locale C --encoding UTF8" \ tianon/postgres-upgrade:10-to-11 # replace the Postgres 10 files with Postgres 11 files mv data/ postgres-10 mv upgraded-postgresql/ data Once you have completed the Funkwhale upgrade with our regular instructions and everything works properly, you can remove the backups/old files:: sudo -u funkwhale -H bash cd /srv/funkwhale/data rm -rf ../postgres.bak rm -rf postgres-10 Full list of changes ^^^^^^^^^^^^^^^^^^^^ Features: - Support for publishing and subscribing to podcasts (#170) - Brand new navigation, queue and player redesign (#594) - Can now browse a library content through the UI (#926) - Federated reports (#1038) - Screening for sign-ups (#1040) - Make it possible to enforce email verification (#1039) - Added a new radio based on another user listenings (#1060) - User management through the server CLI Enhancements: - Added ability to reject library follows from notifications screen (#859) - Added periodic background task and CLI command to associate genre tags to artists and albums based on identical tags found on corresponding tracks (#988) - Added support for CELERYD_CONCURRENCY env var to control the number of worker processes (#997) - Added the ability to sort albums by release date (#1013) - Added two new radios to play your own content or a given library tracks - Advertise list of known nodes on /api/v1/federation/domains and in nodeinfo if stats sharing is enabled - Changed footer to use instance name if available, and append ellipses if instance URL/Name is too long (#1012) - Favor local uploads when playing a track with multiple uploads (#1036) - Include only local content in nodeinfo stats, added downloads count - Make media and static files serving more reliable when reverse proxy X_FORWARDED_* headers are incorrect (#947) - Order the playlist columns by modification date in the Browse tab (#775) - Reduced size of funkwhale/funkwhale docker images thanks to multi-stage builds (!1042) - Remember display settings in Album, Artist, Radio and Playlist views (#391) - Removed unnecessary "Federation music needs approval" setting (#959) - Replaced our slow research logic by PostgreSQL full-text search (#994) - Support autoplay when loading embed frame from Mastodon and third-party websites (#1041) - Support filtering playlist by name and several additional UX improvements in playlists modal (#974) - Support modifying album cover art through the web UI (#588) - Use a dedicated scope for throttling subsonic to avoid intrusive rate-limiting - Use same markdown widget for all content fields (rules, description, reports, notes, etc.) - CLI Importer is now more reliable and less resource-hungry on large libraries - Add support custom domain for S3 storage - Better placeholders for channels when there are no episodes or series - Updated documentation for 0.21 release - Improved performance and error handling when fetching remote attachments Bugfixes: - Added missing manuallyApprovesFollowers entry in JSON-LD contexts (#961) - Fix issue with browser shortcuts such as search and focus URL not being recognised (#340, #985) - Fixed admin dropdown not showing after login (#1042) - Fixed an issue with celerybeat container failing to restart (#1004) - Fixed invalid displayed number of tracks in playlist (#986) - Fixed issue with recent results not being loaded from the API (#948) - Fixed issue with sorting by album name not working (#960) - Fixed short audio glitch when switching switching to another track with player paused (#970) - Improved deduplication logic to prevent skipped files during import (#348, #474, #557, #740, #928) - More resilient tag parsing with empty release date or album artist (#1037) - More robust importer against malformed dates (#966) - Removed "nodeinfo disabled" setting, as nodeinfo is required for the UI to work (#982) - Replaced PDF icon by List icon in playlist placeholder (#943) - Resolve an issue where disc numbers were not taken into consideration when playing an album from the album card (#1006) - Set correct size for album covers in playlist cards (#680) - Remove double spaces in ChannelForm - Deduplicate tags in Audio ActivityPub representation - Add support custom domain for S3 storage - Fix #1079: fixed z-index issues with dropdowns (#1079 and #1075) - Exclude external podcasts from library home - Fixed broken channel save when description is too long - Fixed 500 error when federation is disabled and application+json is requested - Fixed minor subsonic API crash - Fixed broken local profile page when allow-list is enabled - Fixed issue with confirmation email not sending when signup-approval was enabled - Ensure 0 quota on user is honored - Fixed attachments URL not honoring media URL - Fix grammar in msg string in TrackBase.vue - Fix typo in SubscribeButton.vue Translations: - Arabic - Catalan - English (United Kingdom) - German - Hungarian - Japanese - Occitan - Portuguese (Brazil) - Russian Contributors to this release (translation, development, documentation, reviews, design, testing, third-party projects): - Agate - annando - Anton Strömkvist - Audrey - ButterflyOfFire - Ciarán Ainsworth - Creak - Daniele Lira Mereb - dashie - Eloisa - eorn - Francesc Galí - gerhardbeck - GinnyMcQueen - guillermau - Haelwenn - jinxx - Jonathan Aylard - Keunes - M.G - marzzzello - Mathé Grievink - Mélanie Chauvel - Mjourdan - Morgan Kesler - Noe Gaumont - Noureddine HADDAG - Ollie - Peter Wickenberg - Quentin PAGÈS - Renon - Satsuki Yanagi - Shlee - SpcCw - techknowlogick - ThibG - Tony Wasserka - unklebonehead - wakest - wxcafé - Xaloc - Xosé M
  • 0.21-rc2
  • 0.21-rc1
  • 0.20.1   0.20.1 (2019-10-28) ------------------- Upgrade instructions are available at https://docs.funkwhale.audio/index.html Denormalized audio permission logic in a separate table to enhance performance ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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). Under the hood, we now maintain a separate table to link users to the tracks they are allowed to see. This change is **disabled** by default, but should be enabled by default starting in Funkwhale 0.21. If you want to try it now, add ``MUSIC_USE_DENORMALIZATION=True`` to your ``.env`` file, restart Funkwhale, and run the following command:: python manage.py rebuild_music_permissions 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. Enhancements: - Added a retry option for failed uploads (#942) - Added feedback via loading spinner when searching a remote library - Denormalized audio permission logic in a separate table to enhance performance - Placeholders will now be shown if no content is available across the application (#750) - Reduce the number of simultaneous DB connections under some deployment scenario - Support byYear filtering in Subsonic API (#936) Bugfixes: - Ensure password input doesn't overflow outside of container (#933) - Fix audio serving issues under S3/nginx when signatures are enabled - Fix import crash when importing M4A file with no embedded cover (#946) - Fix tag exclusion in custom radios (#950) - Fixed an issue with embed player CSS being purged during build (#935) - Fixed escaped pod name displayed on home/about page (#945) - Fixed pagination in subsonic getSongsByGenre endpoint (#954) - Fixed style glitches in dropdowns Documentation: - Documented how to create DB extension by hand in case of permission error during migrations (#934) Contributors to this release (translation, development, documentation, reviews, design): - Ciarán Ainsworth - Dag Stenstad - Daniele Lira Mereb - Eliot Berriot - Esteban - Johannes H. - knuxify - Mateus Mattei Garcia - Quentin PAGÈS
  • 0.20.0
  • 0.20.0-rc1
  • 0.19.1   0.19.1 (2018-06-28) ------------------- Upgrade instructions are available at https://docs.funkwhale.audio/index.html Enhancements: - The currently playing track is now highlighted with an orange play icon (#832) - Support for importing files with no album tag (#122) - Redirect from / to /library when user is logged in (#864) - Added a SUBSONIC_DEFAULT_TRANSCODING_FORMAT env var to support clients that don't provide the format parameter (#867) - Added button to search for objects on Discogs (#368) - Added copy-to-clipboard button with Subsonic password input (#814) - Added opus to the list of supported mimetypes and extensions (#868) - Aligned search headers with search results in the sidebar (#708) - Clicking on the currently selected playlist in the Playlist popup will now close the popup (#807) - Favorites radio will not be visible if the user does not have any favorites (#419) Bugfixes: - Ensure empty but optional fields in file metadata don't error during import (#850) - Fix broken upload for specific files when using S3 storage (#857) - Fixed broken translation on home and track detail page (#833) - Fixed broken user admin for users with non-digit or letters in their username (#869) - Fixed invalid file extension for transcoded tracks (#848) - Fixed issue with French translation for "Start radio" (#849) - Fixed issue with player changing height when hovering over the volume slider (#838) - Fixed secondary menus truncated on narrow screens (#855) - Fixed wrong og:image url when using S3 storage (#851) - Hide pod statistics on about page if those are disabled (#835) - Use ASCII filename before upload to S3 to avoid playback issues (#847) Contributors to this release (commiters and reviewers): - Ciarán Ainsworth - Creak - ealgase - Eliot Berriot - Esteban - Freyja Wildes - hellekin - Johannes H. - Mehdi - Reg
  • 0.19.0   0.19.0 (2019-05-16) ------------------- Upgrade instructions are available at https://docs.funkwhale.audio/index.html Edits on tracks, albums and artists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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). 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. Approved edits are broadcasted via federation, to ensure other instances get the information too. 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. Admin UI for tracks, albums, artists, libraries and uploads ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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: - tracks - albums - artists - libraries - uploads 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). Artist hiding in the interface ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ It's now possible for users to hide artists they don't want to see. Content linked to hidden artists will not show up in the interface anymore. Especially: - Hidden artists tracks are removed from the current queue - Starting a playlist will skip tracks from hidden artists - Recently favorited, recently listened and recently added widgets on the homepage won't include content from hidden artists - Radio suggestions will exclude tracks from hidden artists - Hidden artists won't appear in Subsonic apps Results linked to hidden artists will continue to show up in search results and their profile page remains accessible. OAuth2 authorization for better integration with third-party apps ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Funkwhale now support the OAuth2 authorization and authentication protocol which will allow third-party apps to interact with Funkwhale on behalf of users. 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). 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`_. Better error handling and display during import ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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. This information is available in all pages that list uploads, when clicking on the button next to the upload status. Support for S3-compatible storages to store media files ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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. Check-out `https://docs.funkwhale.audio/admin/external-storages.html`_ if you want to use this feature. Prune library command ^^^^^^^^^^^^^^^^^^^^^ Users are often surprised by Funkwhale's tendency to keep track, album and artist metadata even if no associated files exist. To help with that, we now offer a ``prune_library`` management command you can run to purge your database from obsolete entries. `Please refer to our documentation for usage instructions <https://docs.funkwhale.audio/admin/commands.html#pruning-library>`_. Check in-place files command ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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. To help with that, we now offer a ``check_inplace_files`` management command you can run to purge your database from obsolete files. `Please refer to our documentation for usage instructions <https://docs.funkwhale.audio/admin/commands.html#remove-obsolete-files-from-database>`_. Features: - Added albums view. Similar to artists view, it's viewable by clicking on the "Albums" link on the top bar. (#356) - Allow artists hiding (#701) - Change the document title to display current track information. (#359) - Display a confirmation dialog when adding duplicate songs to a playlist (#784) - Improved error handling and display during import (#252, #718, #583, #501, #544) - Support embedding full artist discographies (#747) - Support metadata update on tracks, albums and artists and broadcast those on the federation (#689) - Support OAuth2 authorization for better integration with third-party apps (#752) - Support S3-compatible storages for media files (#565) Enhancements: - [Experimental] Added a new "Similar" radio based on users history (suggested by @gordon) - Added a "load more" button on artist pages to load more tracks/albums (#719) - Added a `check_inplace_files` management command to remove purge the database from references to in-place imported files that don't exist on disk anymore (#781) - Added a prune_library management command to remove obsolete metadata from the database (#777) - Added admin options to disable login for users, ensure related content is deleted when deleting a user account (#809) - Added standardized translation context for all strings in the frontend to give accurate hints to translators. - Added twitter:* meta tags to detect tracks and albums players automatically on more sites (#578) Improved responsiveness of embedded player - Advertise the list of supported upload extensions in the Nodeinfo endpoint (#808) - Better handling of follow/accept messages to avoid and recover from desync between instances (#830) - Better workflow for connecting to another instance (#715) 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. - Bumped dependencies to latest versions (#815) - Descriptions will now be shown underneath user libraries (#768) - Don't store unhandled ActivityPub messages in database (#776) - Enhanced the design of the embed wizard. (!619) - Ensure the footer always stays at the bottom of the page - Expose an instance-level actor (service@domain) in nodeinfo endpoint (#689) - Improved readability of logo (#385) - Keep persistent connections to the database instead of recreating a new one for each request - Labels for privacy levels are now consistently grabbed from a common source instead of being hardcoded everytime they are needed. - Merged artist/album buttons with title text on artist and album pages (#725) - Now honor maxBitrate parameter in Subsonic API (#802) - Preload next track in queue (#572) - Reduced app size for regular users by moving admin-related code in a dedicated chunk (#805) - Removed broken/instable lyrics feature (#799) - Show remaining storage space during import and prevent file upload if not enough space is remaining (#550) - The buttons displaying an icon now always show a little divider between the icon and the text. (!620) - Use attributedTo instead of actor in library ActivityPub payload (#619) - Use network/depends_on instead of links in docker-compose.yml (!716) Bugfixes: - Add missing command from contributing file (#754) - Add required envvar for dev environment (!668) - Added env variable to set AWS region and signature version to serve media without proxy (#826) - Allow users with dots in their usernames to request a subsonic password (#798) - Better handling of featuring/multi-artist tracks tagged with MusicBrainz (#782) - Do not consider tracks as duplicates during import if they have different positions (#740) - Ensure all our ActivityPub fetches are authenticated (#758) - Ensure correct track duration and playable status when browsing radios (#812) - Fixed alignement/size issue with some buttons (#702) - Fixed an encoding issue with instance name on about page (#828) - Fixed cover not showing in queue/player when playing tracks from "albums" tab (#795) - Fixed crashing upload processing on invalid date format (#718) - Fixed dev command for fake data creation (!664) - Fixed invalid OEmbed URL when using a local FUNKWHALE_SPA_HTML_ROOT (#824) - Fixed invalid required fields in Upload django's admin (#819) - Fixed issue with querying the albums api endpoint (#356) - Fixed non-transparent background for volume range on Firefox (#722) - Fixed overflowing input on account detail page (#791) - Fixed unplayable radios for anonymous users (#563) - Prevent skipping on file import if album_mbid is different (#772) - Use proper site name/domain in emails (#806) - Width of filter menus for radios has been set to stop text from overlapping the borders Documentation: - Document how to use Redis over unix sockets (#770) Contributors to this release (commiters and translators): - Ale London - Alexander - Ben Finney - ButterflyOfFire - Ciarán Ainsworth - Damien Nicolas - Daniele Lira Mereb - Eliot Berriot - Elza Gelez - gerry_the_hat - gordon - interfect - jake - Jee - jovuit - Mélanie Chauvel - nouts - Pierrick - Qasim Ali - Quentí - Renon - Rodrigo Leite - Sylke Vicious - Thomas Brockmöller - Tixie - Vierkantor - Von - Zach Halasz
  • 0.19.0-rc2
  • 0.19.0-rc1
    e3b0efb2 · Bump to 0.19.0-rc1 ·
  • 0.18.3   0.18.3 (2019-03-21) ------------------- Upgrade instructions are available at https://docs.funkwhale.audio/index.html Avoid mixed content when deploying mono-container behind proxy [Manual action required] --------------------------------------------------------------------------------------- *You are only concerned if you use the mono-container docker deployment behind a reverse proxy* Because of `an issue in our mono-container configuration <https://github.com/thetarkus/docker-funkwhale/issues/19>`_, users deploying Funkwhale via docker using our `funkwhale/all-in-one` image could face some mixed content warnings (and possibly other troubles) when browsing the Web UI. This is fixed in this release, but on existing deployments, you'll need to add ``NESTED_PROXY=1`` in your container environment (either in your ``.env`` file, or via your container management tool), then recreate your funkwhale container. Enhancements: - Added title on hover for truncated content (#766) - Ask for confirmation before leaving upload page if there is a an upload in process (#630) - Exclude in-place imported files from quota computation (#570) - Truncate filename in library file table to ensure correct display of the table. (#735) Bugfixes: - Avoid mixed content when deploying mono-container behind HTTPS proxy (thetarkus/docker-funkwhale#19) - Display new notifications immediatly on notifications page (#729) - Ensure cover art from uploaded files is picked up properly on existing albums (#757) - Fixed a crash when federating a track with unspecified position - Fixed broken Activity and Actor modules in django admin (#767) - Fixed broken sample apache configuration (#764) - Fixed constant and unpredictable reordering during file upload (#716) - Fixed delivering of local activities causing unintended side effects, such as rollbacking changes (#737) - Fixed escaping issues in translated strings (#652) - Fixed saving moderation policy when clicking on "Cancel" (#751) - i18n: Update page title when changing the App's language. (#511) - Include disc number in Subsonic responses (#765) - Do not send notification when rejecting a follow on a local library (#743) Documentation: - Added documentation on mono-container docker upgrade (#713) - Added documentation to set up let's encrypt certificate (#745)
  • 0.18.2   0.18.2 (2019-02-13) ------------------- Upgrade instructions are available at https://docs.funkwhale.audio/index.html Enhancements: - Added a 'fix_federation_ids' management command to deal with protocol/domain issues in federation IDs after deployments (#706) - Can now use a local file with FUNKWHALE_SPA_HTML_ROOT to avoid sending an HTTP request (#705) Bugfixes: - Downgraded channels dependency to 2.1.6 to fix denied uploads (#697) - Fixed cards display issues on medium/small screens (#707) - Fixed Embed component name that could lead to issue when developping on OSX (#696) - Fixed resizing issues for album cards on artist pages (#694)
  • 0.18.1   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   0.18 "Naomi" (2019-01-22) ------------------------- 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 Upgrade instructions are available at https://docs.funkwhale.audio/index.html, ensure you also execute the intructions marked with ``[manual action required]`` and ``[manual action suggested]``. See ``Full changelog`` below for an exhaustive list of changes! Audio transcoding is back! ^^^^^^^^^^^^^^^^^^^^^^^^^^ 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! 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. Licensing and copyright information ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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. License and copyright data is also broadcasted over federation. License matching is done on the content of the ``License`` tag in the files, with a fallback on the ``Copyright`` tag. Funkwhale will successfully extract licensing data for the following licenses: - Creative Commons 0 (Public Domain) - Creative Commons 1.0 (All declinations) - Creative Commons 2.0 (All declinations) - Creative Commons 2.5 (All declinations and countries) - Creative Commons 3.0 (All declinations and countries) - Creative Commons 4.0 (All declinations) Support for other licenses such as Art Libre or WTFPL will be added in future releases. Instance-level moderation tools ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This release includes a first set of moderation tools that will give more control to admins about the way their instance federate with other instance and accounts on the network. Using these tools, it's now possible to: - Browse known accounts and domains, and associated data (storage size, software version, etc.) - Purge data belonging to given accounts and domains - Block or partially restrict interactions with any account or domain All those features are usable using a brand new "moderation" permission, meaning you can appoints one or nultiple moderators to help with this task. 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! Iframe widget to embed public tracks and albums [manual action required] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Funkwhale now support 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). 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. **On docker setups**, edit your ``/srv/funkwhale/nginx/funkwhale.template`` and replace the ``location /api/`` and `location /` blocks by the following snippets:: location / { include /etc/nginx/funkwhale_proxy.conf; # this is needed if you have file import via upload enabled client_max_body_size ${NGINX_MAX_BODY_SIZE}; proxy_pass http://funkwhale-api/; } location /front/ { alias /frontend/; } The change of configuration will be picked when restarting your nginx container. **On non-docker setups**, edit your ``/etc/nginx/sites-available/funkwhale.conf`` file, and replace the ``location /api/`` and `location /` blocks by the following snippets:: location / { include /etc/nginx/funkwhale_proxy.conf; # this is needed if you have file import via upload enabled client_max_body_size ${NGINX_MAX_BODY_SIZE}; proxy_pass http://funkwhale-api/; } location /front/ { alias ${FUNKWHALE_FRONTEND_PATH}/; } Replace ``${FUNKWHALE_FRONTEND_PATH}`` by the corresponding variable from your .env file, which should be ``/srv/funkwhale/front/dist`` by default, then reload your nginx process with ``sudo systemctl reload nginx``. Alternative docker deployment method ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Thanks to the awesome done by @thetarkus at https://github.com/thetarkus/docker-funkwhale, we're now able to provide an alternative and easier Docker deployment method! 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. Both method 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! Automatically load .env file ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ On non-docker deployments, earlier versions required you to source the config/.env file before launching any Funkwhale command, with ``export $(cat config/.env | grep -v ^# | xargs)`` This led to more complex and error prode deployment / setup. This is not the case anymore, and Funkwhale will automatically load this file if it's available. Delete pre 0.17 federated tracks [manual action suggested] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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. To purge the database of those entries, you can run the following command: On docker setups:: docker-compose run --rm api python manage.py script delete_pre_017_federated_uploads --no-input On non-docker setups:: python manage.py script delete_pre_017_federated_uploads --no-input Enable gzip compression [manual action suggested] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Gzip compression will be enabled on new instances by default and will reduce the amount of bandwidth consumed by your instance. If you with to benefit from gzip compression on your instance, edit your reverse proxy virtualhost file (located at ``/etc/nginx/sites-available/funkwhale.conf``) and add the following snippet in the server block, then reload your nginx server:: server { # ... exiting configuration # compression settings gzip on; gzip_comp_level 5; gzip_min_length 256; gzip_proxied any; gzip_vary on; gzip_types application/atom+xml application/javascript application/json application/ld+json application/activity+json application/manifest+json application/rss+xml application/vnd.geo+json application/vnd.ms-fontobject application/x-font-ttf application/x-web-app-manifest+json application/xhtml+xml application/xml 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; # end of compression settings } Full changelog ^^^^^^^^^^^^^^ Features: - Allow embedding of albums and tracks available in public libraries via an <iframe> (#578) - Audio transcoding is back! (#272) - First set of instance level moderation tools (#580, !521) - Store licensing and copyright information from file metadata, if available (#308) Enhancements: - Add UI elements for multi-disc albums (#631) - Added alternative funkwhale/all-in-one docker image (#614) - Broadcast library updates (name, description, visibility) over federation - Based Docker image on alpine to have a smaller (and faster to build) image - Improved front-end performance by stripping unused dependencies, reducing bundle size and enabling gzip compression - Improved accessibility by using main/section/nav tags and aria-labels in most critical places (#612) - The progress bar in the player now display loading state / buffer loading (#586) - Added "type: funkwhale" and "funkwhale-version" in Subsonic responses (#573) - Documented keyboard shortcuts, list is now available by pressing "h" or in the footer (#611) - Documented which Subsonic endpoints are implemented (#575) - Hide invitation code field during signup when it's not required (#410) - Importer will now pick embedded images in files with OTHER type if no COVER_FRONT is present - Improved keyboard accessibility on player, queue and various controls (#576) - Improved performance when listing playable tracks, albums and artists - Increased default upload limit from 30 to 100MB (#654) - Load env file in config/.env automatically to avoid sourcing it by hand (#626) - More resilient date parsing during audio import, will not crash anymore on invalid dates (#622) - Now start radios immediatly, skipping any existing tracks in queue (#585) - Officially support connecting to a password protected redis server, with the redis://:password@localhost:6379/0 scheme (#640) - Performance improvement when fetching favorites, down to a single, small http request - Removed "Activity" page, since all the data is available on the "Browse" page (#600) - Removed the need to specify the DJANGO_ALLOWED_HOSTS variable - Restructured the footer, added useful links and removed unused content - Show short entries first in search results to improve UX - Store disc number and order tracks by disc number / position) (#507) - Strip EXIF metadata from uploaded avatars to avoid leaking private data (#374) - Support blind key rotation in HTTP Signatures (#658) - Support setting a server URL in settings.json (#650) - Updated default docker postgres version from 9.4 to 11 (#656) - Updated lots of dependencies (especially django 2.0->2.1), and removed unused dependencies (#657) - Improved test suite speed by reducing / disabling expensive operations (#648) Bugfixes: - Fixed parsing of embedded file cover for ogg files tagged with MusicBrainz (#469) - Upgraded core dependencies to fix websocket/messaging issues and possible memory leaks (#643) - Fix ".None" extension when downloading Flac file (#473) - Fixed None extension when downloading an in-place imported file (#621) - Added a script to prune pre 0.17 federated tracks (#564) - Advertise public libraries properly in ActivityPub representations (#553) - Allow opus file upload (#598) - Do not display "view on MusicBrainz" button if we miss the mbid (#422) - Do not try to create unaccent extension if it's already present (#663) - Ensure admin links in sidebar are displayed for users with relavant permissions, and only them (#597) - Fix broken websocket connexion under Chrome browser (#589) - Fix play button not starting playback with empty queue (#632) - Fixed a styling inconsistency on about page when instance description was missing (#659) - Fixed a UI discrepency in playlist tracks count (#647) - Fixed greyed tracks in radio builder and detail page (#637) - Fixed inconsistencies in subsonic error responses (#616) - Fixed incorrect icon for "next track" in player control (#613) - Fixed malformed search string when redirecting to LyricsWiki (#608) - Fixed missing track count on various library cards (#581) - Fixed skipped track when appending multiple tracks to the queue under certain conditions (#209) - Fixed wrong album/track count on artist page (#599) - Hide unplayable/emtpy playlists in "Browse playlist" pages (#424) - Initial UI render using correct language from browser (#644) - Invalid URI for reverse proxy websocket with apache (#617) - Properly encode Wikipedia and lyrics search urls (#470) - Refresh profile after user settings update to avoid cache issues (#606) - Use role=button instead of empty links for player controls (#610) Documentation: - Deploy documentation from the master branch instead of the develop branch to avoid inconsistencies (#642) - Document how to find and use library id when importing files in CLI (#562) - Fix documentation typos (#645)
  • 0.17   0.17 (2018-10-07) ----------------- Per user libraries ^^^^^^^^^^^^^^^^^^ 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. Features: - Per user libraries (#463, also fixes #160 and #147) - Authentication using a LDAP directory (#194) Enhancements: - Add configuration option to set Musicbrainz hostname - Add sign up link in the sidebar (#408) - Added a library widget to display libraries associated with a track, album and artist (#551) - Ensure from_activity field is not required in django's admin (#546) - Move setting link from profile page to the sidebar (#406) - Simplified and less error-prone nginx setup (#358) Bugfixes: - Do not restart current song when rordering queue, deleting tracks from queue or adding tracks to queue (#464) - Fix broken icons in playlist editor (#515) - Fixed a few untranslated strings (#559) - Fixed splitted album when importing from federation (#346) - Fixed toggle mute in volume bar does not restore previous volume level (#514) - Fixed wrong env file URL and display bugs in deployment documentation (#520) - Fixed wrong title in PlayButton (#435) - Remove transparency on artist page button (#517) - Set sane width default for ui cards and center play button (#530) - Updated wrong icon and copy in play button dropdown (#436) Documentation: - Fixed wrong URLs for docker / nginx files in documentation (#537) Other: - Added a merge request template and more documentation about the changelog Using a LDAP directory to authenticate to your Funkwhale instance ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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. You can use this authentication backend side by side with the classic one. Have a look at https://docs.funkwhale.audio/installation/ldap.html for detailed instructions on how to set this up. Simplified nginx setup [Docker: Manual action required] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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. 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. On non-docker instances, you have nothing to do. If you have a dockerized instance, here is the upgrade path. First, tweak your .env file:: # remove the FUNKWHALE_URL variable # and add the next variables FUNKWHALE_HOSTNAME=yourdomain.funkwhale FUNKWHALE_PROTOCOL=https # add the following variable, matching the path your app is deployed # leaving the default should work fine if you deployed using the same # paths as the documentation FUNKWHALE_FRONTEND_PATH=/srv/funkwhale/front/dist Then, add the following block at the end of your docker-compose.yml file:: # existing services api: ... celeryworker: ... # new service nginx: image: nginx env_file: - .env environment: # Override those variables in your .env file if needed - "NGINX_MAX_BODY_SIZE=${NGINX_MAX_BODY_SIZE-30M}" volumes: - "./nginx/funkwhale.template:/etc/nginx/conf.d/funkwhale.template:ro" - "./nginx/funkwhale_proxy.conf:/etc/nginx/funkwhale_proxy.conf:ro" - "${MUSIC_DIRECTORY_SERVE_PATH-/srv/funkwhale/data/music}:${MUSIC_DIRECTORY_SERVE_PATH-/srv/funkwhale/data/music}:ro" - "${MEDIA_ROOT}:${MEDIA_ROOT}:ro" - "${STATIC_ROOT}:${STATIC_ROOT}:ro" - "${FUNKWHALE_FRONTEND_PATH}:/frontend:ro" ports: # override those variables in your .env file if needed - "${FUNKWHALE_API_IP}:${FUNKWHALE_API_PORT}:80" command: > sh -c "envsubst \"`env | awk -F = '{printf \" $$%s\", $$1}'`\" < /etc/nginx/conf.d/funkwhale.template > /etc/nginx/conf.d/default.conf && cat /etc/nginx/conf.d/default.conf && nginx -g 'daemon off;'" links: - api By doing that, you'll enable a dockerized nginx that will automatically be configured to serve your Funkwhale instance. Download the required configuration files for the nginx container: .. parsed-literal:: cd /srv/funkwhale mkdir nginx curl -L -o nginx/funkwhale.template "https://code.eliotberriot.com/funkwhale/funkwhale/raw/|version|/deploy/docker.nginx.template" curl -L -o nginx/funkwhale_proxy.conf "https://code.eliotberriot.com/funkwhale/funkwhale/raw/|version|/deploy/funkwhale_proxy.conf" Update the funkwhale.conf configuration of your server's reverse-proxy:: # the file should match something like that, upgrade all variables # between ${} to match the ones in your .env file, # and your SSL configuration if you're not using let's encrypt # The important thing is that you only have a single location block # that proxies everything to your dockerized nginx. sudo nano /etc/nginx/sites-enabled/funkwhale.conf upstream fw { # depending on your setup, you may want to update this server ${FUNKWHALE_API_IP}:${FUNKWHALE_API_PORT}; } map $http_upgrade $connection_upgrade { default upgrade; '' close; } server { listen 80; listen [::]:80; server_name ${FUNKWHALE_HOSTNAME}; location / { return 301 https://$host$request_uri; } } server { listen 443 ssl; listen [::]:443 ssl; server_name ${FUNKWHALE_HOSTNAME}; # TLS ssl_protocols TLSv1.2; ssl_ciphers HIGH:!MEDIUM:!LOW:!aNULL:!NULL:!SHA; ssl_prefer_server_ciphers on; ssl_session_cache shared:SSL:10m; ssl_certificate /etc/letsencrypt/live/${FUNKWHALE_HOSTNAME}/fullchain.pem; ssl_certificate_key /etc/letsencrypt/live/${FUNKWHALE_HOSTNAME}/privkey.pem; # HSTS add_header Strict-Transport-Security "max-age=31536000"; location / { include /etc/nginx/funkwhale_proxy.conf; proxy_pass http://fw/; } } Check that your configuration is valid then reload: sudo nginx -t sudo systemctl reload nginx
  • 0.16.3   0.16.3 (2018-08-21) ------------------- Upgrade instructions are available at https://docs.funkwhale.audio/upgrading.html Bugfixes: - Fixed front-end not contacting the proper path on the API (!385)