GitLabgitlab-org

cli

main
ply6 git calls80 ms98 KiB5 cachedprotocol v2
94 lines3.1 KiBRaw

{{< details >}}

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

Some GitLab instances sit behind a proxy that requires its own credentials, separate from your GitLab authentication. To reach these instances, configure glab to send custom HTTP headers with every request.

The examples on this page are not exhaustive. Use them as a starting point for your proxy.

Configure custom HTTP headers

To access a GitLab instance through an authenticating proxy, add custom headers to the host entry in your global configuration file. Set each header value directly with value, from an environment variable with valueFromEnv, or from the output of a command with valueFromCommand. For example:

yaml
hosts:
  gitlab.example.com:
    custom_headers:
      - name: X-Proxy-Client-ID
        value: client-id
      - name: X-Proxy-Client-Secret
        valueFromEnv: PROXY_CLIENT_SECRET
      - name: Proxy-Authorization
        valueFromCommand: proxy-token-helper

The command must print the complete header value, on a single line, to standard output. glab:

  • Removes leading and trailing whitespace.
  • Fails if the command prints nothing, prints multiple lines or a NUL byte, or does not finish in 30 seconds.
  • Runs each configured command once per process, then reuses the result for all requests, including OAuth token refresh.

The command is split into an executable and arguments, and does not run in a shell. If you need shell expansion or pipelines, use an explicit shell, such as sh -c. Use valueFromEnv instead if another process manages token refresh, or if command startup time is a concern.

Google Identity-Aware Proxy

For a GitLab instance protected by Google Identity-Aware Proxy (IAP), replace SERVICE_ACCOUNT with the service account email and IAP_CLIENT_ID with the IAP OAuth client ID. Then reference the variable from the host configuration.

Export a complete Proxy-Authorization value:

shell
export GLAB_IAP_TOKEN="Bearer $(gcloud auth print-identity-token \
  --impersonate-service-account=SERVICE_ACCOUNT \
  --audiences=IAP_CLIENT_ID \
  --include-email)"

Then reference it from the host configuration:

yaml
hosts:
  gitlab.example.com:
    custom_headers:
      - name: Proxy-Authorization
        valueFromEnv: GLAB_IAP_TOKEN

Alternatively, generate a token whenever a glab process starts:

yaml
hosts:
  gitlab.example.com:
    custom_headers:
      - name: Proxy-Authorization
        valueFromCommand: >-
          sh -c 'printf "Bearer %s" "$(gcloud auth print-identity-token
          --impersonate-service-account=SERVICE_ACCOUNT
          --audiences=IAP_CLIENT_ID --include-email)"'

The active Google Cloud credentials must be allowed to impersonate the service account, and the service account must be allowed to access the IAP-protected application.

1---
2title: Connect through a proxy
3stage: AI Clients
4group: Developer Clients
5info: To determine the technical writer assigned to the Stage/Group associated with this page, see <https://handbook.gitlab.com/handbook/marketing/product-and-technical-marketing/technical-writing/#assignments>
6---
8{{< details >}}
10- Tier: Free, Premium, Ultimate
11- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
13{{< /details >}}
15Some GitLab instances sit behind a proxy that requires its own credentials, separate from your
16GitLab authentication. To reach these instances, configure `glab` to send custom HTTP headers
17with every request.
19The examples on this page are not exhaustive. Use them as a starting point for your proxy.
21## Configure custom HTTP headers
23To access a GitLab instance through an authenticating proxy, add custom headers
24to the host entry in your global configuration file. Set each header value
25directly with `value`, from an environment variable with `valueFromEnv`, or from
26the output of a command with `valueFromCommand`. For example:
28```yaml
29hosts:
30 gitlab.example.com:
31 custom_headers:
32 - name: X-Proxy-Client-ID
33 value: client-id
34 - name: X-Proxy-Client-Secret
35 valueFromEnv: PROXY_CLIENT_SECRET
36 - name: Proxy-Authorization
37 valueFromCommand: proxy-token-helper
38```
40The command must print the complete header value, on a single line, to standard
41output. `glab`:
43- Removes leading and trailing whitespace.
44- Fails if the command prints nothing, prints multiple lines or a `NUL` byte, or
45 does not finish in 30 seconds.
46- Runs each configured command once per process, then reuses the result for all
47 requests, including OAuth token refresh.
49The command is split into an executable and arguments, and does not run in a
50shell. If you need shell expansion or pipelines, use an explicit shell, such as
51`sh -c`. Use `valueFromEnv` instead if another process manages token refresh, or
52if command startup time is a concern.
54## Google Identity-Aware Proxy
56For a GitLab instance protected by Google Identity-Aware Proxy (IAP), replace
57`SERVICE_ACCOUNT` with the service account email and `IAP_CLIENT_ID` with the
58IAP OAuth client ID. Then reference the variable from the host configuration.
60Export a complete `Proxy-Authorization` value:
62```shell
63export GLAB_IAP_TOKEN="Bearer $(gcloud auth print-identity-token \
64 --impersonate-service-account=SERVICE_ACCOUNT \
65 --audiences=IAP_CLIENT_ID \
66 --include-email)"
67```
69Then reference it from the host configuration:
71```yaml
72hosts:
73 gitlab.example.com:
74 custom_headers:
75 - name: Proxy-Authorization
76 valueFromEnv: GLAB_IAP_TOKEN
77```
79Alternatively, generate a token whenever a `glab` process starts:
81```yaml
82hosts:
83 gitlab.example.com:
84 custom_headers:
85 - name: Proxy-Authorization
86 valueFromCommand: >-
87 sh -c 'printf "Bearer %s" "$(gcloud auth print-identity-token
88 --impersonate-service-account=SERVICE_ACCOUNT
89 --audiences=IAP_CLIENT_ID --include-email)"'
90```
92The active Google Cloud credentials must be allowed to impersonate the service
93account, and the service account must be allowed to access the IAP-protected
94application.
Diagnostics6 git calls · 80 ms
CallStatusSizeTime080 ms
discover200185 B3 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=185
git.server.agent=git/2.56.g1891de4-Linux
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch server-option object-format
git.server.fetch=shallow wait-for-done filter
git.protocol.version=2
git.pkt.frames=9
git.pkt.data=7
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=185
git.pkt.payload.max=35
ls-refs20058 KiB · hit3 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=3
git.response.bytes=59849
git.response.cache=HIT
git.response.duration_ms=3
git.protocol.version=2
git.pkt.frames=731
git.pkt.data=730
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=59849
git.pkt.payload.max=143
git.ls_refs.count=730
git.ls_refs.head=refs/heads/main
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=4273
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=combine:blob:none+tree:2
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=1
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=7
git.pkt.data=5
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=4273
git.pkt.payload.max=4173
git.sideband.band1.bytes=4173
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=11
git.pack.bytes=4173
git.fetch.wide.objects=11
git.fetch.wide.extra_bytes=3930
git.fetch.wide.blobs=0
fetchtree:0 · deepen 1020032 KiB · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=32926
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=22
git.pkt.data=20
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=32926
git.pkt.payload.max=32046
git.sideband.band1.bytes=32046
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=80
git.pack.bytes=32046
git.pack.ofs_delta=36
git.pack.ref_delta=0
git.pack.chain.max=2
git.pack.trailer=cb0bad5d7ffc514895d8b21c4dd470327f90bc91
git.pack.full=44
Open pack map
fetchtree:02001.7 KiB · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=73
git.response.bytes=1744
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=5e4007a5673eb3bf5d0d7f1a1463c3b2ca3fb3bd
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1744
git.pkt.payload.max=1717
git.sideband.band1.bytes=1717
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=1717
git.pack.trailer=3f1b9ccc7756e8941d6705e8187c87fd922113e6
Open pack map
fetch2001.4 KiB · hit73 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1449
git.response.cache=HIT
git.response.duration_ms=73
git.fetch.wants=9e366da33b199267fae423827f9bde94d28bdb41
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1449
git.pkt.payload.max=1422
git.sideband.band1.bytes=1422
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://gitlab.com/gitlab-org/cli
Ref
refs/heads/main
Commit
0dd7574dce9e385c5c30540e6c15657adc6bdce9
cf-ray
a5e18b2eeb015e37
Request
e0c71c9e…
Protocol
v2 · sha1
Agent
git/2.56.g1891de4-Linux
Filter
advertised
Fetch
shallow wait-for-done filter
Capabilities
agent ls-refs fetch server-option object-format