Alpine Linux - User contributions [en]

PipeWire

2022-02-12T21:21:25Z

Katt0:

{{Draft|The instructions below have not been thoroughly tested and may break things.}}

[https://pipewire.org/ PipeWire] is a multimedia processing engine that aims to improve audio and video handling on Linux.

== Prerequisites ==

=== Audio Group ===

When elogind is not available, the user has to be added to the <code>audio</code> group. The user must log in for this to take effect.

<pre>
# addgroup <user> audio
</pre>

=== D-Bus ===

PipeWire requires a running [https://www.freedesktop.org/wiki/Software/dbus/ D-Bus] session. If you use a full desktop environment this will probably be started automatically, but with minimal window managers it must be done manually.

<pre>
# apk add dbus dbus-openrc dbus-x11
# rc-service dbus start
# rc-update add dbus default
</pre>

Then use <code>dbus-launch</code> whenever you start an X or Wayland session. For example:
<pre>
$ dbus-launch --exit-with-session sway
</pre>

=== XDG_RUNTIME_DIR ===

If you are not using a Desktop Manager, ensure that your <code>XDG_RUNTIME_DIR</code> is set to a user-writable location. By default for pulseaudio this is {{Path|/run/user/1000/}} or {{Path|/tmp}}. If this is not set, pipewire will create a directory in your home folder instead, called <code>~/pulse</code>, and on attempting to run Pavucontrol or pactl, you will get the following error:

<pre>
$ pactl list
Connection failure: Connection refused
pa_context_connect() failed: Connection refused
</pre>

== Installation and configuration ==

<pre>
# apk add pipewire wireplumber rtkit
</pre>

{{Note|Using [https://gitlab.freedesktop.org/pipewire/wireplumber WirePlumber] rather than the pipewire-media-session (which comes with pipewire) is [https://gitlab.freedesktop.org/pipewire/media-session/-/blob/master/README.md recommended] but not required.}}

Create a custom configuration file in {{Path|/etc/pipewire/pipewire.conf}}:

<pre>
# mkdir /etc/pipewire
# cp /usr/share/pipewire/pipewire.conf /etc/pipewire/
</pre>

Add the following line to the <code>context.exec</code> section at the bottom of {{Path|/etc/pipewire/pipewire.conf}}:

<pre>
{ path = "wireplumber" args = "" }
</pre>

Enable the <code>snd_seq</code> kernel module for ALSA support.

<pre>
# modprobe snd_seq
# echo snd_seq >> /etc/modules
</pre>

Now, edit /usr/share/polkit-1/actions/org.freedesktop.RealtimeKit1.policy and change the <allow_any> on line 14 to yes instead of no, and do the same for line 26
=== ALSA ===

<pre>
# apk add pipewire-alsa
</pre>

ALSA support works out of the box if you have the pipewire-alsa package

=== PulseAudio ===

PipeWire can run a [https://www.freedesktop.org/wiki/Software/PulseAudio/ PulseAudio] daemon which should allow all existing PulseAudio applications to be used with the PipeWire backend.

<pre>
# apk add pipewire-pulse
</pre>

Uncomment the following line in {{Path|/etc/pipewire/pipewire.conf}}:

<pre>
{ path = "/usr/bin/pipewire" args = "-c pipewire-pulse.conf" }
</pre>

It should be automatically enabled.

=== JACK ===

If you will be using PipeWire for [https://jackaudio.org/ JACK] applications install the required package and make system wide links to the PipeWire replacement JACK libraries (I have not had success using <code>pw-jack</code>). You will not need to start a JACK server.

<pre>
# apk add pipewire-jack
# ln -sf /usr/lib/pipewire-0.3/jack/libjackserver.so.0 /usr/lib/libjackserver.so.0
# ln -sf /usr/lib/pipewire-0.3/jack/libjacknet.so.0 /usr/lib/libjacknet.so.0
# ln -sf /usr/lib/pipewire-0.3/jack/libjack.so.0 /usr/lib/libjack.so.0
</pre>

{{Note|These symlinks might be overwritten during updates.}}

=== Video ===

Video should work out-of-the-box with v4l2 devices (e.g. a lot of webcams) and [https://gstreamer.freedesktop.org/ GStreamer] applications.

=== Bluetooth headset ===

Requires <code>pipewire-spa-bluez</code> package in addition to <code>pipewire-pulse</code> daemon to be installed.

=== Automatic bluetooth profile selection ===

To automatically switch between HSP/HFP and A2DP profiles when an input stream is detected, set the bluez5.autoswitch-profile property to true:
<pre>
/etc/pipewire/media-session.d/bluez-monitor.conf

...
rules = [
{
...
actions = {
update-props = {
...
bluez5.autoswitch-profile = true
...
</pre>

=== Screen sharing on Wayland ===

You will need the right [https://github.com/flatpak/xdg-desktop-portal xdg-desktop-portal] backend for your desktop environment. Screen sharing is known to work on:
* GNOME with <code>xdg-desktop-portal-gtk</code>
* KDE Plasma with <code>xdg-desktop-portal-kde</code> and Firefox
* Sway with <code>xdg-desktop-portal-wlr</code> and Firefox

== Usage ==

Start the PipeWire media server. You'll probably get quite a few errors but just ignore them for now.

<pre>
$ pipewire
</pre>

{{Note| PipeWire doesn't auto-start a session manager anymore.
In 3.14 and earlier, the PipeWire default config was edited in packaging to auto-start pipewire-media-session as the default session manager. Since we now have wireplumber available as an alternative session manager, this has been changed in favor of a launch wrapper for pipewire at /usr/libexec/pipewire-launcher. When executed, this will launch pipewire, pipewire-media-session or wireplumber, and pipewire-pulse, depending on what modules are available. If you were launching /usr/bin/pipewire and the session manager manually before, please use the new launcher wrapper instead. WirePlumber can now also be used as a proper alternative for pipewire-media-session.}}

In a different terminal window check the default output device. I don't yet know how this default can be changed for all applications, so you'd better hope it's right!

<pre>
# apk add pipewire-tools
$ pw-cat -p --list-targets
</pre>

Test sound is working using an audio file in a format supported by [http://www.mega-nerd.com/libsndfile/ libsndfile] (e.g. flac, opus, ogg, wav).

<pre>
$ pw-cat -p test.flac
</pre>

If you have a microphone test audio recording is working.

<pre>
$ pw-cat -r --list-targets
$ pw-cat -r recording.flac
(Speak for a while then stop it with Ctrl+c)
$ pw-cat -p recording.flac
</pre>

Test PulseAudio clients using a media player (most use PulseAudio) and if you use JACK test that too:

<pre>
# apk add jack-example-clients
$ jack_simple_client
</pre>

You should hear a sustained beep.

If you are happy everything is working, make PipeWire start automatically when your X or Wayland session starts. For example, you could add the <code>pipewire</code> command to <code>~/.xinitrc</code> or your window manager's config file.

== Troubleshooting ==

=== `pw-cat -p --list-targets` shows no targets ===

First, check whether ALSA knows about your sound card:

<pre>
aplay -l
</pre>

If sound devices are found, the issue is with your pipewire configuration. Consider double-checking the instructions above.

Otherwise, your sound card may not be supported in the version of the Linux Kernel you're running. You should search online for fixes relating to your current kernel version and the codec of your sound card. You can find each of these with:

<pre>
uname -r
cat /proc/asound/card0/codec* | grep Codec
</pre>

== Quick Configuration ==

You might want to use pavucontrol to have a simple GUI app for controlling sound, outputs, etc, in which case:
<pre>
# apk add pavucontrol
</pre>

== See Also ==

* [https://gitlab.freedesktop.org/pipewire/pipewire PipeWire source repository]
* [https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/home PipeWire Wiki]
* [https://wiki.archlinux.org/index.php/PipeWire PipeWire on the ArchWiki]
* [https://wiki.gentoo.org/wiki/Pipewire PipeWire on the Gentoo Wiki]

[[Category:Multimedia]]

PipeWire

2022-02-12T21:19:40Z

Katt0:

{{Draft|The instructions below have not been thoroughly tested and may break things.}}

[https://pipewire.org/ PipeWire] is a multimedia processing engine that aims to improve audio and video handling on Linux.

== Prerequisites ==

=== Audio Group ===

When elogind is not available, the user has to be added to the <code>audio</code> group. The user must log in for this to take effect.

<pre>
# addgroup <user> audio
</pre>

=== D-Bus ===

PipeWire requires a running [https://www.freedesktop.org/wiki/Software/dbus/ D-Bus] session. If you use a full desktop environment this will probably be started automatically, but with minimal window managers it must be done manually.

<pre>
# apk add dbus dbus-openrc dbus-x11
# rc-service dbus start
# rc-update add dbus default
</pre>

Then use <code>dbus-launch</code> whenever you start an X or Wayland session. For example:
<pre>
$ dbus-launch --exit-with-session sway
</pre>

=== XDG_RUNTIME_DIR ===

If you are not using a Desktop Manager, ensure that your <code>XDG_RUNTIME_DIR</code> is set to a user-writable location. By default for pulseaudio this is {{Path|/run/user/1000/}} or {{Path|/tmp}}. If this is not set, pipewire will create a directory in your home folder instead, called <code>~/pulse</code>, and on attempting to run Pavucontrol or pactl, you will get the following error:

<pre>
$ pactl list
Connection failure: Connection refused
pa_context_connect() failed: Connection refused
</pre>

== Installation and configuration ==

<pre>
# apk add pipewire wireplumber rtkit
</pre>

{{Note|Using [https://gitlab.freedesktop.org/pipewire/wireplumber WirePlumber] rather than the pipewire-media-session (which comes with pipewire) is [https://gitlab.freedesktop.org/pipewire/media-session/-/blob/master/README.md recommended] but not required.}}

Create a custom configuration file in {{Path|/etc/pipewire/pipewire.conf}}:

<pre>
# mkdir /etc/pipewire
# cp /usr/share/pipewire/pipewire.conf /etc/pipewire/
</pre>

Add the following line to the <code>context.exec</code> section at the bottom of {{Path|/etc/pipewire/pipewire.conf}}:

<pre>
{ path = "wireplumber" args = "" }
</pre>

Enable the <code>snd_seq</code> kernel module for ALSA support.

<pre>
# modprobe snd_seq
# echo snd_seq >> /etc/modules
</pre>

Now, edit /usr/share/polkit-1/actions/org.freedesktop.RealtimeKit1.policy and change the <allow_any> on line 14 to yes instead of no, and do the same for line 26
=== ALSA ===

ALSA support works out of the box if you have the pipewire-alsa package

=== PulseAudio ===

PipeWire can run a [https://www.freedesktop.org/wiki/Software/PulseAudio/ PulseAudio] daemon which should allow all existing PulseAudio applications to be used with the PipeWire backend.

<pre>
# apk add pipewire-pulse
</pre>

Uncomment the following line in {{Path|/etc/pipewire/pipewire.conf}}:

<pre>
{ path = "/usr/bin/pipewire" args = "-c pipewire-pulse.conf" }
</pre>

It should be automatically enabled.

=== JACK ===

If you will be using PipeWire for [https://jackaudio.org/ JACK] applications install the required package and make system wide links to the PipeWire replacement JACK libraries (I have not had success using <code>pw-jack</code>). You will not need to start a JACK server.

<pre>
# apk add pipewire-jack
# ln -sf /usr/lib/pipewire-0.3/jack/libjackserver.so.0 /usr/lib/libjackserver.so.0
# ln -sf /usr/lib/pipewire-0.3/jack/libjacknet.so.0 /usr/lib/libjacknet.so.0
# ln -sf /usr/lib/pipewire-0.3/jack/libjack.so.0 /usr/lib/libjack.so.0
</pre>

{{Note|These symlinks might be overwritten during updates.}}

=== Video ===

Video should work out-of-the-box with v4l2 devices (e.g. a lot of webcams) and [https://gstreamer.freedesktop.org/ GStreamer] applications.

=== Bluetooth headset ===

Requires <code>pipewire-spa-bluez</code> package in addition to <code>pipewire-pulse</code> daemon to be installed.

=== Automatic bluetooth profile selection ===

To automatically switch between HSP/HFP and A2DP profiles when an input stream is detected, set the bluez5.autoswitch-profile property to true:
<pre>
/etc/pipewire/media-session.d/bluez-monitor.conf

...
rules = [
{
...
actions = {
update-props = {
...
bluez5.autoswitch-profile = true
...
</pre>

=== Screen sharing on Wayland ===

You will need the right [https://github.com/flatpak/xdg-desktop-portal xdg-desktop-portal] backend for your desktop environment. Screen sharing is known to work on:
* GNOME with <code>xdg-desktop-portal-gtk</code>
* KDE Plasma with <code>xdg-desktop-portal-kde</code> and Firefox
* Sway with <code>xdg-desktop-portal-wlr</code> and Firefox

== Usage ==

Start the PipeWire media server. You'll probably get quite a few errors but just ignore them for now.

<pre>
$ pipewire
</pre>

{{Note| PipeWire doesn't auto-start a session manager anymore.
In 3.14 and earlier, the PipeWire default config was edited in packaging to auto-start pipewire-media-session as the default session manager. Since we now have wireplumber available as an alternative session manager, this has been changed in favor of a launch wrapper for pipewire at /usr/libexec/pipewire-launcher. When executed, this will launch pipewire, pipewire-media-session or wireplumber, and pipewire-pulse, depending on what modules are available. If you were launching /usr/bin/pipewire and the session manager manually before, please use the new launcher wrapper instead. WirePlumber can now also be used as a proper alternative for pipewire-media-session.}}

In a different terminal window check the default output device. I don't yet know how this default can be changed for all applications, so you'd better hope it's right!

<pre>
# apk add pipewire-tools
$ pw-cat -p --list-targets
</pre>

Test sound is working using an audio file in a format supported by [http://www.mega-nerd.com/libsndfile/ libsndfile] (e.g. flac, opus, ogg, wav).

<pre>
$ pw-cat -p test.flac
</pre>

If you have a microphone test audio recording is working.

<pre>
$ pw-cat -r --list-targets
$ pw-cat -r recording.flac
(Speak for a while then stop it with Ctrl+c)
$ pw-cat -p recording.flac
</pre>

Test PulseAudio clients using a media player (most use PulseAudio) and if you use JACK test that too:

<pre>
# apk add jack-example-clients
$ jack_simple_client
</pre>

You should hear a sustained beep.

If you are happy everything is working, make PipeWire start automatically when your X or Wayland session starts. For example, you could add the <code>pipewire</code> command to <code>~/.xinitrc</code> or your window manager's config file.

== Troubleshooting ==

=== `pw-cat -p --list-targets` shows no targets ===

First, check whether ALSA knows about your sound card:

<pre>
aplay -l
</pre>

If sound devices are found, the issue is with your pipewire configuration. Consider double-checking the instructions above.

Otherwise, your sound card may not be supported in the version of the Linux Kernel you're running. You should search online for fixes relating to your current kernel version and the codec of your sound card. You can find each of these with:

<pre>
uname -r
cat /proc/asound/card0/codec* | grep Codec
</pre>

== Quick Configuration ==

You might want to use pavucontrol to have a simple GUI app for controlling sound, outputs, etc, in which case:
<pre>
# apk add pavucontrol
</pre>

== See Also ==

* [https://gitlab.freedesktop.org/pipewire/pipewire PipeWire source repository]
* [https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/home PipeWire Wiki]
* [https://wiki.archlinux.org/index.php/PipeWire PipeWire on the ArchWiki]
* [https://wiki.gentoo.org/wiki/Pipewire PipeWire on the Gentoo Wiki]

[[Category:Multimedia]]

PipeWire

2022-02-12T21:15:02Z

Katt0:

{{Draft|The instructions below have not been thoroughly tested and may break things.}}

[https://pipewire.org/ PipeWire] is a multimedia processing engine that aims to improve audio and video handling on Linux.

== Prerequisites ==

=== Audio Group ===

When elogind is not available, the user has to be added to the <code>audio</code> group. The user must log in for this to take effect.

<pre>
# addgroup <user> audio
</pre>

=== D-Bus ===

PipeWire requires a running [https://www.freedesktop.org/wiki/Software/dbus/ D-Bus] session. If you use a full desktop environment this will probably be started automatically, but with minimal window managers it must be done manually.

<pre>
# apk add dbus dbus-openrc dbus-x11
# rc-service dbus start
# rc-update add dbus default
</pre>

Then use <code>dbus-launch</code> whenever you start an X or Wayland session. For example:
<pre>
$ dbus-launch --exit-with-session sway
</pre>

=== XDG_RUNTIME_DIR ===

If you are not using a Desktop Manager, ensure that your <code>XDG_RUNTIME_DIR</code> is set to a user-writable location. By default for pulseaudio this is {{Path|/run/user/1000/}} or {{Path|/tmp}}. If this is not set, pipewire will create a directory in your home folder instead, called <code>~/pulse</code>, and on attempting to run Pavucontrol or pactl, you will get the following error:

<pre>
$ pactl list
Connection failure: Connection refused
pa_context_connect() failed: Connection refused
</pre>

== Installation and configuration ==

<pre>
# apk add pipewire wireplumber rtkit
</pre>

{{Note|Using [https://gitlab.freedesktop.org/pipewire/wireplumber WirePlumber] rather than the pipewire-media-session (which comes with pipewire) is [https://gitlab.freedesktop.org/pipewire/media-session/-/blob/master/README.md recommended] but not required.}}

Create a custom configuration file in {{Path|/etc/pipewire/pipewire.conf}}:

<pre>
# mkdir /etc/pipewire
# cp /usr/share/pipewire/pipewire.conf /etc/pipewire/
</pre>

Add the following line to the <code>context.exec</code> section at the bottom of {{Path|/etc/pipewire/pipewire.conf}}:

<pre>
{ path = "wireplumber" args = "" }
</pre>

Enable the <code>snd_seq</code> kernel module for ALSA support.

<pre>
# modprobe snd_seq
# echo snd_seq >> /etc/modules
</pre>

Now, edit /usr/share/polkit-1/actions/org.freedesktop.RealtimeKit1.policy and change the <allow_any> on line 14 to yes instead of no, and do the same for line 26
=== ALSA ===

If you use neither Jack nor PulseAudio and you don't intend to.

<pre>
# touch /etc/pipewire/media-session.d/with-alsa
</pre>

=== PulseAudio ===

PipeWire can run a [https://www.freedesktop.org/wiki/Software/PulseAudio/ PulseAudio] daemon which should allow all existing PulseAudio applications to be used with the PipeWire backend.

<pre>
# apk add pipewire-pulse
</pre>

Uncomment the following line in {{Path|/etc/pipewire/pipewire.conf}}:

<pre>
{ path = "/usr/bin/pipewire" args = "-c pipewire-pulse.conf" }
</pre>

It should be automatically enabled.

=== JACK ===

If you will be using PipeWire for [https://jackaudio.org/ JACK] applications install the required package and make system wide links to the PipeWire replacement JACK libraries (I have not had success using <code>pw-jack</code>). You will not need to start a JACK server.

<pre>
# apk add pipewire-jack
# ln -sf /usr/lib/pipewire-0.3/jack/libjackserver.so.0 /usr/lib/libjackserver.so.0
# ln -sf /usr/lib/pipewire-0.3/jack/libjacknet.so.0 /usr/lib/libjacknet.so.0
# ln -sf /usr/lib/pipewire-0.3/jack/libjack.so.0 /usr/lib/libjack.so.0
</pre>

{{Note|These symlinks might be overwritten during updates.}}

=== Video ===

Video should work out-of-the-box with v4l2 devices (e.g. a lot of webcams) and [https://gstreamer.freedesktop.org/ GStreamer] applications.

=== Bluetooth headset ===

Requires <code>pipewire-spa-bluez</code> package in addition to <code>pipewire-pulse</code> daemon to be installed.

=== Automatic bluetooth profile selection ===

To automatically switch between HSP/HFP and A2DP profiles when an input stream is detected, set the bluez5.autoswitch-profile property to true:
<pre>
/etc/pipewire/media-session.d/bluez-monitor.conf

...
rules = [
{
...
actions = {
update-props = {
...
bluez5.autoswitch-profile = true
...
</pre>

=== Screen sharing on Wayland ===

You will need the right [https://github.com/flatpak/xdg-desktop-portal xdg-desktop-portal] backend for your desktop environment. Screen sharing is known to work on:
* GNOME with <code>xdg-desktop-portal-gtk</code>
* KDE Plasma with <code>xdg-desktop-portal-kde</code> and Firefox
* Sway with <code>xdg-desktop-portal-wlr</code> and Firefox

== Usage ==

Start the PipeWire media server. You'll probably get quite a few errors but just ignore them for now.

<pre>
$ pipewire
</pre>

{{Note| PipeWire doesn't auto-start a session manager anymore.
In 3.14 and earlier, the PipeWire default config was edited in packaging to auto-start pipewire-media-session as the default session manager. Since we now have wireplumber available as an alternative session manager, this has been changed in favor of a launch wrapper for pipewire at /usr/libexec/pipewire-launcher. When executed, this will launch pipewire, pipewire-media-session or wireplumber, and pipewire-pulse, depending on what modules are available. If you were launching /usr/bin/pipewire and the session manager manually before, please use the new launcher wrapper instead. WirePlumber can now also be used as a proper alternative for pipewire-media-session.}}

In a different terminal window check the default output device. I don't yet know how this default can be changed for all applications, so you'd better hope it's right!

<pre>
# apk add pipewire-tools
$ pw-cat -p --list-targets
</pre>

Test sound is working using an audio file in a format supported by [http://www.mega-nerd.com/libsndfile/ libsndfile] (e.g. flac, opus, ogg, wav).

<pre>
$ pw-cat -p test.flac
</pre>

If you have a microphone test audio recording is working.

<pre>
$ pw-cat -r --list-targets
$ pw-cat -r recording.flac
(Speak for a while then stop it with Ctrl+c)
$ pw-cat -p recording.flac
</pre>

Test PulseAudio clients using a media player (most use PulseAudio) and if you use JACK test that too:

<pre>
# apk add jack-example-clients
$ jack_simple_client
</pre>

You should hear a sustained beep.

If you are happy everything is working, make PipeWire start automatically when your X or Wayland session starts. For example, you could add the <code>pipewire</code> command to <code>~/.xinitrc</code> or your window manager's config file.

== Troubleshooting ==

=== `pw-cat -p --list-targets` shows no targets ===

First, check whether ALSA knows about your sound card:

<pre>
aplay -l
</pre>

If sound devices are found, the issue is with your pipewire configuration. Consider double-checking the instructions above.

Otherwise, your sound card may not be supported in the version of the Linux Kernel you're running. You should search online for fixes relating to your current kernel version and the codec of your sound card. You can find each of these with:

<pre>
uname -r
cat /proc/asound/card0/codec* | grep Codec
</pre>

== See Also ==

* [https://gitlab.freedesktop.org/pipewire/pipewire PipeWire source repository]
* [https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/home PipeWire Wiki]
* [https://wiki.archlinux.org/index.php/PipeWire PipeWire on the ArchWiki]
* [https://wiki.gentoo.org/wiki/Pipewire PipeWire on the Gentoo Wiki]

[[Category:Multimedia]]

Sway

2022-02-12T21:08:40Z

Katt0:

[http://swaywm.org Sway] is a tiling [[Wayland]] compositor. It's a drop-in replacement for the i3 window manager.

== Prerequisites ==

First, install & configure eudev:

<pre>
# apk add eudev
# setup-udev
</pre>

Then install graphics drivers appropriate to your system:

<pre>
# apk add mesa-dri-gallium # gallium
# apk add mesa-dri-classic # or classic
# apk add mesa-dri-nouveau # for nvidia users
</pre>

The following links contain guides for setting up the video stack.

* [[Intel Video]]
* [[Radeon Video]]

Add yourself to the input and video groups:

<pre>
# adduser $USER input
# adduser $USER video
</pre>

You have to log out and back in for this to take effect.

Install some TTF fonts:

<pre>
# apk add ttf-dejavu
</pre>

Since sway 1.6.1 (more specifically, since wlroots 0.14), you need to set up libseat backend if you wish to run sway directly (without nesting it in another wayland compositor). To do that, choose one of the following methods:

<dl>

<dt>Option 1: seatd daemon (recommended)</dt>
<dd>
<pre>
# apk add seatd
# rc-update add seatd
# rc-service seatd start
# adduser $USER seat
</pre>

If you are already logged in as a $USER, you will need to relogin.
</dd>

<dt>Option 2: seatd-launch</dt>
<dd>
<pre>
# apk add seatd-launch
</pre>

When starting sway, you will need to prefix invocation with <code>seatd-launch</code>.
Note: <code>seatd-launch</code> is a suid binary, so it might be wise to use one of the other methods from a security perspective.
</dd>

<dt>Option 3: elogind daemon</dt>
<dd>

<pre>
# apk add elogind polkit-elogind
# rc-update add elogind
# rc-service elogind start
</pre>

Using <code>elogind</code> will automatically set the necessary permissions, so you can skip adding groups like <code>seat</code> and <code>video</code>

</dd>

</dl>

== Installation ==

We can now install sway:

<pre>
# apk add sway sway-doc
# apk add \ # Install optional dependencies:
xwayland \ # recommended for compatibility reasons
foot \ # default terminal emulator
dmenu \ # default application launcher
swaylock \ # lockscreen tool
swayidle # idle management (DPMS) daemon
</pre>

== Running Sway ==

To run sway, first set XDG_RUNTIME_DIR to a suitable location (e.g. create a .run folder in your home directory and set it to ~/.run). Then run sway from the Linux console (dbus-launch is used because pipewire needs it, it is included in dbus-x11 and you may omit it):

<pre>
$ XDG_RUNTIME_DIR=~/.run dbus-launch sway
</pre>

(if you run sway with seatd-launch, you will need to use <code>$ XDG_RUNTIME_DIR=~/.run dbus-launch seatd-launch sway</code>)

You can also create a simple alias in your shell rc file (e.g. .zshrc), like:
<pre>
alias swayinit="XDG_RUNTIME_DIR=~/.run dbus-launch seatd-launch sway"
</pre>

See the [https://wiki.alpinelinux.org/wiki/Wayland Wayland] page for a permanent configuration

{{Note|
swaylock needs to be able to read your <code>/etc/shadow</code> file to be able to validate your password
}}

== Configuration and Usage ==

An example config is provided at <code>/etc/sway/config</code>. Copy it to <code>~/.config/sway/config</code> and read through it to learn the default keybindings.

You might want to have gaps between windows, in which case add:
<pre>
inner_gaps 20
outer_gaps 20
</pre>
(replace 20 with the amount of pixels you want to be used for gaps) in your sway config.

You might have two monitors, and you might want to set their position, so here's an example of how to do it:
<pre>
output eDP-1 mode 1920x1080@60Hz
output eDP-1 position 1920,0
output DP-1 position 0,0
output DP-1 mode 1920x1080@120Hz
</pre>
In this case, eDP-1 is the internal laptop monitor running at 60Hz and DP-1 is the external monitor running at 120Hz. The position of the laptop monitor is where the external monitor's width ends, so if the display is 1920 pixels wide and it is on the left, the laptop's monitor would be on the right, so it's width would start at the end of the second monitor's width, so at 1920. Replace the eDP-1 and DP-1 outputs with your own ones, and to change resolution and refresh rate, change the mode according to your parameters.

For additional information, start at <code>man 5 sway</code> and read the [https://github.com/swaywm/sway/wiki upstream FAQ].

[[Category:Desktop]]