---
argument_specs:
  main:
    description:
      - Sets up a matrix synapse podman container.
      - >-
        See https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html for info on configuration options where descriptions are
        not provided in this documentation.
    options:
      synapse_server_name:
        description: Matrix server name. This can not be changed without a full reset and database wipe. This will be visible to users.
        type: str
        required: true
      synapse_external_domain:
        description:
          - The public-facing domain that clients use to access synapse, without https://. e.g. matrix.domain.tld
          - This is used to set the public_baseurl option for synapse (with https:// and trailing / added)
        type: str
        required: true
      synapse_signing_key:
        description: The homeserver signing key
        type: str
        required: true
      synapse_trusted_key_servers:
        type: list
        required: false
        default:
          - matrix.org
        elements: str
      synapse_remote_room_complexity_limit:
        description: Sets limit_remote_rooms.complexity value
        type: float
        required: false
        default: 0
      synapse_room_complexity_error:
        description: Sets limit_remote_rooms.copmlexity_error value. Required if synapse_remote_room_complexity_level is set.
        type: str
        default: ""
      synapse_turn_uris:
        type: list
        required: false
        default: []
        elements: str
      synapse_turn_shared_secret:
        description: Required if synapse_turn_uris is not empty
        type: str
      synapse_email_smtp_server:
        description: email.smtp_host, set this to enable sending emails
        type: str
        required: false
        default: ""
      synapse_email_smtp_user:
        description: Required if synapse_email_smtp_server is set
        type: str
      synapse_email_smtp_password:
        description: Required if synapse_email_smtp_server is set
        type: str
      synapse_email_from:
        description: Required if synapse_email_smtp_server is set
        type: str
      synapse_email_app_name:
        description: Required if synapse_email_smtp_server is set
        type: str
      synapse_max_upload_size:
        type: str
        required: false
        default: 50M
      synapse_allow_public_rooms_over_federation:
        type: bool
        required: false
        default: false
      synapse_auto_accept_invites:
        type: dict
        required: false
        default:
          enabled: false
      synapse_auto_join_rooms:
        type: list
        required: false
        default: []
        elements: str

      synapse_postgres_tag:
        description: Postgres tag to use for synapse postgres container
        type: str
        required: false
        default: 16-alpine