Configuration

The web client will look by default for a $HOME/.config/zuul/client.conf or a $HOME/.zuul.conf file for its configuration. The file should consist of a [webclient] section with at least the url attribute set. The optional verify_ssl can be set to False to disable SSL verifications when connecting to Zuul (defaults to True). An authentication token can also be stored in the configuration file under the attribute auth_token to avoid passing the token in the clear on the command line. A default tenant can also be set with the tenant attribute.

Here is an example of a configuration file that can be used with zuul-client:

# Example of a zuul-client configuration file.
# Several sections can be created for different Zuul instances or settings.
# The "example" section below can be used when calling zuul-client like so:
#
# zuul-client --use-config example ...

[example]
url=https://example.com/zuul/
# A default tenant can be specified in the configuration file; it will be
# overriden by the --tenant argument if set.
# Note that specifying a tenant is not necessary with a white-labeled tenant API URL,
# see https://zuul-ci.org/docs/zuul/howtos/installation.html#white-labeled-tenant
tenant=mytenant
# verify_ssl=False
auth_token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9
# the path must be writable by the user.
log_file=/path/to/log
log_level=DEBUG

[example2]
url=https://example2.com/zuul/
tenant=myothertenant
# If the identity provider allows Direct Access Grants, a user can exchange their
# credentials for an access token.
username=user1
# password=s3cr3t

It is also possible to run the web client without a configuration file, by using the --zuul-url option to specify the base URL of the Zuul web server.