questions.yaml 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511
  1. groups:
  2. - name: Monero LWS Configuration
  3. description: Configure Monero LWS
  4. - name: Network Configuration
  5. description: Configure Network for Monero LWS
  6. - name: Storage Configuration
  7. description: Configure Storage for Monero LWS
  8. - name: Labels Configuration
  9. description: Configure Labels for Monero LWS
  10. - name: Resources Configuration
  11. description: Configure Resources for Monero LWS
  12. questions:
  13. - variable: TZ
  14. group: Monero LWS Configuration
  15. label: Timezone
  16. schema:
  17. type: string
  18. default: Etc/UTC
  19. required: true
  20. $ref:
  21. - definitions/timezone
  22. - variable: lws
  23. label: ""
  24. group: Monero LWS Configuration
  25. schema:
  26. type: dict
  27. attrs:
  28. - variable: use_remote_node
  29. label: Use remote node
  30. description: |
  31. Leaving this disabled will attempt to use your installed Monero Node app.
  32. If you do not run the Monero Node app, you need to point to a different Monero node.
  33. Ideally this should be another device that you run, but it can be a node run by a third-party.
  34. Although the Monero software will take certain steps to protect your privacy and security when
  35. connecting to a third-party node, there are still meaningful privacy and security disadvantages.
  36. schema:
  37. type: boolean
  38. default: false
  39. - variable: remote_node_host
  40. label: Remote node host
  41. description:
  42. schema:
  43. type: uri
  44. show_if: [["use_remote_node", "=", true]]
  45. required: true
  46. - variable: trust_remote_daemon
  47. label: Trust remote node daemon
  48. description: |
  49. If you are connecting to a third-party node or are unsure, leave this disabled.
  50. If you are connecting to a node that you operate (or substantially trust),
  51. then enable this option to speed up certain functions.
  52. schema:
  53. type: boolean
  54. default: false
  55. show_if: [["use_remote_node", "=", true]]
  56. - variable: monerod_zmq_rpc_port
  57. label: Monero Node ZMQ RPC port
  58. description: The ZMQ RPC port of your Monero Node.
  59. schema:
  60. type: int
  61. min: 1
  62. max: 65535
  63. default: 18082
  64. required: true
  65. - variable: monerod_zmq_pub_port
  66. label: Monero Node ZMQ pub port
  67. description: The ZMQ Pub port of your Monero Node.
  68. schema:
  69. type: int
  70. min: 1
  71. max: 65535
  72. default: 18083
  73. required: true
  74. - variable: accounts
  75. label: Accounts
  76. description: Accounts for view-key scanning.
  77. schema:
  78. type: list
  79. default: []
  80. items:
  81. - variable: account
  82. label: ""
  83. schema:
  84. type: dict
  85. attrs:
  86. - variable: address
  87. label: Address
  88. schema:
  89. type: string
  90. required: true
  91. - variable: view_key
  92. label: View Key
  93. schema:
  94. type: string
  95. required: true
  96. - variable: restore_height
  97. label: Restore Height
  98. schema:
  99. type: int
  100. min: 0
  101. default: 0
  102. - variable: additional_envs
  103. label: Additional Environment Variables
  104. schema:
  105. type: list
  106. default: []
  107. items:
  108. - variable: env
  109. label: Environment Variable
  110. schema:
  111. type: dict
  112. attrs:
  113. - variable: name
  114. label: Name
  115. schema:
  116. type: string
  117. required: true
  118. - variable: value
  119. label: Value
  120. schema:
  121. type: string
  122. - variable: network
  123. label: ""
  124. group: Network Configuration
  125. schema:
  126. type: dict
  127. attrs:
  128. - variable: basic_rest_server_port
  129. label: Basic REST Server Port
  130. description: ""
  131. schema:
  132. type: dict
  133. attrs:
  134. - variable: bind_mode
  135. label: Port Bind Mode
  136. description: |
  137. The port bind mode.</br>
  138. - Publish: The port will be published on the host for external access.</br>
  139. - Expose: The port will be exposed for inter-container communication.</br>
  140. - None: The port will not be exposed or published.</br>
  141. Note: If the Dockerfile defines an EXPOSE directive,
  142. the port will still be exposed for inter-container communication regardless of this setting.
  143. schema:
  144. type: string
  145. default: "published"
  146. enum:
  147. - value: "published"
  148. description: Publish port on the host for external access
  149. - value: "exposed"
  150. description: Expose port for inter-container communication
  151. - value: ""
  152. description: None
  153. - variable: port_number
  154. label: Port Number
  155. schema:
  156. type: int
  157. default: 18090
  158. min: 1
  159. max: 65535
  160. required: true
  161. - variable: host_ips
  162. label: Host IPs
  163. description: IPs on the host to bind this port
  164. schema:
  165. type: list
  166. show_if: [["bind_mode", "=", "published"]]
  167. default: []
  168. items:
  169. - variable: host_ip
  170. label: Host IP
  171. schema:
  172. type: string
  173. required: true
  174. $ref:
  175. - definitions/node_bind_ip
  176. - variable: admin_rest_server_port
  177. label: Admin REST Server Port
  178. description: ""
  179. schema:
  180. type: dict
  181. attrs:
  182. - variable: bind_mode
  183. label: Port Bind Mode
  184. description: |
  185. The port bind mode.</br>
  186. - Publish: The port will be published on the host for external access.</br>
  187. - Expose: The port will be exposed for inter-container communication.</br>
  188. - None: The port will not be exposed or published.</br>
  189. Note: If the Dockerfile defines an EXPOSE directive,
  190. the port will still be exposed for inter-container communication regardless of this setting.
  191. schema:
  192. type: string
  193. default: ""
  194. enum:
  195. - value: "published"
  196. description: Publish port on the host for external access
  197. - value: "exposed"
  198. description: Expose port for inter-container communication
  199. - value: ""
  200. description: None
  201. - variable: port_number
  202. label: Port Number
  203. schema:
  204. type: int
  205. default: 18091
  206. min: 1
  207. max: 65535
  208. required: true
  209. - variable: host_ips
  210. label: Host IPs
  211. description: IPs on the host to bind this port
  212. schema:
  213. type: list
  214. show_if: [["bind_mode", "=", "published"]]
  215. default: []
  216. items:
  217. - variable: host_ip
  218. label: Host IP
  219. schema:
  220. type: string
  221. required: true
  222. $ref:
  223. - definitions/node_bind_ip
  224. - variable: storage
  225. label: ""
  226. group: Storage Configuration
  227. schema:
  228. type: dict
  229. attrs:
  230. - variable: monero_lws
  231. label: Monero LWS Storage
  232. schema:
  233. type: dict
  234. attrs:
  235. - variable: type
  236. label: Type
  237. description: |
  238. ixVolume: Is dataset created automatically by the system.</br>
  239. Host Path: Is a path that already exists on the system.
  240. schema:
  241. type: string
  242. required: true
  243. default: "ix_volume"
  244. enum:
  245. - value: "host_path"
  246. description: Host Path (Path that already exists on the system)
  247. - value: "ix_volume"
  248. description: ixVolume (Dataset created automatically by the system)
  249. - variable: ix_volume_config
  250. label: ixVolume Configuration
  251. description: The configuration for the ixVolume dataset.
  252. schema:
  253. type: dict
  254. show_if: [["type", "=", "ix_volume"]]
  255. $ref:
  256. - "normalize/ix_volume"
  257. attrs:
  258. - variable: acl_enable
  259. label: Enable ACL
  260. description: Enable ACL for the storage.
  261. schema:
  262. type: boolean
  263. default: false
  264. - variable: dataset_name
  265. label: Dataset Name
  266. description: The name of the dataset to use for storage.
  267. schema:
  268. type: string
  269. required: true
  270. hidden: true
  271. default: "monero_lws"
  272. - variable: acl_entries
  273. label: ACL Configuration
  274. schema:
  275. type: dict
  276. show_if: [["acl_enable", "=", true]]
  277. attrs: []
  278. - variable: host_path_config
  279. label: Host Path Configuration
  280. schema:
  281. type: dict
  282. show_if: [["type", "=", "host_path"]]
  283. attrs:
  284. - variable: acl_enable
  285. label: Enable ACL
  286. description: Enable ACL for the storage.
  287. schema:
  288. type: boolean
  289. default: false
  290. - variable: acl
  291. label: ACL Configuration
  292. schema:
  293. type: dict
  294. show_if: [["acl_enable", "=", true]]
  295. attrs: []
  296. $ref:
  297. - "normalize/acl"
  298. - variable: path
  299. label: Host Path
  300. description: The host path to use for storage.
  301. schema:
  302. type: hostpath
  303. show_if: [["acl_enable", "=", false]]
  304. required: true
  305. - variable: additional_storage
  306. label: Additional Storage
  307. schema:
  308. type: list
  309. default: []
  310. items:
  311. - variable: storageEntry
  312. label: Storage Entry
  313. schema:
  314. type: dict
  315. attrs:
  316. - variable: type
  317. label: Type
  318. description: |
  319. ixVolume: Is dataset created automatically by the system.</br>
  320. Host Path: Is a path that already exists on the system.</br>
  321. SMB Share: Is a SMB share that is mounted to as a volume.
  322. schema:
  323. type: string
  324. required: true
  325. default: "ix_volume"
  326. enum:
  327. - value: "host_path"
  328. description: Host Path (Path that already exists on the system)
  329. - value: "ix_volume"
  330. description: ixVolume (Dataset created automatically by the system)
  331. - value: "cifs"
  332. description: SMB/CIFS Share (Mounts a volume to a SMB share)
  333. - variable: read_only
  334. label: Read Only
  335. description: Mount the volume as read only.
  336. schema:
  337. type: boolean
  338. default: false
  339. - variable: mount_path
  340. label: Mount Path
  341. description: The path inside the container to mount the storage.
  342. schema:
  343. type: path
  344. required: true
  345. - variable: host_path_config
  346. label: Host Path Configuration
  347. schema:
  348. type: dict
  349. show_if: [["type", "=", "host_path"]]
  350. attrs:
  351. - variable: acl_enable
  352. label: Enable ACL
  353. description: Enable ACL for the storage.
  354. schema:
  355. type: boolean
  356. default: false
  357. - variable: acl
  358. label: ACL Configuration
  359. schema:
  360. type: dict
  361. show_if: [["acl_enable", "=", true]]
  362. attrs: []
  363. $ref:
  364. - "normalize/acl"
  365. - variable: path
  366. label: Host Path
  367. description: The host path to use for storage.
  368. schema:
  369. type: hostpath
  370. show_if: [["acl_enable", "=", false]]
  371. required: true
  372. - variable: ix_volume_config
  373. label: ixVolume Configuration
  374. description: The configuration for the ixVolume dataset.
  375. schema:
  376. type: dict
  377. show_if: [["type", "=", "ix_volume"]]
  378. $ref:
  379. - "normalize/ix_volume"
  380. attrs:
  381. - variable: acl_enable
  382. label: Enable ACL
  383. description: Enable ACL for the storage.
  384. schema:
  385. type: boolean
  386. default: false
  387. - variable: dataset_name
  388. label: Dataset Name
  389. description: The name of the dataset to use for storage.
  390. schema:
  391. type: string
  392. required: true
  393. default: "storage_entry"
  394. - variable: acl_entries
  395. label: ACL Configuration
  396. schema:
  397. type: dict
  398. show_if: [["acl_enable", "=", true]]
  399. attrs: []
  400. $ref:
  401. - "normalize/acl"
  402. - variable: cifs_config
  403. label: SMB Configuration
  404. description: The configuration for the SMB dataset.
  405. schema:
  406. type: dict
  407. show_if: [["type", "=", "cifs"]]
  408. attrs:
  409. - variable: server
  410. label: Server
  411. description: The server to mount the SMB share.
  412. schema:
  413. type: string
  414. required: true
  415. - variable: path
  416. label: Path
  417. description: The path to mount the SMB share.
  418. schema:
  419. type: string
  420. required: true
  421. - variable: username
  422. label: Username
  423. description: The username to use for the SMB share.
  424. schema:
  425. type: string
  426. required: true
  427. - variable: password
  428. label: Password
  429. description: The password to use for the SMB share.
  430. schema:
  431. type: string
  432. required: true
  433. private: true
  434. - variable: domain
  435. label: Domain
  436. description: The domain to use for the SMB share.
  437. schema:
  438. type: string
  439. - variable: labels
  440. label: ""
  441. group: Labels Configuration
  442. schema:
  443. type: list
  444. default: []
  445. items:
  446. - variable: label
  447. label: Label
  448. schema:
  449. type: dict
  450. attrs:
  451. - variable: key
  452. label: Key
  453. schema:
  454. type: string
  455. required: true
  456. - variable: value
  457. label: Value
  458. schema:
  459. type: string
  460. required: true
  461. - variable: containers
  462. label: Containers
  463. description: Containers where the label should be applied
  464. schema:
  465. type: list
  466. items:
  467. - variable: container
  468. label: Container
  469. schema:
  470. type: string
  471. required: true
  472. enum:
  473. - value: monero-lws
  474. description: monero-lws
  475. - variable: resources
  476. label: ""
  477. group: Resources Configuration
  478. schema:
  479. type: dict
  480. attrs:
  481. - variable: limits
  482. label: Limits
  483. schema:
  484. type: dict
  485. attrs:
  486. - variable: cpus
  487. label: CPUs
  488. description: CPUs limit for Monero LWS.
  489. schema:
  490. type: int
  491. default: 2
  492. required: true
  493. - variable: memory
  494. label: Memory (in MB)
  495. description: Memory limit for Monero LWS.
  496. schema:
  497. type: int
  498. default: 4096
  499. required: true