Host the GitLab product documentation

DETAILS: Tier: Free, Premium, Ultimate Offering: Self-managed

If you are not able to access the GitLab product documentation at docs.gitlab.com, you can host the documentation yourself instead.

NOTE: The local help of your instance does not include all the docs (for example, it doesn't include docs for GitLab Runner or GitLab Operator), and it's not searchable or browsable. It's intended to only support direct links to specific pages from within a self-managed GitLab instance.

Documentation self-hosting options

To host the GitLab product documentation, you can use:

A Docker container
GitLab Pages
Your own web server

The following examples use GitLab 16.0, but make sure to use the version that corresponds to your GitLab instance.

Self-host the product documentation with Docker

The documentation website is served under the port 4000 inside the container. In the following example, we expose this on the host under the same port.

Make sure you either:

Allow port 4000 in your firewall.
Use a different port. In following examples, replace the leftmost 4000 with a different port number.

To run the GitLab product documentation website in a Docker container:

On the server where you host GitLab, or on any other server that your GitLab instance can communicate with:

If you use plain Docker, run:

docker run --detach --name gitlab_docs -it --rm -p 4000:4000 registry.gitlab.com/gitlab-org/gitlab-docs/archives:16.0

If you host your GitLab instance using Docker compose, add the following to your existing docker-compose.yaml:

version: '3.6'
services:
  gitlab_docs:
    image: registry.gitlab.com/gitlab-org/gitlab-docs/archives:16.0
    hostname: 'https://docs.gitlab.example.com:4000'
    ports:
      - '4000:4000'

Then, pull the changes:

docker-compose up -d

Visit http://0.0.0.0:4000 to view the documentation website and verify that it works.
Redirect the help links to the new documentation site.

Self-host the product documentation with GitLab Pages

You can use GitLab Pages to host the GitLab product documentation.

Prerequisites:

Ensure the Pages site URL does not use a subfolder. Because of the way the site is pre-compiled, the CSS and JavaScript files are relative to the main domain or subdomain. For example, URLs like https://example.com/docs/ are not supported.

To host the product documentation site with GitLab Pages:

Create a blank project.

Create a new or edit your existing .gitlab-ci.yml file, and add the following pages job, while ensuring the version is the same as your GitLab installation:

image: registry.gitlab.com/gitlab-org/gitlab-docs/archives:16.0
pages:
  script:
    - mkdir public
    - cp -a /usr/share/nginx/html/* public/
  artifacts:
    paths:
    - public

Optional. Set the GitLab Pages domain name. Depending on the type of the GitLab Pages website, you have two options:

Type of website Default domain Custom domain

Project website Not supported Supported

User or group website Supported Supported
Redirect the help links to the new documentation site.

Type of website	Default domain	Custom domain
Project website	Not supported	Supported
User or group website	Supported	Supported

Self-host the product documentation on your own web server

NOTE: The website you create must be hosted under a subdirectory that matches your installed GitLab version (for example, 16.0/). The Docker images use this version by default.

Because the product documentation site is static, you can take the contents of /usr/share/nginx/html from inside the container, and use your own web server to host the documentation wherever you want.

The html directory should be served as is and it has the following structure:

├── 16.0/
├── index.html

In this example:

16.0/ is the directory where the documentation is hosted.
index.html is a simple HTML file that redirects to the directory containing the documentation. In this case, 16.0/.

To extract the HTML files of the documentation site:

Create the container that holds the HTML files of the documentation website:

docker create -it --name gitlab_docs registry.gitlab.com/gitlab-org/gitlab-docs/archives:16.0

Copy the website under /srv/gitlab/:
```
docker cp gitlab-docs:/usr/share/nginx/html /srv/gitlab/
```
You end up with a /srv/gitlab/html/ directory that holds the documentation website.
Remove the container:
```
docker rm -f gitlab_docs
```
Point your web server to serve the contents of /srv/gitlab/html/.
Redirect the help links to the new documentation site.

Redirect the `/help` links to the new Docs site

After your local product documentation site is running, redirect the help links in the GitLab application to your local site, by using the fully qualified domain name as the documentation URL. For example, if you used the Docker method, enter http://0.0.0.0:4000.

You don't need to append the version. GitLab detects it and appends it to documentation URL requests as needed. For example, if your GitLab version is 16.0:

The GitLab documentation URL becomes http://0.0.0.0:4000/16.0/.
The link in GitLab displays as <instance_url>/help/administration/settings/help_page#destination-requirements.
When you select the link, you are redirected to http://0.0.0.0:4000/16.0/ee/administration/settings/help_page/#destination-requirements.

To test the setting, in GitLab, select a Learn more link. For example:

On the left sidebar, select your avatar.
Select Preferences.
In the Syntax highlighting theme section, select Learn more.

Upgrade the product documentation to a later version

Upgrading the documentation site to a later version requires downloading the newer Docker image tag.

Upgrade using Docker

To upgrade to a later version using Docker:

If you use Docker:

Stop the running container:
```
sudo docker stop gitlab_docs
```
Remove the existing container:
```
sudo docker rm gitlab_docs
```

Pull the new image. For example, 16.0:

docker run --detach --name gitlab_docs -it --rm -p 4000:4000 registry.gitlab.com/gitlab-org/gitlab-docs/archives:16.0

If you use Docker Compose:

Change the version in docker-compose.yaml, for example 16.0:

version: '3.6'
services:
  gitlab_docs:
    image: registry.gitlab.com/gitlab-org/gitlab-docs/archives:16.0
    hostname: 'https://docs.gitlab.example.com:4000'
    ports:
      - '4000:4000'

Pull the changes:
```
docker-compose up -d
```

Upgrade using GitLab Pages

To upgrade to a later version using GitLab Pages:

Edit your existing .gitlab-ci.yml file, and replace the image version number:
```
image: registry.gitlab.com/gitlab-org/gitlab-docs/archives:16.0
```
Commit the changes, push, and GitLab Pages pulls the new documentation site version.

Upgrade using your own web-server

To upgrade to a later version using your own web-server:

Copy the HTML files of the documentation site:

docker create -it --name gitlab_docs registry.gitlab.com/gitlab-org/gitlab-docs/archives:16.0
docker cp gitlab_docs:/usr/share/nginx/html /srv/gitlab/
docker rm -f gitlab_docs

Optional. Remove the old site:
```
rm -r /srv/gitlab/html/16.0/
```

Troubleshooting

Search does not work

Local search is included in versions 15.6 and later. If you're using an earlier version, the search doesn't work.

Those images are pushed to a separate repository in the container registry.

If you want to have a local search, make sure you use the Docker image the contains archives in its name, for example:

registry.gitlab.com/gitlab-org/gitlab-docs/archives:16.0

For more information, read about the different types of searches GitLab Docs are using.

The Docker image is not found

If you're using version 15.5 and earlier, you should drop /archives from the Docker image name.

For example:

registry.gitlab.com/gitlab-org/gitlab-docs:15.5