nixpkgs/pkgs/servers/matrix-synapse/default.nix

{ lib, stdenv, python3, openssl
, enableSystemd ? stdenv.isLinux, nixosTests
, enableRedis ? false
, callPackage
}:

with python3.pkgs;

let
  plugins = python3.pkgs.callPackage ./plugins { };
  tools = callPackage ./tools { };
in
buildPythonApplication rec {
  pname = "matrix-synapse";
  version = "1.35.0";

  src = fetchPypi {
    inherit pname version;
    sha256 = "sha256-McgLJoOS8h8C7mcbLaF0hiMkfthpDRUKyB5Effzk2ds=";
  };

  patches = [
    # adds an entry point for the service
    ./homeserver-script.patch
  ];

  buildInputs = [ openssl ];

  propagatedBuildInputs = [
    authlib
    bcrypt
    bleach
    canonicaljson
    daemonize
    frozendict
    ijson
    jinja2
    jsonschema
    lxml
    msgpack
    netaddr
    phonenumbers
    pillow
    prometheus_client
    psutil
    psycopg2
    pyasn1
    pyjwt
    pymacaroons
    pynacl
    pyopenssl
    pysaml2
    pyyaml
    requests
    setuptools
    signedjson
    sortedcontainers
    treq
    twisted
    typing-extensions
    unpaddedbase64
  ] ++ lib.optional enableSystemd systemd
    ++ lib.optional enableRedis hiredis;

  checkInputs = [ mock parameterized openssl ];

  doCheck = !stdenv.isDarwin;

  checkPhase = ''
    PYTHONPATH=".:$PYTHONPATH" ${python3.interpreter} -m twisted.trial tests
  '';

  passthru.tests = { inherit (nixosTests) matrix-synapse; };
  passthru.plugins = plugins;
  passthru.tools = tools;
  passthru.python = python3;

  meta = with lib; {
    homepage = "https://matrix.org";
    description = "Matrix reference homeserver";
    license = licenses.asl20;
    maintainers = teams.matrix.members;
  };
}
matrix-synapse: 0.99.5.2 -> 1.0.0 2019-06-11 19:31:13 +01:00			`{ lib, stdenv, python3, openssl`
matrix-synapse: expose nixos-test in derivation As proposed during the last matrix-synapse bump[1]. [1] https://github.com/NixOS/nixpkgs/pull/75860#issuecomment-567007810 2019-12-19 13:30:50 +00:00			`, enableSystemd ? stdenv.isLinux, nixosTests`
matrix-synapse: make dependency for `hiredis` optional This is only needed for replication which isn't even supported by the current NixOS module. 2020-10-28 20:05:22 +00:00			`, enableRedis ? false`
rust-synapse-compress-state: init at 0.1.0 "A tool to compress some state in a Synapse instance's database" 2020-12-08 03:10:09 +00:00			`, callPackage`
matrix-synapse: 0.33.6 -> 0.33.8 Also reworked dependencies: * blist and ujson are marked as no longer needed * pytz has no mention throughout `git log -p` on synapse's repository * systemd and affinity are optional (but turned on by default) 2018-11-01 16:48:40 +00:00			`}:`
matrix-synapse: prepare for python3 switch With this commit, we can swap python2 for python3 to run synapse using python3 instead. The reason for not making the switch is that a number of CLI tools provided with synapse do not yet work under py3 despite synapse running fine. So this doesn't actually do anything on its own except to prepare for the upcoming py3 switch. 2018-10-19 05:34:22 +01:00
matrix-synapse: use python3 2019-01-11 14:59:03 +00:00			`with python3.pkgs;`
matrix-synapse: prepare for python3 switch With this commit, we can swap python2 for python3 to run synapse using python3 instead. The reason for not making the switch is that a number of CLI tools provided with synapse do not yet work under py3 despite synapse running fine. So this doesn't actually do anything on its own except to prepare for the upcoming py3 switch. 2018-10-19 05:34:22 +01:00
matrix-synapse: init at 0.12.0 2016-01-08 14:12:00 +00:00			`let`
matrix-synapse: factor out plugins We build plugins separately from the server now. 2019-10-03 14:59:06 +01:00			`plugins = python3.pkgs.callPackage ./plugins { };`
rust-synapse-compress-state: init at 0.1.0 "A tool to compress some state in a Synapse instance's database" 2020-12-08 03:10:09 +00:00			`tools = callPackage ./tools { };`
matrix-synapse: factor out plugins We build plugins separately from the server now. 2019-10-03 14:59:06 +01:00			`in`
			`buildPythonApplication rec {`
matrix-synapse: prepare for python3 switch With this commit, we can swap python2 for python3 to run synapse using python3 instead. The reason for not making the switch is that a number of CLI tools provided with synapse do not yet work under py3 despite synapse running fine. So this doesn't actually do anything on its own except to prepare for the upcoming py3 switch. 2018-10-19 05:34:22 +01:00			`pname = "matrix-synapse";`
synapse: 1.34.0 -> 1.35.0 2021-05-25 19:08:42 +01:00			`version = "1.35.0";`
matrix-synapse: init at 0.12.0 2016-01-08 14:12:00 +00:00
matrix-synapse: prepare for python3 switch With this commit, we can swap python2 for python3 to run synapse using python3 instead. The reason for not making the switch is that a number of CLI tools provided with synapse do not yet work under py3 despite synapse running fine. So this doesn't actually do anything on its own except to prepare for the upcoming py3 switch. 2018-10-19 05:34:22 +01:00			`src = fetchPypi {`
			`inherit pname version;`
synapse: 1.34.0 -> 1.35.0 2021-05-25 19:08:42 +01:00			`sha256 = "sha256-McgLJoOS8h8C7mcbLaF0hiMkfthpDRUKyB5Effzk2ds=";`
matrix-synapse: init at 0.12.0 2016-01-08 14:12:00 +00:00			`};`

matrix-synapse: restore entry point for service 2019-02-23 19:57:20 +00:00			`patches = [`
			`# adds an entry point for the service`
			`./homeserver-script.patch`
			`];`

matrix-synapse: add openssl to buildInputs It should be included regardless of whether tests are run or not, and overriding the package to disable tests would break this package up until this change. 2021-05-19 14:51:52 +01:00			`buildInputs = [ openssl ];`

matrix-synapse: prepare for python3 switch With this commit, we can swap python2 for python3 to run synapse using python3 instead. The reason for not making the switch is that a number of CLI tools provided with synapse do not yet work under py3 despite synapse running fine. So this doesn't actually do anything on its own except to prepare for the upcoming py3 switch. 2018-10-19 05:34:22 +01:00			`propagatedBuildInputs = [`
synapse: 1.34.0 -> 1.35.0 2021-05-25 19:08:42 +01:00			`authlib`
matrix-synapse: 0.33.6 -> 0.33.8 Also reworked dependencies: * blist and ujson are marked as no longer needed * pytz has no mention throughout `git log -p` on synapse's repository * systemd and affinity are optional (but turned on by default) 2018-11-01 16:48:40 +00:00			`bcrypt`
			`bleach`
			`canonicaljson`
			`daemonize`
			`frozendict`
synapse: 1.34.0 -> 1.35.0 2021-05-25 19:08:42 +01:00			`ijson`
matrix-synapse: 0.33.6 -> 0.33.8 Also reworked dependencies: * blist and ujson are marked as no longer needed * pytz has no mention throughout `git log -p` on synapse's repository * systemd and affinity are optional (but turned on by default) 2018-11-01 16:48:40 +00:00			`jinja2`
			`jsonschema`
			`lxml`
matrix-synapse: 0.34.1.1 -> 0.99.0 Also cleanup of old dependencies and irrelevant patch 2019-02-06 09:44:24 +00:00			`msgpack`
matrix-synapse: 0.33.6 -> 0.33.8 Also reworked dependencies: * blist and ujson are marked as no longer needed * pytz has no mention throughout `git log -p` on synapse's repository * systemd and affinity are optional (but turned on by default) 2018-11-01 16:48:40 +00:00			`netaddr`
			`phonenumbers`
			`pillow`
matrix-synapse: 1.20.1 -> 1.21.0 https://github.com/matrix-org/synapse/releases/tag/v1.21.0 2020-10-12 17:22:11 +01:00			`prometheus_client`
matrix-synapse: 0.33.6 -> 0.33.8 Also reworked dependencies: * blist and ujson are marked as no longer needed * pytz has no mention throughout `git log -p` on synapse's repository * systemd and affinity are optional (but turned on by default) 2018-11-01 16:48:40 +00:00			`psutil`
			`psycopg2`
			`pyasn1`
synapse: 1.34.0 -> 1.35.0 2021-05-25 19:08:42 +01:00			`pyjwt`
matrix-synapse: 0.34.1.1 -> 0.99.0 Also cleanup of old dependencies and irrelevant patch 2019-02-06 09:44:24 +00:00			`pymacaroons`
matrix-synapse: 0.33.6 -> 0.33.8 Also reworked dependencies: * blist and ujson are marked as no longer needed * pytz has no mention throughout `git log -p` on synapse's repository * systemd and affinity are optional (but turned on by default) 2018-11-01 16:48:40 +00:00			`pynacl`
			`pyopenssl`
			`pysaml2`
			`pyyaml`
			`requests`
synapse: 1.34.0 -> 1.35.0 2021-05-25 19:08:42 +01:00			`setuptools`
matrix-synapse: 0.33.6 -> 0.33.8 Also reworked dependencies: * blist and ujson are marked as no longer needed * pytz has no mention throughout `git log -p` on synapse's repository * systemd and affinity are optional (but turned on by default) 2018-11-01 16:48:40 +00:00			`signedjson`
			`sortedcontainers`
			`treq`
			`twisted`
matrix-synapse: 1.4.1 -> 1.5.0 https://github.com/matrix-org/synapse/releases/tag/v1.5.0 2019-10-29 17:23:41 +00:00			`typing-extensions`
synapse: 1.34.0 -> 1.35.0 2021-05-25 19:08:42 +01:00			`unpaddedbase64`
matrix-synapse: make dependency for `hiredis` optional This is only needed for replication which isn't even supported by the current NixOS module. 2020-10-28 20:05:22 +00:00			`] ++ lib.optional enableSystemd systemd`
			`++ lib.optional enableRedis hiredis;`
matrix-synapse: init at 0.12.0 2016-01-08 14:12:00 +00:00
matrix-synapse: 0.99.5.2 -> 1.0.0 2019-06-11 19:31:13 +01:00			`checkInputs = [ mock parameterized openssl ];`
matrix-synapse: init at 0.12.0 2016-01-08 14:12:00 +00:00
matrix-synapse: 1.4.0 -> 1.4.1 https://github.com/matrix-org/synapse/releases/tag/v1.4.1 2019-10-18 21:03:51 +01:00			`doCheck = !stdenv.isDarwin;`

matrix-synapse: 0.34.0.1 -> 0.34.1.1 Also correctly run tests. 2019-01-11 09:33:07 +00:00			`checkPhase = ''`
Python: fix outfall after setting `strictDeps = true;` 2019-02-15 09:08:27 +00:00			`PYTHONPATH=".:$PYTHONPATH" ${python3.interpreter} -m twisted.trial tests`
matrix-synapse: 0.34.0.1 -> 0.34.1.1 Also correctly run tests. 2019-01-11 09:33:07 +00:00			`'';`
matrix-synapse: init at 0.12.0 2016-01-08 14:12:00 +00:00
matrix-synapse: factor out plugins We build plugins separately from the server now. 2019-10-03 14:59:06 +01:00			`passthru.tests = { inherit (nixosTests) matrix-synapse; };`
			`passthru.plugins = plugins;`
rust-synapse-compress-state: init at 0.1.0 "A tool to compress some state in a Synapse instance's database" 2020-12-08 03:10:09 +00:00			`passthru.tools = tools;`
matrix-synapse: factor out plugins We build plugins separately from the server now. 2019-10-03 14:59:06 +01:00			`passthru.python = python3;`

treewide: with stdenv.lib; in meta -> with lib; Part of: https://github.com/NixOS/nixpkgs/issues/108938 meta = with stdenv.lib; is a widely used pattern. We want to slowly remove the `stdenv.lib` indirection and encourage people to use `lib` directly. Thus let’s start with the meta field. This used a rewriting script to mostly automatically replace all occurances of this pattern, and add the `lib` argument to the package header if it doesn’t exist yet. The script in its current form is available at https://cs.tvl.fyi/depot@2f807d7f141068d2d60676a89213eaa5353ca6e0/-/blob/users/Profpatsch/nixpkgs-rewriter/default.nix 2021-01-11 07:54:33 +00:00			`meta = with lib; {`
treewide: Per RFC45, remove all unquoted URLs 2020-04-01 02:11:51 +01:00			`homepage = "https://matrix.org";`
matrix-synapse: init at 0.12.0 2016-01-08 14:12:00 +00:00			`description = "Matrix reference homeserver";`
matrix-synapse: 0.16.0 -> 0.16.1 2016-06-22 19:16:28 +01:00			`license = licenses.asl20;`
maintainers/teams: add matrix team 2020-06-12 02:05:26 +01:00			`maintainers = teams.matrix.members;`
matrix-synapse: init at 0.12.0 2016-01-08 14:12:00 +00:00			`};`
			`}`