From 2feb15e058dd9ef531c6ef7f478929dc8101e56d Mon Sep 17 00:00:00 2001 From: eladyn Date: Thu, 14 Dec 2023 15:33:44 +0100 Subject: [PATCH] fix docs formatting and mention system-wide MPRIS --- docs/src/config/File.md | 2 +- docs/src/config/services/Systemd.md | 9 +++++++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/src/config/File.md b/docs/src/config/File.md index 6092ff87..cbc1710c 100644 --- a/docs/src/config/File.md +++ b/docs/src/config/File.md @@ -146,7 +146,7 @@ device_type = "speaker" - **`use_keyring`** config entry / **`--use-keyring`** CLI flag - > __Note:__ If choosing the user's keyring to store login credentials, running spotifyd as a systemd _system service_ is no longer possible. A system wide service cannot access a specific user's keyring. In this case, make sure to run spotifyd as a systemd _user service_. See [systemd configuration][services/Systemd.md]. + > __Note:__ If choosing the user's keyring to store login credentials, running spotifyd as a systemd _system service_ is no longer possible. A system wide service cannot access a specific user's keyring. In this case, make sure to run spotifyd as a systemd _user service_. See [systemd configuration](services/Systemd.md). This features leverages [Linux's DBus Secret Service API][secret-storage-specification] or native macOS keychain in order to forgo the need to store your password directly in the config file. To use it, compile with the `dbus_keyring` feature and set the `use-keyring` config entry to `true` or pass the `--use-keyring` CLI flag during start to the daemon. Remove the `password` and/or `password_cmd` config entries. diff --git a/docs/src/config/services/Systemd.md b/docs/src/config/services/Systemd.md index e88f74f5..c16edd0b 100644 --- a/docs/src/config/services/Systemd.md +++ b/docs/src/config/services/Systemd.md @@ -19,8 +19,13 @@ systemctl --user enable spotifyd.service --now ## As a system wide service -> [!IMPORTANT] -> When running spotifyd as a system wide service, it is not possible to access a user's keyring to obtain login credentials. Do not set `use_keyring = true` and do not specify `--use-keyring`, when running as a system wide service. To be able to access login credentials stored in the user's keyring, run spotifyd as a user service, as decribed above. +
+ +When running spotifyd as a system wide service, it is not possible to access a user's keyring to obtain login credentials. Do not set `use_keyring = true` and do not specify `--use-keyring`, when running as a system wide service. To be able to access login credentials stored in the user's keyring, run spotifyd as a user service, as decribed above. + +Additionally, `use_mpris = true` or `--use-mpris` should not be used, since their intended usage is within user sessions (and not system-wide daemons). If you have very specific requirements and still want to control a system-wide `spotifyd` instance, there is some help available [here](https://github.com/Spotifyd/spotifyd/issues/244). + +
A `systemd.service` unit file is provided to help run spotifyd as a service on systemd-based systems. The file `contrib/spotifyd.service` should be copied to: