questions.yaml 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717
  1. groups:
  2. - name: Roundcube Configuration
  3. description: Configure Roundcube
  4. - name: Network Configuration
  5. description: Configure Network for Roundcube
  6. - name: Storage Configuration
  7. description: Configure Storage for Roundcube
  8. - name: Labels Configuration
  9. description: Configure Labels for Roundcube
  10. - name: Resources Configuration
  11. description: Configure Resources for Roundcube
  12. questions:
  13. - variable: roundcube
  14. label: ""
  15. group: Roundcube Configuration
  16. schema:
  17. type: dict
  18. attrs:
  19. - variable: postgres_image_selector
  20. label: Postgres Image (CAUTION)
  21. description: |
  22. If you are changing this after the postgres directory has been initialized,</br>
  23. STOP! and make sure you have a backup of your data.</br>
  24. Changing this will trigger an one way database upgrade.</br>
  25. You can only select newer versions of postgres.</br>
  26. Selecting an older version will refuse to start.</br>
  27. If something goes wrong, you will have to restore from backup.
  28. schema:
  29. type: string
  30. default: postgres_17_image
  31. required: true
  32. enum:
  33. - value: postgres_15_image
  34. description: Postgres 15
  35. - value: postgres_17_image
  36. description: Postgres 17
  37. - variable: db_password
  38. label: Database Password
  39. description: The password for Roundcube.
  40. schema:
  41. type: string
  42. default: ""
  43. required: true
  44. private: true
  45. - variable: default_host
  46. label: Default Host (IMAP)
  47. description: The default host to connect to.
  48. schema:
  49. type: string
  50. default: ""
  51. required: true
  52. - variable: default_port
  53. label: Default Port (IMAP)
  54. description: The default port to connect to.
  55. schema:
  56. type: int
  57. default: 143
  58. min: 1
  59. max: 65535
  60. required: true
  61. - variable: smtp_server
  62. label: SMTP Server
  63. description: The SMTP server to use.
  64. schema:
  65. type: string
  66. default: ""
  67. required: true
  68. - variable: smtp_port
  69. label: SMTP Port
  70. description: The SMTP port to use.
  71. schema:
  72. type: int
  73. default: 587
  74. min: 1
  75. max: 65535
  76. required: true
  77. - variable: skin
  78. label: Skin
  79. description: |
  80. Configures the default theme</br>
  81. If you don't have the theme installed,
  82. it will show an error on all pages.
  83. schema:
  84. type: string
  85. default: elastic
  86. required: true
  87. - variable: upload_max_size
  88. label: Upload Max Size (MB)
  89. description: The maximum size of an upload in MB.</br>
  90. schema:
  91. type: int
  92. min: 1
  93. default: 5
  94. required: true
  95. - variable: aspell_dicts
  96. label: Aspell Dictionaries
  97. description: A list of aspell dictionaries to install.
  98. schema:
  99. type: list
  100. default: []
  101. items:
  102. - variable: aspellDict
  103. label: Aspell Dictionary
  104. schema:
  105. type: string
  106. required: true
  107. - variable: plugins
  108. label: Plugins
  109. description: A list of plugins to enable.
  110. schema:
  111. type: list
  112. default:
  113. - archive
  114. - zipdownload
  115. items:
  116. - variable: plugin
  117. label: Plugin
  118. schema:
  119. type: string
  120. required: true
  121. - variable: additional_envs
  122. label: Additional Environment Variables
  123. schema:
  124. type: list
  125. default: []
  126. items:
  127. - variable: env
  128. label: Environment Variable
  129. schema:
  130. type: dict
  131. attrs:
  132. - variable: name
  133. label: Name
  134. schema:
  135. type: string
  136. required: true
  137. - variable: value
  138. label: Value
  139. schema:
  140. type: string
  141. - variable: network
  142. label: ""
  143. group: Network Configuration
  144. schema:
  145. type: dict
  146. attrs:
  147. - variable: web_port
  148. label: WebUI Port
  149. schema:
  150. type: dict
  151. attrs:
  152. - variable: bind_mode
  153. label: Port Bind Mode
  154. description: |
  155. The port bind mode.</br>
  156. - Publish: The port will be published on the host for external access.</br>
  157. - Expose: The port will be exposed for inter-container communication.</br>
  158. - None: The port will not be exposed or published.</br>
  159. Note: If the Dockerfile defines an EXPOSE directive,
  160. the port will still be exposed for inter-container communication regardless of this setting.
  161. schema:
  162. type: string
  163. default: "published"
  164. enum:
  165. - value: "published"
  166. description: Publish port on the host for external access
  167. - value: "exposed"
  168. description: Expose port for inter-container communication
  169. - value: ""
  170. description: None
  171. - variable: port_number
  172. label: Port Number
  173. schema:
  174. type: int
  175. show_if: [["bind_mode", "=", "published"]]
  176. default: 31007
  177. min: 1
  178. max: 65535
  179. required: true
  180. - variable: host_ips
  181. label: Host IPs
  182. description: IPs on the host to bind this port
  183. schema:
  184. type: list
  185. show_if: [["bind_mode", "=", "published"]]
  186. default: []
  187. items:
  188. - variable: host_ip
  189. label: Host IP
  190. schema:
  191. type: string
  192. required: true
  193. $ref:
  194. - definitions/node_bind_ip
  195. - variable: storage
  196. label: ""
  197. group: Storage Configuration
  198. schema:
  199. type: dict
  200. attrs:
  201. - variable: html
  202. label: Roundcube HTML Storage
  203. description: The path to store Roundcube HTML.
  204. schema:
  205. type: dict
  206. attrs:
  207. - variable: type
  208. label: Type
  209. description: |
  210. ixVolume: Is dataset created automatically by the system.</br>
  211. Host Path: Is a path that already exists on the system.
  212. schema:
  213. type: string
  214. required: true
  215. default: "ix_volume"
  216. enum:
  217. - value: "host_path"
  218. description: Host Path (Path that already exists on the system)
  219. - value: "ix_volume"
  220. description: ixVolume (Dataset created automatically by the system)
  221. - variable: ix_volume_config
  222. label: ixVolume Configuration
  223. description: The configuration for the ixVolume dataset.
  224. schema:
  225. type: dict
  226. show_if: [["type", "=", "ix_volume"]]
  227. $ref:
  228. - "normalize/ix_volume"
  229. attrs:
  230. - variable: acl_enable
  231. label: Enable ACL
  232. description: Enable ACL for the storage.
  233. schema:
  234. type: boolean
  235. default: false
  236. - variable: dataset_name
  237. label: Dataset Name
  238. description: The name of the dataset to use for storage.
  239. schema:
  240. type: string
  241. required: true
  242. hidden: true
  243. default: "html"
  244. - variable: acl_entries
  245. label: ACL Configuration
  246. schema:
  247. type: dict
  248. show_if: [["acl_enable", "=", true]]
  249. attrs: []
  250. - variable: host_path_config
  251. label: Host Path Configuration
  252. schema:
  253. type: dict
  254. show_if: [["type", "=", "host_path"]]
  255. attrs:
  256. - variable: acl_enable
  257. label: Enable ACL
  258. description: Enable ACL for the storage.
  259. schema:
  260. type: boolean
  261. default: false
  262. - variable: acl
  263. label: ACL Configuration
  264. schema:
  265. type: dict
  266. show_if: [["acl_enable", "=", true]]
  267. attrs: []
  268. $ref:
  269. - "normalize/acl"
  270. - variable: path
  271. label: Host Path
  272. description: The host path to use for storage.
  273. schema:
  274. type: hostpath
  275. show_if: [["acl_enable", "=", false]]
  276. required: true
  277. - variable: config
  278. label: Roundcube Config Storage
  279. description: The path to store Roundcube Config.
  280. schema:
  281. type: dict
  282. attrs:
  283. - variable: type
  284. label: Type
  285. description: |
  286. ixVolume: Is dataset created automatically by the system.</br>
  287. Host Path: Is a path that already exists on the system.
  288. schema:
  289. type: string
  290. required: true
  291. default: "ix_volume"
  292. enum:
  293. - value: "host_path"
  294. description: Host Path (Path that already exists on the system)
  295. - value: "ix_volume"
  296. description: ixVolume (Dataset created automatically by the system)
  297. - variable: ix_volume_config
  298. label: ixVolume Configuration
  299. description: The configuration for the ixVolume dataset.
  300. schema:
  301. type: dict
  302. show_if: [["type", "=", "ix_volume"]]
  303. $ref:
  304. - "normalize/ix_volume"
  305. attrs:
  306. - variable: acl_enable
  307. label: Enable ACL
  308. description: Enable ACL for the storage.
  309. schema:
  310. type: boolean
  311. default: false
  312. - variable: dataset_name
  313. label: Dataset Name
  314. description: The name of the dataset to use for storage.
  315. schema:
  316. type: string
  317. required: true
  318. hidden: true
  319. default: "config"
  320. - variable: acl_entries
  321. label: ACL Configuration
  322. schema:
  323. type: dict
  324. show_if: [["acl_enable", "=", true]]
  325. attrs: []
  326. - variable: host_path_config
  327. label: Host Path Configuration
  328. schema:
  329. type: dict
  330. show_if: [["type", "=", "host_path"]]
  331. attrs:
  332. - variable: acl_enable
  333. label: Enable ACL
  334. description: Enable ACL for the storage.
  335. schema:
  336. type: boolean
  337. default: false
  338. - variable: acl
  339. label: ACL Configuration
  340. schema:
  341. type: dict
  342. show_if: [["acl_enable", "=", true]]
  343. attrs: []
  344. $ref:
  345. - "normalize/acl"
  346. - variable: path
  347. label: Host Path
  348. description: The host path to use for storage.
  349. schema:
  350. type: hostpath
  351. show_if: [["acl_enable", "=", false]]
  352. required: true
  353. - variable: temps
  354. label: Roundcube Temps Storage
  355. description: The path to store Roundcube Temps.
  356. schema:
  357. type: dict
  358. attrs:
  359. - variable: type
  360. label: Type
  361. description: |
  362. ixVolume: Is dataset created automatically by the system.</br>
  363. Host Path: Is a path that already exists on the system.
  364. schema:
  365. type: string
  366. required: true
  367. default: "ix_volume"
  368. enum:
  369. - value: "host_path"
  370. description: Host Path (Path that already exists on the system)
  371. - value: "ix_volume"
  372. description: ixVolume (Dataset created automatically by the system)
  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. hidden: true
  395. default: "temps"
  396. - variable: acl_entries
  397. label: ACL Configuration
  398. schema:
  399. type: dict
  400. show_if: [["acl_enable", "=", true]]
  401. attrs: []
  402. - variable: host_path_config
  403. label: Host Path Configuration
  404. schema:
  405. type: dict
  406. show_if: [["type", "=", "host_path"]]
  407. attrs:
  408. - variable: acl_enable
  409. label: Enable ACL
  410. description: Enable ACL for the storage.
  411. schema:
  412. type: boolean
  413. default: false
  414. - variable: acl
  415. label: ACL Configuration
  416. schema:
  417. type: dict
  418. show_if: [["acl_enable", "=", true]]
  419. attrs: []
  420. $ref:
  421. - "normalize/acl"
  422. - variable: path
  423. label: Host Path
  424. description: The host path to use for storage.
  425. schema:
  426. type: hostpath
  427. show_if: [["acl_enable", "=", false]]
  428. required: true
  429. - variable: postgres_data
  430. label: Roundcube Postgres Data Storage
  431. description: The path to store Roundcube Postgres Data.
  432. schema:
  433. type: dict
  434. attrs:
  435. - variable: type
  436. label: Type
  437. description: |
  438. ixVolume: Is dataset created automatically by the system.</br>
  439. Host Path: Is a path that already exists on the system.
  440. schema:
  441. type: string
  442. required: true
  443. default: "ix_volume"
  444. enum:
  445. - value: "host_path"
  446. description: Host Path (Path that already exists on the system)
  447. - value: "ix_volume"
  448. description: ixVolume (Dataset created automatically by the system)
  449. - variable: ix_volume_config
  450. label: ixVolume Configuration
  451. description: The configuration for the ixVolume dataset.
  452. schema:
  453. type: dict
  454. show_if: [["type", "=", "ix_volume"]]
  455. $ref:
  456. - "normalize/ix_volume"
  457. attrs:
  458. - variable: acl_enable
  459. label: Enable ACL
  460. description: Enable ACL for the storage.
  461. schema:
  462. type: boolean
  463. default: false
  464. - variable: dataset_name
  465. label: Dataset Name
  466. description: The name of the dataset to use for storage.
  467. schema:
  468. type: string
  469. required: true
  470. hidden: true
  471. default: "postgres_data"
  472. - variable: acl_entries
  473. label: ACL Configuration
  474. schema:
  475. type: dict
  476. show_if: [["acl_enable", "=", true]]
  477. attrs: []
  478. - variable: host_path_config
  479. label: Host Path Configuration
  480. schema:
  481. type: dict
  482. show_if: [["type", "=", "host_path"]]
  483. attrs:
  484. - variable: acl_enable
  485. label: Enable ACL
  486. description: Enable ACL for the storage.
  487. schema:
  488. type: boolean
  489. default: false
  490. - variable: acl
  491. label: ACL Configuration
  492. schema:
  493. type: dict
  494. show_if: [["acl_enable", "=", true]]
  495. attrs: []
  496. $ref:
  497. - "normalize/acl"
  498. - variable: path
  499. label: Host Path
  500. description: The host path to use for storage.
  501. schema:
  502. type: hostpath
  503. show_if: [["acl_enable", "=", false]]
  504. required: true
  505. - variable: auto_permissions
  506. label: Automatic Permissions
  507. description: |
  508. Automatically set permissions for the host path.
  509. Enabling this, will check the top level directory,</br>
  510. If it finds incorrect permissions, it will `chown` the
  511. host path to the user and group required for the
  512. postgres container.
  513. schema:
  514. type: boolean
  515. default: false
  516. show_if: [["acl_enable", "=", false]]
  517. - variable: additional_storage
  518. label: Additional Storage
  519. schema:
  520. type: list
  521. default: []
  522. items:
  523. - variable: storageEntry
  524. label: Storage Entry
  525. schema:
  526. type: dict
  527. attrs:
  528. - variable: type
  529. label: Type
  530. description: |
  531. ixVolume: Is dataset created automatically by the system.</br>
  532. Host Path: Is a path that already exists on the system.</br>
  533. SMB Share: Is a SMB share that is mounted to as a volume.
  534. schema:
  535. type: string
  536. required: true
  537. default: "ix_volume"
  538. enum:
  539. - value: "host_path"
  540. description: Host Path (Path that already exists on the system)
  541. - value: "ix_volume"
  542. description: ixVolume (Dataset created automatically by the system)
  543. - value: "cifs"
  544. description: SMB/CIFS Share (Mounts a volume to a SMB share)
  545. - variable: read_only
  546. label: Read Only
  547. description: Mount the volume as read only.
  548. schema:
  549. type: boolean
  550. default: false
  551. - variable: mount_path
  552. label: Mount Path
  553. description: The path inside the container to mount the storage.
  554. schema:
  555. type: path
  556. required: true
  557. - variable: host_path_config
  558. label: Host Path Configuration
  559. schema:
  560. type: dict
  561. show_if: [["type", "=", "host_path"]]
  562. attrs:
  563. - variable: acl_enable
  564. label: Enable ACL
  565. description: Enable ACL for the storage.
  566. schema:
  567. type: boolean
  568. default: false
  569. - variable: acl
  570. label: ACL Configuration
  571. schema:
  572. type: dict
  573. show_if: [["acl_enable", "=", true]]
  574. attrs: []
  575. $ref:
  576. - "normalize/acl"
  577. - variable: path
  578. label: Host Path
  579. description: The host path to use for storage.
  580. schema:
  581. type: hostpath
  582. show_if: [["acl_enable", "=", false]]
  583. required: true
  584. - variable: ix_volume_config
  585. label: ixVolume Configuration
  586. description: The configuration for the ixVolume dataset.
  587. schema:
  588. type: dict
  589. show_if: [["type", "=", "ix_volume"]]
  590. $ref:
  591. - "normalize/ix_volume"
  592. attrs:
  593. - variable: acl_enable
  594. label: Enable ACL
  595. description: Enable ACL for the storage.
  596. schema:
  597. type: boolean
  598. default: false
  599. - variable: dataset_name
  600. label: Dataset Name
  601. description: The name of the dataset to use for storage.
  602. schema:
  603. type: string
  604. required: true
  605. default: "storage_entry"
  606. - variable: acl_entries
  607. label: ACL Configuration
  608. schema:
  609. type: dict
  610. show_if: [["acl_enable", "=", true]]
  611. attrs: []
  612. $ref:
  613. - "normalize/acl"
  614. - variable: cifs_config
  615. label: SMB Configuration
  616. description: The configuration for the SMB dataset.
  617. schema:
  618. type: dict
  619. show_if: [["type", "=", "cifs"]]
  620. attrs:
  621. - variable: server
  622. label: Server
  623. description: The server to mount the SMB share.
  624. schema:
  625. type: string
  626. required: true
  627. - variable: path
  628. label: Path
  629. description: The path to mount the SMB share.
  630. schema:
  631. type: string
  632. required: true
  633. - variable: username
  634. label: Username
  635. description: The username to use for the SMB share.
  636. schema:
  637. type: string
  638. required: true
  639. - variable: password
  640. label: Password
  641. description: The password to use for the SMB share.
  642. schema:
  643. type: string
  644. required: true
  645. private: true
  646. - variable: domain
  647. label: Domain
  648. description: The domain to use for the SMB share.
  649. schema:
  650. type: string
  651. - variable: labels
  652. label: ""
  653. group: Labels Configuration
  654. schema:
  655. type: list
  656. default: []
  657. items:
  658. - variable: label
  659. label: Label
  660. schema:
  661. type: dict
  662. attrs:
  663. - variable: key
  664. label: Key
  665. schema:
  666. type: string
  667. required: true
  668. - variable: value
  669. label: Value
  670. schema:
  671. type: string
  672. required: true
  673. - variable: containers
  674. label: Containers
  675. description: Containers where the label should be applied
  676. schema:
  677. type: list
  678. items:
  679. - variable: container
  680. label: Container
  681. schema:
  682. type: string
  683. required: true
  684. enum:
  685. - value: roundcube
  686. description: roundcube
  687. - value: postgres
  688. description: postgres
  689. - variable: resources
  690. label: ""
  691. group: Resources Configuration
  692. schema:
  693. type: dict
  694. attrs:
  695. - variable: limits
  696. label: Limits
  697. schema:
  698. type: dict
  699. attrs:
  700. - variable: cpus
  701. label: CPUs
  702. description: CPUs limit for Roundcube.
  703. schema:
  704. type: int
  705. default: 2
  706. required: true
  707. - variable: memory
  708. label: Memory (in MB)
  709. description: Memory limit for Roundcube.
  710. schema:
  711. type: int
  712. default: 4096
  713. required: true