questions.yaml 16 KB

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