Merge branch 'wssApache' into 'develop'

Updated apache2 conf file for websockets

See merge request funkwhale/funkwhale!252

changes/changelog.d/252.enhancement

@@ -0,0 +1,15 @@
+Apache2 reverse proxy now supports websockets (tested with Apache 2.4.25) (!252)
+
+Apache support for websocket
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Add this at the beginning of your Apache configuration file::
+
+    Define funkwhale-api-ws ws://localhost:5000
+
+Add this to your Apache configuration file, before the "/api" block::
+
+    # Activating WebSockets
+    ProxyPass "/api/v1/instance/activity" ${funkwhale-api-ws}/api/v1/instance/activity
+
+Websockets may not be supported in older versions of Apache2. Be sure to upgrade to the latest version available.

deploy/apache.conf

@@ -4,10 +4,8 @@ Define funkwhale-sn funkwhale.yourdomain.com
 # Following variables should be modified according to your setup and if you
 # use different configuration than what is described in our installation guide.
 Define funkwhale-api http://localhost:5000
+Define funkwhale-api-ws ws://localhost:5000
 Define MUSIC_DIRECTORY_PATH /srv/funkwhale/data/music
-# websockets are not working yet
-# Define funkwhale-api-ws ws://localhost:5000
-
 
 # HTTP requests redirected to HTTPS
 <VirtualHost *:80>
@@ -70,8 +68,8 @@ Define MUSIC_DIRECTORY_PATH /srv/funkwhale/data/music
       Allow from all
    </Proxy>
 
-   # Activating WebSockets (not working)
-   # ProxyPass "/api/v1/instance/activity"  "ws://localhost:5000/api/v1/instance/activity"
+   # Activating WebSockets
+   ProxyPass "/api/v1/instance/activity"  ${funkwhale-api-ws}/api/v1/instance/activity
 
    <Location "/api">
       # similar to nginx 'client_max_body_size 30M;'

docs/installation/index.rst

@@ -124,15 +124,6 @@ If everything is fine, you can restart your nginx server with ``service nginx re
 Apache2
 ^^^^^^^
 
-.. note::
-
-    Apache2 support is still very recent and the following features
-    are not working yet:
-
-    - Websocket (used for real-time updates on Instance timeline)
-
-    Those features are not necessary to use your Funkwhale instance.
-
 Ensure you have a recent version of apache2 installed on your server.
 You'll also need the following dependencies::