Skip to content

Commit

Permalink
Merge pull request #1249 from eladyn/pr_fixup
Browse files Browse the repository at this point in the history
fix docs formatting and mention system-wide MPRIS
  • Loading branch information
eladyn committed Dec 14, 2023
2 parents 400cf64 + 2feb15e commit c0620c5
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/src/config/File.md
Expand Up @@ -146,7 +146,7 @@ device_type = "speaker"

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

> __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.

Expand Down
9 changes: 7 additions & 2 deletions docs/src/config/services/Systemd.md
Expand Up @@ -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.
<div class="warning">

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).

</div>

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:

Expand Down

0 comments on commit c0620c5

Please sign in to comment.