Skip to content

Xrdp

services.xrdp.audio.enable

Whether to enable audio support for xrdp sessions. So far it only works with PulseAudio sessions on the server side. No PipeWire support yet. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/xrdp.nix

services.xrdp.audio.package

The pulseaudio-module-xrdp package to use. Type: package

Default

pkgs.pulseaudio-module-xrdp

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/xrdp.nix

services.xrdp.defaultWindowManager

The script to run when user log in, usually a window manager, e.g. "icewm", "xfce4-session" This is per-user overridable, if file ~/startwm.sh exists it will be used instead.

Type: string

Default

"xterm"

Example

"xfce4-session"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/xrdp.nix

services.xrdp.enable

Whether to enable xrdp, the Remote Desktop Protocol server. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/xrdp.nix

services.xrdp.extraConfDirCommands

Extra commands to run on the default confDir derivation.

Type: string

Default

""

Example

'' substituteInPlace $out/sesman.ini \ --replace LogLevel=INFO LogLevel=DEBUG \ --replace LogFile=/dev/null LogFile=/var/log/xrdp.log''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/xrdp.nix

services.xrdp.openFirewall

Whether to open the firewall for the specified RDP port. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/xrdp.nix

services.xrdp.package

The xrdp package to use. Type: package

Default

pkgs.xrdp

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/xrdp.nix

services.xrdp.port

Specifies on which port the xrdp daemon listens.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

3389

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/xrdp.nix

services.xrdp.sslCert

ssl certificate path A self-signed certificate will be generated if file not exists.

Type: string

Default

"/etc/xrdp/cert.pem"

Example

"/path/to/your/cert.pem"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/xrdp.nix

services.xrdp.sslKey

ssl private key path A self-signed certificate will be generated if file not exists.

Type: string

Default

"/etc/xrdp/key.pem"

Example

"/path/to/your/key.pem"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/xrdp.nix