deblan/php-censor
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
php-censor/docs/en/plugins/xmpp.md
Dmitry Khomutov 80b7a368b1
Code style fixes (Documentation).
2017-07-18 20:54:24 +07:00

1.1 KiB
Raw Permalink Blame History

Plugin XMPP

Requirements

  • sendxmpp package

Installation

  1. On debian system (for example) use aptitude command to install sendxmpp
  2. Add XMPP plugin in "complete" section of your php-censor.yml

Configuration

Options

  • username : Username of your XMPP sender account. (example : "login@server.com")
  • password : Password of your XMPP sender account.
  • recipients : List of your XMPP recipents account.
  • server : If your server is not the same that your login server (optional, example : gtalk.google.com)
  • tls : Set 1 to enable TLS connection or 0 to disable it. (optional, default is 0)
  • alias : Alias of your sender account. (optional)
  • date_format : strftime mask date format display in notification message. (optional, default is %c of strftime function)

Examples

complete:
    xmpp:
        username: "login@gmail.com"
        password: "AZERTY123"
        recipients:
            - "recipient1@jabber.org"
            - "recipient2@jabber.org"    
        server: "gtalk.google.com"
        tls: 1
        alias: "PHP Censor Notification"
        date_format: "%d/%m/%Y"