Skip to content

Commit

Permalink
docs[Op#53021]: Add some documentation for running the gitlab docker …
Browse files Browse the repository at this point in the history
…service
  • Loading branch information
akabiru committed Feb 27, 2024
1 parent cc4b0ed commit 0623dbc
Showing 1 changed file with 34 additions and 2 deletions.
36 changes: 34 additions & 2 deletions docs/development/development-environment-docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ cp docker-compose.override.example.yml docker-compose.override.yml
# and will install all required server dependencies
docker compose run --rm backend setup

# This will install the web dependencies
# This will install the web dependencies
docker compose run --rm frontend npm install
```

Expand Down Expand Up @@ -307,7 +307,7 @@ On Debian, you need to add the generated root CA to system certificates bundle.
docker compose --project-directory docker/dev/tls cp \
step:/home/step/certs/root_ca.crt /usr/local/share/ca-certificates/OpenProject_Development_Root_CA.crt

# Create symbolic link
# Create symbolic link
ln -s /usr/local/share/ca-certificates/OpenProject_Development_Root_CA.crt /etc/ssl/certs/OpenProject_Development_Root_CA.pem

# Update certificate bundle
Expand Down Expand Up @@ -394,6 +394,38 @@ docker compose --project-directory docker/dev/tls down
docker compose --project-directory docker/dev/tls up -d
```

## GitLab CE Service

Within `docker/dev/gitlab` a compose file is provided for running local Gitlab instance with TLS support. The provides
a production like environment for testing the OpenProject GitLab integration against a community edition gitlab instance
accessible on `https://gitlab.local`.

> NOTE: Configure [TLS Support](#tls-support) first before starting the GitLab service
See [Install GitLab using Docker Compose](https://docs.gitlab.com/ee/install/docker.html#install-gitlab-using-docker-compose)
official GitLab documentation.

### Running the GitLab Instance

Start up the docker compose service for gitlab as follows:

```shell
docker compose --project-directory docker/dev/gitlab up -d
```

### Initial password

Once the GitLab service is started and running, you can access the initial `root` user password as follows:

```shell
docker compose --project-directory docker/dev/gitlab exec -it gitlab grep 'Password:' /etc/gitlab/initial_root_password
```

Within `docker/dev/gitlab` compose files are provided, that elevate the development stack to be run under full TLS
encryption. This simulates much more accurately production environments, and it allows you to connect other services
into your development stack. This needs a couple of steps of more setup complexity, so you should only proceed, if you
really need or want it.

## Local files

Running the docker images will change some of your local files in the mounted code directory. The
Expand Down

0 comments on commit 0623dbc

Please sign in to comment.