Configure a Reverse Proxy

    Your query search resulted in no results.

    Configure a reverse proxy server to use with GoCD server

    It is sometimes useful to front GoCD with a proxy server. In this section, we give you some tips and examples on how to achieve this.

    GoCD with Apache

    An example of how to configure GoCD with Apache is shown below.

    Assumptions:

    • You have Apache with mod_proxy installed
    • The Apache server sits on the same machine as the GoCD server (localhost)
    Listen nnn.nnn.nnn.nnn:80
    NameVirtualHost nnn.nnn.nnn.nnn:80
    
    <VirtualHost nnn.nnn.nnn.nnn:80>
      ServerName go.yourdomain.com
      DocumentRoot /var/www/html
    
      <IfVersion >= 2.4>
        ProxyPass         /  ws://localhost:8153/
        ProxyPassReverse  /  ws://localhost:8153/
      </IfVersion>
    
      <IfVersion < 2.4>
        ProxyPass         /  http://localhost:8153/
        ProxyPassReverse  /  http://localhost:8153/
      </IfVersion>
    
      ProxyPreserveHost On
    </VirtualHost>

    If you’re additionally using SSL (highly recommended), you may use the following snippet -

    Listen nnn.nnn.nnn.nnn:80
    NameVirtualHost nnn.nnn.nnn.nnn:80
    
    <VirtualHost nnn.nnn.nnn.nnn:80>
      ServerName gocd.example.com
    
      # Redirect any http requests to https
      RewriteEngine On
      RewriteRule ^/(.*)$ https://%{SERVER_NAME}/$1 [R=permanent,L]
    </VirtualHost>
    
    <VirtualHost nnn.nnn.nnn.nnn:443>
      ServerName gocd.example.com
    
      # Proxy everything over to the GoCD server
      ProxyPass         /  http://localhost:8153/
      ProxyPassReverse  /  http://localhost:8153/
      ProxyPreserveHost On
      RequestHeader set X-Forwarded-Proto "https"
    
      <Location />
        Order allow,deny
        Allow from all
      </Location>
    
      # SSL configuration
      SSLEngine on
    
      SSLCertificateFile /etc/pki/tls/certs/gocd.example.com.pem
      SSLCertificateKeyFile /etc/pki/tls/private/gocd.example.com.key
      SSLCertificateChainFile /etc/pki/tls/certs/gocd.example.com.pem.chained.pem
    </VirtualHost>

    GoCD with NGINX

    server {
      # Redirect any http requests to https
      listen         80;
      server_name    gocd.example.com;
      return 301     https://gocd.example.com$request_uri;
    }
    
    map $http_upgrade $connection_upgrade {
      default upgrade;
      '' close;
    }
    
    server {
      listen                    443 ssl;
      server_name               gocd.example.com;
    
      ssl_certificate           /etc/pki/tls/certs/gocd.example.com.chained.pem;
      ssl_certificate_key       /etc/pki/tls/private/gocd.example.com.key;
    
      # Proxy everything over to the GoCD server
      location / {
        proxy_set_header        Host            $host;
        proxy_set_header        X-Real-IP       $remote_addr;
        proxy_set_header        X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header        X-Forwarded-Proto $scheme;
        proxy_http_version      1.1;
        proxy_set_header 	      Upgrade $http_upgrade;
        proxy_set_header 	      Connection $connection_upgrade;
        proxy_pass              http://localhost:8153/;
        
        # To be able to upload artifacts larger than default size of 1mb, ensure that you set this up to a large value.
        # setting to `0` will disable checking for body size.
        # See https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size
        client_max_body_size  10000m;
      }
    }

    Also see…