Commit 85b869e7 authored by Marin Jankovski's avatar Marin Jankovski

Merge branch 'pages_example_url' into 'master'

Use the example.com domain for consistency



See merge request !87
parents c2b2e7c4 c54084f6
...@@ -28,7 +28,7 @@ As a user, you should normally be concerned only with the first three items. ...@@ -28,7 +28,7 @@ As a user, you should normally be concerned only with the first three items.
In general there are four kinds of pages one might create. This is better In general there are four kinds of pages one might create. This is better
explained with an example so let's make some assumptions. explained with an example so let's make some assumptions.
The domain under which the pages are hosted is named `gitlab.io`. There is a The domain under which the pages are hosted is named `example.com`. There is a
user with the username `walter` and they are the owner of an organization named user with the username `walter` and they are the owner of an organization named
`therug`. The personal project of `walter` is named `area51` and don't forget `therug`. The personal project of `walter` is named `area51` and don't forget
that the organization has also a project under its namespace, called that the organization has also a project under its namespace, called
...@@ -39,10 +39,10 @@ URL it will be accessible. ...@@ -39,10 +39,10 @@ URL it will be accessible.
| Pages type | Repository name | URL schema | | Pages type | Repository name | URL schema |
| ---------- | --------------- | ---------- | | ---------- | --------------- | ---------- |
| User page | `walter/walter.gitlab.io` | `https://walter.gitlab.io` | | User page | `walter/walter.example.com` | `https://walter.example.com` |
| Group page | `therug/therug.gitlab.io` | `https://therug.gitlab.io` | | Group page | `therug/therug.example.com` | `https://therug.example.com` |
| Specific project under a user's page | `walter/area51` | `https://walter.gitlab.io/area51` | | Specific project under a user's page | `walter/area51` | `https://walter.example.com/area51` |
| Specific project under a group's page | `therug/welovecats` | `https://therug.gitlab.io/welovecats` | | Specific project under a group's page | `therug/welovecats` | `https://therug.example.com/welovecats` |
## Enable the pages feature in your project ## Enable the pages feature in your project
......
...@@ -24,10 +24,10 @@ you need to add a [wildcard DNS A record][wiki-wildcard-dns] pointing to the ...@@ -24,10 +24,10 @@ you need to add a [wildcard DNS A record][wiki-wildcard-dns] pointing to the
host that GitLab runs. For example, an entry would look like this: host that GitLab runs. For example, an entry would look like this:
``` ```
*.gitlab.io. 60 IN A 1.2.3.4 *.example.com. 60 IN A 1.2.3.4
``` ```
where `gitlab.io` is the domain under which GitLab Pages will be served where `example.com` 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.
You should not use the GitLab domain to serve user pages. For more information You should not use the GitLab domain to serve user pages. For more information
...@@ -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: gitlab.io host: example.com
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 `gitlab.io`, replace your GitLab pages domain is `example.com`, replace
```bash ```bash
server_name ~^(?<group>.*)\.YOUR_GITLAB_PAGES\.DOMAIN$; server_name ~^(?<group>.*)\.YOUR_GITLAB_PAGES\.DOMAIN$;
...@@ -80,15 +80,15 @@ See the relevant documentation at <http://doc.gitlab.com/omnibus/settings/pages. ...@@ -80,15 +80,15 @@ See the relevant documentation at <http://doc.gitlab.com/omnibus/settings/pages.
with with
``` ```
server_name ~^(?<group>.*)\.gitlabpages\.com$; server_name ~^(?<group>.*)\.example\.com$;
``` ```
You must be extra careful to not remove the backslashes. If you are using You must be extra careful to not remove the backslashes. If you are using
a subdomain, make sure to escape all dots (`.`) with a backslash (\). a subdomain, make sure to escape all dots (`.`) with a backslash (\).
For example `pages.gitlab.io` would be: For example `pages.example.com` would be:
``` ```
server_name ~^(?<group>.*)\.pages\.gitlab\.io$; server_name ~^(?<group>.*)\.pages\.example\.com$;
``` ```
1. Restart Nginx and GitLab: 1. Restart Nginx and GitLab:
...@@ -115,7 +115,7 @@ required. ...@@ -115,7 +115,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: gitlab.io host: example.com
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
``` ```
......
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