diff --git a/mod_pottymouth/README.md b/mod_pottymouth/README.md deleted file mode 100644 index 6c2565b..0000000 --- a/mod_pottymouth/README.md +++ /dev/null @@ -1,62 +0,0 @@ -# mod_pottymouth - -The 'mod_pottymouth' ejabberd module aims to fill the void left by 'mod_shit' -which has disappeared from the net. It allows individual whole words of a -message to be filtered against a blacklist. It allows multiple blacklists -sharded by language. The internal bloomfilter can support arbitrary blacklist -sizes. Using a large list (say, 87M terms) will slow down the initial server -boot time (to about 15 minutes respectively), but once loaded lookups are very -speedy. - -#### Installation - -On Ubuntu: -```` -cd ~/.ejabberd-modules/sources -clone the git repo -cd mod_pottymouth -ejabberdctl module_install mod_pottymouth -ejabberdctl restart -```` - -module will be installed in: ~/.ejabberd-modules/mod_pottymouth - -#### Config - -The file format is as follows: - -```` -modules: - mod_pottymouth: - blacklists: - default: /home/your_user/blacklist_en.txt - en: /home/your_user/blacklist_en.txt - cn: /home/your_user/blacklist_cn.txt - fr: /home/your_user/blacklist_fr.txt -```` - -For each language (en,cn,fr,...whatever) provide a full path to a backlist file. -The blacklist file is a plain text file with blacklisted words listed one per -line. - -#### Gotchas - -The language will be looked up by whatever value is passed in the xml:lang -attribute of the xml message. So, any xml:lang value to be supported will need -a corresponding entry/blacklist in the config file. If xml:lang is missing, -the 'default' entry in config will be used. - -For xml:lang attribute docs, see: - [http://wiki.xmpp.org/web/Programming_XMPP_Clients#Sending_a_message](http://wiki.xmpp.org/web/Programming_XMPP_Clients#Sending_a_message) - -#### Blacklist helper - -Thinking of a bunch of swear words and all the permutations can be tough. We made -a helper script to take a bare wordlist and generate permutations given a -dictionary of substitution characters: - [https://github.com/madglory/permute_wordlist](https://github.com/madglory/permute_wordlist) - -#### Tip of the hat - -This mod makes use of the excellent 'etbloom' module: - [https://github.com/erlangtoolbox/etbloom](https://github.com/erlangtoolbox/etbloom)