gitlab-org--gitlab-foss/docker
Sytse Sijbrandij c505eda3e8 Merge branch 'master' of gitlab.com:gitlab-org/gitlab-ce 2015-04-27 23:10:10 -07:00
..
assets Separate Dockerfile for Data and Application 2015-03-20 20:03:14 +01:00
data Separate Dockerfile for Data and Application 2015-03-20 20:03:14 +01:00
.dockerignore Gracefully shutdown services in Docker container 2015-02-24 19:20:57 +08:00
Dockerfile Upgrade Docker build to v7.10.0 2015-04-27 13:24:24 +00:00
README.md Add more instuctions on how to publish docker images yourself. 2015-04-27 23:09:03 -07:00
troubleshooting.md Move commands to the readme, rename gitlab to gitlab_app, add PostgreSQL tweaks to gitlab.rb. 2014-12-03 12:41:47 +01:00

README.md

What is GitLab?

GitLab offers git repository management, code reviews, issue tracking, activity feeds, wikis. It has LDAP/AD integration, handles 25,000 users on a single server but can also run on a highly available active/active cluster. A subscription gives you access to our support team and to GitLab Enterprise Edition that contains extra features aimed at larger organizations.

Learn more on https://about.gitlab.com

How to build and use images yourself

At this moment GitLab doesn't have official Docker images. There are unofficial images at the bottom of this document. But in this section we'll build our own. For convinience we will use suffix _xy where xy is current version of GitLab. Build your own based on the Omnibus packages with the following commands. Run these from the GitLab repo root directory. People using boot2docker should run it without sudo.

sudo docker build --tag gitlab_data_image docker/data/
sudo docker build --tag gitlab_app_image_xy docker/

We assume using a data volume container, this will simplify migrations and backups. This empty container will exist to persist as volumes the 3 directories used by GitLab, so remember not to delete it.

The directories on data container are:

  • /var/opt/gitlab for application data
  • /var/log/gitlab for logs
  • /etc/gitlab for configuration

Create the data container with:

sudo docker run --name gitlab_data gitlab_data_image /bin/true

After creating data container run GitLab container:

sudo docker run --detach --name gitlab_app_xy --publish 8080:80 --publish 2222:22 --volumes-from gitlab_data gitlab_app_image_xy

It might take a while before the docker container is responding to queries. You can follow the configuration process with sudo docker logs -f gitlab_app_xy.

You can then go to http://localhost:8080/ or http://192.168.59.103:8080/ if you use boot2docker.

You can login with username root and password 5iveL!fe. Next time, you can just use sudo docker start gitlab_app and sudo docker stop gitlab_app.

How to configure GitLab

This container uses the official Omnibus GitLab distribution, so all configuration is done in the unique configuration file /etc/gitlab/gitlab.rb.

To access GitLab configuration, you can start an interactive command line in a new container using the shared data volume container, you will be able to browse the 3 directories and use your favorite text editor:

sudo docker run -ti -e TERM=linux --rm --volumes-from gitlab_data ubuntu
vi /etc/gitlab/gitlab.rb

Note that GitLab will reconfigure itself at each container start. You will need to restart the container to reconfigure your GitLab.

You can find all available options in Omnibus GitLab documentation.

How to upgrade GitLab

To updgrade GitLab to new versions, stop running container, create new docker image and container from that image.

It Assumes that you're upgrading from 7.8 to 7.9 and you're in the updated GitLab repo root directory:

sudo docker stop gitlab_app_78
sudo docker build --tag gitlab_app_image_79 docker/
sudo docker run --detach --name gitlab_app_79 --publish 8080:80 --publish 2222:22 --volumes-from gitlab_data gitlab_app_image_79

On the first run GitLab will reconfigure and update itself. If everything runs OK don't forget to cleanup old container and image:

sudo docker rm gitlab_app_78
sudo docker rmi gitlab_app_image_78

Troubleshooting

Please see the troubleshooting file in this directory.

Publish the images to Dockerhub

Login to Dockerhub with sudo docker login and run the following (replace '7.9.2' with the version you're using and 'Sytse Sijbrandij' with your name):

sudo docker commit -m "Initial commit" -a "Sytse Sijbrandij" gitlab_app_xy sytse/gitlab-ce:7.9.2
sudo docker push sytse/gitlab-ce:7.9.2
sudo docker commit -m "Initial commit" -a "Sytse Sijbrandij" gitlab_data sytse/gitlab_data
sudo docker push sytse/gitlab_data

Use images published to Dockerhub

This examples uses the unofficial images made by GitLab CEO Sytse.

sudo docker pull sytse/gitlab_data
sudo docker pull sytse/gitlab-ce:7.9.2
sudo docker run --name gitlab_data_volume sytse/gitlab_data /bin/true
sudo docker run --detach --name gitlab_app_7_9_2 --publish 8080:80 --publish 2222:22 --volumes-from gitlab_data_volume sytse/gitlab-ce:7.9.2