questions.yaml 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512
  1. groups:
  2. - name: MakeMKV Configuration
  3. description: Configure MakeMKV
  4. - name: User and Group Configuration
  5. description: Configure User and Group for MakeMKV
  6. - name: Network Configuration
  7. description: Configure Network for MakeMKV
  8. - name: Storage Configuration
  9. description: Configure Storage for MakeMKV
  10. - name: Labels Configuration
  11. description: Configure Labels for MakeMKV
  12. - name: Resources Configuration
  13. description: Configure Resources for MakeMKV
  14. questions:
  15. - variable: TZ
  16. group: MakeMKV Configuration
  17. label: Timezone
  18. schema:
  19. type: string
  20. default: Etc/UTC
  21. required: true
  22. $ref:
  23. - definitions/timezone
  24. - variable: makemkv
  25. label: ""
  26. group: MakeMKV Configuration
  27. schema:
  28. type: dict
  29. attrs:
  30. - variable: devices
  31. label: Devices
  32. description: |
  33. Examples:
  34. - Host Device: /dev/sr0, Container Device: /dev/sr0
  35. - Host Device: /dev/sg0, Container Device: /dev/sg0
  36. schema:
  37. type: list
  38. default: []
  39. items:
  40. - variable: device
  41. label: Device
  42. schema:
  43. type: dict
  44. attrs:
  45. - variable: host_device
  46. label: Host Device
  47. schema:
  48. type: string
  49. required: true
  50. - variable: container_device
  51. label: Container Device
  52. schema:
  53. type: string
  54. required: true
  55. - variable: additional_envs
  56. label: Additional Environment Variables
  57. schema:
  58. type: list
  59. default: []
  60. items:
  61. - variable: env
  62. label: Environment Variable
  63. schema:
  64. type: dict
  65. attrs:
  66. - variable: name
  67. label: Name
  68. schema:
  69. type: string
  70. required: true
  71. - variable: value
  72. label: Value
  73. schema:
  74. type: string
  75. - variable: run_as
  76. label: ""
  77. group: User and Group Configuration
  78. schema:
  79. type: dict
  80. attrs:
  81. - variable: user
  82. label: User ID
  83. description: The user id that MakeMKV files will be owned by.
  84. schema:
  85. type: int
  86. min: 568
  87. default: 568
  88. required: true
  89. - variable: group
  90. label: Group ID
  91. description: The group id that MakeMKV files will be owned by.
  92. schema:
  93. type: int
  94. min: 568
  95. default: 568
  96. required: true
  97. - variable: network
  98. label: ""
  99. group: Network Configuration
  100. schema:
  101. type: dict
  102. attrs:
  103. - variable: web_port
  104. label: WebUI Port
  105. schema:
  106. type: dict
  107. attrs:
  108. - variable: bind_mode
  109. label: Port Bind Mode
  110. description: |
  111. The port bind mode.</br>
  112. - Publish: The port will be published on the host for external access.</br>
  113. - Expose: The port will be exposed for inter-container communication.</br>
  114. - None: The port will not be exposed or published.</br>
  115. Note: If the Dockerfile defines an EXPOSE directive,
  116. the port will still be exposed for inter-container communication regardless of this setting.
  117. schema:
  118. type: string
  119. default: "published"
  120. enum:
  121. - value: "published"
  122. description: Publish port on the host for external access
  123. - value: "exposed"
  124. description: Expose port for inter-container communication
  125. - value: ""
  126. description: None
  127. - variable: port_number
  128. label: Port Number
  129. schema:
  130. type: int
  131. default: 30234
  132. min: 1
  133. max: 65535
  134. required: true
  135. - variable: host_ips
  136. label: Host IPs
  137. description: IPs on the host to bind this port
  138. schema:
  139. type: list
  140. show_if: [["bind_mode", "=", "published"]]
  141. default: []
  142. items:
  143. - variable: host_ip
  144. label: Host IP
  145. schema:
  146. type: string
  147. required: true
  148. $ref:
  149. - definitions/node_bind_ip
  150. - variable: host_network
  151. label: Host Network
  152. description: |
  153. Bind to the host network. It's recommended to keep this disabled.
  154. schema:
  155. type: boolean
  156. default: false
  157. - variable: storage
  158. label: ""
  159. group: Storage Configuration
  160. schema:
  161. type: dict
  162. attrs:
  163. - variable: config
  164. label: MakeMKV Config Storage
  165. description: The path to store MakeMKV Config.
  166. schema:
  167. type: dict
  168. attrs:
  169. - variable: type
  170. label: Type
  171. description: |
  172. ixVolume: Is dataset created automatically by the system.</br>
  173. Host Path: Is a path that already exists on the system.
  174. schema:
  175. type: string
  176. required: true
  177. default: "ix_volume"
  178. enum:
  179. - value: "host_path"
  180. description: Host Path (Path that already exists on the system)
  181. - value: "ix_volume"
  182. description: ixVolume (Dataset created automatically by the system)
  183. - variable: ix_volume_config
  184. label: ixVolume Configuration
  185. description: The configuration for the ixVolume dataset.
  186. schema:
  187. type: dict
  188. show_if: [["type", "=", "ix_volume"]]
  189. $ref:
  190. - "normalize/ix_volume"
  191. attrs:
  192. - variable: acl_enable
  193. label: Enable ACL
  194. description: Enable ACL for the storage.
  195. schema:
  196. type: boolean
  197. default: false
  198. - variable: dataset_name
  199. label: Dataset Name
  200. description: The name of the dataset to use for storage.
  201. schema:
  202. type: string
  203. required: true
  204. hidden: true
  205. default: "config"
  206. - variable: acl_entries
  207. label: ACL Configuration
  208. schema:
  209. type: dict
  210. show_if: [["acl_enable", "=", true]]
  211. attrs: []
  212. - variable: host_path_config
  213. label: Host Path Configuration
  214. schema:
  215. type: dict
  216. show_if: [["type", "=", "host_path"]]
  217. attrs:
  218. - variable: acl_enable
  219. label: Enable ACL
  220. description: Enable ACL for the storage.
  221. schema:
  222. type: boolean
  223. default: false
  224. - variable: acl
  225. label: ACL Configuration
  226. schema:
  227. type: dict
  228. show_if: [["acl_enable", "=", true]]
  229. attrs: []
  230. $ref:
  231. - "normalize/acl"
  232. - variable: path
  233. label: Host Path
  234. description: The host path to use for storage.
  235. schema:
  236. type: hostpath
  237. show_if: [["acl_enable", "=", false]]
  238. required: true
  239. - variable: output
  240. label: MakeMKV Output Storage
  241. description: The target path to store MakeMKV conversions.
  242. schema:
  243. type: dict
  244. attrs:
  245. - variable: type
  246. label: Type
  247. description: |
  248. ixVolume: Is dataset created automatically by the system.</br>
  249. Host Path: Is a path that already exists on the system.
  250. schema:
  251. type: string
  252. required: true
  253. default: "ix_volume"
  254. enum:
  255. - value: "host_path"
  256. description: Host Path (Path that already exists on the system)
  257. - value: "ix_volume"
  258. description: ixVolume (Dataset created automatically by the system)
  259. - variable: ix_volume_config
  260. label: ixVolume Configuration
  261. description: The configuration for the ixVolume dataset.
  262. schema:
  263. type: dict
  264. show_if: [["type", "=", "ix_volume"]]
  265. $ref:
  266. - "normalize/ix_volume"
  267. attrs:
  268. - variable: acl_enable
  269. label: Enable ACL
  270. description: Enable ACL for the storage.
  271. schema:
  272. type: boolean
  273. default: false
  274. - variable: dataset_name
  275. label: Dataset Name
  276. description: The name of the dataset to use for storage.
  277. schema:
  278. type: string
  279. required: true
  280. hidden: true
  281. default: "output"
  282. - variable: acl_entries
  283. label: ACL Configuration
  284. schema:
  285. type: dict
  286. show_if: [["acl_enable", "=", true]]
  287. attrs: []
  288. - variable: host_path_config
  289. label: Host Path Configuration
  290. schema:
  291. type: dict
  292. show_if: [["type", "=", "host_path"]]
  293. attrs:
  294. - variable: acl_enable
  295. label: Enable ACL
  296. description: Enable ACL for the storage.
  297. schema:
  298. type: boolean
  299. default: false
  300. - variable: acl
  301. label: ACL Configuration
  302. schema:
  303. type: dict
  304. show_if: [["acl_enable", "=", true]]
  305. attrs: []
  306. $ref:
  307. - "normalize/acl"
  308. - variable: path
  309. label: Host Path
  310. description: The host path to use for storage.
  311. schema:
  312. type: hostpath
  313. show_if: [["acl_enable", "=", false]]
  314. required: true
  315. - variable: additional_storage
  316. label: Additional Storage
  317. schema:
  318. type: list
  319. default: []
  320. items:
  321. - variable: storageEntry
  322. label: Storage Entry
  323. schema:
  324. type: dict
  325. attrs:
  326. - variable: type
  327. label: Type
  328. description: |
  329. ixVolume: Is dataset created automatically by the system.</br>
  330. Host Path: Is a path that already exists on the system.</br>
  331. SMB Share: Is a SMB share that is mounted to as a volume.
  332. schema:
  333. type: string
  334. required: true
  335. default: "ix_volume"
  336. enum:
  337. - value: "host_path"
  338. description: Host Path (Path that already exists on the system)
  339. - value: "ix_volume"
  340. description: ixVolume (Dataset created automatically by the system)
  341. - value: "cifs"
  342. description: SMB/CIFS Share (Mounts a volume to a SMB share)
  343. - variable: read_only
  344. label: Read Only
  345. description: Mount the volume as read only.
  346. schema:
  347. type: boolean
  348. default: false
  349. - variable: mount_path
  350. label: Mount Path
  351. description: The path inside the container to mount the storage.
  352. schema:
  353. type: path
  354. required: true
  355. - variable: host_path_config
  356. label: Host Path Configuration
  357. schema:
  358. type: dict
  359. show_if: [["type", "=", "host_path"]]
  360. attrs:
  361. - variable: acl_enable
  362. label: Enable ACL
  363. description: Enable ACL for the storage.
  364. schema:
  365. type: boolean
  366. default: false
  367. - variable: acl
  368. label: ACL Configuration
  369. schema:
  370. type: dict
  371. show_if: [["acl_enable", "=", true]]
  372. attrs: []
  373. $ref:
  374. - "normalize/acl"
  375. - variable: path
  376. label: Host Path
  377. description: The host path to use for storage.
  378. schema:
  379. type: hostpath
  380. show_if: [["acl_enable", "=", false]]
  381. required: true
  382. - variable: ix_volume_config
  383. label: ixVolume Configuration
  384. description: The configuration for the ixVolume dataset.
  385. schema:
  386. type: dict
  387. show_if: [["type", "=", "ix_volume"]]
  388. $ref:
  389. - "normalize/ix_volume"
  390. attrs:
  391. - variable: acl_enable
  392. label: Enable ACL
  393. description: Enable ACL for the storage.
  394. schema:
  395. type: boolean
  396. default: false
  397. - variable: dataset_name
  398. label: Dataset Name
  399. description: The name of the dataset to use for storage.
  400. schema:
  401. type: string
  402. required: true
  403. default: "storage_entry"
  404. - variable: acl_entries
  405. label: ACL Configuration
  406. schema:
  407. type: dict
  408. show_if: [["acl_enable", "=", true]]
  409. attrs: []
  410. $ref:
  411. - "normalize/acl"
  412. - variable: cifs_config
  413. label: SMB Configuration
  414. description: The configuration for the SMB dataset.
  415. schema:
  416. type: dict
  417. show_if: [["type", "=", "cifs"]]
  418. attrs:
  419. - variable: server
  420. label: Server
  421. description: The server to mount the SMB share.
  422. schema:
  423. type: string
  424. required: true
  425. - variable: path
  426. label: Path
  427. description: The path to mount the SMB share.
  428. schema:
  429. type: string
  430. required: true
  431. - variable: username
  432. label: Username
  433. description: The username to use for the SMB share.
  434. schema:
  435. type: string
  436. required: true
  437. - variable: password
  438. label: Password
  439. description: The password to use for the SMB share.
  440. schema:
  441. type: string
  442. required: true
  443. private: true
  444. - variable: domain
  445. label: Domain
  446. description: The domain to use for the SMB share.
  447. schema:
  448. type: string
  449. - variable: labels
  450. label: ""
  451. group: Labels Configuration
  452. schema:
  453. type: list
  454. default: []
  455. items:
  456. - variable: label
  457. label: Label
  458. schema:
  459. type: dict
  460. attrs:
  461. - variable: key
  462. label: Key
  463. schema:
  464. type: string
  465. required: true
  466. - variable: value
  467. label: Value
  468. schema:
  469. type: string
  470. required: true
  471. - variable: containers
  472. label: Containers
  473. description: Containers where the label should be applied
  474. schema:
  475. type: list
  476. items:
  477. - variable: container
  478. label: Container
  479. schema:
  480. type: string
  481. required: true
  482. enum:
  483. - value: makemkv
  484. description: makemkv
  485. - variable: resources
  486. label: ""
  487. group: Resources Configuration
  488. schema:
  489. type: dict
  490. attrs:
  491. - variable: limits
  492. label: Limits
  493. schema:
  494. type: dict
  495. attrs:
  496. - variable: cpus
  497. label: CPUs
  498. description: CPUs limit for MakeMKV.
  499. schema:
  500. type: int
  501. default: 2
  502. required: true
  503. - variable: memory
  504. label: Memory (in MB)
  505. description: Memory limit for MakeMKV.
  506. schema:
  507. type: int
  508. default: 4096
  509. required: true