debian-mirror-gitlab/doc/integration/akismet.md

60 lines
2.2 KiB
Markdown
Raw Normal View History

2021-01-29 00:20:46 +05:30
---
2021-10-27 15:23:28 +05:30
stage: Ecosystem
group: Integrations
2021-02-22 17:27:13 +05:30
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
2021-01-29 00:20:46 +05:30
---
2021-04-17 20:07:23 +05:30
# Akismet **(FREE)**
2016-04-02 18:10:28 +05:30
2021-10-27 15:23:28 +05:30
GitLab uses [Akismet](https://akismet.com/) to prevent the creation of
spam issues on public projects. Issues created through the web UI or the API can be submitted to
2021-12-11 22:18:48 +05:30
Akismet for review, and instance administrators can
[mark snippets as spam](../user/snippets.md#mark-snippet-as-spam).
2016-09-13 17:45:13 +05:30
2021-01-29 00:20:46 +05:30
Detected spam is rejected, and an entry is added in the **Spam Log** section of the
Admin page.
2016-04-02 18:10:28 +05:30
2020-06-23 00:09:42 +05:30
Privacy note: GitLab submits the user's IP and user agent to Akismet.
2021-02-22 17:27:13 +05:30
NOTE:
2021-11-18 22:05:49 +05:30
GitLab submits all issues to Akismet.
2016-04-02 18:10:28 +05:30
2021-10-27 15:23:28 +05:30
Akismet configuration is available to users on self-managed GitLab. Akismet is already enabled on
GitLab SaaS (GitLab.com), where it's configuration and management are handled by GitLab Inc.
## Configuration **(FREE SELF)**
2016-04-02 18:10:28 +05:30
To use Akismet:
2021-01-29 00:20:46 +05:30
1. Go to the [Akismet sign-in page](https://akismet.com/account/).
1. Sign in or create a new account.
2021-09-04 01:27:46 +05:30
1. Click **Show** to reveal the API key, and copy the API key's value.
1. Sign in to GitLab as an administrator.
2021-11-11 11:23:49 +05:30
1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Reporting** (`/admin/application_settings/reporting`).
2021-01-29 00:20:46 +05:30
1. Select the **Enable Akismet** checkbox.
2019-02-15 15:39:39 +05:30
1. Fill in the API key from step 3.
1. Save the configuration.
2016-04-02 18:10:28 +05:30
![Screenshot of Akismet settings](img/akismet_settings.png)
2016-09-13 17:45:13 +05:30
2021-10-27 15:23:28 +05:30
## Training **(FREE SELF)**
2016-09-13 17:45:13 +05:30
2021-01-29 00:20:46 +05:30
To better differentiate between spam and ham, you can train the Akismet
2016-09-13 17:45:13 +05:30
filter whenever there is a false positive or false negative.
2019-02-15 15:39:39 +05:30
When an entry is recognized as spam, it is rejected and added to the Spam Logs.
2021-01-29 00:20:46 +05:30
From here you can review if entries are really spam. If one of them is not really
2019-02-15 15:39:39 +05:30
spam, you can use the **Submit as ham** button to tell Akismet that it falsely
2016-09-13 17:45:13 +05:30
recognized an entry as spam.
![Screenshot of Spam Logs](img/spam_log.png)
2021-01-29 00:20:46 +05:30
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-09-13 17:45:13 +05:30
![Screenshot of Issue](img/submit_issue.png)
2021-01-29 00:20:46 +05:30
Training Akismet helps it to recognize spam more accurately in the future.