River: Difference between revisions

From Alpine Linux
No edit summary
(1. Enhanced Beginning to distinguish River from the new river-classic fork; 2. Added suggestions for other packages, including bash/zsh/fish completion; and hints to search: first for river-classic*, etc.; 3. Proposed merging Troubleshooting content into Firefox page; 4. Changed instances of River to river-classic, its new name - may need page title change unless new River version 0.4 is integrated here, if made available; 5. Style amendments)
 
(29 intermediate revisions by 11 users not shown)
Line 1: Line 1:
[https://github.com/riverwm/river River] is a dynamic tiling [[Wayland]] compositor. '''River''' ''"upstream"'' has developed into [https://codeberg.org/river/river/releases/tag/v0.3.12 two different projects]:-
* '''river-classic''', which is an upstream fork of the original '''River''' version 0.3, now known under that [https://codeberg.org/river/river-classic new name].  As of November 2025, it is '''the only version available on Alpine Linux''': it can be downloaded as {{Pkg|river-classic}} from the edge community repository while it retains its legacy name as {{Pkg|river|branch=v3.22}} in the Alpine Linux v3.22 and v3.21 community repositories. {{Pill||v3.22.x|green|palegreen}} {{Pill||v3.21.x|cadetblue|lightblue}}
* The current '''River''' project upstream, version 0.4+, which is developing under their new ''river-window-management-v1 protocol'', also known by its ''rwm tag''.
Updating the original {{ic|river}} package from version 0.3 to version 0.4 would cause breakages, and therefore, distinct projects are being developed upstream.


{{Note|The package testing/river is currently broken. See this comment by the developer https://gitlab.alpinelinux.org/alpine/aports/-/merge_requests/27227#note_191521 on the GitLab merge request.}}
== Prerequisites ==
 
{{:Include:Desktop prerequisites}}
[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. 
* 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 the [[Seat manager|seat manager]] and also enables the [[Repositories#Community|community repository]] and [[eudev]].
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.
 
Many steps below were taken from the [https://wiki.alpinelinux.org/wiki/Sway wiki entry for installing Sway].


== Installation ==
== Installation ==


Login as root.
Install '''river-classic''' and its documentation:
* Under Alpine Linux v3.22 and v3.21 {{Pill||v3.22.x|green|palegreen}} {{Pill||v3.21.x|cadetblue|lightblue}}
:{{Cmd|# apk add {{Pkg|river|branch=v3.22}} {{Pkg|river-doc|branch=v3.22}}}}


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:
* Under Alpine Linux Edge version
{{Cat|/etc/apk/repositories|
:{{Cmd|# apk add {{Pkg|river-classic}} {{Pkg|river-classic-doc}}}}
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:
The <code>-doc</code> packages are required to use the example config.


{{Cmd|apk update
Install your choice of additional packages.  The following list includes icons, fonts and a terminal emulator named '''foot''', which is the default in '''river-classic''''s sample init file that we will use later.
apk add eudev
setup-udev}}


Then install graphics drivers appropriate to your system:
{{Cmd|# apk add {{Pkg|adwaita-icon-theme}} {{Pkg|foot}} {{Pkg|font-dejavu}}}}


{{Cmd|apk add mesa-dri-gallium # gallium
Further packages that are available include the following.  Ensure that the [[Repositories#Using_testing_repository|edge repository is enabled and tagged]] first before installing any of the following with the ''@testing'' tag, last checked in November 2025:-
apk add mesa-dri-classic # or classic}}
* {{Pkg|rivercarro}} for a fork of the rivertile layout (tag as @testing);
* {{Pkg|river-luatile}} to write layouts in lua (tag as @testing);
* {{Pkg|river-shifttags}} to enable the reordering of tags (tag as @testing):
* {{Pkg|river-bedload}} to send info to STDOUT (tag as @testing);
* those for bash/zsh/fish completion (some are in @testing, some in community repo): say, {{Pkg|river-bash-completion|branch=v3.22}} in Alpine Linux v3.22 community repo, or {{Pkg|river-classic-bash-completion}} in Alpine Linux Edge community;
To begin a search for any more packages:-
* If running Edge, run {{ic|apk search -v river-classic}} first, or see {{Pkg|river-classic*}}.
* For Alpine Linux v3.22/v3.21, or for a cruder, more generic search, one could try {{ic|<nowiki>apk search -v river | grep -v 'driver'</nowiki>}} , which would exclude the term 'driver'; {{ic|apk search -v river}}; or see {{Pkg|river*|branch=3.22}} for packages that begin with that term.


The following links contain guides for setting up the video stack.
== Running river-classic ==


* [https://wiki.alpinelinux.org/wiki/Intel_Video Intel Video]
Before running '''river-classic''' for the first time, copy the sample init file to {{Path|~/.config}}:
* [https://wiki.alpinelinux.org/wiki/Radeon_Video Radeon Video]


Install River and the documentation:
{{Cmd|install -Dm0755 /usr/share/doc/river/examples/init -t ~/.config/river}}


{{Cmd|apk add river river-doc mandoc}}
Set [[Wayland#XDG_RUNTIME_DIR|XDG_RUNTIME_DIR]] and then start '''river-classic'''/'''river''' with the same instruction:
{{Cmd|river}}


Install your choice of additional packages:
== Troubleshooting ==
{{Merge|Firefox}}
The following are a few observations discovered while running '''river-classic''';  although not directly related to the compositor, they have been tacked onto the end of this wiki.


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.
Firefox 89.0.1 complained of ''"glxtest: libpci missing"'' on launch, resolved with:
{{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|apk add {{Pkg|pciutils-libs}}}}


{{Cmd|rc-update add seatd
Firefox 89.0.1 furthermore complained continuously:  ''"Unable to load hand2 from the cursor theme"'', resolved as follows:
rc-service seatd start}}


Create a new user and update group membership:
{{Cmd|mkdir -p ~/.icons/default
{{Cmd|adduser sodface
ln -s /usr/share/icons/Adwaita/cursors ~/.icons/default/cursors}}
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 ==
 
Before running River for the first time, copy the sample init file from /etc/river to ~/.config:
 
{{Cmd|install -Dm0755 /usr/share/example/river/init -t ~/.config/river}}
 
Start River:


{{Cmd|1=XDG_RUNTIME_DIR=/tmp river}}
== See also ==


[[Category:Desktop]]
* [https://isaacfreund.com/blog/river-intro/ An introduction to River - isaacfreund.com]


== Notes ==
[[Category:Compositor]]
 
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}}
 
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}}

Latest revision as of 04:14, 27 November 2025

River is a dynamic tiling Wayland compositor. River "upstream" has developed into two different projects:-

  • river-classic, which is an upstream fork of the original River version 0.3, now known under that new name. As of November 2025, it is the only version available on Alpine Linux: it can be downloaded as river-classic from the edge community repository while it retains its legacy name as river in the Alpine Linux v3.22 and v3.21 community repositories.

v3.22.x v3.21.x

  • The current River project upstream, version 0.4+, which is developing under their new river-window-management-v1 protocol, also known by its rwm tag.

Updating the original river package from version 0.3 to version 0.4 would cause breakages, and therefore, distinct projects are being developed upstream.

Prerequisites

Installation

Install river-classic and its documentation:

  • Under Alpine Linux v3.22 and v3.21

v3.22.x v3.21.x

# apk add river river-doc

  • Under Alpine Linux Edge version

# apk add river-classic river-classic-doc

The -doc packages are required to use the example config.

Install your choice of additional packages. The following list includes icons, fonts and a terminal emulator named foot, which is the default in river-classic's sample init file that we will use later.

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

Further packages that are available include the following. Ensure that the edge repository is enabled and tagged first before installing any of the following with the @testing tag, last checked in November 2025:-

To begin a search for any more packages:-

  • If running Edge, run apk search -v river-classic first, or see river-classic*.
  • For Alpine Linux v3.22/v3.21, or for a cruder, more generic search, one could try apk search -v river | grep -v 'driver' , which would exclude the term 'driver'; apk search -v river; or see river* for packages that begin with that term.

Running river-classic

Before running river-classic 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-classic/river with the same instruction:

river

Troubleshooting

This material is proposed for merging ...

It should be merged with Firefox. (Discuss)

The following are a few observations discovered while running river-classic; although not directly related to the compositor, they have been tacked onto the end of this wiki.

Firefox 89.0.1 complained of "glxtest: libpci missing" on launch, resolved with:

apk add pciutils-libs

Firefox 89.0.1 furthermore complained continuously: "Unable to load hand2 from the cursor theme", resolved as follows:

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

See also