Merge pull request #11 from OzGav/main

docs/music-providers/subsonic.md

@@ -0,0 +1,18 @@
+Music Assistant has support for music servers which work to the Open Subsonic API definition. The implementation has been tested against Gonic and Navidrome but should work with any implementation. Currently only Music is imported into the Music Assistant database but the infrastructure for handling podcasts is present when they are supported in Music Assistant.
+
+## Configuration:
+You will need to provide the following to Music Assistant:
+
+- A base URL for the server (e.g. https://music.domain.tld)
+- A port number (e.g. 80 for plain http, 443 for https, or an port where your server can be reached)
+- A path used to get to the rest API (e.g. mypathroute/ if you are path routing, leave this blank unless you know you need it)
+- A user name for the account you want Music Assistant to use to access your server
+- The password for this account
+
+There is also a toggle for podcasts which will have no effect now but will allow those who cannot or do not want to make podcasts available to Music Assistant.
+
+## Known issues:
+Not all server implementations accept an empty string as a search query, however this is considered valid input per the API documentation. If search or track enumeration fails, ask the authors of your server implementation about handling empty query strings.
+
+## Troubleshooting tips
+This provider makes use of https://github.com/khers/py-opensonic for communicating with the server, if something is failing to work properly in Music Assistant, try to use that library to interact with your server (can you ping it?, fetch artist and albums?, can you search?).

mkdocs.yml

@@ -7,11 +7,13 @@ repo_url: https://github.com/music-assistant
 nav:
   - Music Assistant: index.md
   - Server Installation: Installation.md
-  - Home Assistant Integration: integration.md
+  - Home Assistant Integration: 
+    - Integration Installation: integration.md
     - Play Media Service Call: faq/massplaymedia.md
     - Search Service Call: faq/masssearch.md
   - Companion App: companion-app.md
-  - Usage: usage.md
+  - Usage: 
+    - General: usage.md
     - UI: ui.md
   - Music Providers:
     - Deezer: music-providers/deezer.md
@@ -21,6 +23,7 @@ nav:
     - Radio Browser: music-providers/radio-browser.md
     - SoundCloud: music-providers/soundcloud.md
     - Spotify: music-providers/spotify.md
+    - Subsonic: music-providers/subsonic.md
     - Tidal: music-providers/tidal.md
     - TuneIn: music-providers/tunein.md
     - YouTube Music: music-providers/youtube-music.md
@@ -36,6 +39,7 @@ nav:
   - FAQ:
     - How To: faq/how-to.md
     - Volume Normalization: faq/normalization.md
+    - Troubleshooting: faq/troubleshooting.md
   - Developer Docs: developer-docs/dev-docs.md  
 
 theme: