Commit f9109d0e authored by Achilleas Pipinellis's avatar Achilleas Pipinellis Committed by Kamil Trzcinski

GitLab Pages admin guide clean up [ci skip]

- Fix markdown
- Remove how it works section, maybe add it at a later point
parent 059624f8
......@@ -45,8 +45,7 @@ See the relevant documentation at <http://doc.gitlab.com/omnibus/settings/pages.
cd /home/git/gitlab
```
1. Edit `gitlab.yml` and under the `pages` setting, set `enabled` to `true` in
order to enable the pages feature:
1. Edit `gitlab.yml` and under the `pages` setting, set `enabled` to `true`:
```bash
## GitLab Pages
......@@ -70,8 +69,8 @@ See the relevant documentation at <http://doc.gitlab.com/omnibus/settings/pages.
sudo ln -sf /etc/nginx/sites-{available,enabled}/gitlab-pages.conf
```
Don't forget to add your domain name in the Nginx config. For example if your
GitLab pages domain is `gitlabpages.com`, replace
Don't forget to add your domain name in the Nginx config. For example if
your GitLab pages domain is `gitlabpages.com`, replace
```bash
server_name ~^(?<group>.*)\.YOUR_GITLAB_PAGES\.DOMAIN$;
......@@ -113,14 +112,14 @@ required.
port: 443 # Set to 443 if you serve the pages with HTTPS
https: true # Set to true if you serve the pages with HTTPS
```
1. Use the `gitlab-pages-ssl` Nginx configuration file
1. Copy the `gitlab-pages-ssl` Nginx configuration file:
```bash
sudo cp lib/support/nginx/gitlab-pages-ssl /etc/nginx/sites-available/gitlab-pages-ssl.conf
sudo ln -sf /etc/nginx/sites-{available,enabled}/gitlab-pages.conf
```
Make sure to edit the config and 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.
## Set maximum pages size
......@@ -129,18 +128,14 @@ The maximum size of the unpacked archive can be configured in the Admin area
under the Application settings in the **Maximum size of pages (MB)**.
The default is 100MB.
## Security
## Backup
You should strongly consider running GitLab pages under a different hostname
than GitLab to prevent XSS.
Pages are part of the regular backup so there is nothing to configure.
## How it works
## Security
- The public/ is extracted from artifacts and content is served as static pages
- Pages asynchronous worker use `dd` to limit the unpacked tar size
- Pages are part of backups
- Pages notify the deployment status using Commit Status API
- Pages use a new sidekiq queue: pages
You should strongly consider running GitLab pages under a different hostname
than GitLab to prevent XSS attacks.
[ee-80]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/80
[wiki-wildcard-dns]: https://en.wikipedia.org/wiki/Wildcard_DNS_record
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