---

argument_specs:
  main:
    short_description: Authentik container
    description: "Sets up an authentik docker container."
    options:
      authentik_tag:
        description: 'Authentik version to use. Can be minor (2024.8) or patch (2024.8.1) or "latest".'
        type: str
        required: false
        default: latest
      authentik_env:
        description: "dict of custom environment variables for authentik container"
        type: dict
        required: false
        default: {}
      authentik_additional_mounts:
        description: "List of bind mounts or volumes to be mounted inside the container. Each element is a dict with path and exactly one of name, src or template"
        type: list
        required: false
        default: []
        elements: dict
        options:
          path:
            description: "The path inside the container to mount at"
            type: str
            required: true
          readonly:
            description: "If true, volume will be mounted as read only inside the container. Only applies for named and src mounts."
            type: bool
            required: false
            default: false
          mode:
            description: "Permissions for the created/templated directory. Defaults to '0644' for files, '0755' for directories. Doesn't apply for named volumes."
            type: str
            required: false
          name:
            description: "If docker_volume_type is named, the name of the named volume to be mounted at path. If docker_volume_type is bind, the name of the folder to create under /opt/<service>[/suffix]/mounts/ and mount at path."
            type: str
            required: false
          src:
            description: "Host path to bind mount inside the container."
            type: str
            required: false
          template:
            description: "Name of template without .j2 extension. Will be templated at /opt/<service>[/suffix]/mounts/<template> and mounted read only inside the container."
            type: str
            required: false
          copypath:
            description: "Name of file or directory to copy. Will be deployed from files/<copypath> to /opt/<service>[/suffix]/mounts/<copypath> and mounted read only inside the container."
            type: str
            required: false

      # All options after this will be passed directly to the container role
      docker_service_suffix:
        description: "Passed to container role"
        required: false
      docker_host_user:
        description: "Passed to container role"
        required: false

      database_passwords:
        description: "Passed to container role"
        required: false
      docker_additional_services:
        description: "Passed to container role"
        required: false

      docker_volume_type:
        description: "Passed to container role"
        required: false
      reverse_proxy_type:
        description: "Passed to container role"
        required: false
      ports:
        description: "Passed to container role"
        required: false
      docker_vhost_domains:
        description: "Passed to container role"
        required: false
      docker_vhost_additional_locations:
        description: "Passed to container role"
        required: false
      docker_entrypoint:
        description: "Passed to container role"
        required: false
      dockerfile:
        description: "Passed to container role"
        required: false
      docker_networks:
        description: "Passed to container role"
        required: false