Commit 7b688178 authored by Amy Qualls's avatar Amy Qualls

Merge branch 'redirects-feature-toggle-enabled-by-default' into 'master'

Update docs to reflect redirects being enabled by default

See merge request gitlab-org/gitlab!44544
parents 8e7e6300 8a158128
...@@ -235,7 +235,7 @@ control over how the Pages daemon runs and serves content in your environment. ...@@ -235,7 +235,7 @@ control over how the Pages daemon runs and serves content in your environment.
| `pages_path` | The directory on disk where pages are stored, defaults to `GITLAB-RAILS/shared/pages`. | `pages_path` | The directory on disk where pages are stored, defaults to `GITLAB-RAILS/shared/pages`.
| `pages_nginx[]` | | | `pages_nginx[]` | |
| `enable` | Include a virtual host `server{}` block for Pages inside NGINX. Needed for NGINX to proxy traffic back to the Pages daemon. Set to `false` if the Pages daemon should directly receive all requests, for example, when using [custom domains](index.md#custom-domains). | `enable` | Include a virtual host `server{}` block for Pages inside NGINX. Needed for NGINX to proxy traffic back to the Pages daemon. Set to `false` if the Pages daemon should directly receive all requests, for example, when using [custom domains](index.md#custom-domains).
| `FF_ENABLE_REDIRECTS` | Feature flag to enable redirects. See the [redirects documentation](../../user/project/pages/redirects.md#enable-or-disable-redirects) for more info. | | `FF_ENABLE_REDIRECTS` | Feature flag to disable redirects (enabled by default). Read the [redirects documentation](../../user/project/pages/redirects.md#disable-redirects) for more info. |
--- ---
...@@ -424,10 +424,6 @@ Authority (CA) in the system certificate store. ...@@ -424,10 +424,6 @@ Authority (CA) in the system certificate store.
For Omnibus, this is fixed by [installing a custom CA in Omnibus GitLab](https://docs.gitlab.com/omnibus/settings/ssl.html#install-custom-public-certificates). For Omnibus, this is fixed by [installing a custom CA in Omnibus GitLab](https://docs.gitlab.com/omnibus/settings/ssl.html#install-custom-public-certificates).
## Enable redirects
In GitLab Pages, you can [enable the redirects feature](../../user/project/pages/redirects.md#enable-or-disable-redirects) to configure rules to forward one URL to another using HTTP redirects.
## Activate verbose logging for daemon ## Activate verbose logging for daemon
Verbose logging was [introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/2533) in Verbose logging was [introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/2533) in
......
...@@ -347,10 +347,6 @@ world. Custom domains and TLS are supported. ...@@ -347,10 +347,6 @@ world. Custom domains and TLS are supported.
1. Restart NGINX 1. Restart NGINX
1. [Restart GitLab](../restart_gitlab.md#installations-from-source) 1. [Restart GitLab](../restart_gitlab.md#installations-from-source)
## Enable redirects
In GitLab Pages, you can [enable the redirects feature](../../user/project/pages/redirects.md#enable-or-disable-redirects) to configure rules to forward one URL to another using HTTP redirects.
## NGINX caveats ## NGINX caveats
NOTE: **Note:** NOTE: **Note:**
......
...@@ -6,15 +6,15 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -6,15 +6,15 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Create redirects for GitLab Pages # Create redirects for GitLab Pages
> - [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/issues/24) in GitLab Pages 1.25.0 and GitLab 13.4. > - [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/issues/24) in GitLab Pages 1.25.0 and GitLab 13.4 behind a feature flag, disabled by default.
> - It's [deployed behind a feature flag](#enable-or-disable-redirects), disabled by default. > - [Became enabled by default](https://gitlab.com/gitlab-org/gitlab-pages/-/merge_requests/367) in GitLab 13.5.
> - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-redirects).
CAUTION: **Warning:** CAUTION: **Warning:**
This feature might not be available to you. Check the **version history** note above for details. This feature might not be available to you. Check the **version history** note above for details.
In GitLab Pages, you can [enable](#enable-or-disable-redirects) the redirects feature to configure rules to forward one URL to another using HTTP redirects. GitLab Pages uses In GitLab Pages, you can configure rules to forward one URL to another using
[Netlify style redirects](https://docs.netlify.com/routing/redirects/#syntax-for-the-redirects-file). [Netlify style](https://docs.netlify.com/routing/redirects/#syntax-for-the-redirects-file)
HTTP redirects.
## Supported features ## Supported features
...@@ -42,7 +42,7 @@ Supported paths must start with a forward slash `/`. ...@@ -42,7 +42,7 @@ Supported paths must start with a forward slash `/`.
## Create redirects ## Create redirects
To create redirects after [enabling](#enable-or-disable-redirects) the feature, To create redirects,
create a configuration file named `_redirects` in the `public/` directory of your create a configuration file named `_redirects` in the `public/` directory of your
GitLab Pages site. GitLab Pages site.
...@@ -105,19 +105,19 @@ rule 10: valid ...@@ -105,19 +105,19 @@ rule 10: valid
rule 11: valid rule 11: valid
``` ```
## Enable or disable redirects ## Disable redirects
Redirects in GitLab Pages is under development and not ready for production use. It is Redirects in GitLab Pages is under development, and is deployed behind a feature flag
deployed behind a feature flag that is **disabled by default**. that is **enabled by default**.
For [Omnibus installations](../../../administration/pages/index.md), define the To disable redirects, for [Omnibus installations](../../../administration/pages/index.md), define the
`FF_ENABLE_REDIRECTS` environment variable in the `FF_ENABLE_REDIRECTS` environment variable in the
[global settings](../../../administration/pages/index.md#global-settings). [global settings](../../../administration/pages/index.md#global-settings).
Add the following line to `/etc/gitlab/gitlab.rb` and Add the following line to `/etc/gitlab/gitlab.rb` and
[reconfigure the instance](../../../administration/restart_gitlab.md#omnibus-gitlab-reconfigure). [reconfigure the instance](../../../administration/restart_gitlab.md#omnibus-gitlab-reconfigure).
```ruby ```ruby
gitlab_pages['env']['FF_ENABLE_REDIRECTS'] = 'true' gitlab_pages['env']['FF_ENABLE_REDIRECTS'] = 'false'
``` ```
For [source installations](../../../administration/pages/source.md), define the For [source installations](../../../administration/pages/source.md), define the
...@@ -125,6 +125,6 @@ For [source installations](../../../administration/pages/source.md), define the ...@@ -125,6 +125,6 @@ For [source installations](../../../administration/pages/source.md), define the
[restart GitLab](../../../administration/restart_gitlab.md#installations-from-source): [restart GitLab](../../../administration/restart_gitlab.md#installations-from-source):
```shell ```shell
export FF_ENABLE_REDIRECTS="true" export FF_ENABLE_REDIRECTS="false"
/path/to/pages/bin/gitlab-pages -config gitlab-pages.conf /path/to/pages/bin/gitlab-pages -config gitlab-pages.conf
``` ```
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment