2020-10-29 11:09:12 -04:00
---
2020-11-27 13:09:52 -05:00
stage: Create
group: Ecosystem
2020-11-26 01:09:20 -05:00
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-10-29 11:09:12 -04:00
---
2021-02-17 13:09:19 -05:00
# Akismet **(FREE)**
2016-01-09 14:30:34 -05:00
2020-11-16 13:09:15 -05:00
GitLab leverages [Akismet ](https://akismet.com/ ) to protect against spam.
2016-07-18 19:17:43 -04:00
GitLab uses Akismet to prevent the creation of spam issues on public projects. Issues
2020-11-16 13:09:15 -05:00
created through the web UI or the API can be submitted to Akismet for review.
2016-01-09 14:30:34 -05:00
2020-11-16 13:09:15 -05:00
Detected spam is rejected, and an entry is added in the **Spam Log** section of the
Admin page.
2016-07-16 12:42:44 -04:00
2020-05-26 08:08:22 -04:00
Privacy note: GitLab submits the user's IP and user agent to Akismet.
2020-12-04 16:09:29 -05:00
NOTE:
2020-05-26 08:08:22 -04:00
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.
2016-01-09 14:30:34 -05:00
## Configuration
To use Akismet:
2020-11-16 13:09:15 -05:00
1. Go to the [Akismet sign-in page ](https://akismet.com/account/ ).
1. Sign in or create a new account.
2021-06-13 20:09:37 -04:00
1. Click **Show** to reveal the API key, and copy the API key's value.
1. Sign in to GitLab as an administrator.
1. On the top bar, select **Menu >** ** {admin}** **Admin** .
1. In the left sidebar, select **Settings > Reporting** (`/admin/application_settings/reporting`).
2020-11-16 13:09:15 -05:00
1. Select the **Enable Akismet** checkbox.
2018-11-12 19:39:21 -05:00
1. Fill in the API key from step 3.
1. Save the configuration.
2016-01-09 14:30:34 -05:00
![Screenshot of Akismet settings ](img/akismet_settings.png )
2016-08-04 13:29:43 -04:00
## Training
2020-11-16 13:09:15 -05:00
To better differentiate between spam and ham, you can train the Akismet
2016-08-04 13:29:43 -04:00
filter whenever there is a false positive or false negative.
2018-11-12 19:39:21 -05:00
When an entry is recognized as spam, it is rejected and added to the Spam Logs.
2020-11-16 13:09:15 -05:00
From here you can review if entries are really spam. If one of them is not really
2018-11-12 19:39:21 -05:00
spam, you can use the **Submit as ham** button to tell Akismet that it falsely
2016-08-04 13:29:43 -04:00
recognized an entry as spam.
![Screenshot of Spam Logs ](img/spam_log.png )
2020-11-16 13:09:15 -05:00
If an entry that is actually spam was not recognized as such, you can also submit
this information to Akismet. The **Submit as spam** button is only displayed
to administrator users.
2016-08-04 13:29:43 -04:00
![Screenshot of Issue ](img/submit_issue.png )
2020-11-16 13:09:15 -05:00
Training Akismet helps it to recognize spam more accurately in the future.