Files
tf_provider_immich/docs/resources/system_config.md
T

2.7 KiB

page_title, subcategory, description
page_title subcategory description
immich_system_config Resource - immich Manages Immich system configuration. This is a singleton resource.

immich_system_config (Resource)

Manages Immich system configuration. This is a singleton resource.

Example Usage

resource "immich_system_config" "example" {
  password_login = {
    enabled = true
  }

  oauth = {
    enabled       = true
    issuer_url    = "https://keycloak.example.com/realms/immich"
    client_id     = "immich-client"
    client_secret = "your-client-secret"
    scope         = "openid profile email"
    button_text   = "Login with Keycloak"
    auto_register = true
  }

  storage_template = {
    template = "{{y}}/{{y}}-{{m}}-{{d}}/{{filename}}"
  }

  machine_learning = {
    enabled    = true
    url        = "http://immich-machine-learning:3003"
    clip_model = "ViT-L-14__openai"
  }
}

Schema

Optional

Nested Schema for machine_learning

Optional:

  • clip_model (String) CLIP model to use.
  • enabled (Boolean) Enable machine learning features.
  • facial_recognition_model (String) Facial recognition model to use.
  • url (String) URL of the machine learning server.

Nested Schema for oauth

Optional:

  • auto_launch (Boolean) Auto launch OAuth login.
  • auto_register (Boolean) Auto register users via OAuth.
  • button_text (String) OAuth button text.
  • client_id (String) OAuth client ID.
  • client_secret (String, Sensitive) OAuth client secret.
  • default_storage_quota (Number) Default storage quota for new users in bytes.
  • enabled (Boolean) Enable OAuth login.
  • issuer_url (String) OAuth issuer URL.
  • mobile_override_url (String) Mobile override URL.
  • mobile_redirect_uri (String) Mobile redirect URI.
  • scope (String) OAuth scope.
  • signing_algorithm (String) Signing algorithm.

Nested Schema for password_login

Optional:

  • enabled (Boolean) Enable password login.

Nested Schema for storage_template

Optional:

  • template (String) Storage template (e.g. {{y}}/{{y}}-{{m}}-{{d}}/{{filename}}).