summaryrefslogtreecommitdiff
path: root/doc/administration/pages/index.md
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-03-31 03:07:51 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-03-31 03:07:51 +0000
commit83a3209c3f8e5bc055acf80f3440335d2b97133b (patch)
tree0bb8d48ee018534d319311358f7dab6549b752e1 /doc/administration/pages/index.md
parentf6e2f302412fcb32b644b379778964791789cb62 (diff)
downloadgitlab-ce-83a3209c3f8e5bc055acf80f3440335d2b97133b.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/administration/pages/index.md')
-rw-r--r--doc/administration/pages/index.md49
1 files changed, 18 insertions, 31 deletions
diff --git a/doc/administration/pages/index.md b/doc/administration/pages/index.md
index ad0a828afa0..84133205bd3 100644
--- a/doc/administration/pages/index.md
+++ b/doc/administration/pages/index.md
@@ -4,14 +4,14 @@ description: 'Learn how to administer GitLab Pages.'
# GitLab Pages administration
-> - [Introduced][ee-80] in GitLab EE 8.3.
-> - Custom CNAMEs with TLS support were [introduced][ee-173] in GitLab EE 8.5.
-> - GitLab Pages [was ported][ce-14605] to Community Edition in GitLab 8.17.
+> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/80) in GitLab EE 8.3.
+> - Custom CNAMEs with TLS support were [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/173) in GitLab EE 8.5.
+> - GitLab Pages [was ported](https://gitlab.com/gitlab-org/gitlab-foss/issues/14605) to Community Edition in GitLab 8.17.
> - Support for subgroup project's websites was
> [introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/30548) in GitLab 11.8.
GitLab Pages allows for hosting of static sites. It must be configured by an
-administrator. Separate [user documentation][pages-userguide] is available.
+administrator. Separate [user documentation](../../user/project/pages/index.md) is available.
NOTE: **Note:**
This guide is for Omnibus GitLab installations. If you have installed
@@ -20,11 +20,11 @@ GitLab from source, see
## Overview
-GitLab Pages makes use of the [GitLab Pages daemon], a simple HTTP server
+GitLab Pages makes use of the [GitLab Pages daemon](https://gitlab.com/gitlab-org/gitlab-pages), a simple HTTP server
written in Go that can listen on an external IP address and provide support for
custom domains and custom certificates. It supports dynamic certificates through
SNI and exposes pages using HTTP2 by default.
-You are encouraged to read its [README][pages-readme] to fully understand how
+You are encouraged to read its [README](https://gitlab.com/gitlab-org/gitlab-pages/blob/master/README.md) to fully understand how
it works.
In the case of [custom domains](#custom-domains) (but not
@@ -124,9 +124,9 @@ The Pages daemon doesn't listen to the outside world.
pages_external_url 'http://example.io'
```
-1. [Reconfigure GitLab][reconfigure].
+1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
-Watch the [video tutorial][video-admin] for this configuration.
+Watch the [video tutorial](https://youtu.be/dD8c7WNcc6s) for this configuration.
### Wildcard domains with TLS support
@@ -156,7 +156,7 @@ outside world.
where `pages-nginx.crt` and `pages-nginx.key` are the SSL cert and key,
respectively.
-1. [Reconfigure GitLab][reconfigure].
+1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
### Additional configuration for Docker container
@@ -171,7 +171,7 @@ behavior:
gitlab_pages['inplace_chroot'] = true
```
-1. [Reconfigure GitLab][reconfigure].
+1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
NOTE: **Note:**
`inplace_chroot` option might not work with the other features, such as [Pages Access Control](#access-control).
@@ -213,7 +213,7 @@ world. Custom domains are supported, but no TLS.
`192.0.2.2` and `2001::2` are the secondary IPs the GitLab Pages daemon
listens on. If you don't have IPv6, you can omit the IPv6 address.
-1. [Reconfigure GitLab][reconfigure].
+1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
### Custom domains with TLS support
@@ -247,7 +247,7 @@ world. Custom domains and TLS are supported.
`192.0.2.2` and `2001::2` are the secondary IPs where the GitLab Pages daemon
listens on. If you don't have IPv6, you can omit the IPv6 address.
-1. [Reconfigure GitLab][reconfigure].
+1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
### Custom domain verification
@@ -304,7 +304,7 @@ Pages access control is disabled by default. To enable it:
gitlab_pages['access_control'] = true
```
-1. [Reconfigure GitLab][reconfigure].
+1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
1. Users can now configure it in their [projects' settings](../../user/project/pages/pages_access_control.md).
#### Disabling public access to all Pages websites
@@ -340,7 +340,7 @@ pages:
gitlab_pages['http_proxy'] = 'http://example:8080'
```
-1. [Reconfigure GitLab][reconfigure] for the changes to take effect.
+1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect.
### Using a custom Certificate Authority (CA)
@@ -389,7 +389,7 @@ Follow the steps below to configure verbose logging of GitLab Pages daemon.
gitlab_pages['log_verbose'] = true
```
-1. [Reconfigure GitLab][reconfigure].
+1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
## Change storage path
@@ -404,7 +404,7 @@ are stored.
gitlab_rails['pages_path'] = "/mnt/storage/pages"
```
-1. [Reconfigure GitLab][reconfigure].
+1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
## Configure listener for reverse proxy requests
@@ -427,7 +427,7 @@ Omnibus GitLab 11.1.
gitlab_pages['listen_proxy'] = "localhost:10080"
```
-1. [Reconfigure GitLab][reconfigure].
+1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
## Set maximum pages size
@@ -559,7 +559,7 @@ then you must use the following procedure to configure [access control](#access-
## Backup
-GitLab Pages are part of the [regular backup][backup], so there is no separate backup to configure.
+GitLab Pages are part of the [regular backup](../../raketasks/backup_restore.md), so there is no separate backup to configure.
## Security
@@ -610,16 +610,3 @@ The fix is to correct the source file permissions and restart Pages:
sudo chmod 644 /opt/gitlab/embedded/ssl/certs/cacert.pem
sudo gitlab-ctl restart gitlab-pages
```
-
-[backup]: ../../raketasks/backup_restore.md
-[ce-14605]: https://gitlab.com/gitlab-org/gitlab-foss/issues/14605
-[ee-80]: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/80
-[ee-173]: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/173
-[gitlab pages daemon]: https://gitlab.com/gitlab-org/gitlab-pages
-[NGINX configs]: https://gitlab.com/gitlab-org/gitlab/tree/8-5-stable-ee/lib/support/nginx
-[pages-readme]: https://gitlab.com/gitlab-org/gitlab-pages/blob/master/README.md
-[pages-userguide]: ../../user/project/pages/index.md
-[reconfigure]: ../restart_gitlab.md#omnibus-gitlab-reconfigure
-[restart]: ../restart_gitlab.md#installations-from-source
-[gitlab-pages]: https://gitlab.com/gitlab-org/gitlab-pages/tree/v0.2.4
-[video-admin]: https://youtu.be/dD8c7WNcc6s