questions.yaml 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442
  1. groups:
  2. - name: WG Easy Configuration
  3. description: Configure WG Easy
  4. - name: Network Configuration
  5. description: Configure Network for WG Easy
  6. - name: Storage Configuration
  7. description: Configure Storage for WG Easy
  8. - name: Labels Configuration
  9. description: Configure Labels for WG Easy
  10. - name: Resources Configuration
  11. description: Configure Resources for WG Easy
  12. questions:
  13. - variable: wg_easy
  14. label: ""
  15. group: WG Easy Configuration
  16. schema:
  17. type: dict
  18. attrs:
  19. - variable: insecure
  20. label: Allow insecure connections
  21. description: Allow insecure connections to WG Easy.
  22. schema:
  23. type: boolean
  24. default: false
  25. - variable: additional_envs
  26. label: Additional Environment Variables
  27. schema:
  28. type: list
  29. default: []
  30. items:
  31. - variable: env
  32. label: Environment Variable
  33. schema:
  34. type: dict
  35. attrs:
  36. - variable: name
  37. label: Name
  38. schema:
  39. type: string
  40. required: true
  41. - variable: value
  42. label: Value
  43. schema:
  44. type: string
  45. - variable: network
  46. label: ""
  47. group: Network Configuration
  48. schema:
  49. type: dict
  50. attrs:
  51. - variable: web_port
  52. label: WebUI Port
  53. schema:
  54. type: dict
  55. attrs:
  56. - variable: bind_mode
  57. label: Port Bind Mode
  58. description: |
  59. The port bind mode.</br>
  60. - Publish: The port will be published on the host for external access.</br>
  61. - Expose: The port will be exposed for inter-container communication.</br>
  62. - None: The port will not be exposed or published.</br>
  63. Note: If the Dockerfile defines an EXPOSE directive,
  64. the port will still be exposed for inter-container communication regardless of this setting.
  65. schema:
  66. type: string
  67. default: "published"
  68. enum:
  69. - value: "published"
  70. description: Publish port on the host for external access
  71. - value: "exposed"
  72. description: Expose port for inter-container communication
  73. - value: ""
  74. description: None
  75. - variable: port_number
  76. label: Port Number
  77. schema:
  78. type: int
  79. default: 30058
  80. min: 1
  81. max: 65535
  82. required: true
  83. - variable: host_ips
  84. label: Host IPs
  85. description: IPs on the host to bind this port
  86. schema:
  87. type: list
  88. show_if: [["bind_mode", "=", "published"]]
  89. default: []
  90. items:
  91. - variable: host_ip
  92. label: Host IP
  93. schema:
  94. type: string
  95. required: true
  96. $ref:
  97. - definitions/node_bind_ip
  98. - variable: udp_port
  99. label: UDP Port
  100. schema:
  101. type: dict
  102. show_if: [["host_network", "=", false]]
  103. attrs:
  104. - variable: bind_mode
  105. label: Port Bind Mode
  106. description: |
  107. The port bind mode.</br>
  108. - Publish: The port will be published on the host for external access.</br>
  109. - Expose: The port will be exposed for inter-container communication.</br>
  110. - None: The port will not be exposed or published.</br>
  111. Note: If the Dockerfile defines an EXPOSE directive,
  112. the port will still be exposed for inter-container communication regardless of this setting.
  113. schema:
  114. type: string
  115. default: "published"
  116. enum:
  117. - value: "published"
  118. description: Publish port on the host for external access
  119. - value: "exposed"
  120. description: Expose port for inter-container communication
  121. - value: ""
  122. description: None
  123. - variable: port_number
  124. label: Port Number
  125. schema:
  126. type: int
  127. default: 30057
  128. show_if: [["bind_mode", "=", "published"]]
  129. min: 1
  130. max: 65535
  131. required: true
  132. - variable: container_port
  133. label: Container Port
  134. description: |
  135. The port inside the container to bind to,</br>
  136. This has to match the port you configured via the WG Easy UI.
  137. schema:
  138. type: int
  139. default: 51820
  140. required: true
  141. - variable: host_ips
  142. label: Host IPs
  143. description: IPs on the host to bind this port
  144. schema:
  145. type: list
  146. show_if: [["bind_mode", "=", "published"]]
  147. default: []
  148. items:
  149. - variable: host_ip
  150. label: Host IP
  151. schema:
  152. type: string
  153. required: true
  154. $ref:
  155. - definitions/node_bind_ip
  156. - variable: host_network
  157. label: Host Network
  158. description: |
  159. Bind to the host network.</br>
  160. It is needed if you want to access services on the host network.
  161. schema:
  162. type: boolean
  163. default: true
  164. - variable: storage
  165. label: ""
  166. group: Storage Configuration
  167. schema:
  168. type: dict
  169. attrs:
  170. - variable: config
  171. label: WG Easy Config Storage
  172. description: The path to store WG Easy Config.
  173. schema:
  174. type: dict
  175. attrs:
  176. - variable: type
  177. label: Type
  178. description: |
  179. ixVolume: Is dataset created automatically by the system.</br>
  180. Host Path: Is a path that already exists on the system.
  181. schema:
  182. type: string
  183. required: true
  184. default: "ix_volume"
  185. enum:
  186. - value: "host_path"
  187. description: Host Path (Path that already exists on the system)
  188. - value: "ix_volume"
  189. description: ixVolume (Dataset created automatically by the system)
  190. - variable: ix_volume_config
  191. label: ixVolume Configuration
  192. description: The configuration for the ixVolume dataset.
  193. schema:
  194. type: dict
  195. show_if: [["type", "=", "ix_volume"]]
  196. $ref:
  197. - "normalize/ix_volume"
  198. attrs:
  199. - variable: acl_enable
  200. label: Enable ACL
  201. description: Enable ACL for the storage.
  202. schema:
  203. type: boolean
  204. default: false
  205. - variable: dataset_name
  206. label: Dataset Name
  207. description: The name of the dataset to use for storage.
  208. schema:
  209. type: string
  210. required: true
  211. hidden: true
  212. default: "config"
  213. - variable: acl_entries
  214. label: ACL Configuration
  215. schema:
  216. type: dict
  217. show_if: [["acl_enable", "=", true]]
  218. attrs: []
  219. - variable: host_path_config
  220. label: Host Path Configuration
  221. schema:
  222. type: dict
  223. show_if: [["type", "=", "host_path"]]
  224. attrs:
  225. - variable: acl_enable
  226. label: Enable ACL
  227. description: Enable ACL for the storage.
  228. schema:
  229. type: boolean
  230. default: false
  231. - variable: acl
  232. label: ACL Configuration
  233. schema:
  234. type: dict
  235. show_if: [["acl_enable", "=", true]]
  236. attrs: []
  237. $ref:
  238. - "normalize/acl"
  239. - variable: path
  240. label: Host Path
  241. description: The host path to use for storage.
  242. schema:
  243. type: hostpath
  244. show_if: [["acl_enable", "=", false]]
  245. required: true
  246. - variable: additional_storage
  247. label: Additional Storage
  248. schema:
  249. type: list
  250. default: []
  251. items:
  252. - variable: storageEntry
  253. label: Storage Entry
  254. schema:
  255. type: dict
  256. attrs:
  257. - variable: type
  258. label: Type
  259. description: |
  260. ixVolume: Is dataset created automatically by the system.</br>
  261. Host Path: Is a path that already exists on the system.</br>
  262. SMB Share: Is a SMB share that is mounted to as a volume.
  263. schema:
  264. type: string
  265. required: true
  266. default: "ix_volume"
  267. enum:
  268. - value: "host_path"
  269. description: Host Path (Path that already exists on the system)
  270. - value: "ix_volume"
  271. description: ixVolume (Dataset created automatically by the system)
  272. - value: "cifs"
  273. description: SMB/CIFS Share (Mounts a volume to a SMB share)
  274. - variable: read_only
  275. label: Read Only
  276. description: Mount the volume as read only.
  277. schema:
  278. type: boolean
  279. default: false
  280. - variable: mount_path
  281. label: Mount Path
  282. description: The path inside the container to mount the storage.
  283. schema:
  284. type: path
  285. required: true
  286. - variable: host_path_config
  287. label: Host Path Configuration
  288. schema:
  289. type: dict
  290. show_if: [["type", "=", "host_path"]]
  291. attrs:
  292. - variable: acl_enable
  293. label: Enable ACL
  294. description: Enable ACL for the storage.
  295. schema:
  296. type: boolean
  297. default: false
  298. - variable: acl
  299. label: ACL Configuration
  300. schema:
  301. type: dict
  302. show_if: [["acl_enable", "=", true]]
  303. attrs: []
  304. $ref:
  305. - "normalize/acl"
  306. - variable: path
  307. label: Host Path
  308. description: The host path to use for storage.
  309. schema:
  310. type: hostpath
  311. show_if: [["acl_enable", "=", false]]
  312. required: true
  313. - variable: ix_volume_config
  314. label: ixVolume Configuration
  315. description: The configuration for the ixVolume dataset.
  316. schema:
  317. type: dict
  318. show_if: [["type", "=", "ix_volume"]]
  319. $ref:
  320. - "normalize/ix_volume"
  321. attrs:
  322. - variable: acl_enable
  323. label: Enable ACL
  324. description: Enable ACL for the storage.
  325. schema:
  326. type: boolean
  327. default: false
  328. - variable: dataset_name
  329. label: Dataset Name
  330. description: The name of the dataset to use for storage.
  331. schema:
  332. type: string
  333. required: true
  334. default: "storage_entry"
  335. - variable: acl_entries
  336. label: ACL Configuration
  337. schema:
  338. type: dict
  339. show_if: [["acl_enable", "=", true]]
  340. attrs: []
  341. $ref:
  342. - "normalize/acl"
  343. - variable: cifs_config
  344. label: SMB Configuration
  345. description: The configuration for the SMB dataset.
  346. schema:
  347. type: dict
  348. show_if: [["type", "=", "cifs"]]
  349. attrs:
  350. - variable: server
  351. label: Server
  352. description: The server to mount the SMB share.
  353. schema:
  354. type: string
  355. required: true
  356. - variable: path
  357. label: Path
  358. description: The path to mount the SMB share.
  359. schema:
  360. type: string
  361. required: true
  362. - variable: username
  363. label: Username
  364. description: The username to use for the SMB share.
  365. schema:
  366. type: string
  367. required: true
  368. - variable: password
  369. label: Password
  370. description: The password to use for the SMB share.
  371. schema:
  372. type: string
  373. required: true
  374. private: true
  375. - variable: domain
  376. label: Domain
  377. description: The domain to use for the SMB share.
  378. schema:
  379. type: string
  380. - variable: labels
  381. label: ""
  382. group: Labels Configuration
  383. schema:
  384. type: list
  385. default: []
  386. items:
  387. - variable: label
  388. label: Label
  389. schema:
  390. type: dict
  391. attrs:
  392. - variable: key
  393. label: Key
  394. schema:
  395. type: string
  396. required: true
  397. - variable: value
  398. label: Value
  399. schema:
  400. type: string
  401. required: true
  402. - variable: containers
  403. label: Containers
  404. description: Containers where the label should be applied
  405. schema:
  406. type: list
  407. items:
  408. - variable: container
  409. label: Container
  410. schema:
  411. type: string
  412. required: true
  413. enum:
  414. - value: wg-easy
  415. description: wg-easy
  416. - variable: resources
  417. label: ""
  418. group: Resources Configuration
  419. schema:
  420. type: dict
  421. attrs:
  422. - variable: limits
  423. label: Limits
  424. schema:
  425. type: dict
  426. attrs:
  427. - variable: cpus
  428. label: CPUs
  429. description: CPUs limit for WG Easy.
  430. schema:
  431. type: int
  432. default: 2
  433. required: true
  434. - variable: memory
  435. label: Memory (in MB)
  436. description: Memory limit for WG Easy.
  437. schema:
  438. type: int
  439. default: 4096
  440. required: true