Merge pull request #274088 from NickCao/synapse

## Synapse Homeserver {#module-services-matrix-synapse}

[Synapse](https://github.com/matrix-org/synapse) is

[Synapse](https://github.com/element-hq/synapse) is

the reference homeserver implementation of Matrix from the core development

team at matrix.org. The following configuration example will set up a

synapse server for the `example.org` domain, served from

the host `myhostname.example.org`. For more information,

please refer to the

[installation instructions of Synapse](https://matrix-org.github.io/synapse/latest/setup/installation.html) .

[installation instructions of Synapse](https://element-hq.github.io/synapse/latest/setup/installation.html) .

```

{ pkgs, lib, config, ... }:

let

        # the domain (i.e. example.org from @foo:example.org) and the federation port

        # is 8448.

        # Further reference can be found in the docs about delegation under

        # https://matrix-org.github.io/synapse/latest/delegate.html

        # https://element-hq.github.io/synapse/latest/delegate.html

        locations."= /.well-known/matrix/server".extraConfig = mkWellKnown serverConfig;

        # This is usually needed for homeserver discovery (from e.g. other Matrix clients).

        # Further reference can be found in the upstream docs at

::: {.note}

It's also possible to user alternative authentication mechanism such as

[LDAP (via `matrix-synapse-ldap3`)](https://github.com/matrix-org/matrix-synapse-ldap3)

or [OpenID](https://matrix-org.github.io/synapse/latest/openid.html).

or [OpenID](https://element-hq.github.io/synapse/latest/openid.html).

:::

## Element (formerly known as Riot) Web Client {#module-services-matrix-element-web}

        default = { };

        description = mdDoc ''

          The primary synapse configuration. See the

          [sample configuration](https://github.com/matrix-org/synapse/blob/v${pkgs.matrix-synapse-unwrapped.version}/docs/sample_config.yaml)

          [sample configuration](https://github.com/element-hq/synapse/blob/v${pkgs.matrix-synapse-unwrapped.version}/docs/sample_config.yaml)

          for possible values.

          Secrets should be passed in by using the `extraConfigFiles` option.

                    by the module, but in practice it broke on runtime and as a result, no URL

                    preview worked anywhere if this was set.

                    See https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#url_preview_url_blacklist

                    See https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#url_preview_url_blacklist

                    on how to configure it properly.

                  ''))

                  (types.attrsOf types.str));

                Redis configuration for synapse.

                See the

                [upstream documentation](https://github.com/matrix-org/synapse/blob/v${pkgs.matrix-synapse-unwrapped.version}/usage/configuration/config_documentation.md#redis)

                [upstream documentation](https://github.com/element-hq/synapse/blob/v${pkgs.matrix-synapse-unwrapped.version}/docs/usage/configuration/config_documentation.md#redis)

                for available options.

              '';

            };

        description = lib.mdDoc ''

          Options for configuring workers. Worker support will be enabled if at least one worker is configured here.

          See the [worker documention](https://matrix-org.github.io/synapse/latest/workers.html#worker-configuration)

          See the [worker documention](https://element-hq.github.io/synapse/latest/workers.html#worker-configuration)

          for possible options for each worker. Worker-specific options overriding the shared homeserver configuration can be

          specified here for each worker.

            using [`services.matrix-synapse.configureRedisLocally`](#opt-services.matrix-synapse.configureRedisLocally).

            Workers also require a proper reverse proxy setup to direct incoming requests to the appropriate process. See

            the [reverse proxy documentation](https://matrix-org.github.io/synapse/latest/reverse_proxy.html) for a

            the [reverse proxy documentation](https://element-hq.github.io/synapse/latest/reverse_proxy.html) for a

            general reverse proxying setup and

            the [worker documentation](https://matrix-org.github.io/synapse/latest/workers.html#available-worker-applications)

            the [worker documentation](https://element-hq.github.io/synapse/latest/workers.html#available-worker-applications)

            for the available endpoints per worker application.

          :::

        '';

                The file for log configuration.

                See the [python documentation](https://docs.python.org/3/library/logging.config.html#configuration-dictionary-schema)

                for the schema and the [upstream repository](https://github.com/matrix-org/synapse/blob/v${pkgs.matrix-synapse-unwrapped.version}/docs/sample_log_config.yaml)

                for the schema and the [upstream repository](https://github.com/element-hq/synapse/blob/v${pkgs.matrix-synapse-unwrapped.version}/docs/sample_log_config.yaml)

                for an example.

              '';

            };

  format = "pyproject";

  src = fetchFromGitHub {

    owner = "matrix-org";

    owner = "element-hq";

    repo = "synapse";

    rev = "v${version}";

    hash = "sha256-irPExb8rwQjkPp0b3x5hJG4Ay6OnITWIGRPxBSoP/Dk=";

  postPatch = ''

    # Remove setuptools_rust from runtime dependencies

    # https://github.com/matrix-org/synapse/blob/v1.69.0/pyproject.toml#L177-L185

    # https://github.com/element-hq/synapse/blob/v1.69.0/pyproject.toml#L177-L185

    sed -i '/^setuptools_rust =/d' pyproject.toml

    # Remove version pin on build dependencies. Upstream does this on purpose to

    # high parallelisem makes test suite unstable

    # upstream uses 2 cores but 4 seems to be also stable

    # https://github.com/matrix-org/synapse/blob/develop/.github/workflows/latest_deps.yml#L103

    # https://github.com/element-hq/synapse/blob/develop/.github/workflows/latest_deps.yml#L103

    if (( $NIX_BUILD_CORES > 4)); then

      NIX_BUILD_CORES=4

    fi

  meta = with lib; {

    homepage = "https://matrix.org";

    changelog = "https://github.com/matrix-org/synapse/releases/tag/v${version}";

    changelog = "https://github.com/element-hq/synapse/releases/tag/v${version}";

    description = "Matrix reference homeserver";

    license = licenses.asl20;

    license = licenses.agpl3Plus;

    maintainers = teams.matrix.members;

  };

}

    longDescription = ''

      A CLI tool to help admins of Matrix Synapse homeservers

      conveniently issue commands available via its admin API's

      (matrix-org/synapse@master/docs/admin_api)

      (element-hq/synapse@master/docs/admin_api)

    '';

    changelog = "https://github.com/JOJ0/synadm/releases/tag/v${version}";

    homepage = "https://github.com/JOJ0/synadm";