River: Difference between revisions

Latest revision as of 07:11, 9 January 2025

River is a dynamic tiling Wayland compositor.

Note: Before installing any desktop,

Setup your Internet access, if not done already, before you proceed further.
Create a non-privileged user account for security reasons, if you skipped this step during Installation.
Enable community repository.
Install graphics driver for your video hardware.

The setup-wayland-base script installs and enables elogind as seat manager, enables community repository and enables eudev automatically as these are required for Wayland to work.

Installation

Install River and the documentation:

# apk add river river-doc

river-doc is required if you want use the example config.

Install your choice of additional packages:

This list includes icons, fonts, and a terminal emulator named foot which is the default in River's sample init file that we will use later.

# apk add adwaita-icon-theme foot font-dejavu

Set up eudev

Setting up eudev on a desktop system is recommended in Alpine Linux. Without a fully functional device manager users will not be able to connect to input devices. The alpine-conf package provides setup-devd script to easily install and setup device managers.

Setup eudev.

# setup-devd udev

For more details and other options see eudev.

Install Graphics Drivers

Install graphics driver for your video hardware. Without proper driver, River will fail to start.

Setup up a seat manager

Wayland compositors need raw access to input and output devices. This is mediated by a seat manager.

Configure either seatd or elogind as both are supported. However using both may lead to conflicts. Install and configure seatd to start automatically.

Running River

Before running River for the first time, copy the sample init file to ~/.config:

install -Dm0755 /usr/share/doc/river/examples/init -t ~/.config/river

Set XDG_RUNTIME_DIR and then start River:

river

Troubleshooting

Following are a few notes that are most certainly not related to River whatsoever but rather discovered while running River so I'm tacking them onto the end of this wiki.

Firefox 89.0.1 complains on launch "glxtest: libpci missing", resolved by:

apk add pciutils-libs

Firefox 89.0.1 complains continuously "Unable to load hand2 from the cursor theme", resolved by:

mkdir -p ~/.icons/default ln -s /usr/share/icons/Adwaita/cursors ~/.icons/default/cursors

@@ Line 1: / Line 1: @@
-[https://github.com/riverwm/river River] is a dynamic tiling Wayland compositor. An introduction to River can be found in [https://isaacfreund.com/blog/river-intro/ this blog post] by the developer for the 0.1.0 release.
+[https://github.com/riverwm/river River] is a dynamic tiling [[Wayland]] compositor.
-This wiki was written starting from a fresh install using the Alpine 3.14.2 x86_64 extended .iso. The steps begin from the first reboot after running setup-alpine and performing a sys install to disk.
+{{:Include:Desktop prerequisites}}
+The <Code>setup-wayland-base</Code> script installs and enables [[elogind]] as [[Seat manager|seat manager]], enables [[Repositories#Community|community repository]] and enables [[eudev]] automatically as these are required for Wayland to work.
-Many steps below were taken from the [https://wiki.alpinelinux.org/wiki/Sway wiki entry for installing Sway].
 == Installation ==
-Login as root.
+Install River and the documentation:
-Edit the repositories file and uncomment the community and testing repos. For 3.14.2, we need edge/community to get the correct software versions to support River:
+{{Cmd|# apk add {{Pkg|river}} {{Pkg|river-doc}}}}
-{{Cat|/etc/apk/repositories|
-http://dl-cdn.alpinelinux.org/alpine/v3.14/main
-#http://dl-cdn.alpinelinux.org/alpine/v3.14/community
-#http://dl-cdn.alpinelinux.org/alpine/edge/main
-http://dl-cdn.alpinelinux.org/alpine/edge/community
-http://dl-cdn.alpinelinux.org/alpine/edge/testing
-}}
-Install & configure eudev:
+<code>river-doc</code> is required if you want use the example config.
-{{Cmd|apk update
+Install your choice of additional packages:
-apk add eudev
-setup-udev}}
-Then install the mesa gallium drivers:
+This list includes icons, fonts, and a terminal emulator named foot which is the default in River's sample init file that we will use later.
-{{Cmd|apk add mesa-dri-gallium}}
-The following links contain guides for setting up the video stack.
+{{Cmd|# apk add {{Pkg|adwaita-icon-theme}} {{Pkg|foot}} {{Pkg|font-dejavu}}}}
-* [https://wiki.alpinelinux.org/wiki/Intel_Video Intel Video]
+=== Set up eudev ===
-* [https://wiki.alpinelinux.org/wiki/Radeon_Video Radeon Video]
+{{:Include:Setup_Device_Manager}}
-Install River and the documentation:
+=== Install Graphics Drivers ===
-{{Cmd|apk add river river-doc mandoc}}
+Install [[graphics driver]] for your video hardware. Without proper driver, River will fail to start.
-Install your choice of additional packages:
+=== Setup up a seat manager ===
-This list includes icons, fonts, and a terminal emulator named foot which is the default in River's sample init file that we will use later.
+Wayland compositors need raw access to input and output devices. This is mediated by a [[seat manager]].
-{{Cmd|apk add adwaita-icon-theme foot ttf-dejavu}}
-Set seatd to start automatically at next boot and also manually start it for this session:
+Configure either [[seatd]] or [[elogind]] as both are supported. However using both may lead to conflicts.
+[[Seatd|Install and configure seatd to start automatically]].
-{{Cmd|rc-update add seatd
-rc-service seatd start}}
-Create a new user and update group membership:
-{{Cmd|adduser sodface
-addgroup sodface audio
-addgroup sodface input
-addgroup sodface seat
-addgroup sodface video
-addgroup sodface wheel
-}}
-Install sudo and run visudo, uncommenting the desired permissions for the wheel group:
-{{Cmd|apk add sudo && visudo}}
-Logout and log back in as the new user.
 == Running River ==
@@ Line 65: / Line 36: @@
 Before running River for the first time, copy the sample init file to ~/.config:
-{{Cmd|install -Dm0755 /usr/share/doc/river/example/init -t ~/.config/river}}
+{{Cmd|install -Dm0755 /usr/share/doc/river/examples/init -t ~/.config/river}}
-Start River:
+Set [[Wayland#XDG_RUNTIME_DIR|XDG_RUNTIME_DIR]] and then start River:
-{{Cmd|1=XDG_RUNTIME_DIR=/tmp river}}
+{{Cmd|1=river}}
-[[Category:Desktop]]
+== Troubleshooting ==
-== Notes ==
 Following are a few notes that are most certainly not related to River whatsoever but rather discovered while running River so I'm tacking them onto the end of this wiki.
 Firefox 89.0.1 complains on launch "glxtest: libpci missing", resolved by:
-{{Cmd|sudo apk add pciutils-libs}}
+{{Cmd|apk add {{Pkg|pciutils-libs}}}}
 Firefox 89.0.1 complains continuously "Unable to load hand2 from the cursor theme", resolved by:
 {{Cmd|mkdir -p ~/.icons/default
-ln -s /usr/share/icons/Adwaita/cursors .icons/default/cursors}}
+ln -s /usr/share/icons/Adwaita/cursors ~/.icons/default/cursors}}
+== See also ==
+[https://isaacfreund.com/blog/river-intro/ An introduction to River]
+[[Category:Compositor]]
+[[Category:Desktop]]
+[[Category:Wayland]]