diff options
Diffstat (limited to 'doc/administration/pages/source.md')
| -rw-r--r-- | doc/administration/pages/source.md | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/doc/administration/pages/source.md b/doc/administration/pages/source.md index c7c25f0f3a7..0aebeaf2ebe 100644 --- a/doc/administration/pages/source.md +++ b/doc/administration/pages/source.md @@ -17,8 +17,8 @@ You are encouraged to read the [Omnibus documentation](index.md) as it provides some invaluable information to the configuration of GitLab Pages. Please proceed to read it before going forward with this guide. -We also highly recommend that you use the Omnibus GitLab packages, as we -optimize them specifically for GitLab, and we will take care of upgrading GitLab +We also highly recommend that you use the Omnibus GitLab packages. We +optimize them specifically for GitLab, and we take care of upgrading GitLab Pages to the latest supported version. ## Overview @@ -38,22 +38,22 @@ 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 will have to share it via network. + 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 will have to proxy the traffic with - a load balancer. If you choose that route note that you should use TCP load - balancing for HTTPS. If you use TLS-termination (HTTPS-load balancing) the - pages will not be able to be served with user provided certificates. For - HTTP it's OK to use HTTP or TCP load balancing. + but on different ports. In that case, you must proxy the traffic with + a load balancer. If you choose that route, note that 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. -In this document, we will proceed assuming the first option. If you are not -supporting custom domains a secondary IP is not needed. +In this document, we proceed assuming the first option. If you aren't +supporting custom domains, a secondary IP isn't needed. ## Prerequisites Before proceeding with the Pages configuration, make sure that: -1. You have a separate domain under which GitLab Pages will be served. In +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 @@ -74,7 +74,7 @@ host that GitLab runs. For example, an entry would look like this: *.example.io. 1800 IN A 192.0.2.1 ``` -where `example.io` is the domain under which GitLab Pages will be served +Where `example.io` is the domain to serve GitLab Pages from, and `192.0.2.1` is the IP address of your GitLab instance. NOTE: @@ -97,7 +97,7 @@ since that is needed in all configurations. URL scheme: `http://<namespace>.example.io/<project_slug>` This is the minimum setup that you can use Pages with. It is the base for all -other setups as described below. NGINX will proxy all requests to the daemon. +other setups as described below. NGINX proxies all requests to the daemon. The Pages daemon doesn't listen to the outside world. 1. Install the Pages daemon: @@ -117,7 +117,7 @@ The Pages daemon doesn't listen to the outside world. ``` 1. Edit `gitlab.yml` and under the `pages` setting, set `enabled` to `true` and - the `host` to the FQDN under which GitLab Pages will be served: + the `host` to the FQDN to serve GitLab Pages from: ```yaml ## GitLab Pages @@ -159,7 +159,7 @@ The Pages daemon doesn't listen to the outside world. URL scheme: `https://<namespace>.example.io/<project_slug>` -NGINX will proxy all requests to the daemon. Pages daemon doesn't listen to the +NGINX proxies all requests to the daemon. Pages daemon doesn't listen to the outside world. 1. Install the Pages daemon: @@ -238,8 +238,8 @@ world. Custom domains are supported, but no TLS. ``` 1. Edit `gitlab.yml` to look like the example below. You need to change the - `host` to the FQDN under which GitLab Pages will be served. Set - `external_http` to the secondary IP on which the pages daemon will listen + `host` to the FQDN to serve GitLab Pages from. Set + `external_http` to the secondary IP on which the pages daemon listens for connections: ```yaml @@ -303,9 +303,9 @@ world. Custom domains and TLS are supported. ``` 1. Edit `gitlab.yml` to look like the example below. You need to change the - `host` to the FQDN under which GitLab Pages will be served. Set + `host` to the FQDN to serve GitLab Pages from. Set `external_http` and `external_https` to the secondary IP on which the pages - daemon will listen for connections: + daemon listens for connections: ```yaml ## GitLab Pages |