River: Difference between revisions

Latest revision as of 10:45, 17 March 2025

River is a dynamic tiling Wayland compositor.

Prerequisites

Internet connectivity, unless the packages have been pre-fetched into a local cache.
A non-root user account.
The community repository must be enabled.
Set up eudev.
Install and configure D-Bus. without D-Bus icons and keyboard shortcuts may be missing.
Install appropriate Graphics driver drivers for your hardware. Without graphics drivers, errors are likely to occur.
Wayland compositors need raw access to input and output devices, typically mediated by a seat manager. Either seatd or elogind work fine, but installing both leads to conflicts.
Installing wayland-base enables elogind as seat manager, enables community repository and enables eudev.

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

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.
+== Prerequisites ==
+{{:Include:Desktop prerequisites}}
-Many steps below were taken from the [https://wiki.alpinelinux.org/wiki/Sway wiki entry for installing Sway].
+* Wayland compositors need raw access to input and output devices, typically mediated by a [[seat manager]]. Either [[seatd]] or [[elogind]] work fine, but installing both leads to conflicts.
+* Installing [[Alpine_setup_scripts#setup-wayland-base|wayland-base]] enables [[elogind]] as [[Seat manager|seat manager]], enables [[Repositories#Community|community repository]] and enables [[eudev]].
 == 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:
-{{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:
-{{Cmd|apk update
+{{Cmd|# apk add {{Pkg|river}} {{Pkg|river-doc}}}}
-apk add eudev
-setup-udev}}
-Then install graphics drivers appropriate to your system:
+<code>river-doc</code> is required if you want use the example config.
-{{Cmd|apk add mesa-dri-gallium  # gallium
-apk add mesa-dri-classic  # or classic}}
-The following links contain guides for setting up the video stack.
-* [https://wiki.alpinelinux.org/wiki/Intel_Video Intel Video]
-* [https://wiki.alpinelinux.org/wiki/Radeon_Video Radeon Video]
-Install River and the documentation:
-{{Cmd|apk add river river-doc mandoc}}
 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.
-{{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:
-{{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.
+{{Cmd|# apk add {{Pkg|adwaita-icon-theme}} {{Pkg|foot}} {{Pkg|font-dejavu}}}}
 == Running River ==
@@ Line 66: / Line 24: @@
 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:
-{{Cmd|1=XDG_RUNTIME_DIR=/tmp river}}
+Set [[Wayland#XDG_RUNTIME_DIR|XDG_RUNTIME_DIR]] and then start River:
-[[Category:Desktop]]
+{{Cmd|1=river}}
-== Notes ==
+== 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:
-{{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]]