Chapter 2. Running Red Hat Quay in debug mode


To gather debugging information for support cases and troubleshoot issues, you can run {product-title} in debug mode. Debug mode provides verbose logging that speeds up reproducing errors and supports root cause analysis for geo-replication, Operator, standalone deployments, and object storage.

2.1. Red Hat Quay debug variables

Red Hat Quay offers two configuration fields that can be added to your config.yaml file to help diagnose issues or help obtain log information.

Expand
Table 2.1. Debug configuration variables
VariableTypeDescription

DEBUGLOG

Boolean

Whether to enable or disable debug logs. Must be True or False.

USERS_DEBUG

Integer. Either 0 or 1.

Used to debug LDAP operations in clear text, including passwords. Must be used with DEBUGLOG=TRUE.

Important

Setting USERS_DEBUG=1 exposes credentials in clear text. This variable should be removed from the Red Hat Quay deployment after debugging. The log file that is generated with this environment variable should be scrutinized, and passwords should be removed before sending to other users. Use with caution.

To run a standalone Red Hat Quay deployment in debug mode and get verbose logging for troubleshooting, you can use podman run with DEBUGLOG=true. View debug output with the podman logs command.

Procedure

  1. Enter the following command to run your standalone Red Hat Quay deployment in debug mode:

    $ podman run -p 443:8443 -p 80:8080 -e DEBUGLOG=true  -v /config:/conf/stack -v /storage:/datastorage -d {productrepo}/{quayimage}:{productminv}
    Copy to Clipboard Toggle word wrap
  2. To view the debug logs, enter the following command:

    $ podman logs <quay_container_name>
    Copy to Clipboard Toggle word wrap

To run an LDAP Red Hat Quay deployment in debug mode and debug LDAP operations, you can use podman run with DEBUGLOG=true and USERS_DEBUG=1. View debug output with the podman logs command.

Procedure

  1. Enter the following command to run your LDAP Red Hat Quay deployment in debug mode:

    $ podman run -p 443:8443 -p 80:8080 -e DEBUGLOG=true -e USERS_DEBUG=1  -v /config:/conf/stack -v /storage:/datastorage -d {productrepo}/{quayimage}:{productminv}
    Copy to Clipboard Toggle word wrap
  2. To view the debug logs, enter the following command:

    $ podman logs <quay_container_name>
    Copy to Clipboard Toggle word wrap
    Important

    Setting USERS_DEBUG=1 exposes credentials in clear text. This variable should be removed from the Red Hat Quay deployment after debugging. The log file that is generated with this environment variable should be scrutinized, and passwords should be removed before sending to other users. Use with caution.

To run the {product-title} Operator in debug mode and get verbose logging for troubleshooting, you can edit the QuayRegistry custom resource and add DEBUGLOG=true to the env overrides. After the Operator restarts, try pulling an image or dump logs from Quay pods for more information.

Procedure

  1. Enter the following command to edit the QuayRegistry custom resource definition:

    $ oc edit quayregistry <quay_registry_name> -n <quay_namespace>
    Copy to Clipboard Toggle word wrap
  2. Update the QuayRegistry to add the following parameters:

    spec:
      - kind: quay
        managed: true
        overrides:
          env:
          - name: DEBUGLOG
            value: "true"
    Copy to Clipboard Toggle word wrap
  3. After the Red Hat Quay Operator has restarted with debugging enabled, try pulling an image from the registry. If it is still slow, dump all logs from all Quay pods to a file, and check the files for more information.
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2026 Red Hat
Back to top