diff options
| author | Sytse Sijbrandij <sytse@gitlab.com> | 2014-11-27 14:59:33 +0000 |
|---|---|---|
| committer | Sytse Sijbrandij <sytse@gitlab.com> | 2014-11-27 14:59:33 +0000 |
| commit | 426a03039445b8befa631343ad2375441c89480f (patch) | |
| tree | bd78db3bc654405b82b3403e9d0b96485cf499d2 /docker/README.md | |
| parent | b70cee9c2fde878d77b1540c31e7560ea9f97460 (diff) | |
| parent | 0dcc1e88a4a9a1fe4745421474fcb3e93bfb87ef (diff) | |
| download | gitlab-ce-426a03039445b8befa631343ad2375441c89480f.tar.gz | |
Merge branch 'master' into 'master'
Add Dockerfile to build an Omnibus GitLab image
See merge request !244
Diffstat (limited to 'docker/README.md')
| -rw-r--r-- | docker/README.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/docker/README.md b/docker/README.md new file mode 100644 index 00000000000..ca56a9b35a4 --- /dev/null +++ b/docker/README.md @@ -0,0 +1,42 @@ +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. + +<https://about.gitlab.com> + + + + +How to use this image. +====================== + +I recommend creating a data volume container first, this will simplify migrations and backups: + + docker run --name gitlab_data genezys/gitlab:7.5.1 /bin/true + +This empty container will exist to persist as volumes the 3 directories used by GitLab, so remember not to delete it: + +- `/var/opt/gitlab` for application data +- `/var/log/gitlab` for logs +- `/etc/gitlab` for configuration + +Then run GitLab: + + docker run --detach --name gitlab --publish 8080:80 --publish 2222:22 --volumes-from gitlab_data genezys/gitlab:7.5.1 + +You can then go to `http://localhost:8080/` (or most likely `http://192.168.59.103:8080/` if you use boot2docker). Next time, you can just use `docker start gitlab` and `docker stop gitlab`. + + +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 a new container using the shared data volume container: + + docker run -ti --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 [GitLab documentation](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/README.md#configuration). |
