Merge tag '0.11' into develop

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.

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)
 -----------------
 

api/config/settings/common.py

@@ -172,6 +172,18 @@ FIXTURE_DIRS = (
 
 # EMAIL CONFIGURATION
 # ------------------------------------------------------------------------------
+
+# EMAIL
+# ------------------------------------------------------------------------------
+DEFAULT_FROM_EMAIL = env(
+    'DEFAULT_FROM_EMAIL',
+    default='Funkwhale <noreply@{}>'.format(FUNKWHALE_HOSTNAME))
+
+EMAIL_SUBJECT_PREFIX = env(
+    "EMAIL_SUBJECT_PREFIX", default='[Funkwhale] ')
+SERVER_EMAIL = env('SERVER_EMAIL', default=DEFAULT_FROM_EMAIL)
+
+
 EMAIL_CONFIG = env.email_url(
     'EMAIL_CONFIG', default='consolemail://')
 

api/config/settings/production.py

@@ -68,16 +68,6 @@ DEFAULT_FILE_STORAGE = 'django.core.files.storage.FileSystemStorage'
 # ------------------------
 STATICFILES_STORAGE = 'django.contrib.staticfiles.storage.StaticFilesStorage'
 
-
-# EMAIL
-# ------------------------------------------------------------------------------
-DEFAULT_FROM_EMAIL = env('DJANGO_DEFAULT_FROM_EMAIL',
-                         default='funkwhale_api <noreply@funkwhale.io>')
-
-EMAIL_SUBJECT_PREFIX = env("DJANGO_EMAIL_SUBJECT_PREFIX", default='[funkwhale_api] ')
-SERVER_EMAIL = env('DJANGO_SERVER_EMAIL', default=DEFAULT_FROM_EMAIL)
-
-
 # TEMPLATE CONFIGURATION
 # ------------------------------------------------------------------------------
 # See:

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('.')])

changes/changelog.d/109.enhancement

@@ -1 +0,0 @@
-List pending requests by default, added a status filter for requests (#109)

changes/changelog.d/176.enhancement

@@ -1 +0,0 @@
-Can now relaunch errored jobs and batches (#176)

changes/changelog.d/178.doc

@@ -1 +0,0 @@
-Foundations for API documentation with Swagger (#178)

changes/changelog.d/180.doc

@@ -1 +0,0 @@
-Added a documentation area for third-party projects (#180)

changes/changelog.d/182.bugfix

@@ -1 +0,0 @@
-X-sendfile not working with in place import (#182)

changes/changelog.d/183.bugfix

@@ -1 +0,0 @@
-Ensure in place imported files get a proper mimetype (#183)

changes/changelog.d/183.enhancement

@@ -1 +0,0 @@
-Added a fix_track_files command to run checks and fixes against library (#183)

changes/changelog.d/184.bugfix

@@ -1 +0,0 @@
-Fixed small UI glitches/bugs in federation tabs (#184)

changes/changelog.d/185.doc

@@ -1 +0,0 @@
-Document that the database should use an utf-8 encoding (#185)

changes/changelog.d/186.enhancement

@@ -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.

changes/changelog.d/187.feature

@@ -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.

changes/changelog.d/189.bugfix

@@ -1 +0,0 @@
-Federation cache suppression is now simpler and also deletes orphaned files (#189)

changes/changelog.d/actor-fetch.enhancement

@@ -1 +0,0 @@
-Avoid fetching Actor object on every request authentication

changes/changelog.d/apache.enhancement

@@ -1 +0,0 @@
-Sample virtual-host file for Apache2 reverse-proxy (!165)

changes/changelog.d/optimization.doc

@@ -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.

changes/changelog.d/sidebar.enhancement

@@ -1 +0,0 @@
-More structured menus in sidebar, added labels with notifications

deploy/env.prod.sample

@@ -6,7 +6,7 @@
 # - DJANGO_SECRET_KEY
 # - DJANGO_ALLOWED_HOSTS
 # - FUNKWHALE_URL
-# - EMAIL_CONFIG (if you plan to send emails)
+# - EMAIL_CONFIG and DEFAULT_FROM_EMAIL if you plan to send emails)
 # On non-docker setup **only**, you'll also have to tweak/uncomment those variables:
 # - DATABASE_URL
 # - CACHE_URL
@@ -52,6 +52,9 @@ FUNKWHALE_URL=https://yourdomain.funwhale
 # EMAIL_CONFIG=smtp+ssl://user@:password@youremail.host:465'
 # EMAIL_CONFIG=smtp+tls://user@:password@youremail.host:587'
 
+# The email address to use to send systme emails. By default, we will
+# DEFAULT_FROM_EMAIL=noreply@yourdomain
+
 # Depending on the reverse proxy used in front of your funkwhale instance,
 # the API will use different kind of headers to serve audio files
 # Allowed values: nginx, apache2

docs/configuration.rst

@@ -56,6 +56,20 @@ Possible values:
 - ``smtp+ssl://user:password@youremail.host:465``: Send emails via SMTP via youremail.host on port 465, using SSL encryption, authenticating as user "user" with password "password"
 - ``smtp+tls://user:password@youremail.host:587``: Send emails via SMTP via youremail.host on port 587, using TLS encryption, authenticating as user "user" with password "password"
 
+.. _setting-DEFAULT_FROM_EMAIL:
+
+``DEFAULT_FROM_EMAIL``
+^^^^^^^^^^^^^^^^^^^^^^
+
+The email address to use to send email.
+
+Default: ``Funkwhale <noreply@yourdomain>``
+
+.. note::
+
+    Both the forms ``Funkwhale <noreply@yourdomain>`` and
+    ``noreply@yourdomain`` work.
+
 
 .. _setting-MUSIC_DIRECTORY_PATH: