summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorKamil Trzcinski <ayufan@ayufan.eu>2015-11-03 21:28:07 +0100
committerJames Edwards-Jones <jedwardsjones@gitlab.com>2017-01-31 22:50:39 +0000
commit120f9abaa15ce0feec1dc457ad3dc3787e4fbfc6 (patch)
tree4bb8bf5f7e47613ea967555e01fc2c7e27e994c6 /doc
parent659cceb0e8694b58a8b665de3f338245244ef114 (diff)
downloadgitlab-ce-120f9abaa15ce0feec1dc457ad3dc3787e4fbfc6.tar.gz
Add GitLab Pages
- The pages are created when build artifacts for `pages` job are uploaded - Pages serve the content under: http://group.pages.domain.com/project - Pages can be used to serve the group page, special project named as host: group.pages.domain.com - User can provide own 403 and 404 error pages by creating 403.html and 404.html in group page project - Pages can be explicitly removed from the project by clicking Remove Pages in Project Settings - The size of pages is limited by Application Setting: max pages size, which limits the maximum size of unpacked archive (default: 100MB) - 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 needs to be explicitly enabled and domain needs to be specified in gitlab.yml - Pages are part of backups - Pages notify the deployment status using Commit Status API - Pages use a new sidekiq queue: pages - Pages use a separate nginx config which needs to be explicitly added
Diffstat (limited to 'doc')
-rw-r--r--doc/README.md1
-rw-r--r--doc/install/installation.md13
-rw-r--r--doc/pages/README.md12
3 files changed, 26 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md
index 909740211a6..f036febb7b9 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -12,6 +12,7 @@
- [GitLab as OAuth2 authentication service provider](integration/oauth_provider.md). It allows you to login to other applications from GitLab.
- [Container Registry](user/project/container_registry.md) Learn how to use GitLab Container Registry.
- [GitLab basics](gitlab-basics/README.md) Find step by step how to start working on your commandline and on GitLab.
+- [GitLab Pages](pages/README.md) Using GitLab Pages.
- [Importing to GitLab](workflow/importing/README.md) Import your projects from GitHub, Bitbucket, GitLab.com, FogBugz and SVN into GitLab.
- [Importing and exporting projects between instances](user/project/settings/import_export.md).
- [Markdown](user/markdown.md) GitLab's advanced formatting system.
diff --git a/doc/install/installation.md b/doc/install/installation.md
index 425c5d93efb..c78e469055d 100644
--- a/doc/install/installation.md
+++ b/doc/install/installation.md
@@ -313,6 +313,9 @@ sudo usermod -aG redis git
# Change the permissions of the directory where CI artifacts are stored
sudo chmod -R u+rwX shared/artifacts/
+ # Change the permissions of the directory where CI artifacts are stored
+ sudo chmod -R ug+rwX shared/pages/
+
# Copy the example Unicorn config
sudo -u git -H cp config/unicorn.rb.example config/unicorn.rb
@@ -484,6 +487,16 @@ Make sure to edit the config file to match your setup. Also, ensure that you mat
# or else sudo rm -f /etc/nginx/sites-enabled/default
sudo editor /etc/nginx/sites-available/gitlab
+Copy the GitLab pages site config:
+
+ sudo cp lib/support/nginx/gitlab-pages /etc/nginx/sites-available/gitlab-pages
+ sudo ln -s /etc/nginx/sites-available/gitlab-pages /etc/nginx/sites-enabled/gitlab-pages
+
+ # Change YOUR_GITLAB_PAGES\.DOMAIN to the fully-qualified
+ # domain name under which the pages will be served.
+ # The . (dot) replace with \. (backslash+dot)
+ sudo editor /etc/nginx/sites-available/gitlab-pages
+
**Note:** If you want to use HTTPS, replace the `gitlab` Nginx config with `gitlab-ssl`. See [Using HTTPS](#using-https) for HTTPS configuration details.
### Test Configuration
diff --git a/doc/pages/README.md b/doc/pages/README.md
new file mode 100644
index 00000000000..d08c34c3ebc
--- /dev/null
+++ b/doc/pages/README.md
@@ -0,0 +1,12 @@
+# GitLab Pages
+
+To start using GitLab Pages add to your project .gitlab-ci.yml with special pages job.
+
+ pages:
+ image: jekyll
+ script: jekyll build
+ artifacts:
+ paths:
+ - public
+
+TODO