summaryrefslogtreecommitdiff
path: root/doc/integration/akismet.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/integration/akismet.md')
-rw-r--r--doc/integration/akismet.md22
1 files changed, 8 insertions, 14 deletions
diff --git a/doc/integration/akismet.md b/doc/integration/akismet.md
index 5b697d387e9..7cb8f8b70ce 100644
--- a/doc/integration/akismet.md
+++ b/doc/integration/akismet.md
@@ -1,42 +1,36 @@
# Akismet
-> *Note:* Before 8.11 only issues submitted via the API and for non-project
-members were submitted to Akismet.
-
GitLab leverages [Akismet](https://akismet.com/) to protect against spam. Currently
GitLab uses Akismet to prevent the creation of spam issues on public projects. Issues
-created via the WebUI or the API can be submitted to Akismet for review.
+created via the web UI or the API can be submitted to Akismet for review.
Detected spam will be rejected, and an entry in the "Spam Log" section in the
Admin page will be created.
-Privacy note: GitLab submits the user's IP and user agent to Akismet. Note that
-adding a user to a project will disable the Akismet check and prevent this
-from happening.
+Privacy note: GitLab submits the user's IP and user agent to Akismet.
+
+NOTE: **Note:**
+In GitLab 8.11 and later, all issues are submitted to Akismet.
+In earlier GitLab versions, this only applied to API and non-project members.
## Configuration
To use Akismet:
1. Go to the URL: <https://akismet.com/account/>
-
1. Sign-in or create a new account.
-
1. Click on **Show** to reveal the API key.
-
1. Go to **Admin Area > Settings > Reporting** (`/admin/application_settings/reporting`).
-
1. Check the **Enable Akismet** checkbox.
-
1. Fill in the API key from step 3.
-
1. Save the configuration.
![Screenshot of Akismet settings](img/akismet_settings.png)
## Training
-> *Note:* Training the Akismet filter is only available in 8.11 and above.
+NOTE: **Note:**
+Training the Akismet filter is only available in GitLab 8.11 and later.
As a way to better recognize between spam and ham, you can train the Akismet
filter whenever there is a false positive or false negative.