diff options
author | Stan Hu <stanhu@gmail.com> | 2016-01-09 22:30:34 +0300 |
---|---|---|
committer | Douglas Barbosa Alexandre <dbalexandre@gmail.com> | 2016-02-02 16:25:44 +0300 |
commit | d20e75a8d80c2828336cd22897ea6868d666f8a5 (patch) | |
tree | 9cbf725ad1b523ab0c8d94261d4a02a0677ca450 /doc/integration/akismet.md | |
parent | 6cffcb05882b0d3c4a02f9acf21806e25ea09ec3 (diff) |
Support Akismet spam checking for creation of issues via API
Currently any spam detected by Akismet by non-members via API will be logged
in a separate table in the admin page.
Closes #5612
Diffstat (limited to 'doc/integration/akismet.md')
-rw-r--r-- | doc/integration/akismet.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/integration/akismet.md b/doc/integration/akismet.md new file mode 100644 index 00000000000..5cc09bd536d --- /dev/null +++ b/doc/integration/akismet.md @@ -0,0 +1,30 @@ +# Akismet + +GitLab leverages [Akismet](http://akismet.com) to protect against spam. Currently +GitLab uses Akismet to prevent users who are not members of a project from +creating spam via the GitLab API. 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. + +## Configuration + +To use Akismet: + +1. Go to the URL: https://akismet.com/account/ + +2. Sign-in or create a new account. + +3. Click on "Show" to reveal the API key. + +4. Go to Applications Settings on Admin Area (`admin/application_settings`) + +5. Check the `Enable Akismet` checkbox + +6. Fill in the API key from step 3. + +7. Save the configuration. + +![Screenshot of Akismet settings](img/akismet_settings.png) |