Merge pull request #955 from eladyn/zeroconf_auth_docs

document zeroconf based authentication properly
Spotifyd · Sep 6, 2022 · 7146f64 · 7146f64
2 parents 2b847bf 1f13541
commit 7146f64
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/docs/src/config/File.md b/docs/src/config/File.md
@@ -106,6  106,16 @@ device_type = "speaker"
 
 ## Alternatives to storing your password in the config file <!-- omit in toc -->
 
 - use zeroconf authentication from Spotify Connect
 
   Spotifyd is able to advertise itself on the network without credentials. To enable this, you must omit / comment any `username` / `username_cmd` or `password` / `password_cmd` in the configuration. Spotifyd will receive an authentication blob from Spotify when you choose it from the devices list.
 
   > __Note:__ If you choose to go with this, it is also recommended to omit the `cache_path` and `cache_directory` options. Otherwise the first user to connect to the service will have its authentication blob cached by the service and nobody else will be able to connect to the service without clearing the cache.
 
   This way, a Spotifyd instance can also be made available to multiple users.
 
   For more information, have a look at the [librespot documentation][librespot-docs].
 
 - **`password_cmd`** config entry
 
   This feature allows you to provide a command that prints your password to `stdout`, which saves you from having to store your password in the config file directly. To use it, set the `password_cmd` config entry to the command you would like to use and remove the `password` config entry.
@@ -149,3  159,4 @@ If either of these options is given, the shell `spotifyd` will use to run its co
 [playerctl-homepage]: https://github.com/altdesktop/playerctl
 [secret-storage-specification]: https://www.freedesktop.org/wiki/Specifications/secret-storage-spec/
 [sp-homepage]: https://gist.github.com/wandernauta/6800547
 [librespot-docs]: https://github.com/librespot-org/librespot/blob/master/docs/authentication.md#zeroconf-based-authentication