Docs · 1.0

Companion Apps

This chapter covers the Companion apps menu: software that ships with this keelOS version, for the people who use it. Everyone who can log in sees this page.

Open Companion apps in the left menu.

1. kRDPclient

kRDPclient is keelOS's own remote desktop client for Windows (x64). It uses the host's video stream to show a VM's screen, maps USB devices from this computer into the VM, and also handles the clipboard and sound. Other RDP clients (such as mstsc) can connect too, but without these features.

1. Click Download with this host. While it is being prepared the button shows Preparing…; when it is done the browser downloads a zip file.
2. Unpack it on your Windows computer and run krdpclient.exe. This host is already added, with your token and this host's certificate generated for it, so once it opens you can see the VMs on this host.

Note: The zip contains a token with your permissions on this host. Do not forward it to anyone. kRDPclient imports it on first start and deletes the file. Every download creates a new token, shown in the token list of Accounts, Tokens and Permissions as "kRDPclient · your name · date". Revoke it there and that client stops working.

2. keelagent.exe

keelagent.exe runs inside a Windows VM that has a GPU (passed through or SR-IOV). It uses that GPU to encode the VM's picture, so kRDPclient gets a sharper image and the host has less work to do.

1. Turn on the agent channel for the VM (setting vnc.agent_channel), then cold-start the VM.
2. Click Download, copy keelagent.exe into the VM and double-click it.
3. In its window click "Install". It installs itself, together with its driver, as a service.

The card shows the file size and sha256 so you can check the file. For device passthrough see Device Passthrough and Hardware.

If this keelOS version ships no files, the page says "This keelOS version ships no files to download".