metadata.yaml

# Copyright 2024 Canonical Ltd.
# See LICENSE file for licensing details.

name: synapse
display-name: Synapse
summary: Matrix synapse chat server.
description: |
  A charm for the matrix synapse chat server.
  Synapse is a drop in replacement for other chat servers like Mattermost and Slack.
  This charm is useful if you want to spin up your own chat instance.
docs: https://discourse.charmhub.io/t/synapse-documentation-overview/11358
issues: https://github.com/canonical/synapse-operator/issues
maintainers:
  - https://launchpad.net/~canonical-is-devops
source: https://github.com/canonical/synapse-operator
assumes:
  - k8s-api

containers:
  synapse:
    resource: synapse-image
    mounts:
      - storage: data
        location: /data
  synapse-nginx:
    resource: synapse-nginx-image

resources:
  synapse-image:
    type: oci-image
    description: OCI image for Synapse
  synapse-nginx-image:
    type: oci-image
    description: OCI image for Synapse NGINX

storage:
  data:
    type: filesystem
    location: /data

provides:
  grafana-dashboard:
    interface: grafana_dashboard
  metrics-endpoint:
    interface: prometheus_scrape

requires:
    backup:
        interface: s3
        limit: 1
        optional: true
    database:
        interface: postgresql_client
        limit: 1
        optional: true
    ingress:
        interface: ingress
        limit: 2
        optional: true
    logging:
        interface: loki_push_api
        limit: 1
        optional: true
    media:
        interface: s3
        limit: 1
        optional: true
    nginx-route:
        interface: nginx-route
        limit: 1
        optional: true
    redis:
        interface: redis
        limit: 1
        optional: true
    saml:
        interface: saml
        limit: 1
        optional: true
    smtp:
        interface: smtp
        limit: 1
        optional: true

peers:
  synapse-peers:
    interface: synapse-instance