From 211a99cdc471c65ee2d046f9fcc4c4c0341e06ba Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Thu, 30 Dec 2021 03:13:52 +0000 Subject: [PATCH] Add latest changes from gitlab-org/gitlab@master --- doc/administration/pages/index.md | 27 ++++++++++++ doc/administration/pages/source.md | 43 +++++++++---------- doc/api/releases/index.md | 6 +-- doc/api/releases/links.md | 4 +- doc/operations/feature_flags.md | 1 - .../pages_new_project_template.md | 3 -- doc/user/project/pages/introduction.md | 2 - .../project/pages/pages_access_control.md | 4 +- doc/user/project/releases/index.md | 2 - 9 files changed, 54 insertions(+), 38 deletions(-) diff --git a/doc/administration/pages/index.md b/doc/administration/pages/index.md index 5dc598d2ac2..f7e20e9f922 100644 --- a/doc/administration/pages/index.md +++ b/doc/administration/pages/index.md @@ -192,6 +192,33 @@ to use the HTTPS protocol. WARNING: Multiple wildcards for one instance is not supported. Only one wildcard per instance can be assigned. +### Wildcard domains with TLS-terminating Load Balancer + +**Requirements:** + +- [Wildcard DNS setup](#dns-configuration) +- [TLS-terminating load balancer](../../install/aws/manual_install_aws.md#load-balancer) + +--- + +URL scheme: `https://.example.io/` + +This setup is primarily intended to be used when [installing a GitLab POC on Amazon Web Services](../../install/aws/manual_install_aws.md). This includes a TLS-terminating [classic load balancer](../../install/aws/manual_install_aws.md#load-balancer) that listens for HTTPS connections, manages TLS certificates, and forwards HTTP traffic to the instance. + +1. In `/etc/gitlab/gitlab.rb` specify the following configuration: + + ```ruby + external_url "https://gitlab.example.com" # external_url here is only for reference + pages_external_url "https://pages.example.com" # not a subdomain of external_url + + pages_nginx['enable'] = true + pages_nginx['listen_port'] = 80 + pages_nginx['listen_https'] = false + pages_nginx['redirect_http_to_https'] = true + ``` + +1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). + ### Global settings Below is a table of all configuration settings known to Pages in Omnibus GitLab, diff --git a/doc/administration/pages/source.md b/doc/administration/pages/source.md index 45e9dadd1cf..c4b1756d8a1 100644 --- a/doc/administration/pages/source.md +++ b/doc/administration/pages/source.md @@ -35,16 +35,17 @@ In the case of [custom domains](#custom-domains) (but not ports `80` and/or `443`. For that reason, there is some flexibility in the way which you can set it up: -1. Run the Pages daemon in the same server as GitLab, listening on a secondary IP. -1. Run the Pages daemon in a separate server. In that case, the - [Pages path](#change-storage-path) must also be present in the server that - the Pages daemon is installed, so you must share it through the network. -1. Run the Pages daemon in the same server as GitLab, listening on the same IP - but on different ports. In that case, you must proxy the traffic with - a load balancer. If you choose that route, you should use TCP load - balancing for HTTPS. If you use TLS-termination (HTTPS-load balancing), the - pages aren't able to be served with user-provided certificates. For - HTTP, it's OK to use HTTP or TCP load balancing. +- Run the Pages daemon in the same server as GitLab, listening on a secondary + IP. +- Run the Pages daemon in a separate server. In that case, the + [Pages path](#change-storage-path) must also be present in the server that + the Pages daemon is installed, so you must share it through the network. +- Run the Pages daemon in the same server as GitLab, listening on the same IP + but on different ports. In that case, you must proxy the traffic with a load + balancer. If you choose that route, you should use TCP load balancing for + HTTPS. If you use TLS-termination (HTTPS-load balancing), the pages aren't + able to be served with user-provided certificates. For HTTP, you can use HTTP + or TCP load balancing. In this document, we proceed assuming the first option. If you aren't supporting custom domains, a secondary IP isn't needed. @@ -53,16 +54,16 @@ supporting custom domains, a secondary IP isn't needed. Before proceeding with the Pages configuration, make sure that: -1. You have a separate domain to serve GitLab Pages from. In - this document we assume that to be `example.io`. -1. You have configured a **wildcard DNS record** for that domain. -1. You have installed the `zip` and `unzip` packages in the same server that - GitLab is installed since they are needed to compress and decompress the - Pages artifacts. -1. Optional. You have a **wildcard certificate** for the Pages domain if you - decide to serve Pages (`*.example.io`) under HTTPS. -1. Optional but recommended. You have configured and enabled the [shared runners](../../ci/runners/index.md) - so that your users don't have to bring their own. +- You have a separate domain to serve GitLab Pages from. In this document we + assume that to be `example.io`. +- You have configured a **wildcard DNS record** for that domain. +- You have installed the `zip` and `unzip` packages in the same server that + GitLab is installed since they are needed to compress and decompress the + Pages artifacts. +- Optional. You have a **wildcard certificate** for the Pages domain if you + decide to serve Pages (`*.example.io`) under HTTPS. +- Optional but recommended. You have configured and enabled the [shared runners](../../ci/runners/index.md) + so your users don't have to bring their own. ### DNS configuration @@ -417,8 +418,6 @@ server_name ~^.*\.pages\.example\.io$; ## Access control -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/33422) in GitLab 11.5. - GitLab Pages access control can be configured per-project, and allows access to a Pages site to be controlled based on a user's membership to that project. diff --git a/doc/api/releases/index.md b/doc/api/releases/index.md index c253358f01f..c603be9489c 100644 --- a/doc/api/releases/index.md +++ b/doc/api/releases/index.md @@ -6,15 +6,15 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Releases API **(FREE)** -> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/41766) in GitLab 11.7. -> - Using this API you can manipulate GitLab [Release](../../user/project/releases/index.md) entries. -> - For manipulating links as a release asset, see [Release Links API](links.md). > - Release Evidences were [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/26019) in GitLab 12.5. > - `description_html` became an opt-in field [with GitLab 13.12 for performance reasons](https://gitlab.com/gitlab-org/gitlab/-/issues/299447). Please pass the `include_html_description` query string parameter if you need it. > - [The permission model for create, update and delete actions was fixed](https://gitlab.com/gitlab-org/gitlab/-/issues/327505) in GitLab 14.1. See [Release permissions](../../user/project/releases/index.md#release-permissions) for more information. +Use this API to manipulate GitLab [Release](../../user/project/releases/index.md) +entries. For manipulating links as a release asset, see [Release Links API](links.md). + ## Authentication For authentication, the Releases API accepts either: diff --git a/doc/api/releases/links.md b/doc/api/releases/links.md index c9d183b8351..282ef0adc78 100644 --- a/doc/api/releases/links.md +++ b/doc/api/releases/links.md @@ -6,9 +6,9 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Release links API **(FREE)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/41766) in GitLab 11.7. +Use this API to manipulate GitLab [Release](../../user/project/releases/index.md) +links. For manipulating other Release assets, see [Release API](index.md). -Using this API you can manipulate GitLab [Release](../../user/project/releases/index.md) links. For manipulating other Release assets, see [Release API](index.md). GitLab supports links to `http`, `https`, and `ftp` assets. ## Get links diff --git a/doc/operations/feature_flags.md b/doc/operations/feature_flags.md index 49898d2e904..2eb23067ca9 100644 --- a/doc/operations/feature_flags.md +++ b/doc/operations/feature_flags.md @@ -6,7 +6,6 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Feature Flags **(FREE)** -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/7433) in GitLab 11.4. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212318) from GitLab Premium to GitLab Free in 13.5. With Feature Flags, you can deploy your application's new features to production in smaller batches. diff --git a/doc/user/project/pages/getting_started/pages_new_project_template.md b/doc/user/project/pages/getting_started/pages_new_project_template.md index f52f64626ac..cee10675a62 100644 --- a/doc/user/project/pages/getting_started/pages_new_project_template.md +++ b/doc/user/project/pages/getting_started/pages_new_project_template.md @@ -1,5 +1,4 @@ --- -type: reference, howto stage: Release group: Release 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 @@ -7,8 +6,6 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Create a Pages website from a template **(FREE)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/47857) in GitLab 11.8. - GitLab provides templates for the most popular Static Site Generators (SSGs). You can create a new project from a template and run the CI/CD pipeline to generate a Pages website. diff --git a/doc/user/project/pages/introduction.md b/doc/user/project/pages/introduction.md index 59a2f0c2eba..10fbc57fa0b 100644 --- a/doc/user/project/pages/introduction.md +++ b/doc/user/project/pages/introduction.md @@ -214,8 +214,6 @@ needing to compress files on-demand. ### Resolving ambiguous URLs -> [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/issues/95) in GitLab 11.8 - GitLab Pages makes assumptions about which files to serve when receiving a request for a URL that does not include an extension. diff --git a/doc/user/project/pages/pages_access_control.md b/doc/user/project/pages/pages_access_control.md index 4b4d479e3e9..002b234f561 100644 --- a/doc/user/project/pages/pages_access_control.md +++ b/doc/user/project/pages/pages_access_control.md @@ -1,5 +1,4 @@ --- -type: reference, howto stage: Release group: Release 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 @@ -7,8 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # GitLab Pages access control **(FREE)** -> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/33422) in GitLab 11.5. -> - Available on GitLab.com in GitLab 12.4. +> Available on GitLab.com in GitLab 12.4. You can enable Pages access control on your project if your administrator has [enabled the access control feature](../../../administration/pages/index.md#access-control) diff --git a/doc/user/project/releases/index.md b/doc/user/project/releases/index.md index 239e6c9cea8..984d44a4f3a 100644 --- a/doc/user/project/releases/index.md +++ b/doc/user/project/releases/index.md @@ -6,8 +6,6 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Releases **(FREE)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/41766) in GitLab 11.7. - In GitLab, a release enables you to create a snapshot of your project for your users, including installation packages and release notes. You can create a GitLab release on any branch. Creating a release also creates a [Git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) to mark the