questions.yaml 21 KB

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