From 43b96ad6e0e5a1de2265bb29788886bb9e30f288 Mon Sep 17 00:00:00 2001 From: Colin Lord Date: Fri, 29 Dec 2023 23:20:08 -0800 Subject: [PATCH] Add documentation explaining how Navidrome is accessed After installing Navidrome it is not immediately clear how users are populated and accessed so this adds a few sentences describing how it works both from Yunohost SSO and alternative client perspectives. --- doc/ADMIN.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/ADMIN.md b/doc/ADMIN.md index ff1fcb8..521bcfc 100644 --- a/doc/ADMIN.md +++ b/doc/ADMIN.md @@ -3,3 +3,12 @@ Your music files are stored by default in your shared [multimedia folder](https://github.com/YunoHost-Apps/yunohost.multimedia) `/home/yunohost.multimedia/share/Music`. This folder is accessible from Nextcloud with *External Storages* enabled. This will allow you to easily upload your music files to the server. You can configure an alternative path to you music files by editing the path `MusicFolder = "/home/yunohost.multimedia/share/Music"` in this file `/var/lib/navidrome/navidrome.toml` using the [documentation](https://www.navidrome.org/docs/usage/configuration-options/). Remember to restart Navidrome service if you change your configuration file. + +#### Accessing Navidrome + +Navidrome uses its own password database and does not integrate with Yunohost LDAP, so there are two ways to access it: + +- When Navidrome is initially installed, before any users log in there is an option to create a Navidrome admin user by going directly to the access URL set for Navidrome in Yunohost. This admin account can create users who are able to log in via the same access URL. +- The second method to access Navidrome is via Yunohost SSO, which is accomplished by logging in to Yunohost and then clicking on the Navidrome tile. With this method, the Navidrome password database is not populated with the Yunohost password which means future attempts to log in to Navidrome directly via the access URL will fail. This prevents alternative clients from logging in with the Yunohost user credentials, so in order to work around this issue, after logging in to Navidrome with SSO the user password can be manually set via the Navidrome interface. Any password will be accepted as the current password. + +Further explanation of this can be found in [this github issue](https://github.com/YunoHost-Apps/navidrome_ynh/issues/101).