Skip to content

Commit c0620c5

Browse files
authored
Merge pull request #1249 from eladyn/pr_fixup
fix docs formatting and mention system-wide MPRIS
2 parents 400cf64 + 2feb15e commit c0620c5

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

docs/src/config/File.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ device_type = "speaker"
146146

147147
- **`use_keyring`** config entry / **`--use-keyring`** CLI flag <!-- omit in toc -->
148148

149-
> __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].
149+
> __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).
150150
151151
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.
152152

docs/src/config/services/Systemd.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,13 @@ systemctl --user enable spotifyd.service --now
1919

2020
## As a system wide service
2121

22-
> [!IMPORTANT]
23-
> 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.
22+
<div class="warning">
23+
24+
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.
25+
26+
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).
27+
28+
</div>
2429

2530
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:
2631

0 commit comments

Comments
 (0)