This page describes GitLab, which is a software for Git repository management and software development that can run on your own server.
Major GitLab features are depicted in this article on techdo.me.
- User management.
- SSH key management for accessing a repo via SSH and mapping to GUI user.
- Repository/project permissions (private, protected or public). Users and groups.
- View commits.
- Issue tracking.
- Markdown support.
- Branches and tags can be created in GUI.
- Merge requests. Code review.
- New files can be created and in the GUI.
- Files can be edited in the GUI.
- A wiki per project (in separate Git repo).
- Visualization of commits, branches, etc.
Access to repositories
The GitLab GUI always shows the links you need to use for accessing (cloning) the Git repositories either via HTTP or SSH.
Example URLs for project/repository:
SSH access on port 22:
- Note: The repo must be addressed with a absolute path (do not use ":" between hostname and pathname)
The corresponding clone commands are:
git clone http://gitlab.example.com/group1/project1.git git clone ssh://email@example.com/group1/project1.git
- For HTTP you need to authenticate with your GitLab user credentials, if it's not a public repo.
- It's recommended using SSH for accessing the repositories with a Git client.
- The SSH connect must go directly to the host GitLab has been installed on (no proxy in between).
- For SSH you need to always login as user git. The user mapping will be made via your SSH key(s).
- For SSH you need to authenticate with a SSH private key matching the public key you need to register in your GitLab user profile.
- The SSH keys must be unique. You can't add a public key to multiple user profiles. The keys are added to ~git/.ssh/authorized_keys.
- For SSH you need to take care using the correct SSH key, e.g. just add following to ~/.ssh/config:
Host gitlab.example.com IdentityFile ~/.ssh/id_rsa_emptypass StrictHostKeyChecking no UserKnownHostsFile /dev/null
- For SSH you can check the general SSH access and authentication by just connecting to the server with a native SSH client. In addition, your GitLab user mapping will be responded by the server as e.g. Welcome to GitLab, Peter Pan!. A successful connect (using SSH port forwarding) looks like:
> ssh firstname.lastname@example.org X11 forwarding request failed on channel 0 PTY allocation request failed on channel 0 Welcome to GitLab, Peter Pan! Connection to gitlab.example.com closed.
See Operations for info about installing and maintaining GitLab.
See hub.docker.com for running GitLab as Docker container.
Creating the container:
docker run --detach \ --hostname gitlab.example.com \ --publish 9443:9443 --publish 9080:9080 --publish 9022:22 \ --name gitlab \ --restart always \ --volume /srv/gitlab/config:/etc/gitlab \ --volume /srv/gitlab/logs:/var/log/gitlab \ --volume /srv/gitlab/data:/var/opt/gitlab \ gitlab/gitlab-ce:latest
GitLab configuration gitlab.rb:
external_url 'https://gitlab.example.com:9443' nginx['ssl_certificate']= "/etc/gitlab/ssl/fullchain.pem" nginx['ssl_certificate_key'] = "/etc/gitlab/ssl/privkey.pem" gitlab_rails['gitlab_shell_ssh_port'] = 9022 gitlab_rails['gitlab_email_from'] = 'email@example.com' gitlab_rails['gitlab_email_display_name'] = 'GitLab example.com' gitlab_rails['gitlab_email_reply_to'] = 'firstname.lastname@example.org' gitlab_rails['smtp_enable'] = true gitlab_rails['smtp_address'] = "mail.example.com" gitlab_rails['smtp_port'] = 587 gitlab_rails['smtp_user_name'] = "user" gitlab_rails['smtp_password'] = "pass" gitlab_rails['smtp_domain'] = "mail.example.com" gitlab_rails['smtp_authentication'] = "plain" gitlab_rails['smtp_enable_starttls_auto'] = true
Notes about running GitLab on a Docker host with Port 80, 443 and 22 already occupied:
- GitLab must be configured to set the external ports like 9443 and/or 9080. Once you set "external_url 'https://gitlab.example.com:9443'", nginx will listen on port 9443.
- Setting the SSH port
gitlab_rails['gitlab_shell_ssh_port'] = 9022
- does only work when the port forwarding from Docker is e.g. 9022->22. 9022->9022 did not work for me.
- All these HTTP/HTTPS and SSH configured are used as ports in the GitLab user interface, e.g. in the clone URL.
- You can/should create virtual webservers on the Docker host serving port 443 and 80 and redirecting both the the external GitLab URL.
- For TLS with Let's Encrypt see TLS.
docker stop gitlab docker rm gitlab docker pull gitlab/gitlab-ce:latest docker run ...
docker logs gitlab docker exec -it gitlab bash
The GitLab GUI has an excellent online help available at
A feature board respective product backlog with a workflow for requirement engineering could look like:
- new requirement
- business analysis
- technical analysis
- ready for development
- in progress
- in qa
- ready for production
- on production
This feature boards looks like following:
Literature and Tutorials
- GitLab Cookbook
- c't 13/16 S.134
- Video Tutorial: Idea to Production on Google Container Engine (GKE)
- Continuous Integration (CI) mit Docker und GitLab: siehe LM 01/18 S.58
- Testen von HTTP Requests, z.B. für den Empfang von Webhooks bei Git/GitLab.
- Siehe "GitLab Cookbook" S.113 - Using webhooks.
- RequestBin gives you a URL that will collect requests made to it and let you inspect them in a human-friendly way. Use RequestBin to see what your HTTP client is sending or to inspect and debug webhook requests.
- REST Client, Testen von APIs
- Chrome Browser Extension
- Sendet HTTP Request zu einem Server, auch mit Parameter/Value Variablen von simulierten Formularen
- Siehe "GitLab Cookbook" S.121 - Managing your projects via the API.
GitLab official sites:
- GitLab Homepage
- GitLab Community Forum, see also this blog post.
- Chatroom on Gitter
- GitLab Community Edition
- GitLab Community Edition Documentation
- GitLab Community Edition Update
- GitLab Architecture Overview
- GitLab repository on GitLab
- GitLab repository on GitHub
- GitLab Flow
- Installing GitLab in your local network or your own PC and setting it up to work perfectly, with a guide to change SMTP settings
- Archlinux Wiki
- GitLab as an Alternative Development Platform for Github.com (LinuxCon Europe 2014)
Using under openSUSE:
- GitLab CI Doc
- Continuous Integration of GitLab-Hosted Docker Projects with Quay.io (gitlab.com)
- Getting Started With GitLab and GitLab CI
- GitLab Continuous Integration (pro-linux.de)
Agile Software Development:
- How to use GitLab for Agile software development (i.e. Issue Board = Product Backlog, Milestone = Sprint, etc.)