CHANGELOG 11.4 KB
Newer Older
1 2 3
Changelog
=========

4
.. towncrier
5

6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
Release notes:

Preparing for federation
^^^^^^^^^^^^^^^^^^^^^^^^

In order to prepare for federation (see #136 and #137), new API endpoints
have been added under /federation and /.well-known/webfinger.

For these endpoints to work, you will need to update your nginx configuration,
and add the following snippets::

    location /federation/ {
        include /etc/nginx/funkwhale_proxy.conf;
        proxy_pass   http://funkwhale-api/federation/;
    }

    location /.well-known/webfinger {
        include /etc/nginx/funkwhale_proxy.conf;
        proxy_pass   http://funkwhale-api/.well-known/webfinger;
    }

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.

A new ``FEDERATION_ENABLED`` env var have also been added to control wether
federation is enabled or not on the application side. This settings defaults
to True, which should have no consequencies at the moment, since actual
federation is not implemented and the only available endpoints are for
testing purposes.

Add ``FEDERATION_ENABLED=false`` to your .env file to disable federation
on the application side.

The last step involves generating RSA private and public keys for signing
your instance requests on the federation. This can be done via::

    # on docker setups
Agate's avatar
Agate committed
43
    docker-compose run --rm api python manage.py generate_keys --no-input
44 45 46 47 48 49 50 51 52

    # on non-docker setups
    source /srv/funkwhale/virtualenv/bin/activate
    source /srv/funkwhale/load_env
    python manage.py generate_keys --no-input

That's it :)


Agate's avatar
Agate committed
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
0.7 (2018-03-21)
----------------

Features:

- Can now filter artists and albums with no listenable tracks (#114)
- Improve the style of the sidebar to make it easier to understand which tab is
  selected (#118)
- On artist page, albums are not sorted by release date, if any (#116)
- Playlists are here \o/ :tada: (#3, #93, #94)
- Use django-cacheops to cache common ORM requests (#117)


Bugfixes:

- Fixed broken import request admin (#115)
- Fixed forced redirection to login event with
  API_AUTHENTICATION_REQUIRED=False (#119)
- Fixed position not being reseted properly when playing the same track
  multiple times in a row
- Fixed synchronized start/stop radio buttons for all custom radios (#103)
- Fixed typo and missing icon on homepage (#96)


Documentation:

- Up-to-date and complete development and contribution instructions in
  README.rst (#123)


0.6.1 (2018-03-06)
Agate's avatar
Agate committed
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
------------------

Features:

- Can now skip acoustid on file import with the --no-acoustid flag (#111)


Bugfixes:

- Added missing batch id in output during import (#112)
- Added some feedback on the play button (#100)
- Smarter pagination which takes a fixed size (#84)


Other:

- Completely removed django-cachalot from the codebase (#110). You can safely
  remove the CACHALOT_ENABLED setting from your .env file


Agate's avatar
Agate committed
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
0.6 (2018-03-04)
----------------

Features:

- Basic activity stream for listening and favorites (#23)
- Switched to django-channels and daphne for serving HTTP and websocket (#34)

Upgrades notes
**************

This version contains breaking changes in the way funkwhale is deployed,
please read the notes carefully.

Instance timeline
^^^^^^^^^^^^^^^^^

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.

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.

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.

The setting form is available in your profile.

Switch from gunicorn to daphne
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.

This replaces gunicorn and the switch should be easy assuming you
follow the upgrade process described bellow.

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:

.. code-block:: yaml

    api:
      restart: unless-stopped
      image: funkwhale/funkwhale:${FUNKWHALE_VERSION:-latest}
      command: ./compose/django/gunicorn.sh  # You can remove this line

On non docker setups, you'll have to update the [Service] block of your
funkwhale-server systemd unit file to launch the application server using daphne instead of gunicorn.

The new configuration should be similar to this:

.. code-block:: ini

    [Service]
    User=funkwhale
    # adapt this depending on the path of your funkwhale installation
    WorkingDirectory=/srv/funkwhale/api
    EnvironmentFile=/srv/funkwhale/config/.env
    ExecStart=/usr/local/bin/daphne -b ${FUNKWHALE_API_IP} -p ${FUNKWHALE_API_PORT} config.asgi:application

Ensure you update funkwhale's dependencies as usual to install the required
packages.

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:

.. code-block:: txt

    map $http_upgrade $connection_upgrade {
        default upgrade;
        ''      close;
    }

    server {
        ...
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection $connection_upgrade;
    }

Remember to reload your nginx server after the edit.


Agate's avatar
Agate committed
195 196 197 198 199 200 201 202 203 204 205 206 207
0.5.4 (2018-02-28)
------------------

Features:

- Now stop running radio when clearing queue (#98)

Bugfixes:

- Fixed queue skipping tracks (#91)
- Now loop properly on queue when we only have one track (#95)


Agate's avatar
Agate committed
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
0.5.3 (2018-02-27)
------------------

Features:

- Added admin interface for radios, track files, favorites and import requests (#80)
- Added basic instance stats on /about (#82)
- Search now unaccent letters for queries like "The Dø" or "Björk" yielding more results (#81)


Bugfixes:

- Always use username in sidebar (#89)
- Click event outside of player icons (#83)
- Fixed broken import because of missing transaction
- Now always load next radio track on last queue track ended (#87)
- Now exclude tracks without file from radio candidates (#88)
- skip to next track properly on 40X errors (#86)


Other:

- Switched to towncrier for changelog management and compilation

Agate's avatar
Agate committed
232 233 234 235

0.5.2 (2018-02-26)
------------------

Agate's avatar
Agate committed
236 237
- Fixed broken file import due to wrong url (#73)
- More accurate mimetype detection
Agate's avatar
Agate committed
238 239
- Fixed really small size on small screens
- Added masonry layout for artists, requests and radios (#68)
Agate's avatar
Agate committed
240
- We now have a favicon!
Agate's avatar
Agate committed
241
- Fixed truncated play icon (#65)
Agate's avatar
Agate committed
242

Agate's avatar
Agate committed
243 244 245 246

0.5.1 (2018-02-24)
------------------

247
- Front: Fixed broken ajax call on radio builder (#69)
248
- Front: Shuffle now restart next track from beginning (#70)
249
- Front: volume slider should now have the same style everywhere (#72)
Agate's avatar
Agate committed
250

Agate's avatar
Agate committed
251

Agate's avatar
Agate committed
252
0.5 (2018-02-24)
Agate's avatar
Agate committed
253 254
----------------

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

Agate's avatar
Agate committed
262 263 264 265 266
About page:

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

Agate's avatar
Agate committed
267 268 269 270 271 272 273 274 275 276 277 278
Transcoding:

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

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

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

On the frontend, usage of transcoding should be transparent in the player.
Agate's avatar
Agate committed
279

Agate's avatar
Agate committed
280 281 282 283 284 285 286
Music Requests:

This release includes a new feature, music requests, which allows users
to request music they'd like to see imported.
Admins can browse those requests and mark them as completed when
an import is made.

Agate's avatar
Agate committed
287 288
0.4 (2018-02-18)
----------------
Agate's avatar
Agate committed
289

Agate's avatar
Agate committed
290 291
- Front: ambiant colors in player based on current track cover (#59)
- Front: simplified front dev setup thanks to webpack proxy (#59)
292 293
- Front: added some unittests for the store (#55)
- Front: fixed broken login redirection when 401
Agate's avatar
Agate committed
294
- Front: Removed autoplay on page reload
295 296 297 298 299
- API: Added a /instance/settings endpoint
- Front: load /instance/settings on page load
- 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)
300

Agate's avatar
Agate committed
301

Agate's avatar
Agate committed
302 303 304 305 306 307
0.3.5 (2018-01-07)
------------------

- Smarter BACKEND_URL in frontend


Agate's avatar
Agate committed
308
0.3.4 (2018-01-07)
309 310 311
------------------

- Fixed wrong URL construction in ajax call
Agate's avatar
Agate committed
312 313


Agate's avatar
Agate committed
314
0.3.3 (2018-01-07)
Agate's avatar
Agate committed
315 316
------------------

Agate's avatar
Agate committed
317 318
- Users can now create their own dynamic radios (#51)

319

Agate's avatar
Agate committed
320 321 322 323 324 325
0.3.2
------------------

- Fixed an issue in the main dockerfile


Agate's avatar
Agate committed
326
0.3.1
Agate's avatar
Agate committed
327 328 329 330 331 332 333 334
------------------

- Revamped all import logic, everything is more tested and consistend
- Can now use Acoustid in file imports to automatically grab metadata from musicbrainz
- Brand new file import wizard


0.2.7
Agate's avatar
Agate committed
335 336
------------------

337 338 339
- Shortcuts: can now use the ``f`` shortcut to toggle the currently playing track
  as a favorite (#53)
- Shortcuts: avoid collisions between shortcuts by using the exact modifier (#53)
Agate's avatar
Agate committed
340
- Player: Added looping controls and shortcuts (#52)
Agate's avatar
Agate committed
341
- Player: Added shuffling controls and shortcuts (#52)
Agate's avatar
Agate committed
342 343
- Favorites: can now modify the ordering of track list (#50)
- Library: can now search/reorder results on artist browsing view (#50)
Agate's avatar
Agate committed
344 345 346 347 348 349 350 351 352 353 354 355
- Upgraded celery to 4.1, added endpoint logic for fingerprinting audio files
- Fixed #56: invalidate tokens on password change, also added change password form
- Fixed #57: now refresh jwt token on page refresh
- removed ugly dividers in batch import list
- Fixed a few padding issues
- Now persist/restore queue/radio/player state automatically
- Removed old broken imports
- Now force tests paths
- Fixed #54: Now use pytest everywhere \o/
- Now use vuex to manage state for favorites
- Now use vuex to manage state for authentication
- Now use vuex to manage state for player/queue/radios
356

Agate's avatar
Agate committed
357

Agate's avatar
Agate committed
358 359 360 361 362
0.2.6 (2017-12-15)
------------------

- Fixed broken Dockerfile

Agate's avatar
Agate committed
363 364

0.2.5 (2017-12-15)
Agate's avatar
Agate committed
365 366
------------------

367 368
Features:

369
- Import: can now specify search template when querying import sources (#45)
370
- Login form: now redirect to previous page after login (#2)
Agate's avatar
Agate committed
371
- 404: a decent 404 template, at least (#48)
372

373 374 375 376 377
Bugfixes:

- Player: better handling of errors when fetching the audio file (#46)
- Csrf: default CSRF_TRUSTED_ORIGINS to ALLOWED_HOSTS to avoid Csrf issues on admin (#49)

Agate's avatar
Agate committed
378 379 380 381
Tech:

- Django 2 compatibility, lot of packages upgrades (#47)

Agate's avatar
Agate committed
382 383

0.2.4 (2017-12-14)
384 385
------------------

386 387 388
Features:

- Models: now store relese group mbid on Album model (#7)
389
- Models: now bind import job to track files (#44)
390 391 392 393

Bugfixes:

- Library: fixen broken "play all albums" button on artist cards in Artist browsing view (#43)