Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc/pages
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-02-21 21:52:53 +0300
committerJames Edwards-Jones <jedwardsjones@gitlab.com>2017-02-01 01:55:29 +0300
commitdfc3e58a5d763d0250e76625ada08b88a7cb7e63 (patch)
tree631c4b06de7fee78b7399cb5de61fd311dbc89ad /doc/pages
parentacf7ae5ed80ec39d26dbd37c09bc0f3eb78e1628 (diff)
Add configuration scenarios
Diffstat (limited to 'doc/pages')
-rw-r--r--doc/pages/administration.md46
1 files changed, 34 insertions, 12 deletions
diff --git a/doc/pages/administration.md b/doc/pages/administration.md
index 3f3d6cac9b2..db0eb83b9f4 100644
--- a/doc/pages/administration.md
+++ b/doc/pages/administration.md
@@ -88,18 +88,40 @@ The `gitlab-pages` daemon is included in the Omnibus package.
## Configuration
-There are a couple of things to consider before enabling GitLab pages in your
-GitLab EE instance.
-
-1. You need to properly configure your DNS to point to the domain that pages
- will be served
-1. Pages use a separate Nginx configuration file which needs to be explicitly
- added in the server under which GitLab EE runs
-1. Optionally but recommended, you can add some
- [shared runners](../ci/runners/README.md) so that your users don't have to
- bring their own.
-
-Both of these settings are described in detail in the sections below.
+There are multiple ways to set up GitLab Pages according to what URL scheme you
+are willing to support. Below you will find all possible scenarios to choose
+from.
+
+### Configuration scenarios
+
+Before proceeding you have to decide what Pages scenario you want to use.
+Remember that in either scenario, you need:
+
+1. A separate domain
+1. A separate Nginx configuration file which needs to be explicitly added in
+ the server under which GitLab EE runs (Omnibus does that automatically)
+1. (Optional) A wildcard certificate for that domain if you decide to serve
+ pages under HTTPS
+1. (Optional but recommended) [Shared runners](../ci/runners/README.md) so that
+ your users don't have to bring their own.
+
+The possible scenarios are depicted in the table below.
+
+| URL scheme | Option | Wildcard certificate | Pages daemon | Custom domain with HTTP support | Custom domain with HTTPS support | Secondary IP |
+| --- |:---:|:---:|:---:|:---:|:---:|:---:|:---:|
+| `http://page.gitlab.io` | 1 | no | no | no | no | no |
+| `https://page.gitlab.io` | 1 | yes | no | no | no | no |
+| `http://page.gitlab.io` and `http://page.com` | 2 | no | yes | yes | no | yes |
+| `https://page.gitlab.io` and `https://page.com` | 2 | yes | yes | yes/no | yes | yes |
+
+As you see from the table above, each URL scheme comes with an option:
+
+1. Pages enabled, daemon is enabled and NGINX will proxy all requests to the
+ daemon. Pages daemon doesn't listen to the outside world.
+1. Pages enabled, daemon is enabled AND pages has external IP support enabled.
+ In that case, the pages daemon is running, NGINX still proxies requests to
+ the daemon but the daemon is also able to receive requests from the outside
+ world. Custom domains and TLS are supported.
### DNS configuration