questions.yaml 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140
  1. groups:
  2. - name: Immich Configuration
  3. description: Configure Immich
  4. - name: User and Group Configuration
  5. description: Configure User and Group for Immich
  6. - name: Network Configuration
  7. description: Configure Network for Immich
  8. - name: Storage Configuration
  9. description: Configure Storage for Immich
  10. - name: Labels Configuration
  11. description: Configure Labels for Immich
  12. - name: Resources Configuration
  13. description: Configure Resources for Immich
  14. questions:
  15. - variable: TZ
  16. group: Immich Configuration
  17. label: Timezone
  18. schema:
  19. type: string
  20. default: Etc/UTC
  21. required: true
  22. $ref:
  23. - definitions/timezone
  24. - variable: immich
  25. label: ""
  26. group: Immich Configuration
  27. schema:
  28. type: dict
  29. attrs:
  30. - variable: enable_ml
  31. label: Enable Machine Learning
  32. description: |
  33. Enable Machine Learning
  34. schema:
  35. type: boolean
  36. default: true
  37. - variable: ml_image_selector
  38. label: Machine Learning Image Type
  39. description: |
  40. The type of image to use for Machine Learning.
  41. schema:
  42. type: string
  43. default: ml_image
  44. enum:
  45. - value: ml_image
  46. description: Default Machine Learning Image
  47. - value: ml_cuda_image
  48. description: Cuda Machine Learning Image
  49. - value: ml_rocm_image
  50. description: Rocm Machine Learning Image
  51. - value: ml_openvino_image
  52. description: Openvino Machine Learning Image
  53. - variable: db_password
  54. label: Database Password
  55. description: |
  56. The password to use for the database.
  57. schema:
  58. type: string
  59. default: ""
  60. required: true
  61. private: true
  62. - variable: redis_password
  63. label: Redis Password
  64. description: |
  65. The password to use for the redis.
  66. schema:
  67. type: string
  68. default: ""
  69. required: true
  70. private: true
  71. - variable: log_level
  72. label: Log Level
  73. description: |
  74. The log level to use for Machine Learning.
  75. schema:
  76. type: string
  77. default: log
  78. enum:
  79. - value: verbose
  80. description: Verbose
  81. - value: debug
  82. description: Debug
  83. - value: log
  84. description: Log
  85. - value: warn
  86. description: Warn
  87. - value: error
  88. description: Error
  89. - variable: hugging_face_endpoint
  90. label: Hugging Face Endpoint (Optional)
  91. description: |
  92. The Hugging Face endpoint to use for Machine Learning.
  93. schema:
  94. type: string
  95. default: ""
  96. - variable: db_storage_type
  97. label: Database Storage Type
  98. description: |
  99. Recommended type is SSD.</br>
  100. If you encounter a issue with the database while using HDD</br>
  101. please remember to mention that when opening an issue.
  102. schema:
  103. type: string
  104. default: SSD
  105. enum:
  106. - value: SSD
  107. description: SSD
  108. - value: HDD
  109. description: HDD
  110. - variable: additional_envs
  111. label: Additional Environment Variables
  112. schema:
  113. type: list
  114. default: []
  115. items:
  116. - variable: env
  117. label: Environment Variable
  118. schema:
  119. type: dict
  120. attrs:
  121. - variable: name
  122. label: Name
  123. schema:
  124. type: string
  125. required: true
  126. - variable: value
  127. label: Value
  128. schema:
  129. type: string
  130. - variable: run_as
  131. label: ""
  132. group: User and Group Configuration
  133. schema:
  134. type: dict
  135. attrs:
  136. - variable: user
  137. label: User ID
  138. description: The user id that Immich files will be owned by.
  139. schema:
  140. type: int
  141. min: 0
  142. default: 568
  143. required: true
  144. - variable: group
  145. label: Group ID
  146. description: The group id that Immich files will be owned by.
  147. schema:
  148. type: int
  149. min: 0
  150. default: 568
  151. required: true
  152. - variable: network
  153. label: ""
  154. group: Network Configuration
  155. schema:
  156. type: dict
  157. attrs:
  158. - variable: web_port
  159. label: WebUI Port
  160. description: The port for Immich WebUI
  161. schema:
  162. type: dict
  163. attrs:
  164. - variable: bind_mode
  165. label: Port Bind Mode
  166. description: |
  167. The port bind mode.</br>
  168. - Publish: The port will be published on the host for external access.</br>
  169. - Expose: The port will be exposed for inter-container communication.</br>
  170. - None: The port will not be exposed or published.</br>
  171. Note: If the Dockerfile defines an EXPOSE directive,
  172. the port will still be exposed for inter-container communication regardless of this setting.
  173. schema:
  174. type: string
  175. default: "published"
  176. enum:
  177. - value: "published"
  178. description: Publish port on the host for external access
  179. - value: "exposed"
  180. description: Expose port for inter-container communication
  181. - value: ""
  182. description: None
  183. - variable: port_number
  184. label: Port Number
  185. schema:
  186. type: int
  187. default: 30041
  188. min: 1
  189. max: 65535
  190. required: true
  191. - variable: host_ips
  192. label: Host IPs
  193. description: IPs on the host to bind this port
  194. schema:
  195. type: list
  196. show_if: [["bind_mode", "=", "published"]]
  197. default: []
  198. items:
  199. - variable: host_ip
  200. label: Host IP
  201. schema:
  202. type: string
  203. required: true
  204. $ref:
  205. - definitions/node_bind_ip
  206. - variable: storage
  207. label: ""
  208. group: Storage Configuration
  209. schema:
  210. type: dict
  211. attrs:
  212. - variable: use_old_storage_config
  213. label: Use Old Storage Configuration (Deprecated)
  214. description: |
  215. Use the old storage configuration.</br>
  216. This is deprecated and will be removed in the future.</br>
  217. Please use the new storage configuration instead.
  218. schema:
  219. type: boolean
  220. default: false
  221. - variable: data
  222. label: Data Storage (aka Upload Location)
  223. schema:
  224. type: dict
  225. show_if: [["use_old_storage_config", "=", false]]
  226. attrs:
  227. - variable: type
  228. label: Type
  229. description: |
  230. ixVolume: Is dataset created automatically by the system.</br>
  231. Host Path: Is a path that already exists on the system.
  232. schema:
  233. type: string
  234. required: true
  235. default: "ix_volume"
  236. enum:
  237. - value: "host_path"
  238. description: Host Path (Path that already exists on the system)
  239. - value: "ix_volume"
  240. description: ixVolume (Dataset created automatically by the system)
  241. - variable: ix_volume_config
  242. label: ixVolume Configuration
  243. description: The configuration for the ixVolume dataset.
  244. schema:
  245. type: dict
  246. show_if: [["type", "=", "ix_volume"]]
  247. $ref:
  248. - "normalize/ix_volume"
  249. attrs:
  250. - variable: acl_enable
  251. label: Enable ACL
  252. description: Enable ACL for the storage.
  253. schema:
  254. type: boolean
  255. default: false
  256. - variable: dataset_name
  257. label: Dataset Name
  258. description: The name of the dataset to use for storage.
  259. schema:
  260. type: string
  261. required: true
  262. hidden: true
  263. default: "data"
  264. - variable: acl_entries
  265. label: ACL Configuration
  266. schema:
  267. type: dict
  268. show_if: [["acl_enable", "=", true]]
  269. attrs: []
  270. - variable: host_path_config
  271. label: Host Path Configuration
  272. schema:
  273. type: dict
  274. show_if: [["type", "=", "host_path"]]
  275. attrs:
  276. - variable: acl_enable
  277. label: Enable ACL
  278. description: Enable ACL for the storage.
  279. schema:
  280. type: boolean
  281. default: false
  282. - variable: acl
  283. label: ACL Configuration
  284. schema:
  285. type: dict
  286. show_if: [["acl_enable", "=", true]]
  287. attrs: []
  288. $ref:
  289. - "normalize/acl"
  290. - variable: path
  291. label: Host Path
  292. description: The host path to use for storage.
  293. schema:
  294. type: hostpath
  295. show_if: [["acl_enable", "=", false]]
  296. required: true
  297. - variable: library
  298. label: Immich Library Storage
  299. description: The path to store Immich Library.
  300. schema:
  301. type: dict
  302. show_if: [["use_old_storage_config", "=", true]]
  303. attrs:
  304. - variable: type
  305. label: Type
  306. description: |
  307. ixVolume: Is dataset created automatically by the system.</br>
  308. Host Path: Is a path that already exists on the system.
  309. schema:
  310. type: string
  311. required: true
  312. default: "ix_volume"
  313. enum:
  314. - value: "host_path"
  315. description: Host Path (Path that already exists on the system)
  316. - value: "ix_volume"
  317. description: ixVolume (Dataset created automatically by the system)
  318. - variable: ix_volume_config
  319. label: ixVolume Configuration
  320. description: The configuration for the ixVolume dataset.
  321. schema:
  322. type: dict
  323. show_if: [["type", "=", "ix_volume"]]
  324. $ref:
  325. - "normalize/ix_volume"
  326. attrs:
  327. - variable: acl_enable
  328. label: Enable ACL
  329. description: Enable ACL for the storage.
  330. schema:
  331. type: boolean
  332. default: false
  333. - variable: dataset_name
  334. label: Dataset Name
  335. description: The name of the dataset to use for storage.
  336. schema:
  337. type: string
  338. required: true
  339. hidden: true
  340. default: "library"
  341. - variable: acl_entries
  342. label: ACL Configuration
  343. schema:
  344. type: dict
  345. show_if: [["acl_enable", "=", true]]
  346. attrs: []
  347. - variable: host_path_config
  348. label: Host Path Configuration
  349. schema:
  350. type: dict
  351. show_if: [["type", "=", "host_path"]]
  352. attrs:
  353. - variable: acl_enable
  354. label: Enable ACL
  355. description: Enable ACL for the storage.
  356. schema:
  357. type: boolean
  358. default: false
  359. - variable: acl
  360. label: ACL Configuration
  361. schema:
  362. type: dict
  363. show_if: [["acl_enable", "=", true]]
  364. attrs: []
  365. $ref:
  366. - "normalize/acl"
  367. - variable: path
  368. label: Host Path
  369. description: The host path to use for storage.
  370. schema:
  371. type: hostpath
  372. show_if: [["acl_enable", "=", false]]
  373. required: true
  374. - variable: uploads
  375. label: Immich Uploads Storage
  376. description: The path to store Immich Uploads.
  377. schema:
  378. type: dict
  379. show_if: [["use_old_storage_config", "=", true]]
  380. attrs:
  381. - variable: type
  382. label: Type
  383. description: |
  384. ixVolume: Is dataset created automatically by the system.</br>
  385. Host Path: Is a path that already exists on the system.
  386. schema:
  387. type: string
  388. required: true
  389. default: "ix_volume"
  390. enum:
  391. - value: "host_path"
  392. description: Host Path (Path that already exists on the system)
  393. - value: "ix_volume"
  394. description: ixVolume (Dataset created automatically by the system)
  395. - variable: ix_volume_config
  396. label: ixVolume Configuration
  397. description: The configuration for the ixVolume dataset.
  398. schema:
  399. type: dict
  400. show_if: [["type", "=", "ix_volume"]]
  401. $ref:
  402. - "normalize/ix_volume"
  403. attrs:
  404. - variable: acl_enable
  405. label: Enable ACL
  406. description: Enable ACL for the storage.
  407. schema:
  408. type: boolean
  409. default: false
  410. - variable: dataset_name
  411. label: Dataset Name
  412. description: The name of the dataset to use for storage.
  413. schema:
  414. type: string
  415. required: true
  416. hidden: true
  417. default: "uploads"
  418. - variable: acl_entries
  419. label: ACL Configuration
  420. schema:
  421. type: dict
  422. show_if: [["acl_enable", "=", true]]
  423. attrs: []
  424. - variable: host_path_config
  425. label: Host Path Configuration
  426. schema:
  427. type: dict
  428. show_if: [["type", "=", "host_path"]]
  429. attrs:
  430. - variable: acl_enable
  431. label: Enable ACL
  432. description: Enable ACL for the storage.
  433. schema:
  434. type: boolean
  435. default: false
  436. - variable: acl
  437. label: ACL Configuration
  438. schema:
  439. type: dict
  440. show_if: [["acl_enable", "=", true]]
  441. attrs: []
  442. $ref:
  443. - "normalize/acl"
  444. - variable: path
  445. label: Host Path
  446. description: The host path to use for storage.
  447. schema:
  448. type: hostpath
  449. show_if: [["acl_enable", "=", false]]
  450. required: true
  451. - variable: thumbs
  452. label: Immich Thumbs Storage
  453. description: The path to store Immich Thumbs.
  454. schema:
  455. type: dict
  456. show_if: [["use_old_storage_config", "=", true]]
  457. attrs:
  458. - variable: type
  459. label: Type
  460. description: |
  461. ixVolume: Is dataset created automatically by the system.</br>
  462. Host Path: Is a path that already exists on the system.
  463. schema:
  464. type: string
  465. required: true
  466. default: "ix_volume"
  467. enum:
  468. - value: "host_path"
  469. description: Host Path (Path that already exists on the system)
  470. - value: "ix_volume"
  471. description: ixVolume (Dataset created automatically by the system)
  472. - variable: ix_volume_config
  473. label: ixVolume Configuration
  474. description: The configuration for the ixVolume dataset.
  475. schema:
  476. type: dict
  477. show_if: [["type", "=", "ix_volume"]]
  478. $ref:
  479. - "normalize/ix_volume"
  480. attrs:
  481. - variable: acl_enable
  482. label: Enable ACL
  483. description: Enable ACL for the storage.
  484. schema:
  485. type: boolean
  486. default: false
  487. - variable: dataset_name
  488. label: Dataset Name
  489. description: The name of the dataset to use for storage.
  490. schema:
  491. type: string
  492. required: true
  493. hidden: true
  494. default: "thumbs"
  495. - variable: acl_entries
  496. label: ACL Configuration
  497. schema:
  498. type: dict
  499. show_if: [["acl_enable", "=", true]]
  500. attrs: []
  501. - variable: host_path_config
  502. label: Host Path Configuration
  503. schema:
  504. type: dict
  505. show_if: [["type", "=", "host_path"]]
  506. attrs:
  507. - variable: acl_enable
  508. label: Enable ACL
  509. description: Enable ACL for the storage.
  510. schema:
  511. type: boolean
  512. default: false
  513. - variable: acl
  514. label: ACL Configuration
  515. schema:
  516. type: dict
  517. show_if: [["acl_enable", "=", true]]
  518. attrs: []
  519. $ref:
  520. - "normalize/acl"
  521. - variable: path
  522. label: Host Path
  523. description: The host path to use for storage.
  524. schema:
  525. type: hostpath
  526. show_if: [["acl_enable", "=", false]]
  527. required: true
  528. - variable: profile
  529. label: Immich Profile Storage
  530. description: The path to store Immich Profile.
  531. schema:
  532. type: dict
  533. show_if: [["use_old_storage_config", "=", true]]
  534. attrs:
  535. - variable: type
  536. label: Type
  537. description: |
  538. ixVolume: Is dataset created automatically by the system.</br>
  539. Host Path: Is a path that already exists on the system.
  540. schema:
  541. type: string
  542. required: true
  543. default: "ix_volume"
  544. enum:
  545. - value: "host_path"
  546. description: Host Path (Path that already exists on the system)
  547. - value: "ix_volume"
  548. description: ixVolume (Dataset created automatically by the system)
  549. - variable: ix_volume_config
  550. label: ixVolume Configuration
  551. description: The configuration for the ixVolume dataset.
  552. schema:
  553. type: dict
  554. show_if: [["type", "=", "ix_volume"]]
  555. $ref:
  556. - "normalize/ix_volume"
  557. attrs:
  558. - variable: acl_enable
  559. label: Enable ACL
  560. description: Enable ACL for the storage.
  561. schema:
  562. type: boolean
  563. default: false
  564. - variable: dataset_name
  565. label: Dataset Name
  566. description: The name of the dataset to use for storage.
  567. schema:
  568. type: string
  569. required: true
  570. hidden: true
  571. default: "profile"
  572. - variable: acl_entries
  573. label: ACL Configuration
  574. schema:
  575. type: dict
  576. show_if: [["acl_enable", "=", true]]
  577. attrs: []
  578. - variable: host_path_config
  579. label: Host Path Configuration
  580. schema:
  581. type: dict
  582. show_if: [["type", "=", "host_path"]]
  583. attrs:
  584. - variable: acl_enable
  585. label: Enable ACL
  586. description: Enable ACL for the storage.
  587. schema:
  588. type: boolean
  589. default: false
  590. - variable: acl
  591. label: ACL Configuration
  592. schema:
  593. type: dict
  594. show_if: [["acl_enable", "=", true]]
  595. attrs: []
  596. $ref:
  597. - "normalize/acl"
  598. - variable: path
  599. label: Host Path
  600. description: The host path to use for storage.
  601. schema:
  602. type: hostpath
  603. show_if: [["acl_enable", "=", false]]
  604. required: true
  605. - variable: video
  606. label: Immich Video Storage
  607. description: The path to store Immich Video.
  608. schema:
  609. type: dict
  610. show_if: [["use_old_storage_config", "=", true]]
  611. attrs:
  612. - variable: type
  613. label: Type
  614. description: |
  615. ixVolume: Is dataset created automatically by the system.</br>
  616. Host Path: Is a path that already exists on the system.
  617. schema:
  618. type: string
  619. required: true
  620. default: "ix_volume"
  621. enum:
  622. - value: "host_path"
  623. description: Host Path (Path that already exists on the system)
  624. - value: "ix_volume"
  625. description: ixVolume (Dataset created automatically by the system)
  626. - variable: ix_volume_config
  627. label: ixVolume Configuration
  628. description: The configuration for the ixVolume dataset.
  629. schema:
  630. type: dict
  631. show_if: [["type", "=", "ix_volume"]]
  632. $ref:
  633. - "normalize/ix_volume"
  634. attrs:
  635. - variable: acl_enable
  636. label: Enable ACL
  637. description: Enable ACL for the storage.
  638. schema:
  639. type: boolean
  640. default: false
  641. - variable: dataset_name
  642. label: Dataset Name
  643. description: The name of the dataset to use for storage.
  644. schema:
  645. type: string
  646. required: true
  647. hidden: true
  648. default: "video"
  649. - variable: acl_entries
  650. label: ACL Configuration
  651. schema:
  652. type: dict
  653. show_if: [["acl_enable", "=", true]]
  654. attrs: []
  655. - variable: host_path_config
  656. label: Host Path Configuration
  657. schema:
  658. type: dict
  659. show_if: [["type", "=", "host_path"]]
  660. attrs:
  661. - variable: acl_enable
  662. label: Enable ACL
  663. description: Enable ACL for the storage.
  664. schema:
  665. type: boolean
  666. default: false
  667. - variable: acl
  668. label: ACL Configuration
  669. schema:
  670. type: dict
  671. show_if: [["acl_enable", "=", true]]
  672. attrs: []
  673. $ref:
  674. - "normalize/acl"
  675. - variable: path
  676. label: Host Path
  677. description: The host path to use for storage.
  678. schema:
  679. type: hostpath
  680. show_if: [["acl_enable", "=", false]]
  681. required: true
  682. - variable: backups
  683. label: Immich Backups Storage
  684. description: The path to store Immich Backups.
  685. schema:
  686. type: dict
  687. show_if: [["use_old_storage_config", "=", true]]
  688. attrs:
  689. - variable: type
  690. label: Type
  691. description: |
  692. ixVolume: Is dataset created automatically by the system.</br>
  693. Host Path: Is a path that already exists on the system.
  694. schema:
  695. type: string
  696. required: true
  697. default: "ix_volume"
  698. enum:
  699. - value: "host_path"
  700. description: Host Path (Path that already exists on the system)
  701. - value: "ix_volume"
  702. description: ixVolume (Dataset created automatically by the system)
  703. - variable: ix_volume_config
  704. label: ixVolume Configuration
  705. description: The configuration for the ixVolume dataset.
  706. schema:
  707. type: dict
  708. show_if: [["type", "=", "ix_volume"]]
  709. $ref:
  710. - "normalize/ix_volume"
  711. attrs:
  712. - variable: acl_enable
  713. label: Enable ACL
  714. description: Enable ACL for the storage.
  715. schema:
  716. type: boolean
  717. default: false
  718. - variable: dataset_name
  719. label: Dataset Name
  720. description: The name of the dataset to use for storage.
  721. schema:
  722. type: string
  723. required: true
  724. hidden: true
  725. default: "backups"
  726. - variable: acl_entries
  727. label: ACL Configuration
  728. schema:
  729. type: dict
  730. show_if: [["acl_enable", "=", true]]
  731. attrs: []
  732. - variable: host_path_config
  733. label: Host Path Configuration
  734. schema:
  735. type: dict
  736. show_if: [["type", "=", "host_path"]]
  737. attrs:
  738. - variable: acl_enable
  739. label: Enable ACL
  740. description: Enable ACL for the storage.
  741. schema:
  742. type: boolean
  743. default: false
  744. - variable: acl
  745. label: ACL Configuration
  746. schema:
  747. type: dict
  748. show_if: [["acl_enable", "=", true]]
  749. attrs: []
  750. $ref:
  751. - "normalize/acl"
  752. - variable: path
  753. label: Host Path
  754. description: The host path to use for storage.
  755. schema:
  756. type: hostpath
  757. show_if: [["acl_enable", "=", false]]
  758. required: true
  759. - variable: ml_cache
  760. label: Machine Learning Cache
  761. description: The path to store Machine Learning Cache.
  762. schema:
  763. type: dict
  764. attrs:
  765. - variable: type
  766. label: Type
  767. description: |
  768. ixVolume: Is dataset created automatically by the system.</br>
  769. Host Path: Is a path that already exists on the system.
  770. Temporary: Is a temporary directory that will be created on the disk as a docker volume.
  771. schema:
  772. type: string
  773. required: true
  774. default: "temporary"
  775. enum:
  776. - value: "host_path"
  777. description: Host Path (Path that already exists on the system)
  778. - value: "ix_volume"
  779. description: ixVolume (Dataset created automatically by the system)
  780. - value: "temporary"
  781. description: Temporary (Temporary directory created on the disk)
  782. - variable: ix_volume_config
  783. label: ixVolume Configuration
  784. description: The configuration for the ixVolume dataset.
  785. schema:
  786. type: dict
  787. show_if: [["type", "=", "ix_volume"]]
  788. $ref:
  789. - "normalize/ix_volume"
  790. attrs:
  791. - variable: acl_enable
  792. label: Enable ACL
  793. description: Enable ACL for the storage.
  794. schema:
  795. type: boolean
  796. default: false
  797. - variable: dataset_name
  798. label: Dataset Name
  799. description: The name of the dataset to use for storage.
  800. schema:
  801. type: string
  802. required: true
  803. hidden: true
  804. default: "transcodes"
  805. - variable: acl_entries
  806. label: ACL Configuration
  807. schema:
  808. type: dict
  809. show_if: [["acl_enable", "=", true]]
  810. attrs: []
  811. - variable: host_path_config
  812. label: Host Path Configuration
  813. schema:
  814. type: dict
  815. show_if: [["type", "=", "host_path"]]
  816. attrs:
  817. - variable: acl_enable
  818. label: Enable ACL
  819. description: Enable ACL for the storage.
  820. schema:
  821. type: boolean
  822. default: false
  823. - variable: acl
  824. label: ACL Configuration
  825. schema:
  826. type: dict
  827. show_if: [["acl_enable", "=", true]]
  828. attrs: []
  829. $ref:
  830. - "normalize/acl"
  831. - variable: path
  832. label: Host Path
  833. description: The host path to use for storage.
  834. schema:
  835. type: hostpath
  836. show_if: [["acl_enable", "=", false]]
  837. required: true
  838. - variable: postgres_data
  839. label: Postgres Data Storage
  840. description: The path to store Postgres Data.
  841. schema:
  842. type: dict
  843. attrs:
  844. - variable: type
  845. label: Type
  846. description: |
  847. ixVolume: Is dataset created automatically by the system.</br>
  848. Host Path: Is a path that already exists on the system.
  849. schema:
  850. type: string
  851. required: true
  852. default: "ix_volume"
  853. enum:
  854. - value: "host_path"
  855. description: Host Path (Path that already exists on the system)
  856. - value: "ix_volume"
  857. description: ixVolume (Dataset created automatically by the system)
  858. - variable: ix_volume_config
  859. label: ixVolume Configuration
  860. description: The configuration for the ixVolume dataset.
  861. schema:
  862. type: dict
  863. show_if: [["type", "=", "ix_volume"]]
  864. $ref:
  865. - "normalize/ix_volume"
  866. attrs:
  867. - variable: acl_enable
  868. label: Enable ACL
  869. description: Enable ACL for the storage.
  870. schema:
  871. type: boolean
  872. default: false
  873. - variable: dataset_name
  874. label: Dataset Name
  875. description: The name of the dataset to use for storage.
  876. schema:
  877. type: string
  878. required: true
  879. hidden: true
  880. default: "postgres_data"
  881. - variable: acl_entries
  882. label: ACL Configuration
  883. schema:
  884. type: dict
  885. show_if: [["acl_enable", "=", true]]
  886. attrs: []
  887. - variable: host_path_config
  888. label: Host Path Configuration
  889. schema:
  890. type: dict
  891. show_if: [["type", "=", "host_path"]]
  892. attrs:
  893. - variable: acl_enable
  894. label: Enable ACL
  895. description: Enable ACL for the storage.
  896. schema:
  897. type: boolean
  898. default: false
  899. - variable: acl
  900. label: ACL Configuration
  901. schema:
  902. type: dict
  903. show_if: [["acl_enable", "=", true]]
  904. attrs: []
  905. $ref:
  906. - "normalize/acl"
  907. - variable: path
  908. label: Host Path
  909. description: The host path to use for storage.
  910. schema:
  911. type: hostpath
  912. show_if: [["acl_enable", "=", false]]
  913. required: true
  914. - variable: auto_permissions
  915. label: Automatic Permissions
  916. description: |
  917. Automatically set permissions for the host path.
  918. Enabling this, will check the top level directory,</br>
  919. If it finds incorrect permissions, it will `chown` the
  920. host path to the user and group required for the
  921. postgres container.
  922. schema:
  923. type: boolean
  924. default: false
  925. show_if: [["acl_enable", "=", false]]
  926. - variable: additional_storage
  927. label: Additional Storage
  928. schema:
  929. type: list
  930. default: []
  931. items:
  932. - variable: storageEntry
  933. label: Storage Entry
  934. schema:
  935. type: dict
  936. attrs:
  937. - variable: type
  938. label: Type
  939. description: |
  940. ixVolume: Is dataset created automatically by the system.</br>
  941. Host Path: Is a path that already exists on the system.</br>
  942. SMB Share: Is a SMB share that is mounted to as a volume.
  943. schema:
  944. type: string
  945. required: true
  946. default: "ix_volume"
  947. enum:
  948. - value: "host_path"
  949. description: Host Path (Path that already exists on the system)
  950. - value: "ix_volume"
  951. description: ixVolume (Dataset created automatically by the system)
  952. - value: "cifs"
  953. description: SMB/CIFS Share (Mounts a volume to a SMB share)
  954. - variable: read_only
  955. label: Read Only
  956. description: Mount the volume as read only.
  957. schema:
  958. type: boolean
  959. default: false
  960. - variable: mount_path
  961. label: Mount Path
  962. description: The path inside the container to mount the storage.
  963. schema:
  964. type: path
  965. required: true
  966. - variable: host_path_config
  967. label: Host Path Configuration
  968. schema:
  969. type: dict
  970. show_if: [["type", "=", "host_path"]]
  971. attrs:
  972. - variable: acl_enable
  973. label: Enable ACL
  974. description: Enable ACL for the storage.
  975. schema:
  976. type: boolean
  977. default: false
  978. - variable: acl
  979. label: ACL Configuration
  980. schema:
  981. type: dict
  982. show_if: [["acl_enable", "=", true]]
  983. attrs: []
  984. $ref:
  985. - "normalize/acl"
  986. - variable: path
  987. label: Host Path
  988. description: The host path to use for storage.
  989. schema:
  990. type: hostpath
  991. show_if: [["acl_enable", "=", false]]
  992. required: true
  993. - variable: ix_volume_config
  994. label: ixVolume Configuration
  995. description: The configuration for the ixVolume dataset.
  996. schema:
  997. type: dict
  998. show_if: [["type", "=", "ix_volume"]]
  999. $ref:
  1000. - "normalize/ix_volume"
  1001. attrs:
  1002. - variable: acl_enable
  1003. label: Enable ACL
  1004. description: Enable ACL for the storage.
  1005. schema:
  1006. type: boolean
  1007. default: false
  1008. - variable: dataset_name
  1009. label: Dataset Name
  1010. description: The name of the dataset to use for storage.
  1011. schema:
  1012. type: string
  1013. required: true
  1014. default: "storage_entry"
  1015. - variable: acl_entries
  1016. label: ACL Configuration
  1017. schema:
  1018. type: dict
  1019. show_if: [["acl_enable", "=", true]]
  1020. attrs: []
  1021. $ref:
  1022. - "normalize/acl"
  1023. - variable: cifs_config
  1024. label: SMB Configuration
  1025. description: The configuration for the SMB dataset.
  1026. schema:
  1027. type: dict
  1028. show_if: [["type", "=", "cifs"]]
  1029. attrs:
  1030. - variable: server
  1031. label: Server
  1032. description: The server to mount the SMB share.
  1033. schema:
  1034. type: string
  1035. required: true
  1036. - variable: path
  1037. label: Path
  1038. description: The path to mount the SMB share.
  1039. schema:
  1040. type: string
  1041. required: true
  1042. - variable: username
  1043. label: Username
  1044. description: The username to use for the SMB share.
  1045. schema:
  1046. type: string
  1047. required: true
  1048. - variable: password
  1049. label: Password
  1050. description: The password to use for the SMB share.
  1051. schema:
  1052. type: string
  1053. required: true
  1054. private: true
  1055. - variable: domain
  1056. label: Domain
  1057. description: The domain to use for the SMB share.
  1058. schema:
  1059. type: string
  1060. - variable: labels
  1061. label: ""
  1062. group: Labels Configuration
  1063. schema:
  1064. type: list
  1065. default: []
  1066. items:
  1067. - variable: label
  1068. label: Label
  1069. schema:
  1070. type: dict
  1071. attrs:
  1072. - variable: key
  1073. label: Key
  1074. schema:
  1075. type: string
  1076. required: true
  1077. - variable: value
  1078. label: Value
  1079. schema:
  1080. type: string
  1081. required: true
  1082. - variable: containers
  1083. label: Containers
  1084. description: Containers where the label should be applied
  1085. schema:
  1086. type: list
  1087. items:
  1088. - variable: container
  1089. label: Container
  1090. schema:
  1091. type: string
  1092. required: true
  1093. enum:
  1094. - value: server
  1095. description: server
  1096. - value: machine-learning
  1097. description: machine-learning
  1098. - value: pgvecto
  1099. description: pgvecto
  1100. - value: redis
  1101. description: redis
  1102. - variable: resources
  1103. label: ""
  1104. group: Resources Configuration
  1105. schema:
  1106. type: dict
  1107. attrs:
  1108. - variable: limits
  1109. label: Limits
  1110. schema:
  1111. type: dict
  1112. attrs:
  1113. - variable: cpus
  1114. label: CPUs
  1115. description: CPUs limit for Immich.
  1116. schema:
  1117. type: int
  1118. default: 2
  1119. required: true
  1120. - variable: memory
  1121. label: Memory (in MB)
  1122. description: Memory limit for Immich.
  1123. schema:
  1124. type: int
  1125. default: 4096
  1126. required: true
  1127. - variable: gpus
  1128. group: Resources Configuration
  1129. label: GPU Configuration
  1130. schema:
  1131. type: dict
  1132. $ref:
  1133. - "definitions/gpu_configuration"
  1134. attrs: []