Skip to content

Commit

Permalink
doc: brief OpenBSD bits
Browse files Browse the repository at this point in the history
Users are always advised to use official binary packages and/or build
spotifyd themselves using official ports infrastructure (from which
packages are built), so haven't duplicated any compilation instructions
here.

The official package also ships a README with a suggestion on how to
configure and run `spotifyd` which ought to be enough, anyways.
  • Loading branch information
klemensn committed Dec 29, 2023
1 parent bd6017b commit 4555e56
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
- [Cross Compiling on Ubuntu](./installation/Cross-Compiling-on-Ubuntu.md)
- [Installing with Homebrew on macOS](./installation/MacOS.md)
- [Installing on FreeBSD](./installation/FreeBSD.md)
- [Installing on OpenBSD](./installation/OpenBSD.md)
- [Configuration](./config/README.md)
- [CLI options](./config/Cli.md)
- [Configuration file](./config/File.md)
Expand Down
25 changes: 25 additions & 0 deletions docs/src/installation/OpenBSD.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# OpenBSD install guide

`spotifyd` is available on all supported Rust architectures:

* aarch64
* amd64
* i386
* powerpc64
* riscv64
* sparc64

## Install

```sh
# pkg_add spotifyd
```

## Configuring spotifyd

The official package uses PortAudio and works out of the box, no configuration is required.

## Running spotifyd

You may start `spotifyd` as background daemon in your `~/.xsession` X11 startup script
or have clients like `spotify-qt` start/stop it accordingly.
2 changes: 1 addition & 1 deletion docs/src/installation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,6 @@ To enable an additional audio backend, pass `<audio_backend_name>_backend` as a
| Feature Flag | Description |
|--------------|-------------------------------------------------------------------------------------|
| dbus_keyring | Provides password authentication over the system's keyring (supports all platforms) |
| dbus_mpris | Provides multimedia key support (Linux only) |
| dbus_mpris | Provides multimedia key support (Linux and BSD only) |

> __Note:__ Compiling Spotifyd with all features and the pulseaudio backend on Ubuntu would result in the following command: `cargo build --release --no-default-features --features pulseaudio_backend,dbus_keyring,dbus_mpris`

0 comments on commit 4555e56

Please sign in to comment.