123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140 |
- groups:
- - name: Immich Configuration
- description: Configure Immich
- - name: User and Group Configuration
- description: Configure User and Group for Immich
- - name: Network Configuration
- description: Configure Network for Immich
- - name: Storage Configuration
- description: Configure Storage for Immich
- - name: Labels Configuration
- description: Configure Labels for Immich
- - name: Resources Configuration
- description: Configure Resources for Immich
- questions:
- - variable: TZ
- group: Immich Configuration
- label: Timezone
- schema:
- type: string
- default: Etc/UTC
- required: true
- $ref:
- - definitions/timezone
- - variable: immich
- label: ""
- group: Immich Configuration
- schema:
- type: dict
- attrs:
- - variable: enable_ml
- label: Enable Machine Learning
- description: |
- Enable Machine Learning
- schema:
- type: boolean
- default: true
- - variable: ml_image_selector
- label: Machine Learning Image Type
- description: |
- The type of image to use for Machine Learning.
- schema:
- type: string
- default: ml_image
- enum:
- - value: ml_image
- description: Default Machine Learning Image
- - value: ml_cuda_image
- description: Cuda Machine Learning Image
- - value: ml_rocm_image
- description: Rocm Machine Learning Image
- - value: ml_openvino_image
- description: Openvino Machine Learning Image
- - variable: db_password
- label: Database Password
- description: |
- The password to use for the database.
- schema:
- type: string
- default: ""
- required: true
- private: true
- - variable: redis_password
- label: Redis Password
- description: |
- The password to use for the redis.
- schema:
- type: string
- default: ""
- required: true
- private: true
- - variable: log_level
- label: Log Level
- description: |
- The log level to use for Machine Learning.
- schema:
- type: string
- default: log
- enum:
- - value: verbose
- description: Verbose
- - value: debug
- description: Debug
- - value: log
- description: Log
- - value: warn
- description: Warn
- - value: error
- description: Error
- - variable: hugging_face_endpoint
- label: Hugging Face Endpoint (Optional)
- description: |
- The Hugging Face endpoint to use for Machine Learning.
- schema:
- type: string
- default: ""
- - variable: db_storage_type
- label: Database Storage Type
- description: |
- Recommended type is SSD.</br>
- If you encounter a issue with the database while using HDD</br>
- please remember to mention that when opening an issue.
- schema:
- type: string
- default: SSD
- enum:
- - value: SSD
- description: SSD
- - value: HDD
- description: HDD
- - variable: additional_envs
- label: Additional Environment Variables
- schema:
- type: list
- default: []
- items:
- - variable: env
- label: Environment Variable
- schema:
- type: dict
- attrs:
- - variable: name
- label: Name
- schema:
- type: string
- required: true
- - variable: value
- label: Value
- schema:
- type: string
- - variable: run_as
- label: ""
- group: User and Group Configuration
- schema:
- type: dict
- attrs:
- - variable: user
- label: User ID
- description: The user id that Immich files will be owned by.
- schema:
- type: int
- min: 0
- default: 568
- required: true
- - variable: group
- label: Group ID
- description: The group id that Immich files will be owned by.
- schema:
- type: int
- min: 0
- default: 568
- required: true
- - variable: network
- label: ""
- group: Network Configuration
- schema:
- type: dict
- attrs:
- - variable: web_port
- label: WebUI Port
- description: The port for Immich WebUI
- schema:
- type: dict
- attrs:
- - variable: bind_mode
- label: Port Bind Mode
- description: |
- The port bind mode.</br>
- - Publish: The port will be published on the host for external access.</br>
- - Expose: The port will be exposed for inter-container communication.</br>
- - None: The port will not be exposed or published.</br>
- Note: If the Dockerfile defines an EXPOSE directive,
- the port will still be exposed for inter-container communication regardless of this setting.
- schema:
- type: string
- default: "published"
- enum:
- - value: "published"
- description: Publish port on the host for external access
- - value: "exposed"
- description: Expose port for inter-container communication
- - value: ""
- description: None
- - variable: port_number
- label: Port Number
- schema:
- type: int
- default: 30041
- min: 1
- max: 65535
- required: true
- - variable: host_ips
- label: Host IPs
- description: IPs on the host to bind this port
- schema:
- type: list
- show_if: [["bind_mode", "=", "published"]]
- default: []
- items:
- - variable: host_ip
- label: Host IP
- schema:
- type: string
- required: true
- $ref:
- - definitions/node_bind_ip
- - variable: storage
- label: ""
- group: Storage Configuration
- schema:
- type: dict
- attrs:
- - variable: use_old_storage_config
- label: Use Old Storage Configuration (Deprecated)
- description: |
- Use the old storage configuration.</br>
- This is deprecated and will be removed in the future.</br>
- Please use the new storage configuration instead.
- schema:
- type: boolean
- default: false
- - variable: data
- label: Data Storage (aka Upload Location)
- schema:
- type: dict
- show_if: [["use_old_storage_config", "=", false]]
- attrs:
- - variable: type
- label: Type
- description: |
- ixVolume: Is dataset created automatically by the system.</br>
- Host Path: Is a path that already exists on the system.
- schema:
- type: string
- required: true
- default: "ix_volume"
- enum:
- - value: "host_path"
- description: Host Path (Path that already exists on the system)
- - value: "ix_volume"
- description: ixVolume (Dataset created automatically by the system)
- - variable: ix_volume_config
- label: ixVolume Configuration
- description: The configuration for the ixVolume dataset.
- schema:
- type: dict
- show_if: [["type", "=", "ix_volume"]]
- $ref:
- - "normalize/ix_volume"
- attrs:
- - variable: acl_enable
- label: Enable ACL
- description: Enable ACL for the storage.
- schema:
- type: boolean
- default: false
- - variable: dataset_name
- label: Dataset Name
- description: The name of the dataset to use for storage.
- schema:
- type: string
- required: true
- hidden: true
- default: "data"
- - variable: acl_entries
- label: ACL Configuration
- schema:
- type: dict
- show_if: [["acl_enable", "=", true]]
- attrs: []
- - variable: host_path_config
- label: Host Path Configuration
- schema:
- type: dict
- show_if: [["type", "=", "host_path"]]
- attrs:
- - variable: acl_enable
- label: Enable ACL
- description: Enable ACL for the storage.
- schema:
- type: boolean
- default: false
- - variable: acl
- label: ACL Configuration
- schema:
- type: dict
- show_if: [["acl_enable", "=", true]]
- attrs: []
- $ref:
- - "normalize/acl"
- - variable: path
- label: Host Path
- description: The host path to use for storage.
- schema:
- type: hostpath
- show_if: [["acl_enable", "=", false]]
- required: true
- - variable: library
- label: Immich Library Storage
- description: The path to store Immich Library.
- schema:
- type: dict
- show_if: [["use_old_storage_config", "=", true]]
- attrs:
- - variable: type
- label: Type
- description: |
- ixVolume: Is dataset created automatically by the system.</br>
- Host Path: Is a path that already exists on the system.
- schema:
- type: string
- required: true
- default: "ix_volume"
- enum:
- - value: "host_path"
- description: Host Path (Path that already exists on the system)
- - value: "ix_volume"
- description: ixVolume (Dataset created automatically by the system)
- - variable: ix_volume_config
- label: ixVolume Configuration
- description: The configuration for the ixVolume dataset.
- schema:
- type: dict
- show_if: [["type", "=", "ix_volume"]]
- $ref:
- - "normalize/ix_volume"
- attrs:
- - variable: acl_enable
- label: Enable ACL
- description: Enable ACL for the storage.
- schema:
- type: boolean
- default: false
- - variable: dataset_name
- label: Dataset Name
- description: The name of the dataset to use for storage.
- schema:
- type: string
- required: true
- hidden: true
- default: "library"
- - variable: acl_entries
- label: ACL Configuration
- schema:
- type: dict
- show_if: [["acl_enable", "=", true]]
- attrs: []
- - variable: host_path_config
- label: Host Path Configuration
- schema:
- type: dict
- show_if: [["type", "=", "host_path"]]
- attrs:
- - variable: acl_enable
- label: Enable ACL
- description: Enable ACL for the storage.
- schema:
- type: boolean
- default: false
- - variable: acl
- label: ACL Configuration
- schema:
- type: dict
- show_if: [["acl_enable", "=", true]]
- attrs: []
- $ref:
- - "normalize/acl"
- - variable: path
- label: Host Path
- description: The host path to use for storage.
- schema:
- type: hostpath
- show_if: [["acl_enable", "=", false]]
- required: true
- - variable: uploads
- label: Immich Uploads Storage
- description: The path to store Immich Uploads.
- schema:
- type: dict
- show_if: [["use_old_storage_config", "=", true]]
- attrs:
- - variable: type
- label: Type
- description: |
- ixVolume: Is dataset created automatically by the system.</br>
- Host Path: Is a path that already exists on the system.
- schema:
- type: string
- required: true
- default: "ix_volume"
- enum:
- - value: "host_path"
- description: Host Path (Path that already exists on the system)
- - value: "ix_volume"
- description: ixVolume (Dataset created automatically by the system)
- - variable: ix_volume_config
- label: ixVolume Configuration
- description: The configuration for the ixVolume dataset.
- schema:
- type: dict
- show_if: [["type", "=", "ix_volume"]]
- $ref:
- - "normalize/ix_volume"
- attrs:
- - variable: acl_enable
- label: Enable ACL
- description: Enable ACL for the storage.
- schema:
- type: boolean
- default: false
- - variable: dataset_name
- label: Dataset Name
- description: The name of the dataset to use for storage.
- schema:
- type: string
- required: true
- hidden: true
- default: "uploads"
- - variable: acl_entries
- label: ACL Configuration
- schema:
- type: dict
- show_if: [["acl_enable", "=", true]]
- attrs: []
- - variable: host_path_config
- label: Host Path Configuration
- schema:
- type: dict
- show_if: [["type", "=", "host_path"]]
- attrs:
- - variable: acl_enable
- label: Enable ACL
- description: Enable ACL for the storage.
- schema:
- type: boolean
- default: false
- - variable: acl
- label: ACL Configuration
- schema:
- type: dict
- show_if: [["acl_enable", "=", true]]
- attrs: []
- $ref:
- - "normalize/acl"
- - variable: path
- label: Host Path
- description: The host path to use for storage.
- schema:
- type: hostpath
- show_if: [["acl_enable", "=", false]]
- required: true
- - variable: thumbs
- label: Immich Thumbs Storage
- description: The path to store Immich Thumbs.
- schema:
- type: dict
- show_if: [["use_old_storage_config", "=", true]]
- attrs:
- - variable: type
- label: Type
- description: |
- ixVolume: Is dataset created automatically by the system.</br>
- Host Path: Is a path that already exists on the system.
- schema:
- type: string
- required: true
- default: "ix_volume"
- enum:
- - value: "host_path"
- description: Host Path (Path that already exists on the system)
- - value: "ix_volume"
- description: ixVolume (Dataset created automatically by the system)
- - variable: ix_volume_config
- label: ixVolume Configuration
- description: The configuration for the ixVolume dataset.
- schema:
- type: dict
- show_if: [["type", "=", "ix_volume"]]
- $ref:
- - "normalize/ix_volume"
- attrs:
- - variable: acl_enable
- label: Enable ACL
- description: Enable ACL for the storage.
- schema:
- type: boolean
- default: false
- - variable: dataset_name
- label: Dataset Name
- description: The name of the dataset to use for storage.
- schema:
- type: string
- required: true
- hidden: true
- default: "thumbs"
- - variable: acl_entries
- label: ACL Configuration
- schema:
- type: dict
- show_if: [["acl_enable", "=", true]]
- attrs: []
- - variable: host_path_config
- label: Host Path Configuration
- schema:
- type: dict
- show_if: [["type", "=", "host_path"]]
- attrs:
- - variable: acl_enable
- label: Enable ACL
- description: Enable ACL for the storage.
- schema:
- type: boolean
- default: false
- - variable: acl
- label: ACL Configuration
- schema:
- type: dict
- show_if: [["acl_enable", "=", true]]
- attrs: []
- $ref:
- - "normalize/acl"
- - variable: path
- label: Host Path
- description: The host path to use for storage.
- schema:
- type: hostpath
- show_if: [["acl_enable", "=", false]]
- required: true
- - variable: profile
- label: Immich Profile Storage
- description: The path to store Immich Profile.
- schema:
- type: dict
- show_if: [["use_old_storage_config", "=", true]]
- attrs:
- - variable: type
- label: Type
- description: |
- ixVolume: Is dataset created automatically by the system.</br>
- Host Path: Is a path that already exists on the system.
- schema:
- type: string
- required: true
- default: "ix_volume"
- enum:
- - value: "host_path"
- description: Host Path (Path that already exists on the system)
- - value: "ix_volume"
- description: ixVolume (Dataset created automatically by the system)
- - variable: ix_volume_config
- label: ixVolume Configuration
- description: The configuration for the ixVolume dataset.
- schema:
- type: dict
- show_if: [["type", "=", "ix_volume"]]
- $ref:
- - "normalize/ix_volume"
- attrs:
- - variable: acl_enable
- label: Enable ACL
- description: Enable ACL for the storage.
- schema:
- type: boolean
- default: false
- - variable: dataset_name
- label: Dataset Name
- description: The name of the dataset to use for storage.
- schema:
- type: string
- required: true
- hidden: true
- default: "profile"
- - variable: acl_entries
- label: ACL Configuration
- schema:
- type: dict
- show_if: [["acl_enable", "=", true]]
- attrs: []
- - variable: host_path_config
- label: Host Path Configuration
- schema:
- type: dict
- show_if: [["type", "=", "host_path"]]
- attrs:
- - variable: acl_enable
- label: Enable ACL
- description: Enable ACL for the storage.
- schema:
- type: boolean
- default: false
- - variable: acl
- label: ACL Configuration
- schema:
- type: dict
- show_if: [["acl_enable", "=", true]]
- attrs: []
- $ref:
- - "normalize/acl"
- - variable: path
- label: Host Path
- description: The host path to use for storage.
- schema:
- type: hostpath
- show_if: [["acl_enable", "=", false]]
- required: true
- - variable: video
- label: Immich Video Storage
- description: The path to store Immich Video.
- schema:
- type: dict
- show_if: [["use_old_storage_config", "=", true]]
- attrs:
- - variable: type
- label: Type
- description: |
- ixVolume: Is dataset created automatically by the system.</br>
- Host Path: Is a path that already exists on the system.
- schema:
- type: string
- required: true
- default: "ix_volume"
- enum:
- - value: "host_path"
- description: Host Path (Path that already exists on the system)
- - value: "ix_volume"
- description: ixVolume (Dataset created automatically by the system)
- - variable: ix_volume_config
- label: ixVolume Configuration
- description: The configuration for the ixVolume dataset.
- schema:
- type: dict
- show_if: [["type", "=", "ix_volume"]]
- $ref:
- - "normalize/ix_volume"
- attrs:
- - variable: acl_enable
- label: Enable ACL
- description: Enable ACL for the storage.
- schema:
- type: boolean
- default: false
- - variable: dataset_name
- label: Dataset Name
- description: The name of the dataset to use for storage.
- schema:
- type: string
- required: true
- hidden: true
- default: "video"
- - variable: acl_entries
- label: ACL Configuration
- schema:
- type: dict
- show_if: [["acl_enable", "=", true]]
- attrs: []
- - variable: host_path_config
- label: Host Path Configuration
- schema:
- type: dict
- show_if: [["type", "=", "host_path"]]
- attrs:
- - variable: acl_enable
- label: Enable ACL
- description: Enable ACL for the storage.
- schema:
- type: boolean
- default: false
- - variable: acl
- label: ACL Configuration
- schema:
- type: dict
- show_if: [["acl_enable", "=", true]]
- attrs: []
- $ref:
- - "normalize/acl"
- - variable: path
- label: Host Path
- description: The host path to use for storage.
- schema:
- type: hostpath
- show_if: [["acl_enable", "=", false]]
- required: true
- - variable: backups
- label: Immich Backups Storage
- description: The path to store Immich Backups.
- schema:
- type: dict
- show_if: [["use_old_storage_config", "=", true]]
- attrs:
- - variable: type
- label: Type
- description: |
- ixVolume: Is dataset created automatically by the system.</br>
- Host Path: Is a path that already exists on the system.
- schema:
- type: string
- required: true
- default: "ix_volume"
- enum:
- - value: "host_path"
- description: Host Path (Path that already exists on the system)
- - value: "ix_volume"
- description: ixVolume (Dataset created automatically by the system)
- - variable: ix_volume_config
- label: ixVolume Configuration
- description: The configuration for the ixVolume dataset.
- schema:
- type: dict
- show_if: [["type", "=", "ix_volume"]]
- $ref:
- - "normalize/ix_volume"
- attrs:
- - variable: acl_enable
- label: Enable ACL
- description: Enable ACL for the storage.
- schema:
- type: boolean
- default: false
- - variable: dataset_name
- label: Dataset Name
- description: The name of the dataset to use for storage.
- schema:
- type: string
- required: true
- hidden: true
- default: "backups"
- - variable: acl_entries
- label: ACL Configuration
- schema:
- type: dict
- show_if: [["acl_enable", "=", true]]
- attrs: []
- - variable: host_path_config
- label: Host Path Configuration
- schema:
- type: dict
- show_if: [["type", "=", "host_path"]]
- attrs:
- - variable: acl_enable
- label: Enable ACL
- description: Enable ACL for the storage.
- schema:
- type: boolean
- default: false
- - variable: acl
- label: ACL Configuration
- schema:
- type: dict
- show_if: [["acl_enable", "=", true]]
- attrs: []
- $ref:
- - "normalize/acl"
- - variable: path
- label: Host Path
- description: The host path to use for storage.
- schema:
- type: hostpath
- show_if: [["acl_enable", "=", false]]
- required: true
- - variable: ml_cache
- label: Machine Learning Cache
- description: The path to store Machine Learning Cache.
- schema:
- type: dict
- attrs:
- - variable: type
- label: Type
- description: |
- ixVolume: Is dataset created automatically by the system.</br>
- Host Path: Is a path that already exists on the system.
- Temporary: Is a temporary directory that will be created on the disk as a docker volume.
- schema:
- type: string
- required: true
- default: "temporary"
- enum:
- - value: "host_path"
- description: Host Path (Path that already exists on the system)
- - value: "ix_volume"
- description: ixVolume (Dataset created automatically by the system)
- - value: "temporary"
- description: Temporary (Temporary directory created on the disk)
- - variable: ix_volume_config
- label: ixVolume Configuration
- description: The configuration for the ixVolume dataset.
- schema:
- type: dict
- show_if: [["type", "=", "ix_volume"]]
- $ref:
- - "normalize/ix_volume"
- attrs:
- - variable: acl_enable
- label: Enable ACL
- description: Enable ACL for the storage.
- schema:
- type: boolean
- default: false
- - variable: dataset_name
- label: Dataset Name
- description: The name of the dataset to use for storage.
- schema:
- type: string
- required: true
- hidden: true
- default: "transcodes"
- - variable: acl_entries
- label: ACL Configuration
- schema:
- type: dict
- show_if: [["acl_enable", "=", true]]
- attrs: []
- - variable: host_path_config
- label: Host Path Configuration
- schema:
- type: dict
- show_if: [["type", "=", "host_path"]]
- attrs:
- - variable: acl_enable
- label: Enable ACL
- description: Enable ACL for the storage.
- schema:
- type: boolean
- default: false
- - variable: acl
- label: ACL Configuration
- schema:
- type: dict
- show_if: [["acl_enable", "=", true]]
- attrs: []
- $ref:
- - "normalize/acl"
- - variable: path
- label: Host Path
- description: The host path to use for storage.
- schema:
- type: hostpath
- show_if: [["acl_enable", "=", false]]
- required: true
- - variable: postgres_data
- label: Postgres Data Storage
- description: The path to store Postgres Data.
- schema:
- type: dict
- attrs:
- - variable: type
- label: Type
- description: |
- ixVolume: Is dataset created automatically by the system.</br>
- Host Path: Is a path that already exists on the system.
- schema:
- type: string
- required: true
- default: "ix_volume"
- enum:
- - value: "host_path"
- description: Host Path (Path that already exists on the system)
- - value: "ix_volume"
- description: ixVolume (Dataset created automatically by the system)
- - variable: ix_volume_config
- label: ixVolume Configuration
- description: The configuration for the ixVolume dataset.
- schema:
- type: dict
- show_if: [["type", "=", "ix_volume"]]
- $ref:
- - "normalize/ix_volume"
- attrs:
- - variable: acl_enable
- label: Enable ACL
- description: Enable ACL for the storage.
- schema:
- type: boolean
- default: false
- - variable: dataset_name
- label: Dataset Name
- description: The name of the dataset to use for storage.
- schema:
- type: string
- required: true
- hidden: true
- default: "postgres_data"
- - variable: acl_entries
- label: ACL Configuration
- schema:
- type: dict
- show_if: [["acl_enable", "=", true]]
- attrs: []
- - variable: host_path_config
- label: Host Path Configuration
- schema:
- type: dict
- show_if: [["type", "=", "host_path"]]
- attrs:
- - variable: acl_enable
- label: Enable ACL
- description: Enable ACL for the storage.
- schema:
- type: boolean
- default: false
- - variable: acl
- label: ACL Configuration
- schema:
- type: dict
- show_if: [["acl_enable", "=", true]]
- attrs: []
- $ref:
- - "normalize/acl"
- - variable: path
- label: Host Path
- description: The host path to use for storage.
- schema:
- type: hostpath
- show_if: [["acl_enable", "=", false]]
- required: true
- - variable: auto_permissions
- label: Automatic Permissions
- description: |
- Automatically set permissions for the host path.
- Enabling this, will check the top level directory,</br>
- If it finds incorrect permissions, it will `chown` the
- host path to the user and group required for the
- postgres container.
- schema:
- type: boolean
- default: false
- show_if: [["acl_enable", "=", false]]
- - variable: additional_storage
- label: Additional Storage
- schema:
- type: list
- default: []
- items:
- - variable: storageEntry
- label: Storage Entry
- schema:
- type: dict
- attrs:
- - variable: type
- label: Type
- description: |
- ixVolume: Is dataset created automatically by the system.</br>
- Host Path: Is a path that already exists on the system.</br>
- SMB Share: Is a SMB share that is mounted to as a volume.
- schema:
- type: string
- required: true
- default: "ix_volume"
- enum:
- - value: "host_path"
- description: Host Path (Path that already exists on the system)
- - value: "ix_volume"
- description: ixVolume (Dataset created automatically by the system)
- - value: "cifs"
- description: SMB/CIFS Share (Mounts a volume to a SMB share)
- - variable: read_only
- label: Read Only
- description: Mount the volume as read only.
- schema:
- type: boolean
- default: false
- - variable: mount_path
- label: Mount Path
- description: The path inside the container to mount the storage.
- schema:
- type: path
- required: true
- - variable: host_path_config
- label: Host Path Configuration
- schema:
- type: dict
- show_if: [["type", "=", "host_path"]]
- attrs:
- - variable: acl_enable
- label: Enable ACL
- description: Enable ACL for the storage.
- schema:
- type: boolean
- default: false
- - variable: acl
- label: ACL Configuration
- schema:
- type: dict
- show_if: [["acl_enable", "=", true]]
- attrs: []
- $ref:
- - "normalize/acl"
- - variable: path
- label: Host Path
- description: The host path to use for storage.
- schema:
- type: hostpath
- show_if: [["acl_enable", "=", false]]
- required: true
- - variable: ix_volume_config
- label: ixVolume Configuration
- description: The configuration for the ixVolume dataset.
- schema:
- type: dict
- show_if: [["type", "=", "ix_volume"]]
- $ref:
- - "normalize/ix_volume"
- attrs:
- - variable: acl_enable
- label: Enable ACL
- description: Enable ACL for the storage.
- schema:
- type: boolean
- default: false
- - variable: dataset_name
- label: Dataset Name
- description: The name of the dataset to use for storage.
- schema:
- type: string
- required: true
- default: "storage_entry"
- - variable: acl_entries
- label: ACL Configuration
- schema:
- type: dict
- show_if: [["acl_enable", "=", true]]
- attrs: []
- $ref:
- - "normalize/acl"
- - variable: cifs_config
- label: SMB Configuration
- description: The configuration for the SMB dataset.
- schema:
- type: dict
- show_if: [["type", "=", "cifs"]]
- attrs:
- - variable: server
- label: Server
- description: The server to mount the SMB share.
- schema:
- type: string
- required: true
- - variable: path
- label: Path
- description: The path to mount the SMB share.
- schema:
- type: string
- required: true
- - variable: username
- label: Username
- description: The username to use for the SMB share.
- schema:
- type: string
- required: true
- - variable: password
- label: Password
- description: The password to use for the SMB share.
- schema:
- type: string
- required: true
- private: true
- - variable: domain
- label: Domain
- description: The domain to use for the SMB share.
- schema:
- type: string
- - variable: labels
- label: ""
- group: Labels Configuration
- schema:
- type: list
- default: []
- items:
- - variable: label
- label: Label
- schema:
- type: dict
- attrs:
- - variable: key
- label: Key
- schema:
- type: string
- required: true
- - variable: value
- label: Value
- schema:
- type: string
- required: true
- - variable: containers
- label: Containers
- description: Containers where the label should be applied
- schema:
- type: list
- items:
- - variable: container
- label: Container
- schema:
- type: string
- required: true
- enum:
- - value: server
- description: server
- - value: machine-learning
- description: machine-learning
- - value: pgvecto
- description: pgvecto
- - value: redis
- description: redis
- - variable: resources
- label: ""
- group: Resources Configuration
- schema:
- type: dict
- attrs:
- - variable: limits
- label: Limits
- schema:
- type: dict
- attrs:
- - variable: cpus
- label: CPUs
- description: CPUs limit for Immich.
- schema:
- type: int
- default: 2
- required: true
- - variable: memory
- label: Memory (in MB)
- description: Memory limit for Immich.
- schema:
- type: int
- default: 4096
- required: true
- - variable: gpus
- group: Resources Configuration
- label: GPU Configuration
- schema:
- type: dict
- $ref:
- - "definitions/gpu_configuration"
- attrs: []
|