Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Boxiang Sun
gitlab-ce
Commits
0f2274cc
Commit
0f2274cc
authored
Dec 17, 2015
by
Achilleas Pipinellis
Committed by
James Edwards-Jones
Jan 31, 2017
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
First draft of pages documentation
parent
35dd2e12
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
55 additions
and
8 deletions
+55
-8
doc/pages/README.md
doc/pages/README.md
+55
-8
No files found.
doc/pages/README.md
View file @
0f2274cc
# GitLab Pages
# GitLab Pages
To start using GitLab Pages add to your project .gitlab-ci.yml with special pages job.
_**Note:** This feature was introduced in GitLab EE 8.3_
pages:
To start using GitLab Pages add to your project
`.gitlab-ci.yml`
the special
`pages`
job. The example below is using
[
jekyll
][]
and assumes the created
HTML files are generated under the
`public/`
directory which resides under the
root directory of your Git repository.
```
yaml
pages
:
image
:
jekyll
image
:
jekyll
script
:
jekyll build
script
:
jekyll build
artifacts
:
artifacts
:
paths
:
paths
:
-
public
-
public
```
-
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
## Examples
-
Add example with stages.
`test`
using a linter tool,
`deploy`
in
`pages`
-
Add examples of more static tool generators
```
yaml
image
:
jekyll
stages
:
-
test
-
deploy
lint
:
script
:
jekyll build
stage
:
test
pages
:
script
:
jekyll build
stage
:
deploy
artifacts
:
paths
:
-
public
```
## Current limitations
TODO
-
We currently support only http and port 80. It will be extended in the future.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment