questions.yaml 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386
  1. groups:
  2. - name: Unpackerr Configuration
  3. description: Configure Unpackerr
  4. - name: User and Group Configuration
  5. description: Configure User and Group for Unpackerr
  6. - name: Network Configuration
  7. description: Configure Network for Unpackerr
  8. - name: Storage Configuration
  9. description: Configure Storage for Unpackerr
  10. - name: Labels Configuration
  11. description: Configure Labels for Unpackerr
  12. - name: Resources Configuration
  13. description: Configure Resources for Unpackerr
  14. questions:
  15. - variable: TZ
  16. group: Unpackerr Configuration
  17. label: Timezone
  18. schema:
  19. type: string
  20. default: Etc/UTC
  21. required: true
  22. $ref:
  23. - definitions/timezone
  24. - variable: unpackerr
  25. label: ""
  26. group: Unpackerr Configuration
  27. schema:
  28. type: dict
  29. attrs:
  30. - variable: settings
  31. label: Settings
  32. description: Configure Unpackerr settings for different applications.
  33. schema:
  34. type: list
  35. default: []
  36. items:
  37. - variable: setting
  38. label: Setting
  39. schema:
  40. type: dict
  41. attrs:
  42. - variable: type
  43. label: Type
  44. description: The type of application to configure.
  45. schema:
  46. type: string
  47. required: true
  48. enum:
  49. - value: sonarr
  50. description: Sonarr
  51. - value: radarr
  52. description: Radarr
  53. - value: lidarr
  54. description: Lidarr
  55. - value: readarr
  56. description: Readarr
  57. - value: whisparr
  58. description: Whisparr
  59. - variable: url
  60. label: URL
  61. description: URL where this starr app can be accessed.
  62. schema:
  63. type: string
  64. required: true
  65. format: uri
  66. - variable: api_key
  67. label: API Key
  68. schema:
  69. type: string
  70. required: true
  71. - variable: paths
  72. label: Paths
  73. description: File system paths where downloaded items are located.
  74. schema:
  75. type: list
  76. min: 1
  77. default: ["/downloads"]
  78. items:
  79. - variable: path
  80. label: Path
  81. schema:
  82. type: string
  83. required: true
  84. - variable: protocols
  85. label: Protocols
  86. description: Protocols to process.
  87. schema:
  88. type: list
  89. default: ["torrent"]
  90. min: 1
  91. items:
  92. - variable: protocol
  93. label: Protocol
  94. schema:
  95. type: string
  96. required: true
  97. enum:
  98. - value: torrent
  99. description: Torrent
  100. - value: usenet
  101. description: Usenet
  102. - variable: timeout
  103. label: Timeout (seconds)
  104. description: How long to wait for the application to respond, in seconds.
  105. schema:
  106. type: int
  107. default: 10
  108. required: true
  109. - variable: delete_delay
  110. label: Delete Delay (seconds)
  111. description: Extracts are deleted this long after import, in seconds. Use -1 to disable.
  112. schema:
  113. type: int
  114. default: 300
  115. required: true
  116. - variable: delete_orig
  117. label: Delete Original
  118. description: Delete archives after import? It's recommended to keep this false.
  119. schema:
  120. type: boolean
  121. default: false
  122. - variable: syncthing
  123. label: Syncthing
  124. description: Setting this to true makes Unpackerr wait for Syncthing to finish.
  125. schema:
  126. type: boolean
  127. default: false
  128. - variable: additional_envs
  129. label: Additional Environment Variables
  130. description: See options here https://unpackerr.zip/docs/install/configuration
  131. schema:
  132. type: list
  133. default: []
  134. items:
  135. - variable: env
  136. label: Environment Variable
  137. schema:
  138. type: dict
  139. attrs:
  140. - variable: name
  141. label: Name
  142. schema:
  143. type: string
  144. required: true
  145. - variable: value
  146. label: Value
  147. schema:
  148. type: string
  149. - variable: run_as
  150. label: ""
  151. group: User and Group Configuration
  152. schema:
  153. type: dict
  154. attrs:
  155. - variable: user
  156. label: User ID
  157. description: The user id that Unpackerr files will be owned by.
  158. schema:
  159. type: int
  160. min: 568
  161. default: 568
  162. required: true
  163. - variable: group
  164. label: Group ID
  165. description: The group id that Unpackerr files will be owned by.
  166. schema:
  167. type: int
  168. min: 568
  169. default: 568
  170. required: true
  171. - variable: network
  172. label: ""
  173. group: Network Configuration
  174. schema:
  175. type: dict
  176. attrs:
  177. - variable: host_network
  178. label: Host Network
  179. description: |
  180. Bind to the host network. It's recommended to keep this disabled.
  181. schema:
  182. type: boolean
  183. default: false
  184. - variable: storage
  185. label: ""
  186. group: Storage Configuration
  187. schema:
  188. type: dict
  189. attrs:
  190. - variable: additional_storage
  191. label: Additional Storage
  192. schema:
  193. type: list
  194. default: []
  195. items:
  196. - variable: storageEntry
  197. label: Storage Entry
  198. schema:
  199. type: dict
  200. attrs:
  201. - variable: type
  202. label: Type
  203. description: |
  204. ixVolume: Is dataset created automatically by the system.</br>
  205. Host Path: Is a path that already exists on the system.</br>
  206. SMB Share: Is a SMB share that is mounted to as a volume.
  207. schema:
  208. type: string
  209. required: true
  210. default: "ix_volume"
  211. enum:
  212. - value: "host_path"
  213. description: Host Path (Path that already exists on the system)
  214. - value: "ix_volume"
  215. description: ixVolume (Dataset created automatically by the system)
  216. - value: "cifs"
  217. description: SMB/CIFS Share (Mounts a volume to a SMB share)
  218. - variable: read_only
  219. label: Read Only
  220. description: Mount the volume as read only.
  221. schema:
  222. type: boolean
  223. default: false
  224. - variable: mount_path
  225. label: Mount Path
  226. description: The path inside the container to mount the storage.
  227. schema:
  228. type: path
  229. required: true
  230. - variable: host_path_config
  231. label: Host Path Configuration
  232. schema:
  233. type: dict
  234. show_if: [["type", "=", "host_path"]]
  235. attrs:
  236. - variable: acl_enable
  237. label: Enable ACL
  238. description: Enable ACL for the storage.
  239. schema:
  240. type: boolean
  241. default: false
  242. - variable: acl
  243. label: ACL Configuration
  244. schema:
  245. type: dict
  246. show_if: [["acl_enable", "=", true]]
  247. attrs: []
  248. $ref:
  249. - "normalize/acl"
  250. - variable: path
  251. label: Host Path
  252. description: The host path to use for storage.
  253. schema:
  254. type: hostpath
  255. show_if: [["acl_enable", "=", false]]
  256. required: true
  257. - variable: ix_volume_config
  258. label: ixVolume Configuration
  259. description: The configuration for the ixVolume dataset.
  260. schema:
  261. type: dict
  262. show_if: [["type", "=", "ix_volume"]]
  263. $ref:
  264. - "normalize/ix_volume"
  265. attrs:
  266. - variable: acl_enable
  267. label: Enable ACL
  268. description: Enable ACL for the storage.
  269. schema:
  270. type: boolean
  271. default: false
  272. - variable: dataset_name
  273. label: Dataset Name
  274. description: The name of the dataset to use for storage.
  275. schema:
  276. type: string
  277. required: true
  278. default: "storage_entry"
  279. - variable: acl_entries
  280. label: ACL Configuration
  281. schema:
  282. type: dict
  283. show_if: [["acl_enable", "=", true]]
  284. attrs: []
  285. $ref:
  286. - "normalize/acl"
  287. - variable: cifs_config
  288. label: SMB Configuration
  289. description: The configuration for the SMB dataset.
  290. schema:
  291. type: dict
  292. show_if: [["type", "=", "cifs"]]
  293. attrs:
  294. - variable: server
  295. label: Server
  296. description: The server to mount the SMB share.
  297. schema:
  298. type: string
  299. required: true
  300. - variable: path
  301. label: Path
  302. description: The path to mount the SMB share.
  303. schema:
  304. type: string
  305. required: true
  306. - variable: username
  307. label: Username
  308. description: The username to use for the SMB share.
  309. schema:
  310. type: string
  311. required: true
  312. - variable: password
  313. label: Password
  314. description: The password to use for the SMB share.
  315. schema:
  316. type: string
  317. required: true
  318. private: true
  319. - variable: domain
  320. label: Domain
  321. description: The domain to use for the SMB share.
  322. schema:
  323. type: string
  324. - variable: labels
  325. label: ""
  326. group: Labels Configuration
  327. schema:
  328. type: list
  329. default: []
  330. items:
  331. - variable: label
  332. label: Label
  333. schema:
  334. type: dict
  335. attrs:
  336. - variable: key
  337. label: Key
  338. schema:
  339. type: string
  340. required: true
  341. - variable: value
  342. label: Value
  343. schema:
  344. type: string
  345. required: true
  346. - variable: containers
  347. label: Containers
  348. description: Containers where the label should be applied
  349. schema:
  350. type: list
  351. items:
  352. - variable: container
  353. label: Container
  354. schema:
  355. type: string
  356. required: true
  357. enum:
  358. - value: unpackerr
  359. description: unpackerr
  360. - variable: resources
  361. label: ""
  362. group: Resources Configuration
  363. schema:
  364. type: dict
  365. attrs:
  366. - variable: limits
  367. label: Limits
  368. schema:
  369. type: dict
  370. attrs:
  371. - variable: cpus
  372. label: CPUs
  373. description: CPUs limit for Unpackerr.
  374. schema:
  375. type: int
  376. default: 2
  377. required: true
  378. - variable: memory
  379. label: Memory (in MB)
  380. description: Memory limit for Unpackerr.
  381. schema:
  382. type: int
  383. default: 4096
  384. required: true