MirrorMirror
/
funkwhale
mirror of https://dev.funkwhale.audio/funkwhale/funkwhale.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge tag '0.8' into develop 

0.8 (2018-04-02)
----------------

Features:

- Add a detail page for radios (#64)
- Implemented page title binding (#1)
- Previous Track button restart playback after 3 seconds (#146)

Enhancements:

- Added credits to Francis Gading for the logotype (#101)
- API endpoint for fetching instance activity and updated timeline to use this
  new endpoint (#141)
- Better error messages in case of missing environment variables (#140)
- Implemented a @test@yourfunkwhaledomain bot to ensure federation works
  properly. Send it "/ping" and it will answer back :)
- Queue shuffle now apply only to tracks after the current one (#97)
- Removed player from queue tab and consistently show current track in queue
  (#131)
- We now restrict some usernames from being used during signup (#139)

Bugfixes:

- Better error handling during file import (#120)
- Better handling of utf-8 filenames during file import (#138)
- Converted favicon from .ico to .png (#130)
- Upgraded to Python 3.6 to fix weird but harmless weakref error on django task
  (#121)

Documentation:

- Documented the upgrade process (#127)

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

Federation of music libraries is one of the most asked feature.
While there is still a lot of work to do, this version includes
the foundation that will enable funkwhale servers to communicate
between each others, and with other federated software, such as
Mastodon.

Funkwhale will use ActivityPub as it's federation protocol.

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
    docker-compose run --rm api python manage.py generate_keys --no-input

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

To test and troobleshoot federation, we've added a bot account. This bot is available at @test@yourinstancedomain,
and sending it "/ping", for example, via Mastodon, should trigger
a response.
This commit is contained in:
Eliot Berriot 2018-04-02 20:05:09 +02:00
parent 28700270bd 78d0de0e7d
commit fba9a5c97e
No known key found for this signature in database
GPG Key ID: DD6965E2476E5C27
17 changed files with 54 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
CHANGELOG
View File

@ -3,11 +3,55 @@ Changelog
.. towncrier
Release notes:
0.8 (2018-04-02)
----------------
Features:
- Add a detail page for radios (#64)
- Implemented page title binding (#1)
- Previous Track button restart playback after 3 seconds (#146)
Enhancements:
- Added credits to Francis Gading for the logotype (#101)
- API endpoint for fetching instance activity and updated timeline to use this
new endpoint (#141)
- Better error messages in case of missing environment variables (#140)
- Implemented a @test@yourfunkwhaledomain bot to ensure federation works
properly. Send it "/ping" and it will answer back :)
- Queue shuffle now apply only to tracks after the current one (#97)
- Removed player from queue tab and consistently show current track in queue
(#131)
- We now restrict some usernames from being used during signup (#139)
Bugfixes:
- Better error handling during file import (#120)
- Better handling of utf-8 filenames during file import (#138)
- Converted favicon from .ico to .png (#130)
- Upgraded to Python 3.6 to fix weird but harmless weakref error on django task
(#121)
Documentation:
- Documented the upgrade process (#127)
Preparing for federation
^^^^^^^^^^^^^^^^^^^^^^^^
Federation of music libraries is one of the most asked feature.
While there is still a lot of work to do, this version includes
the foundation that will enable funkwhale servers to communicate
between each others, and with other federated software, such as
Mastodon.
Funkwhale will use ActivityPub as it's federation protocol.
In order to prepare for federation (see #136 and #137), new API endpoints
have been added under /federation and /.well-known/webfinger.
@ -47,7 +91,10 @@ your instance requests on the federation. This can be done via::
source /srv/funkwhale/load_env
python manage.py generate_keys --no-input
That's it :)
To test and troobleshoot federation, we've added a bot account. This bot is available at @test@yourinstancedomain,
and sending it "/ping", for example, via Mastodon, should trigger
a response.
0.7 (2018-03-21)

1
changes/changelog.d/1.feature
View File

@ -1 +0,0 @@
Implemented page title binding (#1)

1
changes/changelog.d/101.enhancement
View File

@ -1 +0,0 @@
Added credits to Francis Gading for the logotype (#101)

1
changes/changelog.d/120.bugfix
View File

@ -1 +0,0 @@
Better error handling during file import (#120)

1
changes/changelog.d/121.bugfix
View File

@ -1 +0,0 @@
Upgraded to Python 3.6 to fix weird but harmless weakref error on django task (#121)

0
changes/changelog.d/127.doc
View File

1
changes/changelog.d/130.bugfix
View File

@ -1 +0,0 @@
Converted favicon from .ico to .png (#130)

1
changes/changelog.d/131.enhancement
View File

@ -1 +0,0 @@
Removed player from queue tab and consistently show current track in queue (#131)

1
changes/changelog.d/138.bugfix
View File

@ -1 +0,0 @@
Better handling of utf-8 filenames during file import (#138)

1
changes/changelog.d/139.enhancement
View File

@ -1 +0,0 @@
We now restrict some usernames from being used during signup (#139)

1
changes/changelog.d/140.enhancement
View File

@ -1 +0,0 @@
Better error messages in case of missing environment variables (#140)

2
changes/changelog.d/141.enhancement
View File

@ -1,2 +0,0 @@
API endpoint for fetching instance activity and updated timeline to use this new
endpoint (#141)

1
changes/changelog.d/146.feature
View File

@ -1 +0,0 @@
Previous Track button restart playback after 3 seconds (#146)

1
changes/changelog.d/64.feature
View File

@ -1 +0,0 @@
Add a detail page for radios (#64)

1
changes/changelog.d/97.enhancement
View File

@ -1 +0,0 @@
Queue shuffle now apply only to tracks after the current one (#97)

1
changes/changelog.d/test-bot.enhancement
View File

@ -1 +0,0 @@
Implemented a @test@yourfunkwhaledomain bot to ensure federation works properly. Send it "/ping" and it will answer back :)

5
pyproject.toml
View File

@ -17,6 +17,11 @@
name = "Features"
showcontent = true
[[tool.towncrier.type]]
directory = "enhancement"
name = "Enhancements"
showcontent = true
[[tool.towncrier.type]]
directory = "bugfix"
name = "Bugfixes"