River - Revision history

John3-16: 1. Added instructions for v3.23 in further passages; 2. Added/amended pills for v2.23; 3. Amended style

2025-12-19T18:06:05Z

1. Added instructions for v3.23 in further passages; 2. Added/amended pills for v2.23; 3. Amended style

John3-16: /* Installation */ Added instruction for v3.23 specifically as being the same as for Edge, added 'current-stable' pill, and reordered this instruction to prioritize it over v3.22 and v.3.21

2025-12-17T18:58:37Z

Installation: Added instruction for v3.23 specifically as being the same as for Edge, added 'current-stable' pill, and reordered this instruction to prioritize it over v3.22 and v.3.21

← Older revision		Revision as of 18:58, 17 December 2025
Line 12:		Line 12:

	Install '''river-classic''' and its documentation:		Install '''river-classic''' and its documentation:
			* Under Alpine Linux v3.23 and Edge versions{{Pill\|Version:\|current\|purple\|cornflowerblue}}
			:{{Cmd\|# apk add {{Pkg\|river-classic}} {{Pkg\|river-classic-doc}}}}

	* Under Alpine Linux v3.22 and v3.21 {{Pill\|\|v3.22.x\|green\|palegreen}} {{Pill\|\|v3.21.x\|cadetblue\|lightblue}}		* 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}}}}		:{{Cmd\|# apk add {{Pkg\|river\|branch=v3.22}} {{Pkg\|river-doc\|branch=v3.22}}}}

	* Under Alpine Linux Edge version
	~~:{{Cmd\|# apk add {{Pkg\|river-classic}} {{Pkg\|river-classic-doc}}}}~~

	The <code>-doc</code> packages are required to use the example config.		The <code>-doc</code> packages are required to use the example config.

John3-16: 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

2025-11-27T04:14:08Z

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

← Older revision		Revision as of 04:14, 27 November 2025
Line 1:		Line 1:
	[https://github.com/riverwm/river River] is a dynamic tiling [[Wayland]] compositor.		[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.

	== Prerequisites ==		== Prerequisites ==
	{{:Include:Desktop prerequisites}}		{{:Include:Desktop prerequisites}}
	* 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.		* 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]].		* 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]].

	== Installation ==		== Installation ==

	Install ~~River~~ and ~~the~~ documentation:		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}}}}

	{{Cmd\|# apk add {{Pkg\|river}} {{Pkg\|river-doc}}}}		* Under Alpine Linux Edge version
			:{{Cmd\|# apk add {{Pkg\|river-classic}} {{Pkg\|river-classic-doc}}}}

	<code>~~river~~-doc</code> is required ~~if you want~~ use the example config.		The <code>-doc</code> packages are required to use the example config.

	Install your choice of additional packages:		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.

	~~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 {{Pkg\|adwaita-icon-theme}} {{Pkg\|foot}} {{Pkg\|font-dejavu}}}}

	{{~~Cmd~~\|~~# apk add~~ {{Pkg\|~~adwaita~~-~~icon~~-~~theme~~}} {{Pkg\|~~foot~~}} {{Pkg\|~~font~~-~~dejavu~~}}}}		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:-
			* {{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.

	== Running ~~River~~ ==		== Running river-classic ==

	Before running ~~River~~ for the first time, copy the sample init file to ~/.config:		Before running '''river-classic''' for the first time, copy the sample init file to {{Path\|~/.config}}:

	{{Cmd\|install -Dm0755 /usr/share/doc/river/examples/init -t ~/.config/river}}		{{Cmd\|install -Dm0755 /usr/share/doc/river/examples/init -t ~/.config/river}}

	Set [[Wayland#XDG_RUNTIME_DIR\|XDG_RUNTIME_DIR]] and then start ~~River~~:		Set [[Wayland#XDG_RUNTIME_DIR\|XDG_RUNTIME_DIR]] and then start '''river-classic'''/'''river''' with the same instruction:
			{{Cmd\|river}}
	{{Cmd\|1=river}}

	== Troubleshooting ==		== 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.

	~~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 complained of ''"glxtest: libpci missing"'' on launch, resolved with:

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

	{{Cmd\|apk add {{Pkg\|pciutils-libs}}}}		{{Cmd\|apk add {{Pkg\|pciutils-libs}}}}

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

	{{Cmd\|mkdir -p ~/.icons/default		{{Cmd\|mkdir -p ~/.icons/default
Line 45:		Line 58:
	== See also ==		== See also ==

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

	[[Category:Compositor]]		[[Category:Compositor]]

Prabuanand: removed :Category:Desktop as per Help_talk:Style

2025-05-25T15:29:39Z

removed Category:Desktop as per Help_talk:Style

← Older revision		Revision as of 15:29, 25 May 2025
Line 45:		Line 45:
	== See also ==		== See also ==

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

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

Prabuanand: added heading Prerequisites

2025-03-17T10:45:19Z

added heading Prerequisites

← Older revision		Revision as of 10:45, 17 March 2025
Line 1:		Line 1:
	[https://github.com/riverwm/river River] is a dynamic tiling [[Wayland]] compositor.		[https://github.com/riverwm/river River] is a dynamic tiling [[Wayland]] compositor.

			== Prerequisites ==
	{{:Include:Desktop prerequisites}}		{{: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~~.		* 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 ==		== Installation ==
Line 17:		Line 19:

	{{Cmd\|# apk add {{Pkg\|adwaita-icon-theme}} {{Pkg\|foot}} {{Pkg\|font-dejavu}}}}		{{Cmd\|# apk add {{Pkg\|adwaita-icon-theme}} {{Pkg\|foot}} {{Pkg\|font-dejavu}}}}

	~~=== Set up eudev ===~~
	~~{{:Include:Setup_Device_Manager}}~~

	~~=== 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.~~
	~~[[Seatd\|Install and configure seatd to start automatically]].~~

	== Running River ==		== Running River ==
Line 56:		Line 44:

	== See also ==		== See also ==

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

Prabuanand: Added reference to setup-wayland-base script

2025-01-09T07:11:56Z

Added reference to setup-wayland-base script

← Older revision		Revision as of 07:11, 9 January 2025
Line 1:		Line 1:
	[https://github.com/riverwm/river River] is a dynamic tiling [[Wayland]] compositor.		[https://github.com/riverwm/river River] is a dynamic tiling [[Wayland]] compositor.

			{{: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.

	== Installation ==		== Installation ==

	~~{{:Include:Desktop prerequisites}}~~

	Install River and the documentation:		Install River and the documentation:

Prabuanand: rearranged headings included Set up eudev etc

2025-01-09T05:38:28Z

rearranged headings included Set up eudev etc

@@ 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.
 == Installation ==
-Login as root.
+{{:Include:Desktop prerequisites}}
 Install River and the documentation:
@@ Line 41: / Line 17: @@
 {{Cmd|# apk add {{Pkg|adwaita-icon-theme}} {{Pkg|foot}} {{Pkg|font-dejavu}}}}
 [[Seatd|Install and configure seatd to start automatically]].
 == Running River ==
@@ Line 55: / Line 41: @@
 {{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.
@@ Line 67: / Line 53: @@
 {{Cmd|mkdir -p ~/.icons/default
 ln -s /usr/share/icons/Adwaita/cursors ~/.icons/default/cursors}}
 [[Category:Compositor]]
 [[Category:Desktop]]
 [[Category:Wayland]]

Zcrayfish: /* Notes */ Make filepath less ambiguous.

2024-06-03T02:22:14Z

Notes: Make filepath less ambiguous.

← Older revision		Revision as of 02:22, 3 June 2024
Line 66:		Line 66:

	{{Cmd\|mkdir -p ~/.icons/default		{{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}}

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

WhyNotHugo: Add category compositor

2024-06-02T21:12:36Z

Add category compositor

← Older revision		Revision as of 21:12, 2 June 2024
Line 68:		Line 68:
	ln -s /usr/share/icons/Adwaita/cursors .icons/default/cursors}}		ln -s /usr/share/icons/Adwaita/cursors .icons/default/cursors}}

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

WhyNotHugo: /* Installation */ deduplicate seatd section

2024-03-03T10:02:46Z

Installation: deduplicate seatd section

← Older revision		Revision as of 10:02, 3 March 2024
Line 41:		Line 41:
	{{Cmd\|# apk add {{Pkg\|adwaita-icon-theme}} {{Pkg\|foot}} {{Pkg\|font-dejavu}}}}		{{Cmd\|# apk add {{Pkg\|adwaita-icon-theme}} {{Pkg\|foot}} {{Pkg\|font-dejavu}}}}

	~~Set~~ seatd to start automatically ~~at next boot and also manually start it for this session:~~		[[Seatd\|Install and configure seatd to start automatically]].

	~~{{Cmd\|# rc-update add {{Pkg\|seatd}}~~
	~~<nowiki>#</nowiki> rc-service {{Pkg\|seatd}} start}}~~

	~~Create a new user and update group membership:~~
	~~{{Cmd\|<nowiki># adduser $USER seat~~
	~~# adduser $USER input~~
	~~# adduser $USER video~~
	~~</nowiki>}}~~

	Logout and log back in as the new user.		Logout and log back in as the new user.

← Older revision		Revision as of 18:06, 19 December 2025
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]:-		[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}}~~		{{Pill\|text=v3.23.x}} {{Pill\|\|v3.22.x\|green\|palegreen}} {{Pill\|\|v3.21.x\|cadetblue\|lightblue}}
			* '''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 December 2025, it is ''the only version available'' on Alpine Linux: it can be downloaded as {{Pkg\|river-classic}} from Alpine Linux v3.23 and Edge community repositories, while it retains its legacy name as {{Pkg\|river\|branch=v3.22}} in the v3.22 and v3.21 community repositories.
	* 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''.		* 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.		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.
Line 12:		Line 13:

	Install '''river-classic''' and its documentation:		Install '''river-classic''' and its documentation:
	* Under Alpine Linux v3.23 and Edge versions{{Pill\|~~Version:~~\|~~current\|purple\|cornflowerblue~~}}		* Under Alpine Linux v3.23 and Edge versions {{Pill\|\|text=v3.23.x}}
	:{{Cmd\|# apk add {{Pkg\|river-classic}} {{Pkg\|river-classic-doc}}}}		:{{Cmd\|# apk add {{Pkg\|river-classic}} {{Pkg\|river-classic-doc}}}}

Line 24:		Line 25:
	{{Cmd\|# apk add {{Pkg\|adwaita-icon-theme}} {{Pkg\|foot}} {{Pkg\|font-dejavu}}}}		{{Cmd\|# apk add {{Pkg\|adwaita-icon-theme}} {{Pkg\|foot}} {{Pkg\|font-dejavu}}}}

	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:-		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:-
	* {{Pkg\|rivercarro}} for a fork of the rivertile layout (tag as @testing);		* {{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-luatile}} to write layouts in lua (tag as '''@testing''');
	* {{Pkg\|river-shifttags}} to enable the reordering of tags (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);		* {{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;		* those for bash/zsh/fish completion (some are in '''@testing''', some in '''community''' repo): say, {{Pkg\|river-classic-bash-completion}} in Alpine Linux v3.23 or Edge community, or {{Pkg\|river-bash-completion\|branch=v3.22}} in Alpine Linux v3.22 community repo.
	To begin a search for any more packages:-		To begin a search for any more packages:-
	* If running Edge, ~~run~~ {{ic\|apk search -v river-classic}} first, or see {{Pkg\|river-classic*}}.		* If running v3.23 or Edge, try {{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.		* For Alpine Linux v3.22/v3.21, or for a cruder, more generic search regardless of the Alpine Linux version, 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.

	== Running river-classic ==		== Running river-classic ==