Google Git
Sign in
gerrit / modules / virtualhost / 0c815ffa9efa6ca611b64a61a80d07f96475e2c5
commit0c815ffa9efa6ca611b64a61a80d07f96475e2c5[log] [tgz]
authorDariusz Luksza <dariusz.luksza@gmail.com>Tue Sep 19 12:04:13 2023 +0100
committerDariusz Luksza <dariusz.luksza@gmail.com>Tue Sep 19 13:55:10 2023 +0100
tree1d193c5f51196f8376c15c42f40d37a4662fb6bd
parent52d5f4f248bd00bf418cf73ad254eac6d009d102 [diff]
Add `X-Forwarded-Host` section to the README

To ensure the plugin works correctly in various network setups the
section about `X-Forwarded-Host` was added to the README.md file.

Change-Id: Ib27aefca39c5be6767d258145a39a2f9d0b4e7c2
1 file changed
tree: 1d193c5f51196f8376c15c42f40d37a4662fb6bd
  1. src/
  2. .gitignore
  3. BUILD
  4. LICENSE
  5. README.md
README.md

Gerrit VirtualHost

Gerrit lib module to split the projects' space into virtual hosts similarly of what you would do with an HTTP Server and different domain names.

How to build

Build this module as it was a Gerrit plugin:

  • Clone Gerrit source tree
  • Clone the virtualhost source tree
  • Link the virtualhost directory to Gerrit /plugins/virtualhost
  • From Gerrit source tree run bazel build plugins/virtualhost
  • The virtualhost.jar module is generated under /bazel-genfiles/plugins/virtualhost/

How install

Copy virtualhost.jar library to Gerrit /lib and add the following two extra settings to gerrit.config:

[gerrit]
  installModule = com.gerritforge.gerrit.modules.virtualhost.GuiceModule

[httpd]
  filterClass = com.gerritforge.gerrit.modules.virtualhost.VirtualHostFilter

Propagation of the X-Forwarded-Host Header:

When Gerrit is hidden behind multiple service layers (eg. reverse-proxy and load balancer), it is essential to ensure the propagation from the upstream proxy of the header X-Forwarded-Host from the upstream proxy.

How to define virtual hosts

/etc/virtualhost.config contains the definition of the virtual hosts and the set of projects included.

Each server section defines a virtual host and contains a set of projects included. Projects are defined using Gerrit ref-matching expressions and can be repeated multiple times to include multiple matchers.

Example to include all the projects starting with team1/ and the ones starting with the username:

[server "team1.mycompany.com"]
  projects = team1/*
  projects = ${username}/*

Default host

For all the other server names that are not defined and for SSH access, there is a special default section that lists of visible projects.

Example to include all the projects by default:

[default]
  projects = ^.*