questions.yaml 27 KB

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