groups: - name: Rust Desk Configuration description: Configure Rust Desk - name: User and Group Configuration description: Configure User and Group for Rust Desk - name: Network Configuration description: Configure Network for Rust Desk - name: Storage Configuration description: Configure Storage for Rust Desk - name: Resources Configuration description: Configure Resources for Rust Desk questions: - variable: rustConfig label: "" group: Rust Desk Configuration schema: type: dict attrs: - variable: allowOnlyEncryptedConnections label: Allow Only Encrypted Connections description: | Allow only encrypted connections.
Clients have to use the generated key to connect to the server. schema: type: boolean default: false - variable: additionalRelayServers label: Additional Relay Servers description: | Configure additional relay servers for Rust Desk.
The internal relay server will be added automatically.
Format:
host:port schema: type: list default: [] items: - variable: relayServer label: Relay Server schema: type: string required: true - variable: additionalEnvs label: Additional Environment Variables description: Configure additional environment variables for Rust Desk. schema: type: list default: [] items: - variable: env label: Environment Variable schema: type: dict attrs: - variable: name label: Name schema: type: string required: true - variable: value label: Value schema: type: string required: true - variable: rustRunAs label: "" group: User and Group Configuration schema: type: dict attrs: - variable: user label: User ID description: The user id that Rust Desk will run as. schema: type: int min: 2 default: 568 required: true - variable: group label: Group ID description: The group id that Rust Desk will run as. schema: type: int min: 2 default: 568 required: true - variable: rustNetwork label: "" group: Network Configuration schema: type: dict attrs: - variable: natTypeTestPort label: NAT Type Test Port description: | The port to use for NAT type test.
Internal port will always be 21115 schema: type: int default: 21115 min: 9000 max: 65535 required: true - variable: idRegHolePunchPort label: ID Registration and Hole Punching Port description: | The port to use for ID registration and Hole punching.
Internal port will always be 21116 (TCP/UDP) schema: type: int default: 21116 min: 9000 max: 65535 required: true - variable: relayPort label: Relay Port description: | The port to use for relay.
Internal port will always be 21117 schema: type: int default: 21117 min: 9000 max: 65535 required: true - variable: enableWebClientPorts label: Enable Web Client Ports description: | Enable web client ports.
This is only required for web clients.
schema: type: boolean default: true - variable: serverWebClientsPort label: Server Web Clients Port description: | The port to use for server web clients.
Internal port will always be 21118 schema: type: int default: 21118 min: 9000 max: 65535 required: true show_if: [["enableWebClientPorts", "=", true]] - variable: relayWebClientsPort label: Relay Web Clients Port description: | The port to use for relay web clients.
Internal port will always be 21119 schema: type: int default: 21119 min: 9000 max: 65535 required: true show_if: [["enableWebClientPorts", "=", true]] - variable: hostNetwork label: Host Network description: | Bind to the host network. It's recommended to keep this disabled.
schema: type: boolean default: false - variable: rustStorage label: "" group: Storage Configuration schema: type: dict attrs: - variable: data label: Rust Desk Data Storage description: The path to store Rust Desk Data. schema: type: dict attrs: - variable: type label: Type description: | ixVolume: Is dataset created automatically by the system.
Host Path: Is a path that already exists on the system. schema: type: string required: true immutable: true default: "ixVolume" enum: - value: "hostPath" description: Host Path (Path that already exists on the system) - value: "ixVolume" description: ixVolume (Dataset created automatically by the system) - variable: ixVolumeConfig label: ixVolume Configuration description: The configuration for the ixVolume dataset. schema: type: dict show_if: [["type", "=", "ixVolume"]] $ref: - "normalize/ixVolume" attrs: - variable: aclEnable label: Enable ACL description: Enable ACL for the dataset. schema: type: boolean default: false - variable: datasetName label: Dataset Name description: The name of the dataset to use for storage. schema: type: string required: true immutable: true hidden: true default: "data" - variable: aclEntries label: ACL Configuration schema: type: dict show_if: [["aclEnable", "=", true]] attrs: [] - variable: hostPathConfig label: Host Path Configuration schema: type: dict show_if: [["type", "=", "hostPath"]] attrs: - variable: aclEnable label: Enable ACL description: Enable ACL for the dataset. schema: type: boolean default: false - variable: acl label: ACL Configuration schema: type: dict show_if: [["aclEnable", "=", true]] attrs: [] $ref: - "normalize/acl" - variable: hostPath label: Host Path description: The host path to use for storage. schema: type: hostpath show_if: [["aclEnable", "=", false]] required: true - variable: additionalStorages label: Additional Storage description: Additional storage for Rust Desk. schema: type: list default: [] items: - variable: storageEntry label: Storage Entry schema: type: dict attrs: - variable: type label: Type description: | ixVolume: Is dataset created automatically by the system.
Host Path: Is a path that already exists on the system.
SMB Share: Is a SMB share that is mounted to a persistent volume claim. schema: type: string required: true default: "ixVolume" immutable: true enum: - value: "hostPath" description: Host Path (Path that already exists on the system) - value: "ixVolume" description: ixVolume (Dataset created automatically by the system) - value: "smb-pv-pvc" description: SMB Share (Mounts a persistent volume claim to a SMB share) - variable: readOnly label: Read Only description: Mount the volume as read only. schema: type: boolean default: false - variable: mountPath label: Mount Path description: The path inside the container to mount the storage. schema: type: path required: true - variable: hostPathConfig label: Host Path Configuration schema: type: dict show_if: [["type", "=", "hostPath"]] attrs: - variable: aclEnable label: Enable ACL description: Enable ACL for the dataset. schema: type: boolean default: false - variable: acl label: ACL Configuration schema: type: dict show_if: [["aclEnable", "=", true]] attrs: [] $ref: - "normalize/acl" - variable: hostPath label: Host Path description: The host path to use for storage. schema: type: hostpath show_if: [["aclEnable", "=", false]] required: true - variable: ixVolumeConfig label: ixVolume Configuration description: The configuration for the ixVolume dataset. schema: type: dict show_if: [["type", "=", "ixVolume"]] $ref: - "normalize/ixVolume" attrs: - variable: aclEnable label: Enable ACL description: Enable ACL for the dataset. schema: type: boolean default: false - variable: datasetName label: Dataset Name description: The name of the dataset to use for storage. schema: type: string required: true immutable: true default: "storage_entry" - variable: aclEntries label: ACL Configuration schema: type: dict show_if: [["aclEnable", "=", true]] attrs: [] - variable: smbConfig label: SMB Share Configuration description: The configuration for the SMB Share. schema: type: dict show_if: [["type", "=", "smb-pv-pvc"]] attrs: - variable: server label: Server description: The server for the SMB share. schema: type: string required: true - variable: share label: Share description: The share name for the SMB share. schema: type: string required: true - variable: domain label: Domain (Optional) description: The domain for the SMB share. schema: type: string - variable: username label: Username description: The username for the SMB share. schema: type: string required: true - variable: password label: Password description: The password for the SMB share. schema: type: string required: true private: true - variable: size label: Size (in Gi) description: The size of the volume quota. schema: type: int required: true min: 1 default: 1 - variable: resources group: Resources Configuration label: "" schema: type: dict attrs: - variable: limits label: Limits schema: type: dict attrs: - variable: cpu label: CPU description: CPU limit for Rust Desk. schema: type: string max_length: 6 valid_chars: '^(0\.[1-9]|[1-9][0-9]*)(\.[0-9]|m?)$' valid_chars_error: | Valid CPU limit formats are
- Plain Integer - eg. 1
- Float - eg. 0.5
- Milicpu - eg. 500m default: "4000m" required: true - variable: memory label: Memory description: Memory limit for Rust Desk. schema: type: string max_length: 12 valid_chars: '^[1-9][0-9]*([EPTGMK]i?|e[0-9]+)?$' valid_chars_error: | Valid Memory limit formats are
- Suffixed with E/P/T/G/M/K - eg. 1G
- Suffixed with Ei/Pi/Ti/Gi/Mi/Ki - eg. 1Gi
- Plain Integer in bytes - eg. 1024
- Exponent - eg. 134e6 default: "8Gi" required: true