questions.yaml 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403
  1. groups:
  2. - name: Mempool Configuration
  3. description: Configure Mempool
  4. - name: Network Configuration
  5. description: Configure Network for Mempool
  6. - name: Storage Configuration
  7. description: Configure Storage for Mempool
  8. - name: Labels Configuration
  9. description: Configure Labels for Mempool
  10. - name: Resources Configuration
  11. description: Configure Resources for Mempool
  12. questions:
  13. - variable: TZ
  14. group: Mempool Configuration
  15. label: Timezone
  16. schema:
  17. type: string
  18. default: Etc/UTC
  19. required: true
  20. $ref:
  21. - definitions/timezone
  22. - variable: mempool
  23. label: ""
  24. group: Mempool Configuration
  25. schema:
  26. type: dict
  27. attrs:
  28. - variable: db_password
  29. label: Database Password
  30. description: The database password for Mempool.
  31. schema:
  32. type: string
  33. default: ""
  34. required: true
  35. private: true
  36. - variable: db_root_password
  37. label: Root Database Password
  38. description: The root database password for Mempool.
  39. schema:
  40. type: string
  41. default: ""
  42. required: true
  43. private: true
  44. - variable: use_installed_bitcoin_app
  45. label: Connect to Installed Bitcoin Node App
  46. description: |
  47. Enabling this option will attempt to connect to the installed Bitcoin Node TrueNAS app.
  48. Mempool won't work if your node is pruned.
  49. schema:
  50. type: boolean
  51. default: true
  52. - variable: external_bitcoind_ip
  53. label: External Bitcoin Node RPC IP
  54. schema:
  55. type: ipaddr
  56. required: true
  57. show_if: [["use_installed_bitcoin_app", "=", false]]
  58. - variable: bitcoind_rpc_port
  59. label: Bitcoin Node RPC Port
  60. schema:
  61. type: int
  62. min: 1
  63. max: 65535
  64. default: 8332
  65. required: true
  66. - variable: bitcoind_rpc_user
  67. label: Bitcoin Node RPC User
  68. schema:
  69. type: string
  70. default: truenas
  71. required: true
  72. - variable: bitcoind_rpc_password
  73. label: Bitcoin Node RPC Password
  74. schema:
  75. type: string
  76. required: true
  77. - variable: use_installed_electrs_app
  78. label: Connect to Installed Electrs App
  79. description: |
  80. Enabling this option will attempt to connect to the installed Electrs TrueNAS app.
  81. schema:
  82. type: boolean
  83. default: true
  84. - variable: external_electrum_ip
  85. label: External Electrum RPC IP
  86. schema:
  87. type: ipaddr
  88. required: true
  89. show_if: [["use_installed_electrs_app", "=", false]]
  90. - variable: electrum_rpc_port
  91. label: Electrum RPC Port
  92. schema:
  93. type: int
  94. min: 1
  95. max: 65535
  96. default: 50001
  97. required: true
  98. - variable: electrum_use_tls
  99. label: Connect to Electrum Over TLS
  100. schema:
  101. type: boolean
  102. default: false
  103. show_if: [["use_installed_electrs_app", "=", false]]
  104. - variable: additional_envs
  105. label: Additional Environment Variables
  106. schema:
  107. type: list
  108. default: []
  109. items:
  110. - variable: env
  111. label: Environment Variable
  112. schema:
  113. type: dict
  114. attrs:
  115. - variable: name
  116. label: Name
  117. schema:
  118. type: string
  119. required: true
  120. - variable: value
  121. label: Value
  122. schema:
  123. type: string
  124. - variable: network
  125. label: ""
  126. group: Network Configuration
  127. schema:
  128. type: dict
  129. attrs:
  130. - variable: web_ui_port
  131. label: Web UI 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: 3006
  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: cache
  184. label: Mempool Cache Storage Location
  185. schema:
  186. type: dict
  187. attrs:
  188. - variable: type
  189. label: Type
  190. description: |
  191. ixVolume: Is dataset created automatically by the system.</br>
  192. Host Path: Is a path that already exists on the system.
  193. schema:
  194. type: string
  195. required: true
  196. default: "ix_volume"
  197. enum:
  198. - value: "host_path"
  199. description: Host Path (Path that already exists on the system)
  200. - value: "ix_volume"
  201. description: ixVolume (Dataset created automatically by the system)
  202. - variable: ix_volume_config
  203. label: ixVolume Configuration
  204. description: The configuration for the ixVolume dataset.
  205. schema:
  206. type: dict
  207. show_if: [["type", "=", "ix_volume"]]
  208. $ref:
  209. - "normalize/ix_volume"
  210. attrs:
  211. - variable: acl_enable
  212. label: Enable ACL
  213. description: Enable ACL for the storage.
  214. schema:
  215. type: boolean
  216. default: false
  217. - variable: dataset_name
  218. label: Dataset Name
  219. description: The name of the dataset to use for storage.
  220. schema:
  221. type: string
  222. required: true
  223. hidden: true
  224. default: "mempool_data"
  225. - variable: acl_entries
  226. label: ACL Configuration
  227. schema:
  228. type: dict
  229. show_if: [["acl_enable", "=", true]]
  230. attrs: []
  231. - variable: host_path_config
  232. label: Host Path Configuration
  233. schema:
  234. type: dict
  235. show_if: [["type", "=", "host_path"]]
  236. attrs:
  237. - variable: acl_enable
  238. label: Enable ACL
  239. description: Enable ACL for the storage.
  240. schema:
  241. type: boolean
  242. default: false
  243. - variable: acl
  244. label: ACL Configuration
  245. schema:
  246. type: dict
  247. show_if: [["acl_enable", "=", true]]
  248. attrs: []
  249. $ref:
  250. - "normalize/acl"
  251. - variable: path
  252. label: Host Path
  253. description: The host path to use for storage.
  254. schema:
  255. type: hostpath
  256. show_if: [["acl_enable", "=", false]]
  257. required: true
  258. - variable: mariadb_data
  259. label: Mempool Database Storage Location
  260. schema:
  261. type: dict
  262. attrs:
  263. - variable: type
  264. label: Type
  265. description: |
  266. ixVolume: Is dataset created automatically by the system.</br>
  267. Host Path: Is a path that already exists on the system.
  268. schema:
  269. type: string
  270. required: true
  271. default: "ix_volume"
  272. enum:
  273. - value: "host_path"
  274. description: Host Path (Path that already exists on the system)
  275. - value: "ix_volume"
  276. description: ixVolume (Dataset created automatically by the system)
  277. - variable: ix_volume_config
  278. label: ixVolume Configuration
  279. description: The configuration for the ixVolume dataset.
  280. schema:
  281. type: dict
  282. show_if: [["type", "=", "ix_volume"]]
  283. $ref:
  284. - "normalize/ix_volume"
  285. attrs:
  286. - variable: acl_enable
  287. label: Enable ACL
  288. description: Enable ACL for the storage.
  289. schema:
  290. type: boolean
  291. default: false
  292. - variable: dataset_name
  293. label: Dataset Name
  294. description: The name of the dataset to use for storage.
  295. schema:
  296. type: string
  297. required: true
  298. hidden: true
  299. default: "mariadb_data"
  300. - variable: acl_entries
  301. label: ACL Configuration
  302. schema:
  303. type: dict
  304. show_if: [["acl_enable", "=", true]]
  305. attrs: []
  306. - variable: host_path_config
  307. label: Host Path Configuration
  308. schema:
  309. type: dict
  310. show_if: [["type", "=", "host_path"]]
  311. attrs:
  312. - variable: acl_enable
  313. label: Enable ACL
  314. description: Enable ACL for the storage.
  315. schema:
  316. type: boolean
  317. default: false
  318. - variable: acl
  319. label: ACL Configuration
  320. schema:
  321. type: dict
  322. show_if: [["acl_enable", "=", true]]
  323. attrs: []
  324. $ref:
  325. - "normalize/acl"
  326. - variable: path
  327. label: Host Path
  328. description: The host path to use for storage.
  329. schema:
  330. type: hostpath
  331. show_if: [["acl_enable", "=", false]]
  332. required: true
  333. - variable: labels
  334. label: ""
  335. group: Labels Configuration
  336. schema:
  337. type: list
  338. default: []
  339. items:
  340. - variable: label
  341. label: Label
  342. schema:
  343. type: dict
  344. attrs:
  345. - variable: key
  346. label: Key
  347. schema:
  348. type: string
  349. required: true
  350. - variable: value
  351. label: Value
  352. schema:
  353. type: string
  354. required: true
  355. - variable: containers
  356. label: Containers
  357. description: Containers where the label should be applied
  358. schema:
  359. type: list
  360. items:
  361. - variable: container
  362. label: Container
  363. schema:
  364. type: string
  365. required: true
  366. enum:
  367. - value: backend
  368. description: backend
  369. - value: frontend
  370. description: frontend
  371. - value: mariadb
  372. description: mariadb
  373. - variable: resources
  374. label: ""
  375. group: Resources Configuration
  376. schema:
  377. type: dict
  378. attrs:
  379. - variable: limits
  380. label: Limits
  381. schema:
  382. type: dict
  383. attrs:
  384. - variable: cpus
  385. label: CPUs
  386. description: CPUs limit for Mempool.
  387. schema:
  388. type: int
  389. default: 2
  390. required: true
  391. - variable: memory
  392. label: Memory (in MB)
  393. description: Memory limit for Mempool.
  394. schema:
  395. type: int
  396. default: 4096
  397. required: true