MyFavMirrors
/
owntone-server
mirror of https://github.com/owntone/owntone-server.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
owntone-server/docs/advanced/outputs-pulse.md

140 lines
4.0 KiB
Markdown
Raw Normal View History

[docs] Fix spelling mistakes and extraneous spaces
2024-03-05 05:23:25 -05:00
# PulseAudio
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
[docs] Fix spelling mistakes and extraneous spaces
2024-03-05 05:23:25 -05:00
You have the choice of running PulseAudio either in system mode or user mode.
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
For headless servers, i.e. systems without desktop users, system mode is
recommended.
If there is a desktop user logged in most of the time, a setup with network
access via localhost only for daemons is a more appropriate solution, since the
normal user administration (with, e.g., `pulseaudio -k`) works as advertised.
[docs] Fix spelling mistakes and extraneous spaces
2024-03-05 05:23:25 -05:00
Also, the user specific configuration for PulseAudio is preserved across
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
sessions as expected.
- [System mode](#system-mode-with-bluetooth-support)
- [User mode](#user-mode-with-network-access)
## System Mode with Bluetooth support
Credit: [Rob Pope](http://robpope.co.uk/blog/post/setting-up-forked-daapd-with-bluetooth)
This guide was written based on headless Debian Jessie platforms. Most of the
instructions will require that you are root.
[docs] Fix spelling mistakes and extraneous spaces
2024-03-05 05:23:25 -05:00
### Step 1: Setting up PulseAudio
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
If you see a "Connection refused" error when starting the server, then you
[docs] Fix spelling mistakes and extraneous spaces
2024-03-05 05:23:25 -05:00
will probably need to setup PulseAudio to run in system mode [1]. This means
that the PulseAudio daemon will be started during boot and be available to all
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
users.
[docs] Fix spelling mistakes and extraneous spaces
2024-03-05 05:23:25 -05:00
How to start PulseAudio depends on your distribution, but in many cases you will
need to add a `pulseaudio.service` file to `/etc/systemd/system` with the
following content:
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
[doc] Add configuration documentation in the menu Moreover, the entries in the menu now match the title of the pages.
2024-04-27 15:53:01 -04:00
```conf
[docs] Fix spelling mistakes and extraneous spaces
2024-03-05 05:23:25 -05:00
# systemd service file for PulseAudio running in system mode
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
[Unit]
[docs] Fix spelling mistakes and extraneous spaces
2024-03-05 05:23:25 -05:00
Description=PulseAudio sound server
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
Before=sound.target
[Service]
ExecStart=/usr/bin/pulseaudio --system --disallow-exit
[Install]
WantedBy=multi-user.target
```
[docs] Fix spelling mistakes and extraneous spaces
2024-03-05 05:23:25 -05:00
If you want Bluetooth support, you must also configure PulseAudio to load the
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
Bluetooth module. First install it (Debian:
`apt install pulseaudio-module-bluetooth`) and then add the following to
/etc/pulse/system.pa:
[doc] Add configuration documentation in the menu Moreover, the entries in the menu now match the title of the pages.
2024-04-27 15:53:01 -04:00
```conf
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
#### Enable Bluetooth
.ifexists module-bluetooth-discover.so
load-module module-bluetooth-discover
.endif
```
[docs] Fix spelling mistakes and extraneous spaces
2024-03-05 05:23:25 -05:00
Now you need to make sure that PulseAudio can communicate with the Bluetooth
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
daemon through D-Bus. On Raspbian this is already enabled, and you can skip this
step. Otherwise do one of the following:
1. Add the pulse user to the bluetooth group: `adduser pulse bluetooth`
2. Edit /etc/dbus-1/system.d/bluetooth.conf and change the policy for `<policy context="default"\>` to "allow"
[docs] Fix spelling mistakes and extraneous spaces
2024-03-05 05:23:25 -05:00
Phew, almost done with PulseAudio! Now you should:
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
1. enable system mode on boot with `systemctl enable pulseaudio`
2. reboot (or at least restart dbus and pulseaudio)
3. check that the Bluetooth module is loaded with `pactl list modules short`
### Step 2: Setting up the server
Add the user the server is running as (typically "owntone") to the
"pulse-access" group:
[docs] Fix spelling mistakes and extraneous spaces
2024-03-05 05:23:25 -05:00
```shell
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
adduser owntone pulse-access
```
Now (re)start the server.
### Step 3: Adding a Bluetooth device
To connect with the device, run `bluetoothctl` and then:
```
power on
agent on
scan on
**Note MAC address of BT Speaker**
pair [MAC address]
**Type Pin if prompted**
trust [MAC address]
connect [MAC address]
```
[docs] Fix spelling mistakes and extraneous spaces
2024-03-05 05:23:25 -05:00
Now the speaker should appear. You can also verify that PulseAudio has detected
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
the speaker with `pactl list sinks short`.
## User Mode with Network Access
Credit: wolfmanx and [this blog](http://billauer.co.il/blog/2014/01/pa-multiple-users/)
### Step 1: Copy system pulseaudio configuration to the users home directory
[docs] Fix spelling mistakes and extraneous spaces
2024-03-05 05:23:25 -05:00
```shell
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
mkdir -p ~/.pulse
cp /etc/pulse/default.pa ~/.pulse/
```
### Step 2: Enable TCP access from localhost only
Edit the file `~/.pulse/default.pa` , adding the following line at the end:
[docs] Fix spelling mistakes and extraneous spaces
2024-03-05 05:23:25 -05:00
```shell
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
load-module module-native-protocol-tcp auth-ip-acl=127.0.0.1
```
[doc] Add configuration documentation in the menu Moreover, the entries in the menu now match the title of the pages.
2024-04-27 15:53:01 -04:00
### Step 3: Restart the PulseAudio daemon
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
[docs] Fix spelling mistakes and extraneous spaces
2024-03-05 05:23:25 -05:00
```shell
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
pulseaudio -k
# OR
pulseaudio -D
```
[doc] Add configuration documentation in the menu Moreover, the entries in the menu now match the title of the pages.
2024-04-27 15:53:01 -04:00
### Step 4: Adjust the Configuration File
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
In the `audio` section of `/etc/owntone.conf`, set `server` to `localhost`:
[doc] Add configuration documentation in the menu Moreover, the entries in the menu now match the title of the pages.
2024-04-27 15:53:01 -04:00
```conf
[docs] Generate OwnTone documentation with MkDocs - Copy existing README*.md and INSTALL.md files to docs folder - Set up MkDocs to build documentation (mkdocs.yml) - Add new index.md with a quick overview of OwnTone
2022-03-20 05:12:16 -04:00
server = "localhost"
```
---
[docs] Fix spelling mistakes and extraneous spaces
2024-03-05 05:23:25 -05:00
[1] Note that PulseAudio will warn against system mode. However, in this use
case it is actually the solution recommended by the [PulseAudio folks themselves](https://lists.freedesktop.org/archives/pulseaudio-discuss/2016-August/026823.html).