diff options
Diffstat (limited to 'doc/user/admin_area/reporting/spamcheck.md')
| -rw-r--r-- | doc/user/admin_area/reporting/spamcheck.md | 72 |
1 files changed, 7 insertions, 65 deletions
diff --git a/doc/user/admin_area/reporting/spamcheck.md b/doc/user/admin_area/reporting/spamcheck.md index e2508476c80..043481b6255 100644 --- a/doc/user/admin_area/reporting/spamcheck.md +++ b/doc/user/admin_area/reporting/spamcheck.md @@ -1,69 +1,11 @@ --- -stage: Systems -group: Distribution -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments +redirect_to: '../../../administration/reporting/spamcheck.md' +remove_date: '2023-10-13' --- -# Spamcheck anti-spam service **(FREE SELF)** +This document was moved to [another location](../../../administration/reporting/spamcheck.md). -> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/6259) in GitLab 14.8. - -WARNING: -Spamcheck is available to all tiers, but only on instances using GitLab Enterprise Edition (EE). For [licensing reasons](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/6259#note_726605397), it is not included in the GitLab Community Edition (CE) package. You can [migrate from CE to EE](../../../update/package/convert_to_ee.md). - -[Spamcheck](https://gitlab.com/gitlab-org/spamcheck) is an anti-spam engine -developed by GitLab originally to combat rising amount of spam in GitLab.com, -and later made public to be used in self-managed GitLab instances. - -## Enable Spamcheck - -Spamcheck is only available for package-based installations: - -1. Edit `/etc/gitlab/gitlab.rb` and enable Spamcheck: - - ```ruby - spamcheck['enable'] = true - ``` - -1. Reconfigure GitLab: - - ```shell - sudo gitlab-ctl reconfigure - ``` - -1. Verify that the new services `spamcheck` and `spam-classifier` are - up and running: - - ```shell - sudo gitlab-ctl status - ``` - -## Configure GitLab to use Spamcheck - -1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). -1. Select **Admin Area**. -1. Select **Settings > Reporting**. -1. Expand **Spam and Anti-bot Protection**. -1. Update the Spam Check settings: - 1. Check the "Enable Spam Check via external API endpoint" checkbox. - 1. For **URL of the external Spam Check endpoint** use `grpc://localhost:8001`. - 1. Leave **Spam Check API key** blank. -1. Select **Save changes**. - -NOTE: -In single-node instances, Spamcheck runs over `localhost`, and hence is running -in an unauthenticated mode. If on multi-node instances where GitLab runs on one -server and Spamcheck runs on another server listening over a public endpoint, it -is recommended to enforce some sort of authentication using a reverse proxy in -front of the Spamcheck service that can be used along with an API key. One -example would be to use `JWT` authentication for this and specifying a bearer -token as the API key. -[Native authentication for Spamcheck is in the works](https://gitlab.com/gitlab-com/gl-security/engineering-and-research/automation-team/spam/spamcheck/-/issues/171). - -## Running Spamcheck over TLS - -Spamcheck service on its own cannot communicate directly over TLS with GitLab. -However, Spamcheck can be deployed behind a reverse proxy which performs TLS -termination. In such a scenario, GitLab can be made to communicate with -Spamcheck over TLS by specifying `tls://` scheme for the external Spamcheck URL -instead of `grpc://` in the Admin Area settings. +<!-- This redirect file can be deleted after <2023-10-13>. --> +<!-- Redirects that point to other docs in the same project expire in three months. --> +<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> +<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> |