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
dbfde1d0
Commit
dbfde1d0
authored
Feb 24, 2016
by
Achilleas Pipinellis
Committed by
James Edwards-Jones
Jan 31, 2017
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add requirements section
parent
bcf89171
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
24 additions
and
22 deletions
+24
-22
doc/pages/README.md
doc/pages/README.md
+24
-22
No files found.
doc/pages/README.md
View file @
dbfde1d0
...
...
@@ -19,6 +19,7 @@ deploy static pages for your individual projects, your user or your group.
**Table of Contents**
*generated with [DocToc](https://github.com/thlorenz/doctoc)*
-
[
Getting started with GitLab Pages
](
#getting-started-with-gitlab-pages
)
-
[
GitLab Pages requirements
](
#gitlab-pages-requirements
)
-
[
GitLab pages per user
](
#gitlab-pages-per-user
)
-
[
GitLab pages per group
](
#gitlab-pages-per-group
)
-
[
GitLab pages per project
](
#gitlab-pages-per-project
)
...
...
@@ -36,39 +37,40 @@ deploy static pages for your individual projects, your user or your group.
## Getting started with GitLab Pages
GitLab Pages rely heavily on GitLab CI and its ability to upload artifacts.
The steps that are performed from the initialization of a project to the
creation of the static content, can be summed up to:
1.
Find out the general domain name that is used for GitLab Pages
(ask your administrator). This is very important, so you should first make
sure you get that right.
1.
Create a project (its name should be specific according to the case)
1.
Provide a specific job named
`pages`
in
`.gitlab-ci.yml`
1.
GitLab Runner builds the project
1.
GitLab CI uploads the artifacts
1.
The
[
GitLab Pages daemon
][
pages-daemon
]
serves the content
As a user, you should normally be concerned only with the first three or four
items. If
[
shared runners
](
../ci/runners/README.md
)
are enabled by your GitLab
administrator, you should be able to use them instead of bringing your own.
> **Note:**
> In the rest of this document we will assume that the general domain name that
> is used for GitLab Pages is `example.io`.
GitLab Pages rely heavily on GitLab CI and its ability to upload
[
artifacts
](
../ci/yaml/README.md#artifacts
)
.
In general there are two kinds of pages one might create:
-
Pages per user/group
-
Pages per project
-
Pages per user/group
(
`username.example.io`
)
-
Pages per project
(
`username.example.io/projectname`
)
In GitLab, usernames and groupnames are unique and often people refer to them
as namespaces. There can be only one namespace in a GitLab instance.
> **Note:**
> In the rest of this document we will assume that the general domain name that
> is used for GitLab Pages is `example.io`.
> **Warning:**
> There are some known [limitations](#limitations) regarding namespaces served
> under the general domain name and HTTPS. Make sure to read that section.
### GitLab Pages requirements
In brief, this is what you need to upload your website in GitLab Pages:
1.
Find out the general domain name that is used for GitLab Pages
(ask your administrator). This is very important, so you should first make
sure you get that right.
1.
Create a project
1.
Provide a specific job named
[
`pages`
](
../ci/yaml/README.md#pages
)
in
[
`.gitlab-ci.yml`
](
../ci/yaml/README.md
)
1.
A GitLab Runner to build GitLab Pages
If
[
shared runners
](
../ci/runners/README.md
)
are enabled by your GitLab
administrator, you should be able to use them instead of bringing your own.
### GitLab pages per user
Head over your GitLab instance that supports GitLab Pages and create a
...
...
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