gitlab/nginx: Slapos'ify config and turn nginx into a service
[slapos.git] / software / gitlab / template / nginx-gitlab-http.conf.in
1 {{ autogenerated }}
2 # see:
3 # https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/files/gitlab-cookbooks/gitlab/templates/default/nginx-gitlab-http.conf.erb
4 # (last updated for omnibus-gitlab 8.2.3+ce.0-0-g8eda093)
5
6 {% from 'macrolib.cfg.in' import cfg, cfg_bool, cfg_https, fqdn  with context %}
7
8 ## GitLab
9 ## Modified from https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/support/nginx/gitlab-ssl & https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/support/nginx/gitlab
10 ##
11 ## Lines starting with two hashes (##) are comments with information.
12 ## Lines starting with one hash (#) are configuration parameters that can be uncommented.
13 ##
14 ##################################
15 ##        CHUNKED TRANSFER      ##
16 ##################################
17 ##
18 ## It is a known issue that Git-over-HTTP requires chunked transfer encoding [0]
19 ## which is not supported by Nginx < 1.3.9 [1]. As a result, pushing a large object
20 ## with Git (i.e. a single large file) can lead to a 411 error. In theory you can get
21 ## around this by tweaking this configuration file and either:
22 ## - installing an old version of Nginx with the chunkin module [2] compiled in, or
23 ## - using a newer version of Nginx.
24 ##
25 ## At the time of writing we do not know if either of these theoretical solutions works.
26 ## As a workaround users can use Git over SSH to push large files.
27 ##
28 ## [0] https://git.kernel.org/cgit/git/git.git/tree/Documentation/technical/http-protocol.txt#n99
29 ## [1] https://github.com/agentzh/chunkin-nginx-module#status
30 ## [2] https://github.com/agentzh/chunkin-nginx-module
31 ##
32 ###################################
33 ##         configuration         ##
34 ###################################
35
36 upstream gitlab {
37   server unix:{{ unicorn.socket }} fail_timeout=0;
38 }
39
40 upstream gitlab-workhorse {
41   server unix:{{ gitlab_workhorse.socket }};
42 }
43
44 {# not needed for us - the frontend can do the redirection and also
45    gitlab/nginx speaks HSTS on https port so when we access https port via http
46    protocol, it gets redirected to https
47 <% if @https && @redirect_http_to_https %>
48 ## Redirects all HTTP traffic to the HTTPS host
49 server {
50 <% @listen_addresses.each do |listen_address| %>
51   listen <%= listen_address %>:<%= @redirect_http_to_https_port %>;
52 <% end %>
53   server_name <%= @fqdn %>;
54   server_tokens off; ## Don't show the nginx version number, a security best practice
55   return 301 https://<%= @fqdn %>:<%= @port %>$request_uri;
56   access_log  <%= @log_directory %>/gitlab_access.log gitlab_access;
57   error_log   <%= @log_directory %>/gitlab_error.log;
58 }
59 <% end %>
60 #}
61
62 server {
63   listen [{{ backend_info.host }}]:{{ backend_info.port }}{% if cfg_https %} ssl spdy{% endif %};
64
65   {# we don't use: kerbeeros
66   <% if @kerberos_enabled && @kerberos_use_dedicated_port %>
67   listen <%= listen_address %>:<%= @kerberos_port %><% if @kerberos_https %> ssl<% end %>;
68   <% end %>
69   #}
70
71   server_name {{ fqdn }};
72   server_tokens off; ## Don't show the nginx version number, a security best practice
73   root {{ gitlab_work.location }}/public;
74
75   ## Increase this if you want to upload large attachments
76   ## Or if you want to accept large git objects over http
77   client_max_body_size {{ cfg('nginx_client_max_body_size') }};
78
79   {% if cfg_https %}
80   ## Strong SSL Security
81   ## https://raymii.org/s/tutorials/Strong_SSL_Security_On_nginx.html & https://cipherli.st/
82   ssl on;
83   ssl_certificate {{ nginx.cert_file }};
84   ssl_certificate_key {{ nginx.key_file }};
85   {# we don't need - most root CA will be included by default
86   <% if @ssl_client_certificate %>
87   ssl_client_certificate <%= @ssl_client_certificate%>;
88         <% end %>
89   #}
90
91   # GitLab needs backwards compatible ciphers to retain compatibility with Java IDEs
92   # NOTE(slapos) ^^^ is not relevant for us - we are behind frontend and clients
93   #     directly connects to frontend
94   ssl_ciphers '{{ cfg("nginx_ssl_ciphers") }}';
95   ssl_protocols  {{ cfg('nginx_ssl_protocols') }};
96   ssl_prefer_server_ciphers {{ cfg('nginx_ssl_prefer_server_ciphers') }};
97   ssl_session_cache  {{ cfg('nginx_ssl_session_cache') }};
98   ssl_session_timeout  {{ cfg('nginx_ssl_session_timeout') }};
99
100   {# we do not use: ssl_dhparam
101   <% if @ssl_dhparam %>
102   ssl_dhparam <%= @ssl_dhparam %>;
103   <% end %>
104   #}
105   {% endif %}
106
107   ## Individual nginx logs for this GitLab vhost
108   access_log  {{ nginx.log }}/gitlab_access.log gitlab_access;
109   error_log   {{ nginx.log }}/gitlab_error.log;
110
111   location / {
112     ## Serve static files from defined root folder.
113     ## @gitlab is a named location for the upstream fallback, see below.
114     try_files $uri /index.html $uri.html @gitlab;
115   }
116
117   location /uploads/ {
118     ## If you use HTTPS make sure you disable gzip compression
119     ## to be safe against BREACH attack.
120     {{ 'gzip off;' if cfg_https else ''}}
121
122     ## https://github.com/gitlabhq/gitlabhq/issues/694
123     ## Some requests take more than 30 seconds.
124     proxy_read_timeout      {{ cfg('nginx_proxy_read_timeout') }};
125     proxy_connect_timeout   {{ cfg('nginx_proxy_connect_timeout') }};
126     proxy_redirect          off;
127
128     proxy_set_header    Host                $http_host;
129     proxy_set_header    X-Real-IP           $remote_addr;
130     {% if cfg_https %}
131     proxy_set_header    X-Forwarded-Ssl     on;
132     {% endif %}
133     proxy_set_header    X-Forwarded-For     $proxy_add_x_forwarded_for;
134     proxy_set_header    X-Forwarded-Proto   {{ "https" if cfg_https else "http" }};
135     proxy_set_header    X-Frame-Options     SAMEORIGIN;
136
137     proxy_pass http://gitlab;
138   }
139
140   ## If a file, which is not found in the root folder is requested,
141   ## then the proxy passes the request to the upsteam (gitlab unicorn).
142   location @gitlab {
143     ## If you use HTTPS make sure you disable gzip compression
144     ## to be safe against BREACH attack.
145     {{ 'gzip off;' if cfg_https else ''}}
146
147     ## https://github.com/gitlabhq/gitlabhq/issues/694
148     ## Some requests take more than 30 seconds.
149     proxy_read_timeout      {{ cfg('nginx_proxy_read_timeout') }};
150     proxy_connect_timeout   {{ cfg('nginx_proxy_connect_timeout') }};
151     proxy_redirect          off;
152
153     proxy_set_header    Host                $http_host;
154     proxy_set_header    X-Real-IP           $remote_addr;
155     {% if cfg_https %}
156     proxy_set_header    X-Forwarded-Ssl     on;
157     {% endif %}
158     proxy_set_header    X-Forwarded-For     $proxy_add_x_forwarded_for;
159     proxy_set_header    X-Forwarded-Proto   {{ "https" if cfg_https else "http" }};
160     proxy_set_header    X-Frame-Options     SAMEORIGIN;
161
162     proxy_pass http://gitlab;
163   }
164
165   location ~ ^/[\w\.-]+/[\w\.-]+/gitlab-lfs/objects {
166     client_max_body_size 0;
167     # 'Error' 418 is a hack to re-use the @gitlab-workhorse block
168     error_page 418 = @gitlab-workhorse;
169     return 418;
170   }
171
172   location ~ ^/[\w\.-]+/[\w\.-]+/(info/refs|git-upload-pack|git-receive-pack)$ {
173     client_max_body_size 0;
174     # 'Error' 418 is a hack to re-use the @gitlab-workhorse block
175     error_page 418 = @gitlab-workhorse;
176     return 418;
177   }
178
179   location ~ ^/[\w\.-]+/[\w\.-]+/repository/archive {
180     client_max_body_size 0;
181     # 'Error' 418 is a hack to re-use the @gitlab-workhorse block
182     error_page 418 = @gitlab-workhorse;
183     return 418;
184   }
185
186   location ~ ^/api/v3/projects/.*/repository/archive {
187     client_max_body_size 0;
188     # 'Error' 418 is a hack to re-use the @gitlab-workhorse block
189     error_page 418 = @gitlab-workhorse;
190     return 418;
191   }
192
193   # Build artifacts should be submitted to this location
194   location ~ ^/[\w\.-]+/[\w\.-]+/builds/download {
195     client_max_body_size 0;
196     # 'Error' 418 is a hack to re-use the @gitlab-workhorse block
197     error_page 418 = @gitlab-workhorse;
198     return 418;
199   }
200
201   # Build artifacts should be submitted to this location
202   location ~ /ci/api/v1/builds/[0-9]+/artifacts {
203     client_max_body_size 0;
204     # 'Error' 418 is a hack to re-use the @gitlab-workhorse block
205     error_page 418 = @gitlab-workhorse;
206     return 418;
207   }
208
209   location @gitlab-workhorse {
210     client_max_body_size 0;
211     ## If you use HTTPS make sure you disable gzip compression
212     ## to be safe against BREACH attack.
213     {{ 'gzip off;' if cfg_https else ''}}
214
215     ## https://github.com/gitlabhq/gitlabhq/issues/694
216     ## Some requests take more than 30 seconds.
217     proxy_read_timeout      {{ cfg('nginx_proxy_read_timeout') }};
218     proxy_connect_timeout   {{ cfg('nginx_proxy_connect_timeout') }};
219     proxy_redirect          off;
220
221     proxy_set_header    Host                $http_host;
222     proxy_set_header    X-Real-IP           $remote_addr;
223     {% if cfg_https %}
224     proxy_set_header    X-Forwarded-Ssl     on;
225     {% endif %}
226     proxy_set_header    X-Forwarded-For     $proxy_add_x_forwarded_for;
227     proxy_set_header    X-Forwarded-Proto   {{ "https" if cfg_https else "http" }};
228
229     proxy_pass http://gitlab-workhorse;
230   }
231
232   ## Enable gzip compression as per rails guide:
233   ## http://guides.rubyonrails.org/asset_pipeline.html#gzip-compression
234   ## WARNING: If you are using relative urls remove the block below
235   ## See config/application.rb under "Relative url support" for the list of
236   ## other files that need to be changed for relative url support
237   location ~ ^/(assets)/ {
238     root {{ gitlab_work.location }}/public;
239     gzip_static on; # to serve pre-gzipped version
240     expires max;
241     add_header Cache-Control public;
242   }
243
244
245   error_page 502 /502.html;
246
247   {# we don't support custom nginx configs
248   <%= @custom_gitlab_server_config %>
249   #}
250 }