questions.yaml 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637
  1. groups:
  2. - name: Gitea Configuration
  3. description: Configure Gitea
  4. - name: Network Configuration
  5. description: Configure Network for Gitea
  6. - name: Storage Configuration
  7. description: Configure Storage for Gitea
  8. - name: Labels Configuration
  9. description: Configure Labels for Gitea
  10. - name: Resources Configuration
  11. description: Configure Resources for Gitea
  12. questions:
  13. - variable: gitea
  14. label: ""
  15. group: Gitea 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 Gitea.
  40. schema:
  41. type: string
  42. default: ""
  43. required: true
  44. private: true
  45. - variable: root_url
  46. label: Root URL
  47. description: The root URL for Gitea.
  48. schema:
  49. type: uri
  50. default: ""
  51. required: true
  52. - variable: additional_envs
  53. label: Additional Environment Variables
  54. schema:
  55. type: list
  56. default: []
  57. items:
  58. - variable: env
  59. label: Environment Variable
  60. schema:
  61. type: dict
  62. attrs:
  63. - variable: name
  64. label: Name
  65. schema:
  66. type: string
  67. required: true
  68. - variable: value
  69. label: Value
  70. schema:
  71. type: string
  72. - variable: network
  73. label: ""
  74. group: Network Configuration
  75. schema:
  76. type: dict
  77. attrs:
  78. - variable: web_port
  79. label: WebUI Port
  80. description: The port for Gitea WebUI
  81. schema:
  82. type: dict
  83. attrs:
  84. - variable: bind_mode
  85. label: Port Bind Mode
  86. description: |
  87. The port bind mode.</br>
  88. - Publish: The port will be published on the host for external access.</br>
  89. - Expose: The port will be exposed for inter-container communication.</br>
  90. - None: The port will not be exposed or published.</br>
  91. Note: If the Dockerfile defines an EXPOSE directive,
  92. the port will still be exposed for inter-container communication regardless of this setting.
  93. schema:
  94. type: string
  95. default: "published"
  96. enum:
  97. - value: "published"
  98. description: Publish port on the host for external access
  99. - value: "exposed"
  100. description: Expose port for inter-container communication
  101. - value: ""
  102. description: None
  103. - variable: port_number
  104. label: Port Number
  105. schema:
  106. type: int
  107. default: 30008
  108. min: 1
  109. max: 65535
  110. required: true
  111. - variable: host_ips
  112. label: Host IPs
  113. description: IPs on the host to bind this port
  114. schema:
  115. type: list
  116. show_if: [["bind_mode", "=", "published"]]
  117. default: []
  118. items:
  119. - variable: host_ip
  120. label: Host IP
  121. schema:
  122. type: string
  123. required: true
  124. $ref:
  125. - definitions/node_bind_ip
  126. - variable: ssh_port
  127. label: SSH Port
  128. description: The port for Gitea SSH
  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: 30009
  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: external_ssh_port
  175. label: External SSH Port
  176. description: |
  177. The ssh port that Gitea will be available at externally.</br>
  178. Leave empty to use the same port as the ssh port.
  179. schema:
  180. type: int
  181. "null": true
  182. default: null
  183. - variable: certificate_id
  184. label: Certificate
  185. description: The certificate to use for Portainer.
  186. schema:
  187. type: int
  188. "null": true
  189. $ref:
  190. - "definitions/certificate"
  191. - variable: storage
  192. label: ""
  193. group: Storage Configuration
  194. schema:
  195. type: dict
  196. attrs:
  197. - variable: config
  198. label: Gitea Config Storage
  199. description: The path to store Gitea Config.
  200. schema:
  201. type: dict
  202. attrs:
  203. - variable: type
  204. label: Type
  205. description: |
  206. ixVolume: Is dataset created automatically by the system.</br>
  207. Host Path: Is a path that already exists on the system.
  208. schema:
  209. type: string
  210. required: true
  211. default: "ix_volume"
  212. enum:
  213. - value: "host_path"
  214. description: Host Path (Path that already exists on the system)
  215. - value: "ix_volume"
  216. description: ixVolume (Dataset created automatically by the system)
  217. - variable: ix_volume_config
  218. label: ixVolume Configuration
  219. description: The configuration for the ixVolume dataset.
  220. schema:
  221. type: dict
  222. show_if: [["type", "=", "ix_volume"]]
  223. $ref:
  224. - "normalize/ix_volume"
  225. attrs:
  226. - variable: acl_enable
  227. label: Enable ACL
  228. description: Enable ACL for the storage.
  229. schema:
  230. type: boolean
  231. default: false
  232. - variable: dataset_name
  233. label: Dataset Name
  234. description: The name of the dataset to use for storage.
  235. schema:
  236. type: string
  237. required: true
  238. hidden: true
  239. default: "config"
  240. - variable: acl_entries
  241. label: ACL Configuration
  242. schema:
  243. type: dict
  244. show_if: [["acl_enable", "=", true]]
  245. attrs: []
  246. - variable: host_path_config
  247. label: Host Path Configuration
  248. schema:
  249. type: dict
  250. show_if: [["type", "=", "host_path"]]
  251. attrs:
  252. - variable: acl_enable
  253. label: Enable ACL
  254. description: Enable ACL for the storage.
  255. schema:
  256. type: boolean
  257. default: false
  258. - variable: acl
  259. label: ACL Configuration
  260. schema:
  261. type: dict
  262. show_if: [["acl_enable", "=", true]]
  263. attrs: []
  264. $ref:
  265. - "normalize/acl"
  266. - variable: path
  267. label: Host Path
  268. description: The host path to use for storage.
  269. schema:
  270. type: hostpath
  271. show_if: [["acl_enable", "=", false]]
  272. required: true
  273. - variable: data
  274. label: Gitea Data Storage
  275. description: The path to store Gitea Data.
  276. schema:
  277. type: dict
  278. attrs:
  279. - variable: type
  280. label: Type
  281. description: |
  282. ixVolume: Is dataset created automatically by the system.</br>
  283. Host Path: Is a path that already exists on the system.
  284. schema:
  285. type: string
  286. required: true
  287. default: "ix_volume"
  288. enum:
  289. - value: "host_path"
  290. description: Host Path (Path that already exists on the system)
  291. - value: "ix_volume"
  292. description: ixVolume (Dataset created automatically by the system)
  293. - variable: ix_volume_config
  294. label: ixVolume Configuration
  295. description: The configuration for the ixVolume dataset.
  296. schema:
  297. type: dict
  298. show_if: [["type", "=", "ix_volume"]]
  299. $ref:
  300. - "normalize/ix_volume"
  301. attrs:
  302. - variable: acl_enable
  303. label: Enable ACL
  304. description: Enable ACL for the storage.
  305. schema:
  306. type: boolean
  307. default: false
  308. - variable: dataset_name
  309. label: Dataset Name
  310. description: The name of the dataset to use for storage.
  311. schema:
  312. type: string
  313. required: true
  314. hidden: true
  315. default: "data"
  316. - variable: acl_entries
  317. label: ACL Configuration
  318. schema:
  319. type: dict
  320. show_if: [["acl_enable", "=", true]]
  321. attrs: []
  322. - variable: host_path_config
  323. label: Host Path Configuration
  324. schema:
  325. type: dict
  326. show_if: [["type", "=", "host_path"]]
  327. attrs:
  328. - variable: acl_enable
  329. label: Enable ACL
  330. description: Enable ACL for the storage.
  331. schema:
  332. type: boolean
  333. default: false
  334. - variable: acl
  335. label: ACL Configuration
  336. schema:
  337. type: dict
  338. show_if: [["acl_enable", "=", true]]
  339. attrs: []
  340. $ref:
  341. - "normalize/acl"
  342. - variable: path
  343. label: Host Path
  344. description: The host path to use for storage.
  345. schema:
  346. type: hostpath
  347. show_if: [["acl_enable", "=", false]]
  348. required: true
  349. - variable: postgres_data
  350. label: Gitea Postgres Data Storage
  351. description: The path to store Gitea Postgres Data.
  352. schema:
  353. type: dict
  354. attrs:
  355. - variable: type
  356. label: Type
  357. description: |
  358. ixVolume: Is dataset created automatically by the system.</br>
  359. Host Path: Is a path that already exists on the system.
  360. schema:
  361. type: string
  362. required: true
  363. default: "ix_volume"
  364. enum:
  365. - value: "host_path"
  366. description: Host Path (Path that already exists on the system)
  367. - value: "ix_volume"
  368. description: ixVolume (Dataset created automatically by the system)
  369. - variable: ix_volume_config
  370. label: ixVolume Configuration
  371. description: The configuration for the ixVolume dataset.
  372. schema:
  373. type: dict
  374. show_if: [["type", "=", "ix_volume"]]
  375. $ref:
  376. - "normalize/ix_volume"
  377. attrs:
  378. - variable: acl_enable
  379. label: Enable ACL
  380. description: Enable ACL for the storage.
  381. schema:
  382. type: boolean
  383. default: false
  384. - variable: dataset_name
  385. label: Dataset Name
  386. description: The name of the dataset to use for storage.
  387. schema:
  388. type: string
  389. required: true
  390. hidden: true
  391. default: "postgres_data"
  392. - variable: acl_entries
  393. label: ACL Configuration
  394. schema:
  395. type: dict
  396. show_if: [["acl_enable", "=", true]]
  397. attrs: []
  398. - variable: host_path_config
  399. label: Host Path Configuration
  400. schema:
  401. type: dict
  402. show_if: [["type", "=", "host_path"]]
  403. attrs:
  404. - variable: acl_enable
  405. label: Enable ACL
  406. description: Enable ACL for the storage.
  407. schema:
  408. type: boolean
  409. default: false
  410. - variable: acl
  411. label: ACL Configuration
  412. schema:
  413. type: dict
  414. show_if: [["acl_enable", "=", true]]
  415. attrs: []
  416. $ref:
  417. - "normalize/acl"
  418. - variable: path
  419. label: Host Path
  420. description: The host path to use for storage.
  421. schema:
  422. type: hostpath
  423. show_if: [["acl_enable", "=", false]]
  424. required: true
  425. - variable: auto_permissions
  426. label: Automatic Permissions
  427. description: |
  428. Automatically set permissions for the host path.
  429. Enabling this, will check the top level directory,</br>
  430. If it finds incorrect permissions, it will `chown` the
  431. host path to the user and group required for the
  432. postgres container.
  433. schema:
  434. type: boolean
  435. default: false
  436. show_if: [["acl_enable", "=", false]]
  437. - variable: additional_storage
  438. label: Additional Storage
  439. schema:
  440. type: list
  441. default: []
  442. items:
  443. - variable: storageEntry
  444. label: Storage Entry
  445. schema:
  446. type: dict
  447. attrs:
  448. - variable: type
  449. label: Type
  450. description: |
  451. ixVolume: Is dataset created automatically by the system.</br>
  452. Host Path: Is a path that already exists on the system.</br>
  453. SMB Share: Is a SMB share that is mounted to as a volume.
  454. schema:
  455. type: string
  456. required: true
  457. default: "ix_volume"
  458. enum:
  459. - value: "host_path"
  460. description: Host Path (Path that already exists on the system)
  461. - value: "ix_volume"
  462. description: ixVolume (Dataset created automatically by the system)
  463. - value: "cifs"
  464. description: SMB/CIFS Share (Mounts a volume to a SMB share)
  465. - variable: read_only
  466. label: Read Only
  467. description: Mount the volume as read only.
  468. schema:
  469. type: boolean
  470. default: false
  471. - variable: mount_path
  472. label: Mount Path
  473. description: The path inside the container to mount the storage.
  474. schema:
  475. type: path
  476. required: true
  477. - variable: host_path_config
  478. label: Host Path Configuration
  479. schema:
  480. type: dict
  481. show_if: [["type", "=", "host_path"]]
  482. attrs:
  483. - variable: acl_enable
  484. label: Enable ACL
  485. description: Enable ACL for the storage.
  486. schema:
  487. type: boolean
  488. default: false
  489. - variable: acl
  490. label: ACL Configuration
  491. schema:
  492. type: dict
  493. show_if: [["acl_enable", "=", true]]
  494. attrs: []
  495. $ref:
  496. - "normalize/acl"
  497. - variable: path
  498. label: Host Path
  499. description: The host path to use for storage.
  500. schema:
  501. type: hostpath
  502. show_if: [["acl_enable", "=", false]]
  503. required: true
  504. - variable: ix_volume_config
  505. label: ixVolume Configuration
  506. description: The configuration for the ixVolume dataset.
  507. schema:
  508. type: dict
  509. show_if: [["type", "=", "ix_volume"]]
  510. $ref:
  511. - "normalize/ix_volume"
  512. attrs:
  513. - variable: acl_enable
  514. label: Enable ACL
  515. description: Enable ACL for the storage.
  516. schema:
  517. type: boolean
  518. default: false
  519. - variable: dataset_name
  520. label: Dataset Name
  521. description: The name of the dataset to use for storage.
  522. schema:
  523. type: string
  524. required: true
  525. default: "storage_entry"
  526. - variable: acl_entries
  527. label: ACL Configuration
  528. schema:
  529. type: dict
  530. show_if: [["acl_enable", "=", true]]
  531. attrs: []
  532. $ref:
  533. - "normalize/acl"
  534. - variable: cifs_config
  535. label: SMB Configuration
  536. description: The configuration for the SMB dataset.
  537. schema:
  538. type: dict
  539. show_if: [["type", "=", "cifs"]]
  540. attrs:
  541. - variable: server
  542. label: Server
  543. description: The server to mount the SMB share.
  544. schema:
  545. type: string
  546. required: true
  547. - variable: path
  548. label: Path
  549. description: The path to mount the SMB share.
  550. schema:
  551. type: string
  552. required: true
  553. - variable: username
  554. label: Username
  555. description: The username to use for the SMB share.
  556. schema:
  557. type: string
  558. required: true
  559. - variable: password
  560. label: Password
  561. description: The password to use for the SMB share.
  562. schema:
  563. type: string
  564. required: true
  565. private: true
  566. - variable: domain
  567. label: Domain
  568. description: The domain to use for the SMB share.
  569. schema:
  570. type: string
  571. - variable: labels
  572. label: ""
  573. group: Labels Configuration
  574. schema:
  575. type: list
  576. default: []
  577. items:
  578. - variable: label
  579. label: Label
  580. schema:
  581. type: dict
  582. attrs:
  583. - variable: key
  584. label: Key
  585. schema:
  586. type: string
  587. required: true
  588. - variable: value
  589. label: Value
  590. schema:
  591. type: string
  592. required: true
  593. - variable: containers
  594. label: Containers
  595. description: Containers where the label should be applied
  596. schema:
  597. type: list
  598. items:
  599. - variable: container
  600. label: Container
  601. schema:
  602. type: string
  603. required: true
  604. enum:
  605. - value: gitea
  606. description: gitea
  607. - value: postgres
  608. description: postgres
  609. - variable: resources
  610. label: ""
  611. group: Resources Configuration
  612. schema:
  613. type: dict
  614. attrs:
  615. - variable: limits
  616. label: Limits
  617. schema:
  618. type: dict
  619. attrs:
  620. - variable: cpus
  621. label: CPUs
  622. description: CPUs limit for Gitea.
  623. schema:
  624. type: int
  625. default: 2
  626. required: true
  627. - variable: memory
  628. label: Memory (in MB)
  629. description: Memory limit for Gitea.
  630. schema:
  631. type: int
  632. default: 4096
  633. required: true