questions.yaml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350
  1. groups:
  2. - name: Rust Desk Configuration
  3. description: Configure Rust Desk
  4. - name: User and Group Configuration
  5. description: Configure User and Group for Rust Desk
  6. - name: Network Configuration
  7. description: Configure Network for Rust Desk
  8. - name: Storage Configuration
  9. description: Configure Storage for Rust Desk
  10. - name: Resources Configuration
  11. description: Configure Resources for Rust Desk
  12. questions:
  13. - variable: rustConfig
  14. label: ""
  15. group: Rust Desk Configuration
  16. schema:
  17. type: dict
  18. attrs:
  19. - variable: allowOnlyEncryptedConnections
  20. label: Allow Only Encrypted Connections
  21. description: |
  22. Allow only encrypted connections.</br>
  23. Clients have to use the generated key to connect to the server.
  24. schema:
  25. type: boolean
  26. default: false
  27. - variable: additionalRelayServers
  28. label: Additional Relay Servers
  29. description: |
  30. Configure additional relay servers for Rust Desk.</br>
  31. The internal relay server will be added automatically. </br>
  32. Format: </br> host:port
  33. schema:
  34. type: list
  35. default: []
  36. items:
  37. - variable: relayServer
  38. label: Relay Server
  39. schema:
  40. type: string
  41. required: true
  42. - variable: additionalEnvs
  43. label: Additional Environment Variables
  44. description: Configure additional environment variables for Rust Desk.
  45. schema:
  46. type: list
  47. default: []
  48. items:
  49. - variable: env
  50. label: Environment Variable
  51. schema:
  52. type: dict
  53. attrs:
  54. - variable: name
  55. label: Name
  56. schema:
  57. type: string
  58. required: true
  59. - variable: value
  60. label: Value
  61. schema:
  62. type: string
  63. required: true
  64. - variable: rustRunAs
  65. label: ""
  66. group: User and Group Configuration
  67. schema:
  68. type: dict
  69. attrs:
  70. - variable: user
  71. label: User ID
  72. description: The user id that Rust Desk will run as.
  73. schema:
  74. type: int
  75. min: 2
  76. default: 568
  77. required: true
  78. - variable: group
  79. label: Group ID
  80. description: The group id that Rust Desk will run as.
  81. schema:
  82. type: int
  83. min: 2
  84. default: 568
  85. required: true
  86. - variable: rustNetwork
  87. label: ""
  88. group: Network Configuration
  89. schema:
  90. type: dict
  91. attrs:
  92. - variable: natTypeTestPort
  93. label: NAT Type Test Port
  94. description: |
  95. The port to use for NAT type test.</br>
  96. Internal port will always be 21115
  97. schema:
  98. type: int
  99. default: 21115
  100. min: 9000
  101. max: 65535
  102. required: true
  103. - variable: idRegHolePunchPort
  104. label: ID Registration and Hole Punching Port
  105. description: |
  106. The port to use for ID registration and Hole punching.</br>
  107. Internal port will always be 21116 (TCP/UDP)
  108. schema:
  109. type: int
  110. default: 21116
  111. min: 9000
  112. max: 65535
  113. required: true
  114. - variable: relayPort
  115. label: Relay Port
  116. description: |
  117. The port to use for relay.</br>
  118. Internal port will always be 21117
  119. schema:
  120. type: int
  121. default: 21117
  122. min: 9000
  123. max: 65535
  124. required: true
  125. - variable: enableWebClientPorts
  126. label: Enable Web Client Ports
  127. description: |
  128. Enable web client ports.</br>
  129. This is only required for web clients.</br>
  130. schema:
  131. type: boolean
  132. default: true
  133. - variable: serverWebClientsPort
  134. label: Server Web Clients Port
  135. description: |
  136. The port to use for server web clients.</br>
  137. Internal port will always be 21118
  138. schema:
  139. type: int
  140. default: 21118
  141. min: 9000
  142. max: 65535
  143. required: true
  144. show_if: [["enableWebClientPorts", "=", true]]
  145. - variable: relayWebClientsPort
  146. label: Relay Web Clients Port
  147. description: |
  148. The port to use for relay web clients.</br>
  149. Internal port will always be 21119
  150. schema:
  151. type: int
  152. default: 21119
  153. min: 9000
  154. max: 65535
  155. required: true
  156. show_if: [["enableWebClientPorts", "=", true]]
  157. - variable: hostNetwork
  158. label: Host Network
  159. description: |
  160. Bind to the host network. It's recommended to keep this disabled.</br>
  161. schema:
  162. type: boolean
  163. default: false
  164. - variable: rustStorage
  165. label: ""
  166. group: Storage Configuration
  167. schema:
  168. type: dict
  169. attrs:
  170. - variable: data
  171. label: Rust Desk Data Storage
  172. description: The path to store Rust Desk Data.
  173. schema:
  174. type: dict
  175. attrs:
  176. - variable: type
  177. label: Type
  178. description: |
  179. ixVolume: Is dataset created automatically by the system.</br>
  180. Host Path: Is a path that already exists on the system.
  181. schema:
  182. type: string
  183. required: true
  184. immutable: true
  185. default: "ixVolume"
  186. enum:
  187. - value: "hostPath"
  188. description: Host Path (Path that already exists on the system)
  189. - value: "ixVolume"
  190. description: ixVolume (Dataset created automatically by the system)
  191. - variable: datasetName
  192. label: Dataset Name
  193. schema:
  194. type: string
  195. show_if: [["type", "=", "ixVolume"]]
  196. required: true
  197. hidden: true
  198. immutable: true
  199. default: "data"
  200. $ref:
  201. - "normalize/ixVolume"
  202. - variable: hostPath
  203. label: Host Path
  204. schema:
  205. type: hostpath
  206. show_if: [["type", "=", "hostPath"]]
  207. required: true
  208. - variable: additionalStorages
  209. label: Additional Storage
  210. description: Additional storage for Rust Desk.
  211. schema:
  212. type: list
  213. default: []
  214. items:
  215. - variable: storageEntry
  216. label: Storage Entry
  217. schema:
  218. type: dict
  219. attrs:
  220. - variable: type
  221. label: Type
  222. description: |
  223. ixVolume: Is dataset created automatically by the system.</br>
  224. Host Path: Is a path that already exists on the system.</br>
  225. SMB Share: Is a SMB share that is mounted to a persistent volume claim.
  226. schema:
  227. type: string
  228. required: true
  229. default: "ixVolume"
  230. immutable: true
  231. enum:
  232. - value: "hostPath"
  233. description: Host Path (Path that already exists on the system)
  234. - value: "ixVolume"
  235. description: ixVolume (Dataset created automatically by the system)
  236. - value: "smb-pv-pvc"
  237. description: SMB Share (Mounts a persistent volume claim to a SMB share)
  238. - variable: mountPath
  239. label: Mount Path
  240. description: The path inside the container to mount the storage.
  241. schema:
  242. type: path
  243. required: true
  244. - variable: hostPath
  245. label: Host Path
  246. description: The host path to use for storage.
  247. schema:
  248. type: hostpath
  249. show_if: [["type", "=", "hostPath"]]
  250. required: true
  251. - variable: datasetName
  252. label: Dataset Name
  253. description: The name of the dataset to use for storage.
  254. schema:
  255. type: string
  256. show_if: [["type", "=", "ixVolume"]]
  257. required: true
  258. immutable: true
  259. default: "storage_entry"
  260. $ref:
  261. - "normalize/ixVolume"
  262. - variable: server
  263. label: Server
  264. description: The server for the SMB share.
  265. schema:
  266. type: string
  267. show_if: [["type", "=", "smb-pv-pvc"]]
  268. required: true
  269. - variable: share
  270. label: Share
  271. description: The share name for the SMB share.
  272. schema:
  273. type: string
  274. show_if: [["type", "=", "smb-pv-pvc"]]
  275. required: true
  276. - variable: domain
  277. label: Domain (Optional)
  278. description: The domain for the SMB share.
  279. schema:
  280. type: string
  281. show_if: [["type", "=", "smb-pv-pvc"]]
  282. - variable: username
  283. label: Username
  284. description: The username for the SMB share.
  285. schema:
  286. type: string
  287. show_if: [["type", "=", "smb-pv-pvc"]]
  288. required: true
  289. - variable: password
  290. label: Password
  291. description: The password for the SMB share.
  292. schema:
  293. type: string
  294. show_if: [["type", "=", "smb-pv-pvc"]]
  295. required: true
  296. private: true
  297. - variable: size
  298. label: Size (in Gi)
  299. description: The size of the volume quota.
  300. schema:
  301. type: int
  302. show_if: [["type", "=", "smb-pv-pvc"]]
  303. required: true
  304. min: 1
  305. default: 1
  306. - variable: resources
  307. group: Resources Configuration
  308. label: ""
  309. schema:
  310. type: dict
  311. attrs:
  312. - variable: limits
  313. label: Limits
  314. schema:
  315. type: dict
  316. attrs:
  317. - variable: cpu
  318. label: CPU
  319. description: CPU limit for Rust Desk.
  320. schema:
  321. type: string
  322. max_length: 6
  323. valid_chars: '^(0\.[1-9]|[1-9][0-9]*)(\.[0-9]|m?)$'
  324. valid_chars_error: |
  325. Valid CPU limit formats are</br>
  326. - Plain Integer - eg. 1</br>
  327. - Float - eg. 0.5</br>
  328. - Milicpu - eg. 500m
  329. default: "4000m"
  330. required: true
  331. - variable: memory
  332. label: Memory
  333. description: Memory limit for Rust Desk.
  334. schema:
  335. type: string
  336. max_length: 12
  337. valid_chars: '^[1-9][0-9]*([EPTGMK]i?|e[0-9]+)?$'
  338. valid_chars_error: |
  339. Valid Memory limit formats are</br>
  340. - Suffixed with E/P/T/G/M/K - eg. 1G</br>
  341. - Suffixed with Ei/Pi/Ti/Gi/Mi/Ki - eg. 1Gi</br>
  342. - Plain Integer in bytes - eg. 1024</br>
  343. - Exponent - eg. 134e6
  344. default: "8Gi"
  345. required: true