From d7eddf5c2fc3cf449adbd6acb3aaaf5949314044 Mon Sep 17 00:00:00 2001 From: sefidel Date: Sun, 13 Aug 2023 16:44:02 +0900 Subject: chore: use nixpkgs' mautrix-whatsapp module --- modules/services/matrix-bridge.nix | 1 - overlays/mautrix-whatsapp-module.nix | 192 ----------------------------------- 2 files changed, 193 deletions(-) delete mode 100644 overlays/mautrix-whatsapp-module.nix diff --git a/modules/services/matrix-bridge.nix b/modules/services/matrix-bridge.nix index 65d8187..061a812 100644 --- a/modules/services/matrix-bridge.nix +++ b/modules/services/matrix-bridge.nix @@ -7,7 +7,6 @@ in { imports = [ ../../overlays/mautrix-signal-module.nix - ../../overlays/mautrix-whatsapp-module.nix ]; options.modules.services.matrix-bridge = { diff --git a/overlays/mautrix-whatsapp-module.nix b/overlays/mautrix-whatsapp-module.nix deleted file mode 100644 index 4cebcb6..0000000 --- a/overlays/mautrix-whatsapp-module.nix +++ /dev/null @@ -1,192 +0,0 @@ -{ config, pkgs, lib, ... }: - -with lib; - -let - dataDir = "/var/lib/mautrix-whatsapp"; - registrationFile = "${dataDir}/whatsapp-registration.yaml"; - cfg = config.services.mautrix-whatsapp; - settingsFormat = pkgs.formats.json { }; - settingsFile = - settingsFormat.generate "mautrix-whatsapp-config.json" cfg.settings; -in -{ - options = { - services.mautrix-whatsapp = { - enable = mkEnableOption (lib.mdDoc "Mautrix-Whatsapp, a Matrix-Whatsapp puppeting bridge."); - - settings = mkOption rec { - apply = recursiveUpdate default; - inherit (settingsFormat) type; - default = { - homeserver = { - software = "standard"; - }; - - appservice = rec { - database = { - type = "sqlite"; - uri = "sqlite:///${dataDir}/mautrix-whatsapp.db"; - }; - hostname = "0.0.0.0"; - port = 8080; - address = "http://localhost:${toString port}"; - as_token = "$MAUTRIX_WHATSAPP_APPSERVICE_AS_TOKEN"; - hs_token = "$MAUTRIX_WHATSAPP_APPSERVICE_HS_TOKEN"; - }; - - bridge = { - permissions."*" = "relay"; - relay.whitelist = [ ]; - double_puppet_server_map = { }; - login_shared_secret_map = { }; - }; - - logging = { - version = 1; - - formatters.precise.format = "[%(levelname)s@%(name)s] %(message)s"; - - handlers.console = { - class = "logging.StreamHandler"; - formatter = "precise"; - }; - - # log to console/systemd instead of file - file_name_format = null; - - loggers = { - mau.level = "INFO"; - telethon.level = "INFO"; - - # prevent tokens from leaking in the logs: - # https://github.com/tulir/mautrix-telegram/issues/351 - aiohttp.level = "WARNING"; - }; - }; - }; - example = literalExpression '' - { - homeserver = { - address = "http://localhost:8008"; - domain = "public-domain.tld"; - }; - - appservice.public = { - prefix = "/public"; - external = "https://public-appservice-address/public"; - }; - - bridge.permissions = { - "example.com" = "full"; - "@admin:example.com" = "admin"; - }; - } - ''; - description = lib.mdDoc '' - {file}`config.yaml` configuration as a Nix attribute set. - Configuration options should match those described in - [example-config.yaml](https://github.com/mautrix/whatsapp/blob/master/mautrix_whatsapp/example-config.yaml). - - Secret tokens should be specified using {option}`environmentFile` - instead of this world-readable attribute set. - ''; - }; - - environmentFile = mkOption { - type = types.nullOr types.path; - default = null; - description = lib.mdDoc '' - File containing environment variables to be passed to the mautrix-whatsapp service, - in which secret tokens can be specified securely by defining values for e.g. - `MAUTRIX_WHATSAPP_APPSERVICE_AS_TOKEN`, - `MAUTRIX_WHATSAPP_APPSERVICE_HS_TOKEN`, - - For Mautrix-Whatsapp, only AS_TOKEN and HS_TOKEN is available. - ''; - }; - - serviceDependencies = mkOption { - type = with types; listOf str; - default = optional config.services.matrix-synapse.enable "matrix-synapse.service"; - defaultText = literalExpression '' - optional config.services.matrix-synapse.enable "matrix-synapse.service" - ''; - description = lib.mdDoc '' - List of Systemd services to require and wait for when starting the application service. - ''; - }; - }; - }; - - config = mkIf cfg.enable { - systemd.services.mautrix-whatsapp = { - description = "Mautrix-Whatsapp, a Matrix-Whatsapp puppeting bridge."; - - wantedBy = [ "multi-user.target" ]; - wants = [ "network-online.target" ] ++ cfg.serviceDependencies; - after = [ "network-online.target" ] ++ cfg.serviceDependencies; - path = [ pkgs.lottieconverter pkgs.ffmpeg-full ]; - - # mautrix-whatsapp tries to generate a dotfile in the home directory of - # the running user if using a postgresql database: - # - # File "python3.10/site-packages/asyncpg/connect_utils.py", line 257, in _dot_postgre> - # return (pathlib.Path.home() / '.postgresql' / filename).resolve() - # File "python3.10/pathlib.py", line 1000, in home - # return cls("~").expanduser() - # File "python3.10/pathlib.py", line 1440, in expanduser - # raise RuntimeError("Could not determine home directory.") - # RuntimeError: Could not determine home directory. - environment.HOME = dataDir; - - preStart = '' - # generate the appservice's registration file if absent - if [ ! -f '${registrationFile}' ]; then - ${pkgs.mautrix-whatsapp}/bin/mautrix-whatsapp \ - --generate-registration \ - --config='${settingsFile}' \ - --registration='${registrationFile}' - fi - - ${pkgs.envsubst}/bin/envsubst \ - -i ${settingsFile} \ - -o /run/mautrix-whatsapp/config.json - - # wait until dendrite grabs the config - sleep 5 - '' + lib.optionalString (pkgs.mautrix-whatsapp ? alembic) '' - # run automatic database init and migration scripts - ${pkgs.mautrix-whatsapp.alembic}/bin/alembic -x config='${settingsFile}' upgrade head - ''; - - serviceConfig = { - Type = "simple"; - Restart = "always"; - - ProtectSystem = "strict"; - ProtectHome = true; - ProtectKernelTunables = true; - ProtectKernelModules = true; - ProtectControlGroups = true; - - DynamicUser = true; - Group = "mautrix-whatsapp"; - PrivateTmp = true; - WorkingDirectory = pkgs.mautrix-whatsapp; # necessary for the database migration scripts to be found - StateDirectory = baseNameOf dataDir; - RuntimeDirectory = "mautrix-whatsapp"; - RuntimeDirectoryMode = "0700"; - UMask = "0027"; - EnvironmentFile = cfg.environmentFile; - - ExecStart = '' - ${pkgs.mautrix-whatsapp}/bin/mautrix-whatsapp \ - --config='/run/mautrix-whatsapp/config.json' - ''; - }; - }; - }; - - # meta.maintainers = with maintainers; [ boppyt ]; -} -- cgit 1.4.1