questions.yaml 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516
  1. groups:
  2. - name: Syncthing Configuration
  3. description: Configure Syncthing
  4. - name: User and Group Configuration
  5. description: Configure User and Group for Syncthing
  6. - name: Network Configuration
  7. description: Configure Network for Syncthing
  8. - name: Storage Configuration
  9. description: Configure Storage for Syncthing
  10. - name: Labels Configuration
  11. description: Configure Labels for Syncthing
  12. - name: Resources Configuration
  13. description: Configure Resources for Syncthing
  14. questions:
  15. - variable: TZ
  16. group: Syncthing Configuration
  17. label: Timezone
  18. schema:
  19. type: string
  20. default: Etc/UTC
  21. required: true
  22. $ref:
  23. - definitions/timezone
  24. - variable: syncthing
  25. label: ""
  26. group: Syncthing Configuration
  27. schema:
  28. type: dict
  29. attrs:
  30. - variable: additional_envs
  31. label: Additional Environment Variables
  32. schema:
  33. type: list
  34. default: []
  35. items:
  36. - variable: env
  37. label: Environment Variable
  38. schema:
  39. type: dict
  40. attrs:
  41. - variable: name
  42. label: Name
  43. schema:
  44. type: string
  45. required: true
  46. - variable: value
  47. label: Value
  48. schema:
  49. type: string
  50. - variable: run_as
  51. label: ""
  52. group: User and Group Configuration
  53. schema:
  54. type: dict
  55. attrs:
  56. - variable: user
  57. label: User ID
  58. description: The user id that Syncthing will run as.
  59. schema:
  60. type: int
  61. min: 568
  62. default: 568
  63. required: true
  64. - variable: group
  65. label: Group ID
  66. description: The group id that Syncthing will run as.
  67. schema:
  68. type: int
  69. min: 568
  70. default: 568
  71. required: true
  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. schema:
  81. type: dict
  82. attrs:
  83. - variable: bind_mode
  84. label: Port Bind Mode
  85. description: |
  86. The port bind mode.</br>
  87. - Publish: The port will be published on the host for external access.</br>
  88. - Expose: The port will be exposed for inter-container communication.</br>
  89. - None: The port will not be exposed or published.</br>
  90. Note: If the Dockerfile defines an EXPOSE directive,
  91. the port will still be exposed for inter-container communication regardless of this setting.
  92. schema:
  93. type: string
  94. default: "published"
  95. enum:
  96. - value: "published"
  97. description: Publish port on the host for external access
  98. - value: "exposed"
  99. description: Expose port for inter-container communication
  100. - value: ""
  101. description: None
  102. - variable: port_number
  103. label: Port Number
  104. schema:
  105. type: int
  106. default: 8384
  107. min: 1
  108. max: 65535
  109. required: true
  110. - variable: host_ips
  111. label: Host IPs
  112. description: IPs on the host to bind this port
  113. schema:
  114. type: list
  115. show_if: [["bind_mode", "=", "published"]]
  116. default: []
  117. items:
  118. - variable: host_ip
  119. label: Host IP
  120. schema:
  121. type: string
  122. required: true
  123. $ref:
  124. - definitions/node_bind_ip
  125. - variable: tcp_port
  126. label: TCP Port (File Transfers)
  127. description: The TCP port for Syncthing transfers.
  128. schema:
  129. type: dict
  130. show_if: [["host_network", "=", false]]
  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. show_if: [["bind_mode", "=", "published"]]
  156. default: 22000
  157. min: 1
  158. max: 65535
  159. required: true
  160. - variable: host_ips
  161. label: Host IPs
  162. description: IPs on the host to bind this port
  163. schema:
  164. type: list
  165. show_if: [["bind_mode", "=", "published"]]
  166. default: []
  167. items:
  168. - variable: host_ip
  169. label: Host IP
  170. schema:
  171. type: string
  172. required: true
  173. $ref:
  174. - definitions/node_bind_ip
  175. - variable: quic_port
  176. label: QUIC (UDP) Port (File Transfers)
  177. description: The QUIC (UDP) port for Syncthing transfers.
  178. schema:
  179. type: dict
  180. show_if: [["host_network", "=", false]]
  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: "published"
  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. show_if: [["bind_mode", "=", "published"]]
  206. default: 22000
  207. min: 1
  208. max: 65535
  209. required: true
  210. - variable: host_ips
  211. label: Host IPs
  212. description: IPs on the host to bind this port
  213. schema:
  214. type: list
  215. show_if: [["bind_mode", "=", "published"]]
  216. default: []
  217. items:
  218. - variable: host_ip
  219. label: Host IP
  220. schema:
  221. type: string
  222. required: true
  223. $ref:
  224. - definitions/node_bind_ip
  225. - variable: host_network
  226. label: Host Network
  227. description: |
  228. Bind to the host network.</br></br>
  229. If this is disabled, you will need to add your local networks in CIDR format to the Syncthing WebUI.</br>
  230. In the Syncthing WebUI, go to Advanced Settings > Options > Always Local Nets</br>
  231. Separate each CIDR network with a comma.</br>
  232. Example: 192.168.0.0/24,192.168.1.0/24
  233. schema:
  234. type: boolean
  235. default: true
  236. - variable: certificate_id
  237. label: Certificate
  238. description: The certificate to use for Syncthing
  239. schema:
  240. type: int
  241. "null": true
  242. $ref:
  243. - "definitions/certificate"
  244. - variable: storage
  245. label: ""
  246. group: Storage Configuration
  247. schema:
  248. type: dict
  249. attrs:
  250. - variable: home
  251. label: Syncthing Home Storage
  252. description: The path to store Syncthing Home.
  253. schema:
  254. type: dict
  255. attrs:
  256. - variable: type
  257. label: Type
  258. description: |
  259. ixVolume: Is dataset created automatically by the system.</br>
  260. Host Path: Is a path that already exists on the system.
  261. schema:
  262. type: string
  263. required: true
  264. default: "ix_volume"
  265. enum:
  266. - value: "host_path"
  267. description: Host Path (Path that already exists on the system)
  268. - value: "ix_volume"
  269. description: ixVolume (Dataset created automatically by the system)
  270. - variable: ix_volume_config
  271. label: ixVolume Configuration
  272. description: The configuration for the ixVolume dataset.
  273. schema:
  274. type: dict
  275. show_if: [["type", "=", "ix_volume"]]
  276. $ref:
  277. - "normalize/ix_volume"
  278. attrs:
  279. - variable: acl_enable
  280. label: Enable ACL
  281. description: Enable ACL for the storage.
  282. schema:
  283. type: boolean
  284. default: false
  285. - variable: dataset_name
  286. label: Dataset Name
  287. description: The name of the dataset to use for storage.
  288. schema:
  289. type: string
  290. required: true
  291. hidden: true
  292. default: "home"
  293. - variable: acl_entries
  294. label: ACL Configuration
  295. schema:
  296. type: dict
  297. show_if: [["acl_enable", "=", true]]
  298. attrs: []
  299. - variable: host_path_config
  300. label: Host Path Configuration
  301. schema:
  302. type: dict
  303. show_if: [["type", "=", "host_path"]]
  304. attrs:
  305. - variable: acl_enable
  306. label: Enable ACL
  307. description: Enable ACL for the storage.
  308. schema:
  309. type: boolean
  310. default: false
  311. - variable: acl
  312. label: ACL Configuration
  313. schema:
  314. type: dict
  315. show_if: [["acl_enable", "=", true]]
  316. attrs: []
  317. $ref:
  318. - "normalize/acl"
  319. - variable: path
  320. label: Host Path
  321. description: The host path to use for storage.
  322. schema:
  323. type: hostpath
  324. show_if: [["acl_enable", "=", false]]
  325. required: true
  326. - variable: additional_storage
  327. label: Additional Storage
  328. schema:
  329. type: list
  330. min: 1
  331. required: true
  332. default:
  333. - type: host_path
  334. mount_path: /data1
  335. items:
  336. - variable: storageEntry
  337. label: Storage Entry
  338. schema:
  339. type: dict
  340. attrs:
  341. - variable: type
  342. label: Type
  343. description: |
  344. Host Path: Is a path that already exists on the system.</br>
  345. SMB Share: Is a SMB share that is mounted to as a volume.
  346. schema:
  347. type: string
  348. required: true
  349. default: "host_path"
  350. enum:
  351. - value: "host_path"
  352. description: Host Path (Path that already exists on the system)
  353. - value: "cifs"
  354. description: SMB/CIFS Share (Mounts a volume to a SMB share)
  355. - variable: read_only
  356. label: Read Only
  357. description: Mount the volume as read only.
  358. schema:
  359. type: boolean
  360. default: false
  361. - variable: mount_path
  362. label: Mount Path
  363. description: The path inside the container to mount the storage.
  364. schema:
  365. type: path
  366. required: true
  367. - variable: host_path_config
  368. label: Host Path Configuration
  369. schema:
  370. type: dict
  371. show_if: [["type", "=", "host_path"]]
  372. attrs:
  373. - variable: acl_enable
  374. label: Enable ACL
  375. description: Enable ACL for the storage.
  376. schema:
  377. type: boolean
  378. default: false
  379. - variable: acl
  380. label: ACL Configuration
  381. schema:
  382. type: dict
  383. show_if: [["acl_enable", "=", true]]
  384. attrs: []
  385. $ref:
  386. - "normalize/acl"
  387. - variable: path
  388. label: Host Path
  389. description: The host path to use for storage.
  390. schema:
  391. type: hostpath
  392. show_if: [["acl_enable", "=", false]]
  393. required: true
  394. - variable: cifs_config
  395. label: SMB Configuration
  396. description: The configuration for the SMB dataset.
  397. schema:
  398. type: dict
  399. show_if: [["type", "=", "cifs"]]
  400. attrs:
  401. - variable: migration_mode
  402. label: Migration Mode
  403. description: |
  404. NOTE: This only works properly with TrueNAS SCALE 24.04.0 or newer.<br/>
  405. Enabling this will force the following:</br>
  406. - Read Only Mount, regardless of the value of the Read Only checkbox.</br>
  407. - SMB/CIFS Mount Options will be set to "vers=3.0", "cifsacl", "noperm"</br>
  408. This option is used to migrate data from third party</br>
  409. NAS platforms onto TrueNAS SCALE.</br>
  410. Keep in mind that the ACL preservation is not guaranteed when:</br>
  411. - Non-AD environment</br>
  412. - ACL or remote server contains local users</br>
  413. schema:
  414. type: boolean
  415. default: false
  416. - variable: server
  417. label: Server
  418. description: The server to mount the SMB share.
  419. schema:
  420. type: string
  421. required: true
  422. - variable: path
  423. label: Path
  424. description: The path to mount the SMB share.
  425. schema:
  426. type: string
  427. required: true
  428. - variable: username
  429. label: Username
  430. description: The username to use for the SMB share.
  431. schema:
  432. type: string
  433. required: true
  434. - variable: password
  435. label: Password
  436. description: The password to use for the SMB share.
  437. schema:
  438. type: string
  439. required: true
  440. private: true
  441. - variable: domain
  442. label: Domain
  443. description: The domain to use for the SMB share.
  444. schema:
  445. type: string
  446. - variable: labels
  447. label: ""
  448. group: Labels Configuration
  449. schema:
  450. type: list
  451. default: []
  452. items:
  453. - variable: label
  454. label: Label
  455. schema:
  456. type: dict
  457. attrs:
  458. - variable: key
  459. label: Key
  460. schema:
  461. type: string
  462. required: true
  463. - variable: value
  464. label: Value
  465. schema:
  466. type: string
  467. required: true
  468. - variable: containers
  469. label: Containers
  470. description: Containers where the label should be applied
  471. schema:
  472. type: list
  473. items:
  474. - variable: container
  475. label: Container
  476. schema:
  477. type: string
  478. required: true
  479. enum:
  480. - value: syncthing
  481. description: syncthing
  482. - variable: resources
  483. label: ""
  484. group: Resources Configuration
  485. schema:
  486. type: dict
  487. attrs:
  488. - variable: limits
  489. label: Limits
  490. schema:
  491. type: dict
  492. attrs:
  493. - variable: cpus
  494. label: CPUs
  495. description: CPUs limit for Syncthing.
  496. schema:
  497. type: int
  498. default: 2
  499. required: true
  500. - variable: memory
  501. label: Memory (in MB)
  502. description: Memory limit for Syncthing.
  503. schema:
  504. type: int
  505. default: 4096
  506. required: true