Merge branch 'develop' into 'develop'

Spelling corrections, user guides for apps

See merge request funkwhale/funkwhale!608

docs/developers/index.rst

@@ -0,0 +1,15 @@
+Developer documentation
+=========================
+
+This documentation is targeted primarily at developers who want to understand
+how Funkwhale works and how to build apps that integrate with Funkwhale's ecosystem.
+
+Reference
+---------
+
+.. toctree::
+   :maxdepth: 2
+
+   ../api
+   ../federation/index
+   subsonic

docs/developpers/index.rst

@@ -1,15 +0,0 @@
-Developpers documentation
-=========================
-
-This documentation is targeted primarily at developpers who want to understand
-how Funkwhale work and how to build apps that integrate with Funkwhale's ecosystem.
-
-Reference
----------
-
-.. toctree::
-   :maxdepth: 2
-
-   ../api
-   ../federation/index
-   subsonic

docs/index.rst

@@ -19,7 +19,7 @@ Funkwhale is a self-hosted, modern free and open-source music server, heavily in
    configuration
    troubleshooting
    importing-music
-   developpers/index
+   developers/index
    third-party
    contributing
    translators

docs/installation/index.rst

@@ -154,7 +154,7 @@ On docker deployments, run the following commands:
 
     export FUNKWHALE_VERSION="|version|"
     # download the needed files
-    curl -L -o /etc/nginx/funkwhale_proxy.conf "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/|version|/deploy/funkwhale_proxy.conf"
+    curl -L -o /etc/nginx/funkwhale_proxy.conf "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/|version|/deploy/docker.funkwhale_proxy.conf"
     curl -L -o /etc/nginx/sites-available/funkwhale.template "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/|version|/deploy/docker.proxy.template"
 
 .. code-block:: shell

docs/users/apps.rst

@@ -69,13 +69,19 @@ Ultrasonic (Android)
 - Google Play: https://play.google.com/store/apps/details?id=org.moire.ultrasonic
 - Sources: https://github.com/ultrasonic/ultrasonic
 
-
 Ultrasonic is a full-featured Subsonic client with Playlists, Stars, Search,
 Offline mode, etc.
 
 It's one of the recommended Android client to use with Funkwhale, as we are doing
 our Android tests on this one.
 
+To enable playback from Funkwhale, enter the following information in the server settings:
+
+- Server address: the root URL of your instance
+- Username: your username on the instance
+- Password: this will be your subsonic password
+
+Then in the general settings select "Browse Using ID3 Tags"
 
 DSub (Android)
 ^^^^^^^^^^^^^^
@@ -95,6 +101,13 @@ DSub is a full-featured Subsonic client that works great, and has a lot of featu
 It's one of the recommended Android client to use with Funkwhale, as we are doing
 our Android tests on this one.
 
+To enable playback from Funkwhale, enter the following information in the server settings:
+
+- Server address: the root URL of your instance
+- Username: your username on the instance
+- Password: this will be your subsonic password
+- Browse By Tags: enabled
+
 play:Sub (iOS)
 ^^^^^^^^^^^^^^
 
@@ -102,8 +115,7 @@ play:Sub (iOS)
 - App Store: https://itunes.apple.com/us/app/play-sub-subsonic-music-streamer/id955329386
 - Website: http://michaelsapps.dk/playsubapp/
 
-Although paying, this app is known to work great with Funkwhale as the maintainer, Michael Bech Hansen implements Funkwhale
-specific logic and checks.
+Although paid, this app is known to work great with Funkwhale as the maintainer, Michael Bech Hansen, implements Funkwhale-specific logic and checks.
 
 Substreamer (iOS)
 ^^^^^^^^^^^^^^^^^
@@ -122,3 +134,41 @@ music from your Funkwhale instance. However, it does not implement advanced
 features such as playlist management, search or stars.
 
 This is the client we use for our desktop tests.
+
+To enable playback from Funkwhale, enter the following information in the Internet -> subsonic settings:
+
+- Server address: the root URL of your instance
+- Username: your username on the instance
+- Password: this will be your subsonic password
+
+Mopidy (CLI)
+^^^^^^^^^^^^
+- Price: free
+- Website: https://www.mopidy.com/
+
+Mopidy is a Python-based music server which you can run on your machine in order
+to access your music through a CLI such as `ncmpcpp <https://github.com/arybczak/ncmpcpp>`_.
+
+In order to use Mopidy to stream from the CLI, you will need to install the following dependencies:
+
+- Mopidy
+- mopidy-subidy: a plugin for Subsonic https://github.com/Prior99/mopidy-subidy
+- ncmpcpp
+
+Once installed, add the following to your /etc/mopidy/mopidy.conf::
+
+    [subidy]
+    enabled=True
+    url=https://path.to/your/funkwhale/server
+    username=funkwhale
+    password=your_subsonic_password
+    #legacy_auth=(optional - setting to yes may solve some connection errors)
+    #api_version=(optional - specify which API version to use. Subsonic 6.2 uses 1.14.0)
+
+Then in your .config/ncmpcpp/config, change the startup_screen value so that it doesn't default to the built-in media library::
+
+   startup_screen = browser
+
+This will show your artists, albums, and playlists when you start ncmpcpp.
+
+[Optional]: enable and start mopidy as a service to start the server at boot.

docs/users/upload.rst

@@ -21,7 +21,7 @@ default upload quota (1GB by default). This default quota can be increased,
 reduced or completely removed by your instance admins depending on their policy.
 
 Additionnaly, instance admins can grant you storage space manually. Get in touch with them
-if you'd like some additionnal storage space.
+if you'd like some additional storage space.
 
 You can view your current quota and usage at any time by visiting ``/content/libraries/`` on your instance,
 or clicking the "Add content" link in the sidebar, then visiting the "Upload audio content" section.
@@ -31,13 +31,13 @@ or clicking the "Add content" link in the sidebar, then visiting the "Upload aud
 Creating a library
 ------------------
 
-In Funkwhale's world, a library is a collection of audio files with an associated visibility level. A library can either be:
+In Funkwhale's world, a library is a collection of audio files with an associated visibility level. A library can be:
 
 - Public: anyone can follow the library to automatically access its content (including users on other instances)
 - Local: other users from your instance can follow the library to automatically access its content
-- Private: nobody will access the library content
+- Private: nobody apart from you can access the library content
 
-Regardless of this visibility settings, you can share the library link to specific users
+Regardless of visibility settings, you can share the library link to specific users
 and accept their follow request in order to grant then access to its content. Typically, this
 is useful when you have a private library you want to share with friends or family.
 
@@ -68,7 +68,7 @@ The minimum required tags are:
 - Artist
 - Album
 
-However, Funkwhale can understand and use additionnal tags to enhance user experience and display more information. The full list of supported tags is available below:
+However, Funkwhale can understand and use additional tags to enhance user experience and display more information. The full list of supported tags is available below:
 
 +----------------------------------+--------------------------------------------+---------------------------------------------------------------+
 | Name                             | Example value                              | Description                                                   |