GitLabのOmnibusEdition(?)ではデフォルトでnginxがバンドルされており、特に設定しなければそのnginxが自動で使用されます。

私ね。これ、知りませんでした。バンドルされているのは知っていたのですが設定で有効にするものだと思っていました。まさかデフォルトで使用されるようになっているとは…。なんてお節介だ…。

環境


  • GitLab Omnibus 10.6.0 (Dockerを使用)
  • nginx 1.12.2

上記でやってます。今回GitLabはDockerを使っていますが直接インストールした場合でも基本は変わらないはずです。

構成


次のような構成にします。

  • GitLabのバンドルnginxは無効にする
  • nginxのバーチャルホストで指定したドメインへのアクセスをGitLabに振り分ける
  • nginxとGitLabはunixソケット通信する

unicorn(GitLabが使用しているアプリサーバ)に振り分ける方法も試してみたのですが、エラーが出たのとあまり時間がとれなかったためソケット通信でやりました。ちゃんとやればunicornのポートに振り分けることもできると思います。

GitLabの設定


基本的に下記のドキュメントの「Using a non-bundled web-server」の項目を参考にしながらやります。

NGINX settings

以下はすべて設定ファイルgitlab.rbで行います。設定ファイル内で該当する箇所を探して変更します。また、ドメインはご自身のものに置き換えてください。

外部URL設定

external_urlにドメインを設定します。

1
external_url 'https://gitlab.example.com'

外部nginx設定

GitLabにバンドルされているnginxの設定を無効にします。

1
nginx['enable'] = false

今回使用するnginx(GitLabにバンドルされていないもの)のユーザを指定します。これはwww-dataだったりする場合もあるので、使ってるnginxで確認してください。

1
web_server['external_users'] = ['nginx']
2
web_server['username'] = 'nginx'

信頼できるプロキシ設定

同一ネットワークであれば設定は不要なのですが、今回のようにDockerで動かしている場合などは必要なようです。Dockerの場合はデフォルトで172.17.0.0/16のネットワークなのでそれを指定します。

1
gitlab_rails['trusted_proxies'] = ['172.17.0.0/16']

設定反映

GitLab側はこれで完了ですのでgitlab-ctl reconfigureで設定反映させます。Dokcerの場合はコンテナ再起動でも構いません。

nginx


nginxですがこちらの公式のサンプルを参考にしました。だいたい下記のような感じになるのではないかと思います。暗号化のところはあんまり詳しくないので要件に合わせて設定してください。

1
upstream gitlab-workhorse {
2
  # ソケットファイルの場所を指定
3
  server unix:/var/opt/gitlab/data/gitlab-workhorse/socket fail_timeout=0;
4
}
5
6
# httpの場合はhttpsにリダイレクトさせる
7
server {
8
    listen       80;
9
    server_name  gitlab.example.com;
10
    return       301 https://$host$request_uri;
11
}
12
13
server {
14
    listen                        0.0.0.0:443 ssl http2;
15
    listen                        [::]:443;
16
    server_name                   gitlab.example.com;
17
    ssl                           on;
18
    ssl_certificate               ${ssl.pem};
19
    ssl_certificate_key           ${ssl.key};
20
    ssl_protocols                 TLSv1.1 TLSv1.2;
21
    ssl_ciphers                   'ECDH !aNULL !eNULL !SSLv2 !SSLv3';
22
    ssl_prefer_server_ciphers     on;
23
24
    access_log /var/log/nginx/gitlab_access.log;
25
    error_log /var/log/nginx/gitlab_error.log;
26
27
    location / {
28
        proxy_set_header    Host                $http_host;
29
        proxy_set_header    X-Real-IP           $remote_addr;
30
        proxy_set_header    X-Forwarded-Ssl     on;
31
        proxy_set_header    X-Forwarded-For     $proxy_add_x_forwarded_for;
32
        proxy_set_header    X-Forwarded-Proto   $scheme;
33
        proxy_set_header    X-CSRF-Token        $http_x_csrf_token;
34
        proxy_redirect      off;
35
        proxy_set_header    X-Frame-Options     SAMEORIGIN;
36
        proxy_pass          http://gitlab-workhorse;
37
    }
38
}

ソケットのパーミッション

前述のGitLabのドキュメントにも記載されているのですが、ソケットとそのディレクトリの所有者がnginxでないとパーミッションエラーで接続できない(502 Bad Gateway)になります。

また、Dockerの場合のみの問題かもしれませんが、所有者がコンテナの起動毎にもとに戻ってしまうんですね。困った…。仕方ないので、起動後に所有者を変更するスクリプトを書きました。

1
#!/bin/sh
2
3
docker-compose up -d
4
sleep 120
5
chown nginx:nginx /ソケットのディレクトリ
6
chown nginx:nginx /ソケットのディレクトリ/socket

docker-compose upの後にGitLabが起動完了しそうな時間だけ待って、所有者を変更しているだけです。

ダメな場合は?


nginxのエラーログをみながら、nginx側の問題なのかGitLab側の問題なのか切り分けて少しづつ設定を変えて確認していきます。