Alpine Linux - User contributions [en]

Wayland

2025-11-06T09:18:22Z

Bezzumnbiu: Fix mistake

[https://en.wikipedia.org/wiki/Wayland%20(protocol) Wayland] is a new display protocol that aims to replace [[Xorg|X11]]. Wayland requires a [[Seat manager|seat manager]] to work.

The {{ic|setup-wayland-base}} script installs and enables [[elogind]] as [[Seat manager|seat manager]] besides enabling [[Repositories#Community|community repository]] and [[eudev]].

== Compositors ==

Display servers that implement the Wayland display server protocol are also called Wayland compositors because they additionally perform the task of a compositing window manager.

Multiple compositor implementations exist, including [[Sway]], [https://en.wikipedia.org/wiki/Mutter%20(software) Mutter] ([[GNOME]]'s compositor) and [https://en.wikipedia.org/wiki/KWin Kwin] ([[KDE]]'s compositor). The following [[:Category:Compositor|compositors]] are available in Alpine Linux.

== XDG_RUNTIME_DIR ==

As per the protocol spec, Wayland compositors require the <code>XDG_RUNTIME_DIR</code> variable to be set.

=== With elogind ===

When using [[elogind]] as a seat manager, it exports <code>XDG_RUNTIME_DIR</code> and other XDG environment variables automatically for each session. No further configuration is required.

=== With pam_rundir ===

[https://github.com/jjk-jacky/pam_rundir pam_rundir] is a [[PAM]] module that provides the runtime directory variable. Installing the package {{pkg|pam-rundir}} takes care of dependencies and no further configuration is required.

{{Note| <code>XDG_RUNTIME_DIR</code> variable MUST be initialised before the Wayland compositor, and also before the D-Bus session instance is started in your startup script/file for both the methods listed below.}}

=== With mkrundir ===

[https://git.sr.ht/~whynothugo/mkrundir mkrundir] is an executable that can be used to initialise the runtime directory explicitly by each user. To use <code>mkrundir</Code>, install the package {{pkg|mkrundir}} available in [[Repositories#Testing|testing]] repository. In your shell init script (e.g.: {{Path|~/.profile}} include an entry as follows at the '''top''' of the file {{Cat|~/.profile|...
export XDG_RUNTIME_DIR{{=}}$(mkrundir)
...}}

As per [https://git.sr.ht/~whynothugo/mkrundir mkrundir] website, this might have issues inside containers, due to privilege escalation.

=== Creating and exporting XDG_RUNTIME_DIR manually ===

Generally, care should be taken when configuring the <code>XDG_*</code> variables manually as this configuration may have errors or conflict with other utilities that do this automatically. Use this only on a system that's not using [[elogind]] and other solutions outlined above cannot handle this.

The <code>XDG_RUNTIME_DIR</code> can be initialised manually by adding below snippet to shell init scripts (e.g.: {{Path|~/.profile}}):

{{Cat|~/.profile|<nowiki>if [ -z "$XDG_RUNTIME_DIR" ]; then
XDG_RUNTIME_DIR="/tmp/$(id -u)-runtime-dir"

mkdir -pm 0700 "$XDG_RUNTIME_DIR"
export XDG_RUNTIME_DIR
fi
</nowiki>}}

== Troubleshooting ==

=== error: XDG_RUNTIME_DIR is invalid or not set in the environment ===

The above error message appears when starting services/applications that require the environment variable [[#XDG_RUNTIME_DIR|XDG_RUNTIME_DIR]] to be set. Fix it using one of the above methods before proceeding.

== See also ==

* [https://wiki.archlinux.org/title/Wayland Wayland - Arch Wiki]
* [https://wiki.gentoo.org/wiki/Wayland Wayland - Gentoo Wiki]
* [https://en.wikipedia.org/wiki/Wayland_(protocol) Wayland (protocol) - Wikipedia]

[[Category:Desktop]]
[[Category:Wayland]]
[[Category:Compositor]]

MDNS

2025-06-04T07:20:42Z

Bezzumnbiu: fix mistakes

{{DISPLAYTITLE:mDNS}}
[https://en.wikipedia.org/wiki/Multicast_DNS Multicast DNS] is a protocol that is normally used for the discovery of printers. Avahi is a popular implementation by but more setup is needed for the regular name resolution to see the results.

== Setup avahi ==

Install, enable and start avahi with:{{cmd|$ doas apk add {{pkg|avahi}}
$ doas rc-update add avahi-daemon
$ doas rc-service avahi-daemon start}}

It should now be possible to browse results. To look for a printer, use:

{{cmd|$ doas apk add {{pkg|avahi-tools}}
$ avahi-browse --resolve --terminate _ipp._tcp}}

Make note of the hostname, as we will use it afterwards.

== Setup avahi2dns ==

Name resolution is implemented by musl, and it only supports DNS, so we have to map the avahi results to a regular DNS server. This is done by [https://github.com/LouisBrunner/avahi2dns avahi2dns]. As of now, {{pkg|avahi2dns}} package is available in the [[Repositories#Testing|testing]] repository. It can be safely installed by following the [[Repositories#Using_testing_repository|guidelines]].

{{cmd|$ doas apk add avahi2dns@testing}}

since we will want a full DNS server running at port 53, we need to configure avahi2dns to use another port. This is done by default with {{path|/etc/conf.d/avahi2dns}} containing:

command_args="-p 5354"

Enable and start avahi2dns with the command:{{cmd|$ doas rc-update add avahi2dns
$ doas rc-service avahi2dns start}}

It should now be possible to use DNS to query the address of the printer:{{cmd|$ drill -p 5354 @127.0.0.1 <printer_name>.local}}

Where printer_name is the hostname given by avahi-browse.

== Setup Networkmanager ==

If you are already using [[NetworkManager|Networkmanager]], you can leverage {{pkg|dnsmasq}} as your DNS server which can easily forward mDNS requests to another server.

Install the {{pkg|networkmanager-dnsmasq}} package: {{cmd|$ doas apk add {{pkg|networkmanager-dnsmasq}}}}

Configure networkmanager to use dnsmasq as it's dns server by editing {{path|/etc/NetworkManager/NetworkManager.conf}} as follows {{Cat|/etc/NetworkManager/NetworkManager.conf|<nowiki>[main]
dhcp=internal
dns=dnsmasq</nowiki>}}

Then we need to tell dnsmasq to forward all mDNS queries to avahidns by editing the file {{path|/etc/NetworkManager/dnsmasq.d/mdns.conf}} as follows {{Cat|/etc/NetworkManager/dnsmasq.d/mdns.conf|# Forward queries for the "local" domain to 127.0.0.1 port 5354
server{{=}}/local/127.0.0.1#5354}}

Restart networkmanager: {{cmd|$ doas rc-service networkmanager restart}}

== Without NetworkManager ==

If you are not using [[NetworkManager|Networkmanager]], you will need to setup a DNS resolver that will forward request of .local domain to avahi2dns and handle other requests normally. There is more than one way to do it.

=== Setup unbound as DNS resolver ===

We will use [[Setting up unbound DNS server|unbound]] as the server and {{ic|resolvconf}} tool to inform unbound about the DHCP results. This option is probably most convenient for a laptop: using the DHCP provided by the server for the regular DNS requests.

Install the programs: {{cmd|$ doas apk add {{pkg|openresolv}} {{pkg|unbound}}}}

Create {{path|/etc/resolvconf.conf}} as follows:{{Cat|/etc/resolvconf.conf|<nowiki>name_servers=127.0.0.1
unbound_conf=/etc/unbound/unbound.conf.d/resolvconf.conf</nowiki>}}

This tells resolveconf to use a local nameserver and pass the DHCP provided DNS server to unbound. Create {{path|/etc/unbound/unbound.conf.d/avahi-local.conf}} as follows {{Cat|/etc/unbound/unbound.conf.d/avahi-local.conf|
forward-zone:
name: "local"
forward-addr: 127.0.0.1@5354
server:
do-not-query-localhost: no
domain-insecure: "local"
}}
This reads the information provided by resolvconf, but forwards .local requests to avahi2dns. We also need to disable dnssec for .local and tell unbound that it is OK to query localhost.

Enable and start unbound. {{cmd|$ doas rc-update add unbound
$ doas rc-service unbound start}}

=== Using existing bind server as DNS resolver ===

It is assumed that a bind(named) server is already installed and running, if not, then you can use the instructions [[Small-Time_DNS_with_BIND9]]

Once the bind(named) server is up and running, then the solution is to set an access "zone" for postfix addresses.local

To do this, add the following lines to the bind configuration file {{path|/etc/bind/named.conf}} as follows {{Cat|/etc/bind/named.conf|

zone "local" {
type forward; # type requests
forward only; # rule to use only forwards
forwarders {
127.0.0.1 port 5354; # Avahi2dns address and port
};
};
}}
Additionally, you may need to disable dnssec verification for the .local postfix. To do this, add the following lines inside the options configuration {{Cat|/etc/bind/named.conf|...

options {
...
validate-except {
"local";
};
...
};
}}
After adding the configuration, double-check that you have a .local zone. To do this, use the command: {{Cmd|$ named-checkconf -l # OUTPUT: local IN _default forward}}

If there were no errors, you can reload the bind(named) service:{{Cmd|$ doas rc-service named reload}}

=== Setup DHCP client ===

How send the DHCP provided DNS to resolvconf depends on the DHCP client being used.

==== udhcpc ====

This is the DHCP client in busybox, and will work for both wired and wireless interfaces. Create {{path|/etc/udhcpc/udhcpc.conf}} as follows {{path||/etc/udhcpc/udhcpc.conf|<nowiki>
RESOLV_CONF="/etc/udhcpc-resolv.conf"</nowiki>}}

Create the file {{path|/etc/udhcpc/post-bound/resolvconf}} as follows {{Cat|/etc/udhcpc/post-bound/resolvconf|
#!/bin/sh
cat /etc/udhcpc-resolv.conf | resolvconf -a $interface
}}
and make it executable {{cmd|$ doas chmod 755 /etc/udhcpc/post-bound/resolvconf}}

==== iwd ====

When using [[iwd]] an inconvenience of this setup is that udhcpc will not reconfigure the interface when connecting to other wifi networks. For that to happen one has to run

{{cmd|$ iwctl station wlan0 connect <network_name>
$ doas kill -USR2 $(cat /run/udhcpc.wlan0.pid)
$ doas kill -USR1 $(cat /run/udhcpc.wlan0.pid)}}

To avoid having to manually reconfigure the wifi interface, we can configure [[iwd]] to use DHCP internally and forward DNS server info to resolveconf. To do that create the file {{path|/etc/iwd/main.conf}} as follows {{Cat|/etc/iwd/main.conf|<nowiki>[General]
EnableNetworkConfiguration=True

[Network]
NameResolvingService=resolvconf</nowiki>}}

== Troubleshooting ==

=== Test the setup ===

You should be able to query for both the printer address and regular addresses with: {{cmd|$ drill @127.0.0.1 <printer_name>.local
$ drill @127.0.0.1 alpinelinux.org}}

Your {{path|/etc/resolv.conf}} should also contain {{Cat|/etc/resolv.conf|nameserver 127.0.0.1}}

Printer discovery should now be working.

=== Failure in parallel query of A and AAAA requsts ===

An issue with parallel query of A and AAAA requsts was reported to [https://github.com/LouisBrunner/avahi2dns/issues/21 upstream] related to ipv4/ipv6 dual-setups and since been resolved in Alpine Linux {{MR|82560}} by adding a timeout 2.5s.

[[Category:Networking]]
[[Category:Printers]]

MDNS

2025-04-02T05:29:29Z

Bezzumnbiu: add another config to use bind(named) with mDNS

{{DISPLAYTITLE:mDNS}}
[https://en.wikipedia.org/wiki/Multicast_DNS Multicast DNS] is a protocol that is normally used for the discovery of printers. Avahi is a popular implementation by but more setup is needed for the regular name resolution to see the results.

== Setup avahi ==

Install, enable and start avahi with:

{{cmd|doas apk add {{pkg|avahi}}
doas rc-update add avahi-daemon
doas rc-service avahi-daemon start}}

It should now be possible to browse results. To look for a printer, use:

{{cmd|doas apk add {{pkg|avahi-tools}}
avahi-browse --resolve --terminate _ipp._tcp}}

Make note of the hostname, as we will use it afterwards.

== Setup avahi2dns ==

Name resolution is implemented by musl, and it only supports DNS, so we have to map the avahi results to a regular DNS server. This is done by avahi2dns.

{{cmd|doas apk add {{pkg|avahi2dns}}}}

since we will want a full DNS server running at port 53, we need to configure avahi2dns to use another port. This is done by default with {{path|/etc/conf.d/avahi2dns}} containing:

command_args="-p 5354"

Enable and start avahi2dns with

{{cmd|doas rc-update add avahi2dns
doas rc-service avahi2dns start}}

It should now be possible to use DNS to query the address of the printer.

{{cmd|drill -p 5354 @127.0.0.1 <printer_name>.local}}

Where printer_name is the hostname given by avahi-browse.

== Setup Networkmanager ==

If you are already using networkmanager, you can leverage {{pkg|dnsmasq}} as your DNS server which can easily forward mDNS requests to another server.

Install the {{pkg|networkmanager-dnsmasq}} package:

{{cmd|doas apk add {{pkg|networkmanager-dnsmasq}}}}

Configure networkmanager to use dnsmasq as it's dns server by editing {{path|/etc/NetworkManager/NetworkManager.conf}}

[main]
dhcp=internal
dns=dnsmasq

Then we need to tell dnsmasq to forward all mDNS queries to avahidns {{path|/etc/NetworkManager/dnsmasq.d/mdns.conf}}:

# Forward queries for the "local" domain to 127.0.0.1 port 5354
server=/local/127.0.0.1#5354

Restart networkmanager:

{{cmd|doas rc-service networkmanager restart}}

== Without NetworkManager ==

=== Setup DNS resolver ===

If you are not using NetworkManager, you will need to setup a DNS resolver that will forward request of .local domain to avahi2dns and handle other requests normally. There is more than one way to do it, but we document an option that is probably most convenient for a laptop: using the DHCP provided server for the regular DNS requests. We will use unbound as the server and resolvconf to inform unbound about the DHCP results.

Install the programs:

{{cmd|doas apk add {{pkg|openresolv}} {{pkg|unbound}}}}

Create {{path|/etc/resolvconf.conf}}:

name_servers=127.0.0.1
unbound_conf=/etc/unbound/unbound.conf.d/resolvconf.conf

This tells resolveconf to use a local nameserver and pass the DHCP provided DNS server to unbound

Create {{path|/etc/unbound/unbound.conf.d/avahi-local.conf}}:

forward-zone:
name: "local"
forward-addr: 127.0.0.1@5354
server:
do-not-query-localhost: no
domain-insecure: "local"

This reads the information provided by resolvconf, but forwards .local requests to avahi2dns. We also need to disable dnssec for .local and tell unbound that it is OK to query localhost.

Enable and start unbound

{{cmd|doas rc-update add unbound
doas rc-service unbound start}}

=== Using bind(named) as DNS resolver ===

It is assumed that bind(named) is already installed and running, if not, then you can use the instructions[[https://wiki.alpinelinux.org/wiki/Small-Time_DNS_with_BIND9]]

If you already have a bind(named) server configured, then the solution is to set an access "zone" for postfix addresses.local

To do this, add the following lines to the bind configuration file (by default, the /etc/bind/named.conf file is used):

zone "local" {
type forward; # type requests
forward only; # rule to use only forwards
forwarders {
127.0.0.1 port 5354; # Avahi2dns adress and port
};
};

Additionally, you may need to disable dnssec verification for the .local postfix. To do this, add the following lines inside the options configuration:

options {
...
validate-except {
"local";
};
...
};

After adding the configuration, double-check that you have a .local zone. To do this, use the command:

named-checkconf -l # OUTPUT: local IN _default forward

If there were no errors, you can reload the bind(named) service:

rc-service named reload

=== Setup DHCP client ===

How send the DHCP provided DNS to resolvconf depends on the DHCP client being used.

==== udhcpc ====

This is the DHCP client in busybox, and will work for both wired and wireless interfaces.

Create {{path|/etc/udhcpc/udhcpc.conf}}:

RESOLV_CONF="/etc/udhcpc-resolv.conf"

Create {{path|/etc/udhcpc/post-bound/resolvconf}}:

#!/bin/sh
cat /etc/udhcpc-resolv.conf | resolvconf -a $interface

and make it executable

{{cmd|chmod 755 /etc/udhcpc/post-bound/resolvconf}}

An inconvenience of this setup is that udhcpc will not reconfigure the interface when connecting to other wifi networks. For that to happen one has to run

{{cmd|iwctl station wlan0 connect <network_name>
doas kill -USR2 $(cat /run/udhcpc.wlan0.pid)
doas kill -USR1 $(cat /run/udhcpc.wlan0.pid)}}

==== iwd ====

To avoid having to manually reconfigure the wifi interface, we can configure iwd to use DHCP internally and forward DNS server info to resolveconf. To do that create {{path|/etc/iwd/main.conf}}:

[General]
EnableNetworkConfiguration=True

[Network]
NameResolvingService=resolvconf

== Test the setup ==

You should now be able to query for both the printer address and regular addresses with

{{cmd|drill @127.0.0.1 <printer_name>.local
drill @127.0.0.1 alpinelinux.org}}

Your {{path|/etc/resolv.conf}} should also contain

nameserver 127.0.0.1

Printer discovery should now be working.

[[Category:Networking]]