questions.yaml 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276
  1. groups:
  2. - name: Homebox Configuration
  3. description: Configure Homebox
  4. - name: User and Group Configuration
  5. description: Configure User and Group for Homebox
  6. - name: Network Configuration
  7. description: Configure Network for Homebox
  8. - name: Storage Configuration
  9. description: Configure Storage for Homebox
  10. - name: Labels Configuration
  11. description: Configure Labels for Homebox
  12. - name: Resources Configuration
  13. description: Configure Resources for Homebox
  14. questions:
  15. - variable: TZ
  16. group: Homebox Configuration
  17. label: Timezone
  18. schema:
  19. type: string
  20. default: Etc/UTC
  21. required: true
  22. $ref:
  23. - definitions/timezone
  24. - variable: homebox
  25. label: ""
  26. group: Homebox 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 Homebox Web 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 Homebox Web 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: host_network
  79. label: Host Network
  80. description: |
  81. Bind to the host network. It's recommended to keep this disabled.
  82. schema:
  83. type: boolean
  84. default: false
  85. - variable: web_port
  86. label: WebUI Port
  87. schema:
  88. type: dict
  89. attrs:
  90. - variable: bind_mode
  91. label: Port Bind Mode
  92. description: |
  93. The port bind mode.</br>
  94. - Publish: The port will be published on the host for external access.</br>
  95. - Expose: The port will be exposed for inter-container communication.</br>
  96. - None: The port will not be exposed or published.</br>
  97. Note: If the Dockerfile defines an EXPOSE directive,
  98. the port will still be exposed for inter-container communication regardless of this setting.
  99. schema:
  100. type: string
  101. default: "published"
  102. enum:
  103. - value: "published"
  104. description: Publish port on the host for external access
  105. - value: "exposed"
  106. description: Expose port for inter-container communication
  107. - value: ""
  108. description: None
  109. - variable: port_number
  110. label: Port Number
  111. schema:
  112. type: int
  113. default: 30149
  114. min: 1
  115. max: 65535
  116. required: true
  117. - variable: host_ips
  118. label: Host IPs
  119. description: IPs on the host to bind this port
  120. schema:
  121. type: list
  122. show_if: [["bind_mode", "=", "published"]]
  123. default: []
  124. items:
  125. - variable: host_ip
  126. label: Host IP
  127. schema:
  128. type: string
  129. required: true
  130. $ref:
  131. - definitions/node_bind_ip
  132. - variable: storage
  133. label: ""
  134. group: Storage Configuration
  135. schema:
  136. type: dict
  137. attrs:
  138. - variable: data
  139. label: Homebox Web Data Storage
  140. description: The path to store Homebox Web Data.
  141. schema:
  142. type: dict
  143. attrs:
  144. - variable: type
  145. label: Type
  146. description: |
  147. ixVolume: Is dataset created automatically by the system.</br>
  148. Host Path: Is a path that already exists on the system.
  149. schema:
  150. type: string
  151. required: true
  152. default: "ix_volume"
  153. enum:
  154. - value: "host_path"
  155. description: Host Path (Path that already exists on the system)
  156. - value: "ix_volume"
  157. description: ixVolume (Dataset created automatically by the system)
  158. - variable: ix_volume_config
  159. label: ixVolume Configuration
  160. description: The configuration for the ixVolume dataset.
  161. schema:
  162. type: dict
  163. show_if: [["type", "=", "ix_volume"]]
  164. $ref:
  165. - "normalize/ix_volume"
  166. attrs:
  167. - variable: acl_enable
  168. label: Enable ACL
  169. description: Enable ACL for the storage.
  170. schema:
  171. type: boolean
  172. default: false
  173. - variable: dataset_name
  174. label: Dataset Name
  175. description: The name of the dataset to use for storage.
  176. schema:
  177. type: string
  178. required: true
  179. hidden: true
  180. default: "data"
  181. - variable: acl_entries
  182. label: ACL Configuration
  183. schema:
  184. type: dict
  185. show_if: [["acl_enable", "=", true]]
  186. attrs: []
  187. - variable: host_path_config
  188. label: Host Path Configuration
  189. schema:
  190. type: dict
  191. show_if: [["type", "=", "host_path"]]
  192. attrs:
  193. - variable: acl_enable
  194. label: Enable ACL
  195. description: Enable ACL for the storage.
  196. schema:
  197. type: boolean
  198. default: false
  199. - variable: acl
  200. label: ACL Configuration
  201. schema:
  202. type: dict
  203. show_if: [["acl_enable", "=", true]]
  204. attrs: []
  205. $ref:
  206. - "normalize/acl"
  207. - variable: path
  208. label: Host Path
  209. description: The host path to use for storage.
  210. schema:
  211. type: hostpath
  212. show_if: [["acl_enable", "=", false]]
  213. required: true
  214. - variable: labels
  215. label: ""
  216. group: Labels Configuration
  217. schema:
  218. type: list
  219. default: []
  220. items:
  221. - variable: label
  222. label: Label
  223. schema:
  224. type: dict
  225. attrs:
  226. - variable: key
  227. label: Key
  228. schema:
  229. type: string
  230. required: true
  231. - variable: value
  232. label: Value
  233. schema:
  234. type: string
  235. required: true
  236. - variable: containers
  237. label: Containers
  238. description: Containers where the label should be applied
  239. schema:
  240. type: list
  241. items:
  242. - variable: container
  243. label: Container
  244. schema:
  245. type: string
  246. required: true
  247. enum:
  248. - value: homebox
  249. description: homebox
  250. - variable: resources
  251. label: ""
  252. group: Resources Configuration
  253. schema:
  254. type: dict
  255. attrs:
  256. - variable: limits
  257. label: Limits
  258. schema:
  259. type: dict
  260. attrs:
  261. - variable: cpus
  262. label: CPUs
  263. description: CPUs limit for Homebox Web.
  264. schema:
  265. type: int
  266. default: 2
  267. required: true
  268. - variable: memory
  269. label: Memory (in MB)
  270. description: Memory limit for Homebox Web.
  271. schema:
  272. type: int
  273. default: 4096
  274. required: true