Skip to content

Rkvm

services.rkvm.client.enable

Whether to enable the rkvm client daemon (input receiver). Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rkvm.nix

services.rkvm.client.settings

Structured client daemon configuration Type: TOML value

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rkvm.nix

services.rkvm.client.settings.certificate

TLS ceritficate path.

::: {.note} This should be generated with {command}rkvm-certificate-gen. :::

Type: path

Default

"/etc/rkvm/certificate.pem"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rkvm.nix

services.rkvm.client.settings.password

Shared secret token to authenticate the client. Make sure this matches your server's config.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rkvm.nix

services.rkvm.client.settings.server

An RKVM server's internet socket address, either IPv4 or IPv6.

Type: string

Example

"192.168.0.123:5258"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rkvm.nix

services.rkvm.enable

Whether to enable rkvm, a Virtual KVM switch for Linux machines.

Type: boolean

Default

config.services.rkvm.server.enable || config.services.rkvm.client.enable

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rkvm.nix

services.rkvm.package

The rkvm package to use. Type: package

Default

pkgs.rkvm

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rkvm.nix

services.rkvm.server.enable

Whether to enable the rkvm server daemon (input transmitter). Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rkvm.nix

services.rkvm.server.settings

Structured server daemon configuration Type: TOML value

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rkvm.nix

services.rkvm.server.settings.certificate

TLS certificate path.

::: {.note} This should be generated with {command}rkvm-certificate-gen. :::

Type: path

Default

"/etc/rkvm/certificate.pem"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rkvm.nix

services.rkvm.server.settings.key

TLS key path.

::: {.note} This should be generated with {command}rkvm-certificate-gen. :::

Type: path

Default

"/etc/rkvm/key.pem"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rkvm.nix

services.rkvm.server.settings.listen

An internet socket address to listen on, either IPv4 or IPv6.

Type: string

Default

"0.0.0.0:5258"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rkvm.nix

services.rkvm.server.settings.password

Shared secret token to authenticate the client. Make sure this matches your client's config.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rkvm.nix

services.rkvm.server.settings.switch-keys

A key list specifying a host switch combination.

A list of key names is available in https://github.com/htrefil/rkvm/blob/master/switch-keys.md.

Type: list of string

Default

["left-alt""left-ctrl"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rkvm.nix