Commit a691e9f4 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis Committed by James Edwards-Jones

Minor cleanup, use gitlab.io as an example domain for GP

parent d26eadf3
...@@ -12,26 +12,26 @@ GitLab EE instance. ...@@ -12,26 +12,26 @@ GitLab EE instance.
1. You need to properly configure your DNS to point to the domain that pages 1. You need to properly configure your DNS to point to the domain that pages
will be served will be served
1. Pages use a separate nginx configuration file which needs to be explicitly 1. Pages use a separate Nginx configuration file which needs to be explicitly
added in the server under which GitLab EE runs added in the server under which GitLab EE runs
Both of these settings are described in detail in the sections below. Both of these settings are described in detail in the sections below.
### DNS configuration ### DNS configuration
GitLab Pages expect to run on their own virtual host. In your DNS you need to GitLab Pages expect to run on their own virtual host. In your DNS server/provider
add a [wildcard DNS A record][wiki-wildcard-dns] pointing to the host that you need to add a [wildcard DNS A record][wiki-wildcard-dns] pointing to the
GitLab runs. For example, an entry would look like this: host that GitLab runs. For example, an entry would look like this:
``` ```
*.gitlabpages.com. 60 IN A 1.2.3.4 *.gitlab.io. 60 IN A 1.2.3.4
``` ```
where `gitlabpages.com` is the domain under which GitLab Pages will be served where `gitlab.io` is the domain under which GitLab Pages will be served
and `1.2.3.4` is the IP address of your GitLab instance. and `1.2.3.4` is the IP address of your GitLab instance.
It is strongly advised to **not** use the GitLab domain to serve user pages. It is strongly advised to **not** use the GitLab domain to serve user pages.
See [security](#security). For more information see the [security section](#security).
### Omnibus package installations ### Omnibus package installations
...@@ -58,7 +58,7 @@ See the relevant documentation at <http://doc.gitlab.com/omnibus/settings/pages. ...@@ -58,7 +58,7 @@ See the relevant documentation at <http://doc.gitlab.com/omnibus/settings/pages.
# The domain under which the pages are served: # The domain under which the pages are served:
# http://group.example.com/project # http://group.example.com/project
# or project path can be a group page: group.example.com # or project path can be a group page: group.example.com
host: example.com host: gitlab.io
port: 80 # Set to 443 if you serve the pages with HTTPS port: 80 # Set to 443 if you serve the pages with HTTPS
https: false # Set to true if you serve the pages with HTTPS https: false # Set to true if you serve the pages with HTTPS
``` ```
...@@ -71,7 +71,7 @@ See the relevant documentation at <http://doc.gitlab.com/omnibus/settings/pages. ...@@ -71,7 +71,7 @@ See the relevant documentation at <http://doc.gitlab.com/omnibus/settings/pages.
``` ```
Don't forget to add your domain name in the Nginx config. For example if Don't forget to add your domain name in the Nginx config. For example if
your GitLab pages domain is `gitlabpages.com`, replace your GitLab pages domain is `gitlab.io`, replace
```bash ```bash
server_name ~^(?<group>.*)\.YOUR_GITLAB_PAGES\.DOMAIN$; server_name ~^(?<group>.*)\.YOUR_GITLAB_PAGES\.DOMAIN$;
...@@ -80,16 +80,11 @@ See the relevant documentation at <http://doc.gitlab.com/omnibus/settings/pages. ...@@ -80,16 +80,11 @@ See the relevant documentation at <http://doc.gitlab.com/omnibus/settings/pages.
with with
``` ```
server_name ~^(?<group>.*)\.gitlabpages\.com$; server_name *.gitlab.io;
``` ```
You must be extra careful to not remove the backslashes. If you are using You must be add `*` in front of your domain, this is required to catch all
a subdomain, make sure to escape all dots (`.`) with a backslash (\). subdomains of `gitlab.io`.
For example `pages.gitlab.io` would be:
```
server_name ~^(?<group>.*)\.pages\.gitlab\.io$;
```
1. Restart Nginx and GitLab: 1. Restart Nginx and GitLab:
...@@ -115,7 +110,7 @@ required. ...@@ -115,7 +110,7 @@ required.
# The domain under which the pages are served: # The domain under which the pages are served:
# http://group.example.com/project # http://group.example.com/project
# or project path can be a group page: group.example.com # or project path can be a group page: group.example.com
host: example.com host: gitlab.io
port: 443 # Set to 443 if you serve the pages with HTTPS port: 443 # Set to 443 if you serve the pages with HTTPS
https: true # Set to true if you serve the pages with HTTPS https: true # Set to true if you serve the pages with HTTPS
``` ```
...@@ -128,13 +123,13 @@ required. ...@@ -128,13 +123,13 @@ required.
``` ```
Make sure to edit the config to add your domain as well as correctly point Make sure to edit the config to add your domain as well as correctly point
to the right location where the SSL certificates reside. After all changes to the right location of the SSL certificate files. Restart Nginx for the
restart Nginx. changes to take effect.
## Set maximum pages size ## Set maximum pages size
The maximum size of the unpacked archive can be configured in the Admin area The maximum size of the unpacked archive per project can be configured in the
under the Application settings in the **Maximum size of pages (MB)**. Admin area under the Application settings in the **Maximum size of pages (MB)**.
The default is 100MB. The default is 100MB.
## Change storage path ## Change storage path
......
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