OS Manuals

/usr/bin/gitlab-workhorse

A smart reverse proxy for GitLab intended to handle resource-intensive and long-running requests.

From gitlab-workhorse-ce-fips-19.2 19.2.9-r2 (enterprise-packages), captured 2026-11-08 by running gitlab-workhorse --help (exit 0). permalink

Usage of /usr/bin/gitlab-workhorse:

  /usr/bin/gitlab-workhorse [OPTIONS]

Options:
  -apiCiLongPollingDuration duration
    	Long polling duration for job requesting for runners (default 50ns)
  -apiLimit uint
    	Number of API requests allowed at single time
  -apiQueueDuration duration
    	Maximum queueing duration of requests (default 30s)
  -apiQueueLimit uint
    	Number of API requests allowed to be queued
  -authBackend string
    	Authentication/authorization backend (default "http://localhost:8080")
  -authSocket string
    	Optional: Unix domain socket to dial authBackend at
  -cableBackend string
    	ActionCable backend
  -cableSocket string
    	Optional: Unix domain socket to dial cableBackend at
  -config string
    	TOML file to load config from
  -developmentMode
    	Allow the assets to be served from Rails app
  -documentRoot string
    	Path to static files content (default "public")
  -iamServiceURL string
    	Optional: URL of the IAM Auth service for OAuth request routing during the AUTH-011 gradual rollout
  -listenAddr string
    	Listen address for HTTP server (default "localhost:8181")
  -listenNetwork string
    	Listen 'network' (tcp, tcp4, tcp6, unix) (default "tcp")
  -listenUmask int
    	Umask for Unix socket
  -logFile string
    	Log file location
  -logFormat string
    	Log format to use defaults to text (text, json, structured, none) (default "text")
  -pprofListenAddr string
    	pprof listening address, e.g. 'localhost:6060'
  -prometheusListenAddr string
    	Prometheus listening address, e.g. 'localhost:9229'
  -propagateCorrelationID X-Request-ID
    	Reuse existing Correlation-ID from the incoming request header X-Request-ID if present
  -proxyHeadersTimeout duration
    	How long to wait for response headers when proxying the request (default 5m0s)
  -secretPath string
    	File with secret key to authenticate with authBackend (default "./.gitlab_workhorse_secret")
  -version
    	Print version and exit
Options (23)
OptionDescriptionSource
-apiCiLongPollingDuration durationLong polling duration for job requesting for runners (default 50ns)help
-apiLimit uintNumber of API requests allowed at single timehelp
-apiQueueDuration durationMaximum queueing duration of requests (default 30s)help
-apiQueueLimit uintNumber of API requests allowed to be queuedhelp
-authBackend stringAuthentication/authorization backend (default "http://localhost:8080")help
-authSocket stringOptional: Unix domain socket to dial authBackend athelp
-cableBackend stringActionCable backendhelp
-cableSocket stringOptional: Unix domain socket to dial cableBackend athelp
-config stringTOML file to load config fromhelp
-developmentModeAllow the assets to be served from Rails apphelp
-documentRoot stringPath to static files content (default "public")help
-iamServiceURL stringOptional: URL of the IAM Auth service for OAuth request routing during the AUTH-011 gradual rollouthelp
-listenAddr stringListen address for HTTP server (default "localhost:8181")help
-listenNetwork stringListen 'network' (tcp, tcp4, tcp6, unix) (default "tcp")help
-listenUmask intUmask for Unix sockethelp
-logFile stringLog file locationhelp
-logFormat stringLog format to use defaults to text (text, json, structured, none) (default "text")help
-pprofListenAddr stringpprof listening address, e.g. 'localhost:6060'help
-prometheusListenAddr stringPrometheus listening address, e.g. 'localhost:9229'help
-propagateCorrelationID X-Request-IDReuse existing Correlation-ID from the incoming request header X-Request-ID if presenthelp
-proxyHeadersTimeout durationHow long to wait for response headers when proxying the request (default 5m0s)help
-secretPath stringFile with secret key to authenticate with authBackend (default "./.gitlab_workhorse_secret")help
-versionPrint version and exithelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.