matrixbridge/synapse-auth-module
HF d1b45f822f update monkey patch to matrix 1.84.1 2023-05-30 16:20:35 +02:00
..
README.md Use updated ModulesAPI method to resolve alias to room_id 2022-10-19 00:10:56 +02:00
deploy.sh continue 2022-01-14 01:18:47 +01:00
ppfun_auth.py update monkey patch to matrix 1.84.1 2023-05-30 16:20:35 +02:00

README.md

ppfun-auth-module for matrix-synapse

Allows pixelplanet users to login with their credentials on matrix. Required synapse version is 1.69+

Installation

Put ppfun_auth.py into the python PATH of synapse, sometimes it is /usr/local/lib/python3.8/site-packages/ppfun_auth.py or in Debian / Ubuntu distribution in /opt/venvs/matrix-synapse/....

Configuration (homeserver.yml):

modules:
  - module: ppun_auth.PPfunAuthProvider
    config:
      apisocketkey: "APISOCKETKEY_CONFIGURED_IN_PIXELPLANET"
      ppfunurl: "http://local.pixelplanet.url:port"
      # if true, only mail-verified users can log in
      verified: true
      # rooms that will be automatically joined on login, must be a list 
      autojoin_rooms: ['#pp_en:pixelplanet.fun', '#pp_int:pixelplanet.fun']
      # dont notify users in pp_ channels
      # when true, it triggers a monkeypatch that blocks notifications in bridged channels in order to avoid flooding the synapse database with push_actions
      block_notify: false

References