diff --git a/doc/development/pipelines.md b/doc/development/pipelines.md index c6c32ce22233ebd60f5e66be07681bc69a2dbb0b_ZG9jL2RldmVsb3BtZW50L3BpcGVsaW5lcy5tZA==..b85a189ede71127452d4cedf684830defdfc1815_ZG9jL2RldmVsb3BtZW50L3BpcGVsaW5lcy5tZA== 100644 --- a/doc/development/pipelines.md +++ b/doc/development/pipelines.md @@ -130,8 +130,8 @@ ### Tag pipelines Tag pushes to [Release mirror](https://dev.gitlab.org/gitlab/omnibus-gitlab) starts a pipeline with the -[release jobs](#release-jobs). Tag pushes to [Development repository](https://gitlab.com/gitlab-org/omnibus-gitlab) and [Security -mirror](https://gitlab.com/gitlab-org/security/omnibus-gitlab) behaves as regular branch pushes (except that they don't have an option +[release jobs](#release-jobs). Tag pushes to [Development repository](https://gitlab.com/gitlab-org/omnibus-gitlab) and +[Security mirror](https://gitlab.com/gitlab-org/security/omnibus-gitlab) behaves as regular branch pushes (except that they don't have an option to start a package-and-qa pipeline) and run basic stylistic checks and unit tests. @@ -164,8 +164,8 @@ ### Triggered pipelines -We use triggered pipelines to run a "package-and-qa" pipeline in the [QA -mirror](https://gitlab.com/gitlab-org/build/omnibus-gitlab-mirror). These can be triggered either from a pipeline in the +We use triggered pipelines to run a "package-and-qa" pipeline in the +[QA mirror](https://gitlab.com/gitlab-org/build/omnibus-gitlab-mirror). These can be triggered either from a pipeline in the [Development repository](https://gitlab.com/gitlab-org/omnibus-gitlab) or [GitLab project](https://gitlab.com/gitlab-org/gitlab). This pipeline is intended to give the developers a package and an image to test @@ -286,8 +286,8 @@ #### `Trigger:qa-docker` -This job builds a GitLab QA Docker image from the [qa directory in the Rails -codebase](https://gitlab.com/gitlab-org/gitlab/blob/master/qa/Dockerfile). This +This job builds a GitLab QA Docker image from the +[qa directory in the Rails codebase](https://gitlab.com/gitlab-org/gitlab/blob/master/qa/Dockerfile). This QA image is used for QA runs. This job is run only on [QA mirror](https://gitlab.com/gitlab-org/build/omnibus-gitlab-mirror) on triggered pipelines. @@ -331,8 +331,8 @@ #### `QA-branch` -This job builds a GitLab QA Docker image from the [qa directory in the Rails -codebase](https://gitlab.com/gitlab-org/gitlab/blob/master/qa/Dockerfile). +This job builds a GitLab QA Docker image from the +[qa directory in the Rails codebase](https://gitlab.com/gitlab-org/gitlab/blob/master/qa/Dockerfile). This job is run only on [Release mirror](https://dev.gitlab.org/gitlab/omnibus-gitlab) on branch and nightly pipelines. @@ -384,8 +384,8 @@ ### `Docker-QA` -This job builds a GitLab QA Docker image from the [qa directory in the Rails -codebase](https://gitlab.com/gitlab-org/gitlab/blob/master/qa/Dockerfile) and +This job builds a GitLab QA Docker image from the +[qa directory in the Rails codebase](https://gitlab.com/gitlab-org/gitlab/blob/master/qa/Dockerfile) and pushes it to the internal GitLab container registry. This job is run only on [Release mirror](https://dev.gitlab.org/gitlab/omnibus-gitlab) and on tag pipelines. diff --git a/doc/development/setup.md b/doc/development/setup.md index c6c32ce22233ebd60f5e66be07681bc69a2dbb0b_ZG9jL2RldmVsb3BtZW50L3NldHVwLm1k..b85a189ede71127452d4cedf684830defdfc1815_ZG9jL2RldmVsb3BtZW50L3NldHVwLm1k 100644 --- a/doc/development/setup.md +++ b/doc/development/setup.md @@ -8,8 +8,8 @@ Development of Omnibus GitLab can be done using an existing package available from the [Downloads page](https://about.gitlab.com/install/). To know how to setup -a build environment to build these packages and use them, please read [Setting -up a Build Environment](../build/build_package.md#preparing-a-build-environment) +a build environment to build these packages and use them, please read +[Setting up a Build Environment](../build/build_package.md#preparing-a-build-environment) Choose one of the GitLab installation methods below. To provide isolation and to prevent rebuilding of the package for each and every change, it is preferred diff --git a/doc/settings/configuration.md b/doc/settings/configuration.md index c6c32ce22233ebd60f5e66be07681bc69a2dbb0b_ZG9jL3NldHRpbmdzL2NvbmZpZ3VyYXRpb24ubWQ=..b85a189ede71127452d4cedf684830defdfc1815_ZG9jL3NldHRpbmdzL2NvbmZpZ3VyYXRpb24ubWQ= 100644 --- a/doc/settings/configuration.md +++ b/doc/settings/configuration.md @@ -181,8 +181,8 @@ ``` If you're running Gitaly on its own server remember to also include the -`gitaly_address` for each Git data directory. See [the documentation on -configuring Gitaly](https://docs.gitlab.com/ee/administration/gitaly/configure_gitaly.html#configure-gitaly-clients). +`gitaly_address` for each Git data directory. See +[the documentation on configuring Gitaly](https://docs.gitlab.com/ee/administration/gitaly/configure_gitaly.html#configure-gitaly-clients). If you're not looking to move all repositories, but instead want to move specific projects between existing repository storages, use the @@ -551,8 +551,8 @@ ## Error Reporting and Logging with Sentry [Sentry](https://sentry.io) is an error reporting and logging tool which can be -used as SaaS or on premise. It's Open Source, and you can [browse its source code -repositories](https://github.com/getsentry). +used as SaaS or on premise. It's Open Source, and you can +[browse its source code repositories](https://github.com/getsentry). To configure Sentry: @@ -615,7 +615,7 @@ ## Set a Content Security Policy Setting a Content Security Policy (CSP) can help thwart JavaScript -cross-site scripting (XSS) attacks. See [the Mozilla documentation on -CSP](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) for more +cross-site scripting (XSS) attacks. See +[the Mozilla documentation on CSP](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) for more details. @@ -620,9 +620,8 @@ details. -GitLab 12.2 added support for [CSP and nonce-source with inline -JavaScript](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src). -It is [not configured on by default -yet](https://gitlab.com/gitlab-org/gitlab/-/issues/30720). +GitLab 12.2 added support for +[CSP and nonce-source with inline JavaScript](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src). +It is [not configured on by default yet](https://gitlab.com/gitlab-org/gitlab/-/issues/30720). NOTE: Improperly configuring the CSP rules could prevent GitLab from working diff --git a/doc/settings/logs.md b/doc/settings/logs.md index c6c32ce22233ebd60f5e66be07681bc69a2dbb0b_ZG9jL3NldHRpbmdzL2xvZ3MubWQ=..b85a189ede71127452d4cedf684830defdfc1815_ZG9jL3NldHRpbmdzL2xvZ3MubWQ= 100644 --- a/doc/settings/logs.md +++ b/doc/settings/logs.md @@ -190,8 +190,8 @@ ``` A restart of the database is required for this to take effect. For more -details, see the [PostgreSQL -documentation](https://www.postgresql.org/docs/12/runtime-config-logging.html). +details, see the +[PostgreSQL documentation](https://www.postgresql.org/docs/12/runtime-config-logging.html). ## Text logging diff --git a/doc/settings/nginx.md b/doc/settings/nginx.md index c6c32ce22233ebd60f5e66be07681bc69a2dbb0b_ZG9jL3NldHRpbmdzL25naW54Lm1k..b85a189ede71127452d4cedf684830defdfc1815_ZG9jL3NldHRpbmdzL25naW54Lm1k 100644 --- a/doc/settings/nginx.md +++ b/doc/settings/nginx.md @@ -991,8 +991,8 @@ Some security scanners detect issues when they see the `Server: nginx` http header. Most scanners with this alert will notify as `Low` or `Info` severity. [See Nessus as an example](https://www.tenable.com/plugins/nessus/106375). -We recommend ignoring this warning, as the benefit of removing the header is low, and its presence [helps support the -NGINX project in usage statistics](https://trac.nginx.org/nginx/ticket/1644). We do provide a way to turn off the +We recommend ignoring this warning, as the benefit of removing the header is low, and its presence +[helps support the NGINX project in usage statistics](https://trac.nginx.org/nginx/ticket/1644). We do provide a way to turn off the header with `hide_server_tokens`: 1. Edit `/etc/gitlab/gitlab.rb` and set the value: diff --git a/doc/settings/redis.md b/doc/settings/redis.md index c6c32ce22233ebd60f5e66be07681bc69a2dbb0b_ZG9jL3NldHRpbmdzL3JlZGlzLm1k..b85a189ede71127452d4cedf684830defdfc1815_ZG9jL3NldHRpbmdzL3JlZGlzLm1k 100644 --- a/doc/settings/redis.md +++ b/doc/settings/redis.md @@ -72,8 +72,7 @@ ## Using Google Cloud Memorystore -Google Cloud Memorystore [does not support the Redis `CLIENT` -command](https://cloud.google.com/memorystore/docs/redis/product-constraints#blocked_redis_commands). +Google Cloud Memorystore [does not support the Redis `CLIENT` command](https://cloud.google.com/memorystore/docs/redis/product-constraints#blocked_redis_commands). By default, Sidekiq will attempt to set the `CLIENT` for debugging purposes. This can be disabled via the following configuration setting: @@ -116,8 +115,8 @@ ## Setting the Redis Cache instance as an LRU -Using multiple Redis instances allows you to configure Redis as a [Least -Recently Used cache](https://redis.io/docs/manual/eviction/). Note you should only +Using multiple Redis instances allows you to configure Redis as a +[Least Recently Used cache](https://redis.io/docs/manual/eviction/). Note you should only do this for the Redis cache and rate-limiting instances; the Redis queues, shared state instances, and tracechunks instances should never be configured as an LRU, since they contain data (e.g. Sidekiq jobs) that is expected to be persistent. @@ -249,8 +248,7 @@ of the Redis server. The second line indicates the certificate is not properly trusted on this server. See the [previous section](#ssl-certificates). -1. Verify that the SSL certificate is working via [these troubleshooting - steps](ssl.md#custom-certificates-missing-or-skipped). +1. Verify that the SSL certificate is working via [these troubleshooting steps](ssl.md#custom-certificates-missing-or-skipped). ### NOAUTH Authentication required diff --git a/doc/settings/ssl.md b/doc/settings/ssl.md index c6c32ce22233ebd60f5e66be07681bc69a2dbb0b_ZG9jL3NldHRpbmdzL3NzbC5tZA==..b85a189ede71127452d4cedf684830defdfc1815_ZG9jL3NldHRpbmdzL3NzbC5tZA== 100644 --- a/doc/settings/ssl.md +++ b/doc/settings/ssl.md @@ -489,8 +489,7 @@ certificate bundle to load, while the latter defines a directory in which to search for more certificates. These variables should not be necessary if you have added certificates to the `trusted-certs` directory. However, if for some -reason you need to set them, they can be [defined as environment -variables](environment-variables.md). For example: +reason you need to set them, they can be [defined as environment variables](environment-variables.md). For example: ```ruby gitlab_rails['env'] = {"SSL_CERT_FILE" => "/usr/lib/ssl/private/customcacert.pem"} diff --git a/doc/troubleshooting.md b/doc/troubleshooting.md index c6c32ce22233ebd60f5e66be07681bc69a2dbb0b_ZG9jL3Ryb3VibGVzaG9vdGluZy5tZA==..b85a189ede71127452d4cedf684830defdfc1815_ZG9jL3Ryb3VibGVzaG9vdGluZy5tZA== 100644 --- a/doc/troubleshooting.md +++ b/doc/troubleshooting.md @@ -395,8 +395,7 @@ command, it is only for GitLab installations from source. The GitLab web interface uses CSS and JavaScript files, called 'assets' in Ruby -on Rails-speak. In the [upstream GitLab -repository](https://gitlab.com/gitlab-org/gitlab-foss/tree/master/app/assets) +on Rails-speak. In the [upstream GitLab repository](https://gitlab.com/gitlab-org/gitlab-foss/tree/master/app/assets) these files are stored in a developer-friendly way: easy to read and edit. When you are a normal user of GitLab, you do not want these files to be in the developer friendly format however because that makes GitLab slow. This is why @@ -784,7 +783,7 @@ ## Upgrade fails with `timeout: run: /opt/gitlab/service/gitaly` error -If the package upgrade fails when running reconfigure with the following error, +If the package upgrade fails when running reconfigure with the following error, check that all Gitaly processes are stopped and then rerun `sudo gitlab-ctl reconfigure`. ```plaintext