From 60412ad51aa9e285dbb87c07a8f13a4a3796fb6d Mon Sep 17 00:00:00 2001
From: Eliot Berriot <contact@eliotberriot.com>
Date: Wed, 9 May 2018 23:19:58 +0200
Subject: [PATCH] Fix #75: changelog
---
changes/changelog.d/75.feature | 43 ++++++++++++++++++++++++++++++++++
1 file changed, 43 insertions(+)
create mode 100644 changes/changelog.d/75.feature
diff --git a/changes/changelog.d/75.feature b/changes/changelog.d/75.feature
new file mode 100644
index 00000000..e603b081
--- /dev/null
+++ b/changes/changelog.d/75.feature
@@ -0,0 +1,43 @@
+Subsonic API implementation to offer compatibility with existing clients such as DSub (#75)
+
+Subsonic API
+^^^^^^^^^^^^
+
+This release implements some core parts of the Subsonic API, which is widely
+deployed in various projects and supported by numerous clients.
+
+By offering this API in Funkwhale, we make it possible to access the instance
+library and listen to the music without from existing Subsonic clients, and
+without developping our own alternative clients for each and every platform.
+
+Most advanced Subsonic clients support offline caching of music files,
+playlist management and search, which makes them well-suited for nomadic use.
+
+Please head over :doc:`users/apps` for more informations about supported clients
+and user instructions.
+
+At the instance-level, the Subsonic API is enabled by default, but require
+and additional endpoint to be added in you reverse-proxy configuration.
+
+On nginx, add the following block::
+
+ location /rest/ {
+ include /etc/nginx/funkwhale_proxy.conf;
+ proxy_pass http://funkwhale-api/api/subsonic/rest/;
+ }
+
+On Apache, add the following block::
+
+ <Location "/rest">
+ ProxyPass ${funkwhale-api}/api/subsonic/rest
+ ProxyPassReverse ${funkwhale-api}/api/subsonic/rest
+ </Location>
+
+The Subsonic can be disabled at the instance level from the django admin.
+
+.. note::
+
+ Because of Subsonic's API design which assumes cleartext storing of
+ user passwords, we chose to have a dedicated, separate password
+ for that purpose. Users can generate this password from their
+ settings page in the web client.
--
GitLab