questions.yaml 19 KB

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