questions.yaml 15 KB

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