From 6cb3fc7be8d8a42880ea6db1c73f7ed2a4cfc7fe Mon Sep 17 00:00:00 2001 From: Wyatt Johnson Date: Tue, 6 Feb 2018 10:23:26 -0700 Subject: [PATCH] added docs for akismet --- docs/_docs/04-03-additional-plugins.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/_docs/04-03-additional-plugins.md b/docs/_docs/04-03-additional-plugins.md index b9f4d4067..8fe72dd01 100644 --- a/docs/_docs/04-03-additional-plugins.md +++ b/docs/_docs/04-03-additional-plugins.md @@ -103,3 +103,16 @@ Source: [plugins/talk-plugin-subscriber](https://github.com/coralproject/talk/tr Enables a `Subscriber` badge to be added to comments where the author has the `SUBSCRIBER` tag. This must match with a custom auth integration that adds the tag to the users that are subscribed to the service. + +## talk-plugin-akismet + +Source: [plugins/talk-plugin-akismet](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-akismet){:target="_blank"} + +Enables spam detection from [Akismet](https://akismet.com/). Comments will be passed to the Akismet API for spam detection. If a comment +is determined to be spam, it will prompt the user, indicating that the comment might be considered spam. If the user continues after this +point with the still spam-like comment, the comment will be reported as containing spam, and sent for moderator approval. + +Configuration: + +- `TALK_AKISMET_API_KEY` (**required**) - The Akismet API key located on your account page +- `TALK_AKISMET_SITE` (**required**) - The URL for your site that the comment are appearing on (not the root url, the url for the articles) \ No newline at end of file