How to run Spice Agent - Revision history

Sertonix: update & deactivate links

2023-08-25T02:57:02Z

update & deactivate links

Bbbhltz: added category

2023-05-26T20:43:44Z

added category

← Older revision		Revision as of 20:43, 26 May 2023
Line 101:		Line 101:
	==Rebuild the kernel to include uinput==		==Rebuild the kernel to include uinput==
	See [[Custom_Kernel]] for pointers on how to build a custom kernel. The option you'll need to change in the config is <code>CONFIG_INPUT_UINPUT</code>.		See [[Custom_Kernel]] for pointers on how to build a custom kernel. The option you'll need to change in the config is <code>CONFIG_INPUT_UINPUT</code>.

			[[Category:Virtualization]]

Bbbhltz: /* Before You Start */ update link to page instead of redirect, minor formatting

2023-05-26T20:39:05Z

Before You Start: update link to page instead of redirect, minor formatting

← Older revision		Revision as of 20:39, 26 May 2023
Line 20:		Line 20:
	=Before You Start=		=Before You Start=
	Most features of the Spice Agent are only useful when running a graphical interface.		Most features of the Spice Agent are only useful when running a graphical interface.
	I roughly followed the [[~~Awesome(wm)_Setup~~]] guide, but substituted <code>awesome</code> with <code>i3wm</code> as that has my preference (you have to install ~~<code>~~i3status~~</code>~~ manually, and use <code>i3</code> in the <code>.xinitrc</code> file).		I roughly followed the [[AwesomeWM]] guide, but substituted <code>awesome</code> with <code>i3wm</code> as that has my preference (you have to install {{Pkg\|i3status}} manually, and use <code>i3</code> in the <code>.xinitrc</code> file).

	For the Spice Agent to work, don't remove the <code>Channel spice</code> that is automatically added by Libvirt.		For the Spice Agent to work, don't remove the <code>Channel spice</code> that is automatically added by Libvirt.

MartinJM: Added information on autostarting spice-vdagent instead of just spice-vdagentd.

2021-02-08T15:44:06Z

Added information on autostarting spice-vdagent instead of just spice-vdagentd.

← Older revision		Revision as of 15:44, 8 February 2021
Line 67:		Line 67:
	# rc-update add spice-vdagentd default		# rc-update add spice-vdagentd default

			The above will start the <code>spice-vdagentd</code>, but not the <code>spice-vdagent</code>. As the <code>spice-vdagent</code> should be started with the de/wm you're using, there is not one general way which works for all setups. If you want to find a way that works for you, [https://wiki.archlinux.org/index.php/Autostarting#On_desktop_environment_startup the Arch wiki has a decent page on autostarting].

	=Using the virt edition of Alpine=		=Using the virt edition of Alpine=

MartinJM: Added information on init script and installing the uinput module when using the virt kernel.

2021-02-05T15:47:34Z

Added information on init script and installing the uinput module when using the virt kernel.

← Older revision		Revision as of 15:47, 5 February 2021
Line 38:		Line 38:
	$ make		$ make

	Install the program (should be optional, but I haven't tried it without yet):		Install the program (should be optional when running manually, but I haven't tried it without yet):
	# make install		# make install


	=Running the Spice Agent=		=Running the Spice Agent=
	~~{{Draft\|While this works, it's very rough and the steps need to be performed every time you want to run it. It would be nice to have init scripts to do this.}}~~

			==Running manually==
	First start the <code>spice-vdagentd</code>:		First start the <code>spice-vdagentd</code>:
	# modprobe uinput		# modprobe uinput
Line 54:		Line 54:
	$ spice-vdagent -x -d		$ spice-vdagent -x -d
	Notice that there is no need to run this last command as root.		Notice that there is no need to run this last command as root.

			==Running with init script==
			''This assumes you ran <code>make install</code> at the end of building. If you have not, you'll have to change this accordingly. It also requires that <code>uinput</code> can be loaded with <code>modprobe</code>. If you cannot, look at [[#Using_the_virt_edition_of_Alpine]].''

			To run with an init script, we will use the Gentoo init script, although we have to change the paths to make it work properly (latest commit is <code>b3b3e1d9a13c389f17e01c78c6c1a996d08420b5</code> at the time of writing):
			$ wget https://gitweb.gentoo.org/repo/gentoo.git/plain/app-emulation/spice-vdagent/files/spice-vdagent.initd-4
			$ sed 's,/var/run,/run,g;s,/usr/sbin,/usr/local/sbin,g' spice-vdagent.initd-4 > spice-vdagentd
			Then we move the file to the right location, change the ownership, make it executable and add it to the default runlevel:
			# mv spice-vdagentd /etc/init.d/
			# chown root:root /etc/init.d/spice-vdagentd
			# chmod +x /etc/init.d/spice-vdagentd
			# rc-update add spice-vdagentd default


	=Using the virt edition of Alpine=		=Using the virt edition of Alpine=
	This currently does not work on the virt edition (version 3.12.1), as it doesn't have <code>uinput</code> enabled in the kernel. However, there are still several ways to get it working.		This currently does not work on the virt edition (version 3.12.1), as it doesn't have <code>uinput</code> enabled in the kernel. However, there are still several ways to get it working.

	==Run without ~~the~~ uinput==		==Run without uinput==
	You can make the <code>spice-vdagentd</code> work without the uinput module by starting it as follows, but it will disable the cursor while the <code>spice-vdagent</code> is running:		You can make the <code>spice-vdagentd</code> work without the uinput module by starting it as follows, but it will disable the cursor while the <code>spice-vdagent</code> is running:
	# mkdir /run/spice-vdagentd		# mkdir /run/spice-vdagentd
Line 64:		Line 77:

	==Build uinput as module==		==Build uinput as module==
	{{Draft\|~~This will build the module, and it can be loaded~~, but ~~it doesn't install the module. This~~ has ~~yet~~ to be ~~added~~.}}		{{Draft\|The following contains all necessary information, but has to be rewritten to be more clear.}}
	Follow the steps in [[Creating_an_Alpine_package#Setup_your_system_and_account\|Setup your system and account for building packages]] and cd to the {{Path\|aports/main/linux-lts}} directory.		Follow the steps in [[Creating_an_Alpine_package#Setup_your_system_and_account\|Setup your system and account for building packages]] and cd to the {{Path\|aports/main/linux-lts}} directory.
	Check that the kernel version you've pulled is the same that you're running with <code>uname -r</code> and <code>head APKBUILD</code>.		Check that the kernel version you've pulled is the same that you're running with <code>uname -r</code> and <code>head APKBUILD</code>.
Line 80:		Line 93:
	# insmod drivers/input/misc/uinput.ko		# insmod drivers/input/misc/uinput.ko
	After this, you can use the spice agent as described in [[How_to_run_Spice_Agent#Running_the_Spice_Agent\|Running the Spice Agent]], except that the <code>modprobe uinput</code> is not necessary.		After this, you can use the spice agent as described in [[How_to_run_Spice_Agent#Running_the_Spice_Agent\|Running the Spice Agent]], except that the <code>modprobe uinput</code> is not necessary.

			Alternatively, you can "install" the module by copying it to {{Path\|/lib/modules/`uname -r`/extra}} (which you'll most likely have to create first) and running <code>depmod</code> (as root).
			After this, you can load the module normally with <code>modprobe uinput</code>.
			This is necessary if you want to use the init script as described in [[#Running_with_init_script]].

	==Rebuild the kernel to include uinput==		==Rebuild the kernel to include uinput==
	See [[Custom_Kernel]] for pointers on how to build a custom kernel. The option you'll need to change in the config is <code>CONFIG_INPUT_UINPUT</code>.		See [[Custom_Kernel]] for pointers on how to build a custom kernel. The option you'll need to change in the config is <code>CONFIG_INPUT_UINPUT</code>.

MartinJM: Added information on how to get uinput working on the virt edition.

2020-11-11T13:58:48Z

Added information on how to get uinput working on the virt edition.

@@ Line 34: / Line 34: @@
 We need this specific version because the newest version requires a newer <code>spice-protocol</code> version than is provided by the repositories (version 0.14.1). If you follow this guide with a later version of Alpine, you may want to get a newer version from git as well.
-Build the code (still in the <code>vd_agent</code> directory):
+Build the code (still in the {{Path|vd_agent}} directory):
    $ ./autogen.sh
    $ make
@@ Line 56: / Line 56: @@
 =Using the virt edition of Alpine=
-This currently does not work on the virt edition (version 3.12.1), as it doesn't have the <code>uinput</code> module enabled in the kernel.
+This currently does not work on the virt edition (version 3.12.1), as it doesn't have <code>uinput</code> enabled in the kernel. However, there are still several ways to get it working.
-You can still make the <code>spice-vdagentd</code> work by starting it as follows, but it will disable the cursor while the <code>spice-vdagent</code> is running:
+==Run without the uinput==
    # mkdir /run/spice-vdagentd
    # spice-vdagentd -d -x -X -u /dev/null -f

MartinJM at 14:22, 1 November 2020

2020-11-01T14:22:45Z

← Older revision		Revision as of 14:22, 1 November 2020
Line 29:		Line 29:

	Get the source code:		Get the source code:
	$ git clone ~~(TODO~~: ~~LINK TO VDAGENT GIT ON FREEDESKTOP GITLAB)~~		$ git clone https://gitlab.freedesktop.org/spice/linux/vd_agent.git
	$ cd vd_agent		$ cd vd_agent
	$ git checkout spice-vdagent-0.20.0		$ git checkout spice-vdagent-0.20.0

MartinJM at 14:22, 1 November 2020

2020-11-01T14:22:23Z

← Older revision		Revision as of 14:22, 1 November 2020
Line 20:		Line 20:
	=Before You Start=		=Before You Start=
	Most features of the Spice Agent are only useful when running a graphical interface.		Most features of the Spice Agent are only useful when running a graphical interface.
	I roughly followed the (~~TODO: LINK TO AWESOME SETUP GUIDE~~) guide, but substituted <code>awesome</code> with <code>i3wm</code> as that has my preference (you have to install <code>i3status</code> manually, and use <code>i3</code> in the <code>.xinitrc</code> file).		I roughly followed the [[Awesome(wm)_Setup]] guide, but substituted <code>awesome</code> with <code>i3wm</code> as that has my preference (you have to install <code>i3status</code> manually, and use <code>i3</code> in the <code>.xinitrc</code> file).

	For the Spice Agent to work, don't remove the <code>Channel spice</code> that is automatically added by Libvirt.		For the Spice Agent to work, don't remove the <code>Channel spice</code> that is automatically added by Libvirt.

MartinJM: Created page with "=How To Run Spice Agent in Alpine= This is a guide on how to run Spice Agent in Alpine Linux 3.12.1-standard. The Spice Agent can be used to get some additional features wh..."

2020-11-01T14:20:48Z

Created page with "=How To Run Spice Agent in Alpine= This is a guide on how to run Spice Agent in Alpine Linux 3.12.1-standard. The Spice Agent can be used to get some additional features wh..."

New page

=How To Run Spice Agent in Alpine=

This is a guide on how to run Spice Agent in Alpine Linux 3.12.1-standard.

The Spice Agent can be used to get some additional features when running Alpine Linux in a Qemu/Libvirt VM.

=Features=
Working:
* Client mouse mode
* Automatic adjustment of the X-session resolution
* Clipboard sharing

Not working:
* The <code>State</code> field in Libvirt - it always shows "disconnected", even when it is working

Not tested:
* Transferring files
* Multiple displays/screens

=Before You Start=
Most features of the Spice Agent are only useful when running a graphical interface.
I roughly followed the (TODO: LINK TO AWESOME SETUP GUIDE) guide, but substituted <code>awesome</code> with <code>i3wm</code> as that has my preference (you have to install <code>i3status</code> manually, and use <code>i3</code> in the <code>.xinitrc</code> file).

For the Spice Agent to work, don't remove the <code>Channel spice</code> that is automatically added by Libvirt.

=Building the Spice Agent=
Install the dependencies:
# apk add alpine-sdk autoconf automake glib-dev libxfixes-dev libxrandr-dev libxinerama-dev spice-protocol alsa-lib-dev dbus-dev libdrm-dev libpciaccess-dev

Get the source code:
$ git clone (TODO: LINK TO VDAGENT GIT ON FREEDESKTOP GITLAB)
$ cd vd_agent
$ git checkout spice-vdagent-0.20.0
We need this specific version because the newest version requires a newer <code>spice-protocol</code> version than is provided by the repositories (version 0.14.1). If you follow this guide with a later version of Alpine, you may want to get a newer version from git as well.

Build the code (still in the <code>vd_agent</code> directory):
$ ./autogen.sh
$ make

Install the program (should be optional, but I haven't tried it without yet):
# make install

=Running the Spice Agent=
{{Draft|While this works, it's very rough and the steps need to be performed every time you want to run it. It would be nice to have init scripts to do this.}}

First start the <code>spice-vdagentd</code>:
# modprobe uinput
# mkdir /run/spice-vdagentd
# spice-vdagentd -d -x -X
<small>You can also remove the lower-case <code>-x</code> flag to deamonize the <code>spice-vdagentd</code>.</small>

Then start the <code>spice-vdagent</code>:
$ spice-vdagent -x -d
Notice that there is no need to run this last command as root.

=Using the virt edition of Alpine=
This currently does not work on the virt edition (version 3.12.1), as it doesn't have the <code>uinput</code> module enabled in the kernel.

You can still make the <code>spice-vdagentd</code> work by starting it as follows, but it will disable the cursor while the <code>spice-vdagent</code> is running:
# mkdir /run/spice-vdagentd
# spice-vdagentd -d -x -X -u /dev/null -f

← Older revision		Revision as of 02:57, 25 August 2023
Line 29:		Line 29:

	Get the source code:		Get the source code:
	$ git clone https://gitlab.freedesktop.org/spice/linux/vd_agent.git		$ git clone <nowiki>https://gitlab.freedesktop.org/spice/linux/vd_agent.git</nowiki>
	$ cd vd_agent		$ cd vd_agent
	$ git checkout spice-vdagent-0.20.0		$ git checkout spice-vdagent-0.20.0
Line 59:		Line 59:

	To run with an init script, we will use the Gentoo init script, although we have to change the paths to make it work properly (latest commit is <code>b3b3e1d9a13c389f17e01c78c6c1a996d08420b5</code> at the time of writing):		To run with an init script, we will use the Gentoo init script, although we have to change the paths to make it work properly (latest commit is <code>b3b3e1d9a13c389f17e01c78c6c1a996d08420b5</code> at the time of writing):
	$ wget https://gitweb.gentoo.org/repo/gentoo.git/plain/app-emulation/spice-vdagent/files/spice-vdagent.initd-4		$ wget <nowiki>https://gitweb.gentoo.org/repo/gentoo.git/plain/app-emulation/spice-vdagent/files/spice-vdagent.initd-4</nowiki>
	$ sed 's,/var/run,/run,g;s,/usr/sbin,/usr/local/sbin,g' spice-vdagent.initd-4 > spice-vdagentd		$ sed 's,/var/run,/run,g;s,/usr/sbin,/usr/local/sbin,g' spice-vdagent.initd-4 > spice-vdagentd
	Then we move the file to the right location, change the ownership, make it executable and add it to the default runlevel:		Then we move the file to the right location, change the ownership, make it executable and add it to the default runlevel:
Line 67:		Line 67:
	# rc-update add spice-vdagentd default		# rc-update add spice-vdagentd default

	The above will start the <code>spice-vdagentd</code>, but not the <code>spice-vdagent</code>. As the <code>spice-vdagent</code> should be started with the de/wm you're using, there is not one general way which works for all setups. If you want to find a way that works for you, [https://wiki.archlinux.org/~~index.php~~/Autostarting#On_desktop_environment_startup the Arch wiki has a decent page on autostarting].		The above will start the <code>spice-vdagentd</code>, but not the <code>spice-vdagent</code>. As the <code>spice-vdagent</code> should be started with the de/wm you're using, there is not one general way which works for all setups. If you want to find a way that works for you, [https://wiki.archlinux.org/title/Autostarting#On_desktop_environment_startup the Arch wiki has a decent page on autostarting].

	=Using the virt edition of Alpine=		=Using the virt edition of Alpine=